Class: Supervisor

Extends

• Worker

Members

---

<readonly> accountSid :string

Type:

• string

Inherited From:

• Worker#accountSid

---

activities

Inherited From:

• Worker#activities

---

<readonly> activity

Inherited From:

• Worker#activity

---

<readonly> attributes :Record.<any, any>

Type:

• Record.<any, any>

Inherited From:

• Worker#attributes

---

channels

Inherited From:

• Worker#channels

---

<readonly> dateActivityChanged :Date

Type:

• Date

Inherited From:

• Worker#dateActivityChanged

---

<readonly> dateCreated :Date

Type:

• Date

Inherited From:

• Worker#dateCreated

---

<readonly> dateStatusChanged :Date

Type:

• Date

Inherited From:

• Worker#dateStatusChanged

---

<readonly> dateUpdated :Date

Type:

• Date

Inherited From:

• Worker#dateUpdated

---

<readonly> friendlyName :string

Type:

• string

Inherited From:

• Worker#friendlyName

---

<readonly> name :string

Type:

• string

Inherited From:

• Worker#name

---

reservations

Inherited From:

• Worker#reservations

---

<readonly> sid :string

Type:

• string

Inherited From:

• Worker#sid

---

version :string

Type:

• string

Inherited From:

• Worker#version

---

<readonly> workerActivitySid :string

Type:

• string

Inherited From:

• Worker#workerActivitySid

---

<readonly> workerSid :string

Type:

• string

Inherited From:

• Worker#workerSid

---

<readonly> workspaceSid :string

Type:

• string

Inherited From:

• Worker#workspaceSid

Methods

---

_bumpVersion()

bumps the worker version

Inherited From:

• Worker#_bumpVersion

---

createTask(to, from, workflowSid, taskQueueSid [, options])

Create a Task

Parameters:

Name	Type	Argument	Description
to	string		The contact uri of the customer. Stored in the Task's attributes as "outbound_to"
from	string		The contact uri of the Worker. Stored in the Task's attributes as "from"
workflowSid	string		The Sid of the Workflow this Task should belong to
taskQueueSid	string		The Sid of the TaskQueue this Task should belong to, used for reporting purposes only
options	WorkerTaskOptions	<optional>

Inherited From:

• Worker#createTask

Returns:

• Rejected if unable to create a Task on behalf of the Worker. Returns the TaskSid of the created Task.

Type

Promise.<string>

---

disconnect()

Gracefully disconnect the client.

Inherited From:

• Worker#disconnect

Returns:

Type

void

---

fetchLatestVersion()

Fetch the last version of this Worker

Inherited From:

• Worker#fetchLatestVersion

Returns:

Type

Promise.<this>

---

getLogger(prefix)

Parameters:

Name	Type	Description
prefix	string

Inherited From:

• Worker#getLogger

Returns:

Type

Logger

---

getRoutes()

Inherited From:

• Worker#getRoutes

Returns:

Type

Routes

---

monitor(taskSid, reservationSid [, extraParams])

Add this Supervisor to an ongoing Reservation by Sid.

Parameters:

Name	Type	Argument	Description
taskSid	string		The sid of the Task to add a monitor to.
reservationSid	string		The sid of the Reservation to add a monitor to.
extraParams	Record.<any, any>	<optional>	An object containing extra params to append to the payload.

Returns:

Promise

---

setAttributes(attributes)

Update attributes

Parameters:

Name	Type	Description
attributes	Record.<any, any>	A JSON describing the Worker's attributes

Inherited From:

• Worker#setAttributes

Returns:

• Rejected if the attributes cannot be set

Type

Promise.<this>

---

updateToken(newToken)

Update token

Parameters:

Name	Type	Description
newToken	string	The new token that should be used for authentication

Inherited From:

• Worker#updateToken

Returns:

• Emits error if unable to update token

Type

void

Events

---

activityUpdated

Worker activity has updated

Parameters:

Name	Type	Description
worker	Worker	The updated Worker

Inherited From:

• Worker#event:activityUpdated

---

attributesUpdated

Worker attributes have updated

Parameters:

Name	Type	Description
worker	Worker	The updated Worker

Inherited From:

• Worker#event:attributesUpdated

---

disconnected

The signaling layer has lost the websocket connection

Parameters:

Name	Type	Description
reason	Object	The reason the Worker websocket disconnected

Inherited From:

• Worker#event:disconnected

---

error

An error has occurred

Parameters:

Name	Type	Description
error	Error	The Error that occurred

Inherited From:

• Worker#event:error

---

monitor

Add this Supervisor to an ongoing Reservation by Sid.

Parameters:

Name	Type	Argument	Description
taskSid	string		The sid of the Task to add a monitor to.
reservationSid	string		The sid of the Reservation to add a monitor to.
extraParams	Object	<optional>	An object containing extra params to append to the payload.

---

ready

Worker is ready to listen for events and take action

Inherited From:

• Worker#event:ready

---

reservationCreated

A Reservation has been created for the Worker

Parameters:

Name	Type	Description
reservation	Reservation	The created Reservation

Inherited From:

• Worker#event:reservationCreated

---

reservationFailed

Worker was unable to receive a Reservation for the Task it created

Parameters:

Name	Type	Description
task	Object	The raw Task-like payload that failed to generate a Reservation

Inherited From:

• Worker#event:reservationFailed

---

tokenExpired

The Worker token has expired

Inherited From:

• Worker#event:tokenExpired

---

tokenUpdated

The Worker token has successfully updated

Inherited From:

• Worker#event:tokenUpdated