com.twilio.rest.taskrouter.v1.workspace

Class TaskCreator

java.lang.Object

com.twilio.base.Creator<Task>

com.twilio.rest.taskrouter.v1.workspace.TaskCreator

public class TaskCreator
extends Creator<Task>

Constructor Summary

Constructors

Constructor and Description
TaskCreator(String pathWorkspaceSid) Construct a new TaskCreator.

Method Summary

Modifier and Type	Method and Description
Task	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
TaskCreator	setAttributes(String attributes) Url-encoded JSON string describing the attributes of this task.
TaskCreator	setPriority(Integer priority) Override priority for the Task.
TaskCreator	setTaskChannel(String taskChannel) When MultiTasking is enabled specify the type of the task by passing either TaskChannel Unique Name or Task Channel Sid.
TaskCreator	setTimeout(Integer timeout) The amount of time in seconds the task is allowed to live up to a maximum of 2 weeks.
TaskCreator	setWorkflowSid(String workflowSid) The WorkflowSid for the Workflow that you would like to handle routing for this Task.

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

TaskCreator

public TaskCreator(String pathWorkspaceSid)

Construct a new TaskCreator.

Parameters:

pathWorkspaceSid - The workspace_sid

Method Detail

setTimeout

public TaskCreator setTimeout(Integer timeout)

The amount of time in seconds the task is allowed to live up to a maximum of 2 weeks. Defaults to 24 hours. On timeout, `task.canceled` event will fire with description "Task TTL Exceeded"..

Parameters:

timeout - The amount of time in seconds the task is allowed to live up to a maximum of 2 weeks.

Returns:

this

setPriority

public TaskCreator setPriority(Integer priority)

Override priority for the Task. When supplied, the Task will take on the given priority unless it matches a Workflow Target with a Priority set. When not supplied, the Task will take on the priority of the matching Workflow Target..

Parameters:

priority - Override priority for the Task.

Returns:

this

setTaskChannel

public TaskCreator setTaskChannel(String taskChannel)

When MultiTasking is enabled specify the type of the task by passing either TaskChannel Unique Name or Task Channel Sid. Default value is "default".

Parameters:

taskChannel - When MultiTasking is enabled specify the type of the task by passing either TaskChannel Unique Name or Task Channel Sid.

Returns:

this

setWorkflowSid

public TaskCreator setWorkflowSid(String workflowSid)

The WorkflowSid for the Workflow that you would like to handle routing for this Task. If there is only one Workflow defined for the Workspace that you are posting a task to, then this is an optional parameter, and that single workflow will be used..

Parameters:

workflowSid - The WorkflowSid for the Workflow that you would like to handle routing for this Task.

Returns:

this

setAttributes

public TaskCreator setAttributes(String attributes)

Url-encoded JSON string describing the attributes of this task. This data will be passed back to the Workflow's AssignmentCallbackURL when the Task is assigned to a Worker. An example task: `{ "task_type": "call", "twilio_call_sid": "CAxxx", "customer_ticket_number": "12345" }`.

Parameters:

attributes - Url-encoded JSON string describing the attributes of this task.

Returns:

this

create

public Task create(TwilioRestClient client)

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

Specified by:

create in class Creator<Task>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Task