Documentation

Classes

Classes

Activity
Channel
IncomingTransfer
OutgoingTransfer
Reservation
Supervisor
Task
TaskQueue
Transfers
Worker
Workspace

Events

availabilityUpdated

The availability of this Channel was updated

Parameters:
Name Type Description
channel Channel

The Channel whose availability was updated

capacityUpdated

The capacity of this Channel was updated

Parameters:
Name Type Description
channel Channel

The Channel whose capacity was updated

attemptFailed

The attempt to transfer the Task to the desired entity failed

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The OutgoingTransfer that had an attempt failure

canceled

The Task's current OutgoingTransfer has successfully been cancelled

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The OutgoingTransfer that was canceled

completed

The OutgoingTransfer has successfully been transferred to the desired entity

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The OutgoingTransfer that was completed

failed

All attempts to transfer the Task to the desired entity have failed. No more attempts on the OutgoingTransfer will be made.

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The OutgoingTransfer that has failed

accepted

Fired when a Reservation has been accepted for this Worker

Parameters:
Name Type Description
reservation Reservation

The accepted Reservation

canceled

Fired when a Reservation has been canceled for this Worker

Parameters:
Name Type Description
reservation Reservation

The canceled Reservation

completed

Fired when an accepted Reservation has been completed for this Worker

Parameters:
Name Type Description
reservation Reservation

The completed Reservation

rejected

Fired when a Reservation has been rejected for this Worker

Parameters:
Name Type Description
reservation Reservation

The rejected Reservation

rescinded

Fired when a Reservation has been rescinded for the Worker

Parameters:
Name Type Description
reservation Reservation

The rescinded Reservation

timeout

Fired when a Reservation has been timed out for this Worker

Parameters:
Name Type Description
reservation Reservation

The timed out Reservation

wrapup

Fired when a Reservation has been wrapped up for the Worker

Parameters:
Name Type Description
reservation Reservation

The wrapped up Reservation

activityUpdated

Worker activity has updated

Parameters:
Name Type Description
worker Worker

The updated Worker
Inherited From:

attributesUpdated

Worker attributes have updated

Parameters:
Name Type Description
worker Worker

The updated Worker
Inherited From:

disconnected

The signaling layer has lost the websocket connection

Parameters:
Name Type Description
reason Object

The reason the Worker websocket disconnected
Inherited From:

error

An error has occurred

Parameters:
Name Type Description
error Error

The Error that occurred
Inherited From:

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:

reservationCreated

A Reservation has been created for the Worker

Parameters:
Name Type Description
reservation Reservation

The created Reservation
Inherited From:

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:

tokenExpired

The Worker token has expired

Inherited From:

tokenUpdated

The Worker token has successfully updated

Inherited From:

canceled

The Task was canceled

Parameters:
Name Type Description
task Task

The Task who was canceled

completed

The Task was completed

Parameters:
Name Type Description
task Task

The Task who was completed

transferAttemptFailed

An OutgoingTransfer attempt has been failed for Task

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The currently in process OutgoingTransfer

transferCanceled

An OutgoingTransfer has been canceled for Task

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The currently in process OutgoingTransfer

transferCompleted

An OutgoingTransfer has been competed for Task

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The currently in process OutgoingTransfer

transferFailed

An OutgoingTransfer has been failed for Task

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The currently in process OutgoingTransfer

transferInitiated

An OutgoingTransfer has been initiated for Task

Parameters:
Name Type Description
outgoingTransfer OutgoingTransfer

The currently in process OutgoingTransfer

updated

The attributes of this Task was updated

Parameters:
Name Type Description
task Task

The Task whose attributes were updated

wrapup

The Task was wrapped up

Parameters:
Name Type Description
task Task

The Task who was wrapped up

activityUpdated

Worker activity has updated

Parameters:
Name Type Description
worker Worker

The updated Worker

attributesUpdated

Worker attributes have updated

Parameters:
Name Type Description
worker Worker

The updated Worker

disconnected

The signaling layer has lost the websocket connection

Parameters:
Name Type Description
reason Object

The reason the Worker websocket disconnected

error

An error has occurred

Parameters:
Name Type Description
error Error

The Error that occurred

ready

Worker is ready to listen for events and take action

reservationCreated

A Reservation has been created for the Worker

Parameters:
Name Type Description
reservation Reservation

The created Reservation

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

tokenExpired

The Worker token has expired

tokenUpdated

The Worker token has successfully updated