Class Task

Hierarchy

TypedEventEmitter<TaskEvents, this>
- Task

Constructors

constructor

new Task(): Task
Returns Task
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).constructor

Properties

`Readonly`addOns

addOns: Object

`Readonly`age

age: number

`Readonly`attributes

attributes: Record<string, any>

`Readonly`dateCreated

dateCreated: Date

`Readonly`dateUpdated

dateUpdated: Date

`Readonly`priority

priority: number

`Readonly`queueName

queueName: string

`Readonly`queueSid

queueSid: string

`Readonly`reason

reason: string

`Readonly`routingTarget

routingTarget: string

`Readonly`sid

sid: string

`Readonly`status

status:
    | "completed"
    | "canceled"
    | "pending"
    | "wrapping"
    | "reserved"
    | "assigned"

`Readonly`taskChannelSid

taskChannelSid: string

`Readonly`taskChannelUniqueName

taskChannelUniqueName: string

`Readonly`timeout

timeout: number

`Readonly`transfers

transfers: Transfers

`Readonly`version

version: string

`Readonly`virtualStartTime

virtualStartTime: Date

`Readonly`workflowName

workflowName: string

`Readonly`workflowSid

workflowSid: string

Methods

addListener

addListener<E extends keyof TaskEvents>(event: E, listener: TaskEvents[E]): this
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
- listener: TaskEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).addListener

complete

complete(reason: string): Promise<Task>
Parameters
- reason: string
Returns Promise<Task>

emit

emit<E extends keyof TaskEvents>(
event: E,
...args: Parameters<TaskEvents[E]>,
): boolean
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
- ...args: Parameters<TaskEvents[E]>
Returns boolean
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).emit

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).eventNames

fetchLatestVersion

fetchLatestVersion(): Promise<Task>
Returns Promise<Task>

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).getMaxListeners

hold

hold(
    targetWorkerSid: string,
    onHold: boolean,
    options?: TaskHoldOptions,
): Promise<Task>
Parameters
- targetWorkerSid: string
- onHold: boolean
- Optionaloptions: TaskHoldOptions
Returns Promise<Task>

kick

kick(workerSid: string): Promise<Task>
Parameters
- workerSid: string
Returns Promise<Task>

listenerCount

listenerCount<E extends keyof TaskEvents>(event: E): number
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).listenerCount

listeners

listeners<E extends keyof TaskEvents>(event: E): TaskEvents[E][]
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
Returns TaskEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).listeners

off

off<E extends keyof TaskEvents>(event: E, listener: TaskEvents[E]): this
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
- listener: TaskEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).off

on

on<E extends keyof TaskEvents>(event: E, listener: TaskEvents[E]): this
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
- listener: TaskEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).on

once

once<E extends keyof TaskEvents>(event: E, listener: TaskEvents[E]): this
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
- listener: TaskEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).once

prependListener

prependListener<E extends keyof TaskEvents>(
event: E,
listener: TaskEvents[E],
): this
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
- listener: TaskEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).prependListener

prependOnceListener

prependOnceListener<E extends keyof TaskEvents>(
event: E,
listener: TaskEvents[E],
): this
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
- listener: TaskEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).prependOnceListener

rawListeners

rawListeners<E extends keyof TaskEvents>(event: E): TaskEvents[E][]
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
Returns TaskEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).rawListeners

removeAllListeners

removeAllListeners<E extends keyof TaskEvents>(event?: E): this
Type Parameters
- E extends keyof TaskEvents
Parameters
- Optionalevent: E
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).removeAllListeners

removeListener

removeListener<E extends keyof TaskEvents>(
event: E,
listener: TaskEvents[E],
): this
Type Parameters
- E extends keyof TaskEvents
Parameters
- event: E
- listener: TaskEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).removeListener

setAttributes

setAttributes(attributes: Object): Promise<Task>
Parameters
- attributes: Object
Returns Promise<Task>

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<TaskEvents>).setMaxListeners

setVirtualStartTime

setVirtualStartTime(date: Date): Promise<Task>
Parameters
- date: Date
Returns Promise<Task>

transfer

transfer(to: string, options: TransferOptions): Promise<Task>
Parameters
- to: string
- options: TransferOptions
Returns Promise<Task>

updateParticipant

updateParticipant(options: TaskParticipantOptions): Promise<Task>
Parameters
- options: TaskParticipantOptions
Returns Promise<Task>

wrapUp

wrapUp(options: WrappingOptions): Promise<Task>
Parameters
- options: WrappingOptions
Returns Promise<Task>