com.twilio.sdk.resource.instance.taskrouter

Class Worker

java.lang.Object

com.twilio.sdk.resource.Resource<C>

com.twilio.sdk.resource.InstanceResource<C>

com.twilio.sdk.resource.NextGenInstanceResource<TwilioTaskRouterClient>

com.twilio.sdk.resource.instance.taskrouter.Worker

public class Worker
extends NextGenInstanceResource<TwilioTaskRouterClient>

Workers represent an entity that is able to perform tasks, such as an agent working in a call center, or a salesperson handling leads. See the TaskRouter documentation.

Constructor Summary

Constructors

Constructor and Description
Worker(TwilioTaskRouterClient client) Instantiates a worker.
Worker(TwilioTaskRouterClient client, Map<String,Object> properties) Instantiates a worker.
Worker(TwilioTaskRouterClient client, String workspaceSid, String workerSid) Instantiates a worker.

Method Summary

Modifier and Type	Method and Description
String	getAccountSid() The ID of the Account that owns this worker.
String	getActivityName() String describing the worker's current activity, for example 'on-call', 'after-call-work', 'break', etc.
String	getActivitySid() The ID of the Activity this Worker is currently performing.
String	getAttributes() A user-defined JSON object describing this Worker.
Date	getDateCreated() The date and time this Worker was created.
Date	getDateStatusChanged() The date and time this Worker's Activity status last changed.
Date	getDateUpdated() The date and time this Worker was last updated.
String	getFriendlyName() A human-readable name for this Worker.
WorkerReservationList	getReservations() Retrieves the WorkerReservationList for this Workspace.
WorkerReservationList	getReservations(Map<String,String> filters) Retrieves the WorkerReservationList for this Workspace.
String	getSid() This Worker's unique ID.
WorkerStatistics	getStatistics() Get worker statistics.
WorkerStatistics	getWorkerStatistics(Map<String,String> filters) Get worker statistics.
WorkerStatistics	getWorkerStatistics(StatisticsQueryBuilder queryBuilder) Get worker statistics.
String	getWorkspaceSid() The ID of the Workspace containing this Worker.
boolean	isAvailable() Whether this Worker can be assigned another Task.
Map<String,Object>	parseAttributes() A map that represents the JSON describing this Worker.
void	update(Map<String,String> attributes, String friendlyName, String activitySid) Update a worker's attributes and/or friendly name and/or activity
void	updateActivity(String activitySid) Update a worker's activity

Methods inherited from class com.twilio.sdk.resource.InstanceResource

getCastedObject, getObject, getProperty, getPropertyAsInteger, toJSON, update, update

Methods inherited from class com.twilio.sdk.resource.Resource

setRequestAccountSid

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Worker

public Worker(TwilioTaskRouterClient client)

Instantiates a worker.

Parameters:

client - the client

Worker

public Worker(TwilioTaskRouterClient client,
              Map<String,Object> properties)

Instantiates a worker.

Parameters:

client - the client

properties - the properties

Worker

public Worker(TwilioTaskRouterClient client,
              String workspaceSid,
              String workerSid)

Instantiates a worker.

Parameters:

client - the client

workspaceSid - the workspace sid

workerSid - the worker sid

Method Detail

update

public void update(Map<String,String> attributes,
                   String friendlyName,
                   String activitySid)
            throws TwilioRestException

Update a worker's attributes and/or friendly name and/or activity

Parameters:

attributes - attributes of a worker

friendlyName - friendly name of a worker

activitySid - activity of a worker

Throws:

TwilioRestException

updateActivity

public void updateActivity(String activitySid)
                    throws TwilioRestException

Update a worker's activity

Parameters:

activitySid - the activitysid to update the worker to

Throws:

TwilioRestException

getAccountSid

public String getAccountSid()

The ID of the Account that owns this worker.

Returns:

the account sid

getActivityName

public String getActivityName()

String describing the worker's current activity, for example 'on-call', 'after-call-work', 'break', etc. Workers may only perform Activities that exist in this Workspace.

Returns:

the activity name

getActivitySid

public String getActivitySid()

The ID of the Activity this Worker is currently performing.

Returns:

the activity sid

getAttributes

public String getAttributes()

A user-defined JSON object describing this Worker.

Returns:

the attributes

parseAttributes

public Map<String,Object> parseAttributes()
                                   throws org.json.simple.parser.ParseException

A map that represents the JSON describing this Worker.

Returns:

the attributes

Throws:

org.json.simple.parser.ParseException

getDateCreated

public Date getDateCreated()

The date and time this Worker was created.

Returns:

the date created

getDateStatusChanged

public Date getDateStatusChanged()

The date and time this Worker's Activity status last changed.

Returns:

the date updated

getDateUpdated

public Date getDateUpdated()

The date and time this Worker was last updated.

Returns:

the date updated

getFriendlyName

public String getFriendlyName()

A human-readable name for this Worker.

Returns:

the friendly name

getSid

public String getSid()

This Worker's unique ID.

Returns:

the sid

getWorkspaceSid

public String getWorkspaceSid()

The ID of the Workspace containing this Worker.

Returns:

the workspace sid

isAvailable

public boolean isAvailable()

Whether this Worker can be assigned another Task.

Returns:

true, if available

getStatistics

public WorkerStatistics getStatistics()

Get worker statistics.

Returns:

worker statistics

getWorkerStatistics

public WorkerStatistics getWorkerStatistics(StatisticsQueryBuilder queryBuilder)

Get worker statistics.

Parameters:

queryBuilder - query builder which contains all parameters for the stats query request

Returns:

worker statistics

getWorkerStatistics

public WorkerStatistics getWorkerStatistics(Map<String,String> filters)

Get worker statistics.

Parameters:

filters - the filters

Returns:

worker statistics

getReservations

public WorkerReservationList getReservations()

Retrieves the WorkerReservationList for this Workspace.

Returns:

the WorkerReservationList

getReservations

public WorkerReservationList getReservations(Map<String,String> filters)

Retrieves the WorkerReservationList for this Workspace.

Parameters:

filters - for reservations

Returns:

the WorkerReservationList