Class ScheduleTask

constructor

• new ScheduleTask(userClient, taskProps, parentSchedule): ScheduleTask

• Parameters

  • userClient: UserClient
  • taskProps: RawScheduleTask
  • parentSchedule: Schedule

  Returns ScheduleTask

action

continue_on_failure

Readonlycreated_at

Readonlyid

Readonlyis_queued

ReadonlyparentSchedule

payload

Readonlysequence_id

time_offset

updated_at

delete

• delete(): Promise<void>

• Delete this task

  Returns Promise<void>

setAction

• setAction(action, payload?): Promise<void>

• Set the action type (and a new payload)

  Parameters

  • action: ScheduleActionType
  • Optionalpayload: string

  Returns Promise<void>

setContinueOnFailure

• setContinueOnFailure(continueOnFailure): Promise<void>

• Update the continue_on_failure flag of the task

  Parameters

  • continueOnFailure: boolean

    The new continue_on_failure flag

  Returns Promise<void>

setPayload

• setPayload(payload): Promise<void>

• Update the payload of the task

  Parameters

  • payload: string

    The new payload

  Returns Promise<void>

setTimeOffset

• setTimeOffset(timeOffset): Promise<void>

• Update the time_offset of the task

  Parameters

  • timeOffset: number

    The new time_offset

  Returns Promise<void>