Properties:
| Name | Type | Argument | Description |
|---|---|---|---|
dateCreated |
Date | The timestamp when this Transfer was created |
|
dateUpdated |
Date | The timestamp when this Transfer was last updated |
|
mode |
string | Transfer mode ['WARM', 'COLD'] |
|
queueSid |
string | The Sid of the TaskQueue the Task belongs to |
|
reservationSid |
string | The Sid of the initiating Reservation. |
|
to |
string | The sid of the Worker or TaskQueue this Transfer is intended for |
|
transferFailedReason |
string |
<optional> |
The reason, if applicable, for why a transfer failed |
type |
string | The transfer type ['QUEUE', 'WORKER'] |
|
sid |
string | The sid of this Transfer |
|
status |
string | ['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED'] |
|
workerSid |
string | The sid of the initiating Worker |
|
workflowSid |
string | The Sid of the Workflow the Task was created against |
Extends
- Transfer
Members
-
taskSid :string
-
taskSid
Type:
- string
Methods
-
<async> cancel()
-
Cancel the ongoing OutgoingTransfer
Returns:
- Rejected if the OutgoingTransfer state could not be updated to 'canceled'
- Type
- Promise.<this>
Events
-
attemptFailed
-
The attempt to transfer the Task to the desired entity failed
Parameters:
Name Type Description outgoingTransferOutgoingTransfer The OutgoingTransfer that had an attempt failure
-
canceled
-
The Task's current OutgoingTransfer has successfully been cancelled
Parameters:
Name Type Description outgoingTransferOutgoingTransfer The OutgoingTransfer that was canceled
-
completed
-
The OutgoingTransfer has successfully been transferred to the desired entity
Parameters:
Name Type Description outgoingTransferOutgoingTransfer 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 outgoingTransferOutgoingTransfer The OutgoingTransfer that has failed