Class ScheduleTask

Implements

ScheduleTaskAttributes

Index

Constructors

Properties

action continue_on_failure created_at id is_queued parentSchedule payload sequence_id time_offset updated_at

Methods

delete setAction setContinueOnFailure setPayload setTimeOffset

Constructors

constructor

new ScheduleTask(userClient, taskProps, parentSchedule): ScheduleTask
Parameters
- userClient: UserClient
- taskProps: RawScheduleTask
- parentSchedule: Schedule
Returns ScheduleTask
- Defined in src/UserClient/ScheduleTask.ts:19

Properties

action

action: ScheduleActionType

continue_on_failure

continue_on_failure: boolean

`Readonly`created_at

created_at: Date

`Readonly`id

id: number

`Readonly`is_queued

is_queued: boolean

`Readonly`parentSchedule

parentSchedule: Schedule

payload

payload: string

`Readonly`sequence_id

sequence_id: number

time_offset

time_offset: number

updated_at

updated_at: Date

Methods

delete

delete(): Promise<void>
Delete this task

Returns Promise<void>
- Defined in src/UserClient/ScheduleTask.ts:101

setAction

setAction(action, payload?): Promise<void>
Set the action type (and a new payload)
Parameters
- action: ScheduleActionType
- Optionalpayload: string
Returns Promise<void>
- Defined in src/UserClient/ScheduleTask.ts:61

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>
- Defined in src/UserClient/ScheduleTask.ts:82

setPayload

setPayload(payload): Promise<void>
Update the payload of the task
Parameters
- payload: string
  The new payload
Returns Promise<void>
- Defined in src/UserClient/ScheduleTask.ts:72

setTimeOffset

setTimeOffset(timeOffset): Promise<void>
Update the time_offset of the task
Parameters
- timeOffset: number
  The new time_offset
Returns Promise<void>
- Defined in src/UserClient/ScheduleTask.ts:92