com.twilio.rest.taskrouter.v1

Class WorkspaceCreator

java.lang.Object

com.twilio.base.Creator<Workspace>

com.twilio.rest.taskrouter.v1.WorkspaceCreator

public class WorkspaceCreator
extends Creator<Workspace>

Constructor Summary

Constructors

Constructor and Description
WorkspaceCreator(String friendlyName) Construct a new WorkspaceCreator.

Method Summary

Modifier and Type	Method and Description
Workspace	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
WorkspaceCreator	setEventCallbackUrl(String eventCallbackUrl) The URL we should call when an event occurs.
WorkspaceCreator	setEventCallbackUrl(URI eventCallbackUrl) The URL we should call when an event occurs.
WorkspaceCreator	setEventsFilter(String eventsFilter) The list of Workspace events for which to call event_callback_url.
WorkspaceCreator	setMultiTaskEnabled(Boolean multiTaskEnabled) Whether to enable multi-tasking.
WorkspaceCreator	setPrioritizeQueueOrder(Workspace.QueueOrder prioritizeQueueOrder) The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues.
WorkspaceCreator	setTemplate(String template) An available template name.

Methods inherited from class com.twilio.base.Creator

create, createAsync, createAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceCreator

public WorkspaceCreator(String friendlyName)

Construct a new WorkspaceCreator.

Parameters:

friendlyName - A string to describe the Workspace resource

Method Detail

setEventCallbackUrl

public WorkspaceCreator setEventCallbackUrl(URI eventCallbackUrl)

The URL we should call when an event occurs. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See Workspace Events for more information..

Parameters:

eventCallbackUrl - The URL we should call when an event occurs

Returns:

this

setEventCallbackUrl

public WorkspaceCreator setEventCallbackUrl(String eventCallbackUrl)

The URL we should call when an event occurs. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See Workspace Events for more information..

Parameters:

eventCallbackUrl - The URL we should call when an event occurs

Returns:

this

setEventsFilter

public WorkspaceCreator setEventsFilter(String eventsFilter)

The list of Workspace events for which to call event_callback_url. For example if `EventsFilter=task.created,task.canceled,worker.activity.update`, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated..

Parameters:

eventsFilter - The list of Workspace events for which to call event_callback_url

Returns:

this

setMultiTaskEnabled

public WorkspaceCreator setMultiTaskEnabled(Boolean multiTaskEnabled)

Whether to enable multi-tasking. Can be: `true` to enable multi-tasking, or `false` to disable it. The default is `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (`true`), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. Otherwise, each Worker will only receive a new reservation when the previous task is completed. Learn more at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking]..

Parameters:

multiTaskEnabled - Whether multi-tasking is enabled

Returns:

this

setTemplate

public WorkspaceCreator setTemplate(String template)

An available template name. Can be: `NONE` or `FIFO` and the default is `NONE`. Pre-configures the Workspace with the Workflow and Activities specified in the template. `NONE` will create a Workspace with only a set of default activities. `FIFO` will configure TaskRouter with a set of default activities and a single TaskQueue for first-in, first-out distribution, which can be useful when you are getting started with TaskRouter..

Parameters:

template - An available template name

Returns:

this

setPrioritizeQueueOrder

public WorkspaceCreator setPrioritizeQueueOrder(Workspace.QueueOrder prioritizeQueueOrder)

The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo]..

Parameters:

prioritizeQueueOrder - The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues

Returns:

this

create

public Workspace create(TwilioRestClient client)

Make the request to the Twilio API to perform the create.

Specified by:

create in class Creator<Workspace>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Workspace