ITask

Properties:

• source: Task

  source object backing the task

• sourceObject: object

  source object backing the instance (any)

• addOns: object

  the addons attached to the Task

• age: number

  the age of the Task in seconds

• attributes: object

  the attributes of the Task

• dateCreated: Date

  the date the Task was created

• dateUpdated: Date

  the date the Task was last updated

• priority: number

  the priority of the Task

• queueName: string

  the friendly name of the TaskQueue the Task is currently in

• queueSid: string

  the sid of the TaskQueue the Task is currently in

• reason: string

  the reason the Task was completed or canceled, if applicable

• sid: string

  the sid of the Reservation

• status: ITask.TaskReservationStatus

  the status of the Reservation

• taskSid: string

  the sid of the Task

• taskStatus: ITask.TaskTaskStatus

  the status of the Task

• taskChannelSid: string

  the sid of the Task Channel associated to the Task in MultiTask mode

• taskChannelUniqueName: string

  the unique name of the Task Channel associated to the Task in MultiTask mode

• timeout: number

  the number of seconds the Task is allowed to live

• workflowName: string

  the name of the Workflow responsible for routing the Task

• workflowSid: string

  the sid of the Workflow responsible for routing the Task

• workerSid: string

  the sid of the worker the task is assigned to

• incomingTransferObject?: ITask.TaskTransfer

  transfer object if Task was transferred to the current user

  • mode: "COLD" | "WARM" - transfer mode
  • sid: string - The sid of this Transfer
  • status: "INITIATED" | "FAILED" | "COMPLETE" | "CANCELED" - transfer status
  • to: string - The sid of the Worker or TaskQueue this Transfer is intended for
  • type: "QUEUE" | "WORKER" - The transfer type
  • workerSid: string - The sid of the initiating Worker
  • worker?: IWorker - The instance of the initiating Worker
  • queue?: IQueue - Target queue instance
• outgoingTransferObject?: ITask.TaskTransfer

  transfer object if is being transferred to another user by current user

  • mode: "COLD" | "WARM" - transfer mode
  • sid: string - The sid of this Transfer
  • status: "INITIATED" | "FAILED" | "COMPLETE" | "CANCELED" - transfer status
  • to: string - The sid of the Worker or TaskQueue this Transfer is intended for
  • type: "QUEUE" | "WORKER" - The transfer type
  • workerSid: string - The sid of the initiating Worker
  • worker?: IWorker - The instance of the initiating Worker
  • queue?: IQueue - Target queue instance
• routingTarget: string

  the final target for task assignemnt

• channelType: string

  channel type - either channelType property defined in the attributes of Task or taskChannelUniqueName property

• defaultFrom: string

  default initiator of a Task. Either name or from property defined in the attributes. If not specified then 'Anonymous' is returned

• formattedAttributes: object

  formatted task attributes used by flex ui

  • from?: string - formatted from phone number with country code
  • outbound_to?: string - formatted outbound_to phone number with country code
• conference?: Conference

  the conference related to this task