com.twilio.sdk.resource.instance.taskrouter
Class Workflow

java.lang.Object
  extended by com.twilio.sdk.resource.Resource<C>
      extended by com.twilio.sdk.resource.InstanceResource<C>
          extended by com.twilio.sdk.resource.NextGenInstanceResource<TwilioTaskRouterClient>
              extended by com.twilio.sdk.resource.instance.taskrouter.Workflow

public class Workflow
extends NextGenInstanceResource<TwilioTaskRouterClient>

Workflows control how tasks will be prioritized and routed into Queues, and how Tasks should escalate in priority or move across queues over time. Workflows are described in a simple JSON format. See the TaskRouter documentation.


Constructor Summary
Workflow(TwilioTaskRouterClient client)
          Instantiates a workflow.
Workflow(TwilioTaskRouterClient client, Map<String,Object> properties)
          Instantiates a workflow.
Workflow(TwilioTaskRouterClient client, String workspaceSid, String workflowSid)
          Instantiates a workflow.
 
Method Summary
 String getAssignmentCallbackUrl()
          The URL that will be called whenever a task managed by this Workflow is assigned to a Worker.
 String getConfiguration()
          JSON document configuring the rules for this Workflow.
 Date getDateCreated()
          The date and time this Workflow was created.
 Date getDateUpdated()
          The date and time this Workflow was last updated.
 String getFallbackAssignmentCallbackUrl()
          If the request to the AssignmentCallbackUrl fails, the assignment callback will be made to this URL.
 String getFriendlyName()
          A human-readable description of this Workflow.
 String getSid()
          This Workflow's unique ID.
 String getTaskReservationTimeout()
          Determines how long TaskRouter will wait for a confirmation response from your application after assigning a Task to a worker.
 String getWorkspaceSid()
          The unique ID of the Workspace containing this Workflow.
 
Methods inherited from class com.twilio.sdk.resource.InstanceResource
getObject, getProperty, 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

Workflow

public Workflow(TwilioTaskRouterClient client)
Instantiates a workflow.

Parameters:
client - the client

Workflow

public Workflow(TwilioTaskRouterClient client,
                Map<String,Object> properties)
Instantiates a workflow.

Parameters:
client - the client
properties - the properties

Workflow

public Workflow(TwilioTaskRouterClient client,
                String workspaceSid,
                String workflowSid)
Instantiates a workflow.

Parameters:
client - the client
workspaceSid - the workspace sid
workflowSid - the workflow sid
Method Detail

getAssignmentCallbackUrl

public String getAssignmentCallbackUrl()
The URL that will be called whenever a task managed by this Workflow is assigned to a Worker.

Returns:
the assignment callback url

getConfiguration

public String getConfiguration()
JSON document configuring the rules for this Workflow.

Returns:
the configuration

getDateCreated

public Date getDateCreated()
The date and time this Workflow was created.

Returns:
the date created

getDateUpdated

public Date getDateUpdated()
The date and time this Workflow was last updated.

Returns:
the date updated

getFallbackAssignmentCallbackUrl

public String getFallbackAssignmentCallbackUrl()
If the request to the AssignmentCallbackUrl fails, the assignment callback will be made to this URL.

Returns:
the fallback assignment callback url

getFriendlyName

public String getFriendlyName()
A human-readable description of this Workflow.

Returns:
the friendly name

getSid

public String getSid()
This Workflow's unique ID.

Returns:
the sid

getTaskReservationTimeout

public String getTaskReservationTimeout()
Determines how long TaskRouter will wait for a confirmation response from your application after assigning a Task to a worker. Defaults to 120 seconds.

Returns:
the task reservation timeout

getWorkspaceSid

public String getWorkspaceSid()
The unique ID of the Workspace containing this Workflow.

Returns:
the workspace sid


Copyright © 2011 Twilio, Inc. All Rights Reserved.