Instance methods
DynamicSchedule: register() instance method
Instance methods
DynamicSchedule: register() instance method
Use this method to register a new schedule with the DynamicSchedule.
Parameters
id
string
requiredThe id of the schedule to register. The identifier you use will be available in the
context.source.id when the Job runs.
schedule
Schedule
requiredThe schedule to register. It is either a cron or interval schedule.
Returns
id
string
The id of the schedule that was registered.
schedule
Schedule
The schedule that was registered, one of “cron” or “interval”.
metadata
any
requiredMetadata about the schedule.
active
boolean
requiredWhether the schedule is active or not.
Was this page helpful?