Class MessageScheduler

Index

Constructors

Methods

cancel cancelForJid clearAll get getPending schedule scheduleDelay start stop

Constructors

constructor

new MessageScheduler(
sendMessage: (jid: string, content: AnyMessageContent) => Promise<any>,
options?: SchedulerOptions,
): MessageScheduler
Parameters
- sendMessage: (jid: string, content: AnyMessageContent) => Promise<any>
- Optionaloptions: SchedulerOptions
Returns MessageScheduler
- Defined in lib/Utils/scheduling.d.ts:31

Methods

cancel

cancel(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in lib/Utils/scheduling.d.ts:34

cancelForJid

cancelForJid(jid: string): number
Parameters
- jid: string
Returns number
- Defined in lib/Utils/scheduling.d.ts:35

clearAll

clearAll(): number
Returns number
- Defined in lib/Utils/scheduling.d.ts:38

get

get(id: string): ScheduledMessage | undefined
Parameters
- id: string
Returns ScheduledMessage | undefined
- Defined in lib/Utils/scheduling.d.ts:37

getPending

getPending(): ScheduledMessage[]
Returns ScheduledMessage[]
- Defined in lib/Utils/scheduling.d.ts:36

schedule

schedule(
    jid: string,
    content: AnyMessageContent,
    scheduledTime: Date,
    repeatOptions?: RepeatOptions,
): ScheduledMessage
Parameters
- jid: string
- content: AnyMessageContent
- scheduledTime: Date
- OptionalrepeatOptions: RepeatOptions
Returns ScheduledMessage
- Defined in lib/Utils/scheduling.d.ts:32

scheduleDelay

scheduleDelay(
    jid: string,
    content: AnyMessageContent,
    delayMs: number,
    repeatOptions?: RepeatOptions,
): ScheduledMessage
Parameters
- jid: string
- content: AnyMessageContent
- delayMs: number
- OptionalrepeatOptions: RepeatOptions
Returns ScheduledMessage
- Defined in lib/Utils/scheduling.d.ts:33

start

start(): void
Returns void
- Defined in lib/Utils/scheduling.d.ts:40

stop

stop(): void
Returns void
- Defined in lib/Utils/scheduling.d.ts:39