Documentation

Class: OutgoingTransfer

OutgoingTransfer

An OutgoingTransfer represents the currently active outgoing transfer initiated by the Worker to another Worker or queue

Properties:
Name Type Description
dateCreated Date

The timestamp when this OutgoingTransfer was created
dateUpdated Date

The timestamp when this OutgoingTransfer was last updated
mode string

Transfer mode ['WARM', 'COLD']
reservationSid string

The sid of the initiating Reservation.
sid string

The sid of this OutgoingTransfer
status string

['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED']
to string

The sid of the Worker or TaskQueue this OutgoingTransfer is intended for
transferFailedReason string

The reason, if applicable, for why the transfer failed
type string

The transfer type ['QUEUE', 'WORKER']
workerSid string

The sid of the initiating Worker

Methods

<async> cancel()

Cancel the ongoing OutgoingTransfer

Returns:
Type
Promise.<this>

Events

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