com.twilio.rest.taskrouter.v1.workspace

Class TaskReader

java.lang.Object

com.twilio.base.Reader<Task>

com.twilio.rest.taskrouter.v1.workspace.TaskReader

public class TaskReader
extends Reader<Task>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Page<Task>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Task>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<Task>	nextPage(Page<Task> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<Task>	previousPage(Page<Task> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<Task>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
TaskReader	setAssignmentStatus(List<String> assignmentStatus) The `assignment_status` of the Tasks you want to read.
TaskReader	setAssignmentStatus(String assignmentStatus) The `assignment_status` of the Tasks you want to read.
TaskReader	setEvaluateTaskAttributes(String evaluateTaskAttributes) The attributes of the Tasks to read.
TaskReader	setHasAddons(Boolean hasAddons) Whether to read Tasks with addons.
TaskReader	setOrdering(String ordering) How to order the returned Task resources.
TaskReader	setPriority(Integer priority) The priority value of the Tasks to read.
TaskReader	setTaskQueueName(String taskQueueName) The `friendly_name` of the TaskQueue with the Tasks to read.
TaskReader	setTaskQueueSid(String taskQueueSid) The SID of the TaskQueue with the Tasks to read.
TaskReader	setWorkflowName(String workflowName) The friendly name of the Workflow with the Tasks to read.
TaskReader	setWorkflowSid(String workflowSid) The SID of the Workflow with the Tasks to read.

Methods inherited from class com.twilio.base.Reader

firstPage, getLimit, getPage, getPageSize, limit, nextPage, pageSize, previousPage, read, readAsync, readAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskReader

public TaskReader(String pathWorkspaceSid)

Construct a new TaskReader.

Parameters:

pathWorkspaceSid - The SID of the Workspace with the Tasks to read

Method Detail

setPriority

public TaskReader setPriority(Integer priority)

The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority..

Parameters:

priority - The priority value of the Tasks to read

Returns:

this

setAssignmentStatus

public TaskReader setAssignmentStatus(List<String> assignmentStatus)

The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`..

Parameters:

assignmentStatus - Returns the list of all Tasks in the Workspace with the specified assignment_status

Returns:

this

setAssignmentStatus

public TaskReader setAssignmentStatus(String assignmentStatus)

The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`..

Parameters:

assignmentStatus - Returns the list of all Tasks in the Workspace with the specified assignment_status

Returns:

this

setWorkflowSid

public TaskReader setWorkflowSid(String workflowSid)

The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID..

Parameters:

workflowSid - The SID of the Workflow with the Tasks to read

Returns:

this

setWorkflowName

public TaskReader setWorkflowName(String workflowName)

The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name..

Parameters:

workflowName - The friendly name of the Workflow with the Tasks to read

Returns:

this

setTaskQueueSid

public TaskReader setTaskQueueSid(String taskQueueSid)

The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID..

Parameters:

taskQueueSid - The SID of the TaskQueue with the Tasks to read

Returns:

this

setTaskQueueName

public TaskReader setTaskQueueName(String taskQueueName)

The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name..

Parameters:

taskQueueName - The friendly_name of the TaskQueue with the Tasks to read

Returns:

this

setEvaluateTaskAttributes

public TaskReader setEvaluateTaskAttributes(String evaluateTaskAttributes)

The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter..

Parameters:

evaluateTaskAttributes - The task attributes of the Tasks to read

Returns:

this

setOrdering

public TaskReader setOrdering(String ordering)

How to order the returned Task resources. y default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `Priority` or `DateCreated` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Multiple sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order..

Parameters:

ordering - Controls the order of the Tasks returned

Returns:

this

setHasAddons

public TaskReader setHasAddons(Boolean hasAddons)

Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons..

Parameters:

hasAddons - Whether to read Tasks with addons

Returns:

this

read

public ResourceSet<Task> read(TwilioRestClient client)

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

Specified by:

read in class Reader<Task>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Task ResourceSet

firstPage

public Page<Task> firstPage(TwilioRestClient client)

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

Specified by:

firstPage in class Reader<Task>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Task ResourceSet

getPage

public Page<Task> getPage(String targetUrl,
                          TwilioRestClient client)

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Task>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Task ResourceSet

nextPage

public Page<Task> nextPage(Page<Task> page,
                           TwilioRestClient client)

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Task>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

public Page<Task> previousPage(Page<Task> page,
                               TwilioRestClient client)

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Task>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page