Skip to main content
Message Scheduler Schedules messages for future delivery using the IMessageSDK

Constructor

Parameters

required

Returns

MessageScheduler

Methods

cancel()

Cancel a scheduled message

Parameters

string
required

Returns

boolean true if cancelled, false if not found

destroy()

Destroy the scheduler and clean up resources

export()

Export all scheduled messages (for persistence)

Returns

RecurringMessageScheduledMessage

get()

Get a scheduled message by ID

Parameters

string
required

Returns

ScheduledMessageRecurringMessage

getPending()

Get all pending scheduled messages

Returns

ScheduledMessageRecurringMessage

import()

Import scheduled messages (for persistence) Only imports pending messages with future send times

Parameters

{ recurring: RecurringMessage[]; scheduled: ScheduledMessage[] }
required

Returns

{ imported: number; skipped: number }

reschedule()

Reschedule a pending message

Parameters

string
required
Date
required

Returns

boolean true if rescheduled, false if not found or not pending

schedule()

Schedule a one-time message

Parameters

Returns

string The scheduled message ID

scheduleRecurring()

Schedule a recurring message

Parameters

Returns

string The recurring message ID