Interface ScheduledTaskModule

Defines a task that is executed periodically or upon the start of the bot.

since: 2.0.0

Hierarchy

Module
- ScheduledTaskModule

Implemented by

AbstractScheduledTaskModule

Index

Methods

Methods

execute

execute(): Promise<any>

- Defined in api/modules/ScheduledTaskModule.ts:17
The method that gets executed periodically or on start, depending on the module's configuration.

abstract

since

2.0.0

Returns Promise<any>

A promise that is used to determine if and when the task completes.

getRuntime

getRuntime(): ModuleAwareRuntime

Inherited from Module.getRuntime
- Defined in api/modules/Module.ts:14
Returns a runtime object corresponding to the current module.

since

2.0.0

Returns ModuleAwareRuntime

getSchedule

getSchedule(): string | number

- Defined in api/modules/ScheduledTaskModule.ts:26
Returns the schedule that specifies when this commands gets executed. This must be a cron-like string or a number in milliseconds. If this returns 0 or undefined or null, this task will never be scheduled to run.

since

2.0.0

Returns string | number

onListen

onListen(): Promise<any>

Inherited from Module.onListen
- Defined in api/modules/Module.ts:21
Gets called when the bot starts listening.

since

2.0.0

Returns Promise<any>

onShutdown

onShutdown(): Promise<any>

Inherited from Module.onShutdown
- Defined in api/modules/Module.ts:28
Gets called when the bot is shutting down.

since

2.0.0

Returns Promise<any>

shouldExecuteOnStart

shouldExecuteOnStart(): boolean

- Defined in api/modules/ScheduledTaskModule.ts:34
Returns true if the scheduled task should run when the bot starts, or false otherwise.

since

2.0.0

Returns boolean

Generated using TypeDoc