Documentation

Class: Activity

Activity

An Activity represents a state that a Worker can be in (e.g. Idle, Offline, Busy, ...)

Properties:
Name Type Description
accountSid string

The sid of the Twilio account
available boolean

If the Worker can handle Tasks in this state
dateCreated Date

The date this Activity was created
dateUpdated Date

The date this Activity was last updated
isCurrent boolean

If this particular Activity represents the current state of the Worker
name string

The friendly name of this Activity
sid string

The sid of this Activity
workspaceSid string

The sid of the Workspace owning this Activity

Members

<readonly> accountSid :string

Type:
  • string

<readonly> available :boolean

Type:
  • boolean

<readonly> dateCreated :Date

Type:
  • Date

<readonly> dateUpdated :Date

Type:
  • Date

isCurrent

<readonly> name :string

Type:
  • string

<readonly> sid :string

Type:
  • string

<readonly> workspaceSid :string

Type:
  • string

Methods

setAsCurrent( [options])

Make this Activity the current state of the Worker

Parameters:
Name Type Argument Description
options ActivityUpdateOptions <optional>
Returns:
  • Rejected if the Worker's activity state could not be set
Type
Promise.<this>