Class Supervisor

A wrapper for the TaskRouter Supervisor class.

Hierarchy

Supervisor
- Supervisor

Constructors

constructor

new Supervisor(token: string, options?: WorkerOptions): Supervisor
Parameters
- token: string
- Optionaloptions: WorkerOptions
Returns Supervisor
Overrides TRSupervisor.constructor

Properties

`Readonly`accountSid

accountSid: string

`Readonly`activities

activities: Map<string, Activity>

`Readonly`activity

activity: Activity

`Readonly`activitySid

activitySid: string

`Readonly`attributes

attributes: Record<string, any>

`Readonly`available

available: boolean

`Readonly`channels

channels: Map<string, Channel>

`Readonly`connectActivitySid

connectActivitySid: string

`Readonly`dateActivityChanged

dateActivityChanged: Date

`Readonly`dateCreated

dateCreated: Date

`Readonly`dateStatusChanged

dateStatusChanged: Date

`Readonly`dateUpdated

dateUpdated: Date

`Readonly`disconnectActivitySid

disconnectActivitySid: string

`Readonly`friendlyName

friendlyName: string

`Readonly`name

name: string

`Readonly`reservations

reservations: Map<string, Reservation>

`Readonly`sid

sid: string

version

version: string

`Readonly`workerActivitySid

workerActivitySid: string

`Readonly`workerSid

workerSid: string

`Readonly`workspaceSid

workspaceSid: string

Methods

addListener

addListener<E extends keyof WorkerEvents>(
event: E,
listener: WorkerEvents[E],
): this
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
- listener: WorkerEvents[E]
Returns this
Inherited from TRSupervisor.addListener

createTask

createTask(
    to: string,
    from: string,
    workflowSid: string,
    taskQueueSid: string,
    options?: TaskOptions,
): Promise<string>
Parameters
- to: string
- from: string
- workflowSid: string
- taskQueueSid: string
- Optionaloptions: TaskOptions
Returns Promise<string>
Inherited from TRSupervisor.createTask

disconnect

disconnect(): void
Returns void
Inherited from TRSupervisor.disconnect

emit

emit<E extends keyof WorkerEvents>(
event: E,
...args: Parameters<WorkerEvents[E]>,
): boolean
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
- ...args: Parameters<WorkerEvents[E]>
Returns boolean
Inherited from TRSupervisor.emit

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from TRSupervisor.eventNames

fetchLatestVersion

fetchLatestVersion(): Promise<Worker>
Returns Promise<Worker>
Inherited from TRSupervisor.fetchLatestVersion

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TRSupervisor.getMaxListeners

listenerCount

listenerCount<E extends keyof WorkerEvents>(event: E): number
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
Returns number
Inherited from TRSupervisor.listenerCount

listeners

listeners<E extends keyof WorkerEvents>(event: E): WorkerEvents[E][]
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
Returns WorkerEvents[E][]
Inherited from TRSupervisor.listeners

monitor

monitor(
    taskSid: string,
    reservationSid: string,
    extraParams: Object,
): Promise<void>
Parameters
- taskSid: string
- reservationSid: string
- extraParams: Object
Returns Promise<void>
Inherited from TRSupervisor.monitor

off

off<E extends keyof WorkerEvents>(event: E, listener: WorkerEvents[E]): this
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
- listener: WorkerEvents[E]
Returns this
Inherited from TRSupervisor.off

on

on<E extends keyof WorkerEvents>(event: E, listener: WorkerEvents[E]): this
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
- listener: WorkerEvents[E]
Returns this
Inherited from TRSupervisor.on

once

once<E extends keyof WorkerEvents>(event: E, listener: WorkerEvents[E]): this
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
- listener: WorkerEvents[E]
Returns this
Inherited from TRSupervisor.once

prependListener

prependListener<E extends keyof WorkerEvents>(
event: E,
listener: WorkerEvents[E],
): this
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
- listener: WorkerEvents[E]
Returns this
Inherited from TRSupervisor.prependListener

prependOnceListener

prependOnceListener<E extends keyof WorkerEvents>(
event: E,
listener: WorkerEvents[E],
): this
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
- listener: WorkerEvents[E]
Returns this
Inherited from TRSupervisor.prependOnceListener

rawListeners

rawListeners<E extends keyof WorkerEvents>(event: E): WorkerEvents[E][]
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
Returns WorkerEvents[E][]
Inherited from TRSupervisor.rawListeners

removeAllListeners

removeAllListeners<E extends keyof WorkerEvents>(event?: E): this
Type Parameters
- E extends keyof WorkerEvents
Parameters
- Optionalevent: E
Returns this
Inherited from TRSupervisor.removeAllListeners

removeListener

removeListener<E extends keyof WorkerEvents>(
event: E,
listener: WorkerEvents[E],
): this
Type Parameters
- E extends keyof WorkerEvents
Parameters
- event: E
- listener: WorkerEvents[E]
Returns this
Inherited from TRSupervisor.removeListener

setAttributes

setAttributes(attributes: any): Promise<Worker>
Parameters
- attributes: any
Returns Promise<Worker>
Inherited from TRSupervisor.setAttributes

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Inherited from TRSupervisor.setMaxListeners

setWorkerActivity

setWorkerActivity(
    workerSid: string,
    activitySid: string,
    options?: ActivityOptions,
): Promise<Worker>
Parameters
- workerSid: string
- activitySid: string
- Optionaloptions: ActivityOptions
Returns Promise<Worker>
Inherited from TRSupervisor.setWorkerActivity

setWorkerAttributes

setWorkerAttributes(
workerSid: string,
attributes: Record<string, any>,
): Promise<Worker>
Parameters
- workerSid: string
- attributes: Record<string, any>
Returns Promise<Worker>
Inherited from TRSupervisor.setWorkerAttributes

updateToken

updateToken(newToken: string): void
Parameters
- newToken: string
Returns void
Inherited from TRSupervisor.updateToken

Class Supervisor

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Supervisor

Properties

ReadonlyaccountSid

Readonlyactivities

Readonlyactivity

ReadonlyactivitySid

Readonlyattributes

Readonlyavailable

Readonlychannels

ReadonlyconnectActivitySid

ReadonlydateActivityChanged

ReadonlydateCreated

ReadonlydateStatusChanged

ReadonlydateUpdated

ReadonlydisconnectActivitySid

ReadonlyfriendlyName

Readonlyname

Readonlyreservations

Readonlysid

version

ReadonlyworkerActivitySid

ReadonlyworkerSid

ReadonlyworkspaceSid

Methods

addListener

Type Parameters

Parameters

Returns this

createTask

Parameters

Returns Promise<string>

disconnect

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

fetchLatestVersion

Returns Promise<Worker>

getMaxListeners

Returns number

listenerCount

Type Parameters

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns WorkerEvents[E][]

monitor

Parameters

Returns Promise<void>

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

prependListener

Type Parameters

Parameters

Returns this

prependOnceListener

`Readonly`accountSid

`Readonly`activities

`Readonly`activity

`Readonly`activitySid

`Readonly`attributes

`Readonly`available

`Readonly`channels

`Readonly`connectActivitySid

`Readonly`dateActivityChanged

`Readonly`dateCreated

`Readonly`dateStatusChanged

`Readonly`dateUpdated

`Readonly`disconnectActivitySid

`Readonly`friendlyName

`Readonly`name

`Readonly`reservations

`Readonly`sid

`Readonly`workerActivitySid

`Readonly`workerSid

`Readonly`workspaceSid