com.twilio.sdk.taskrouter

Class TaskRouterCapability

java.lang.Object

com.twilio.sdk.CapabilityToken

com.twilio.sdk.taskrouter.TaskRouterCapability

Direct Known Subclasses:

TaskRouterTaskQueueCapability, TaskRouterWorkerCapability, TaskRouterWorkspaceCapability

public class TaskRouterCapability
extends CapabilityToken

Nested Class Summary

Nested classes/interfaces inherited from class com.twilio.sdk.CapabilityToken

CapabilityToken.DomainException

Constructor Summary

Constructors

Constructor and Description
TaskRouterCapability(String accountSid, String authToken, String workspaceSid, String channelId) Create a new Capability object to authorize clients to interact with the TaskRouter service.

Method Summary

Modifier and Type	Method and Description
TaskRouterCapability	addPolicy(Policy policy)
void	addPolicy(String url, String method, Map<String,FilterRequirement> queryFilter, Map<String,FilterRequirement> postFilter, boolean allow) Add policy to list of access policies
void	allow(String url, String method, Map<String,FilterRequirement> queryFilter, Map<String,FilterRequirement> postFilter) Add Allow access policy
void	allowDelete() Allow deletion of the defined resource
void	allowDeleteSubresources() Allow deletion of any subresources of the defined resource
void	allowFetchSubresources() Allow fetching all subresources of the defined resource
void	allowTaskReservationUpdates() Deprecated. Please use {TaskRouterWorkerCapability.allowReservationUpdates} instead
void	allowUpdates() Allow updating attributes of the defined resource
void	allowUpdatesSubresources() Allow updating attributes of all subresources of the defined resource
void	allowWorkerActivityUpdates() Deprecated. Please use {TaskRouterWorkerCapability.allowActivityUpdates} instead
void	allowWorkerFetchAttributes() Deprecated. Please use {TaskRouterWorkerCapability} instead; added automatically in constructor
void	deny(String url, String method, Map<String,FilterRequirement> queryFilter, Map<String,FilterRequirement> postFilter) Add Deny access policy
String	generateToken() Generate a capability token with the currently-configured policies on this object.
String	generateToken(long ttl) Generate a capability token with the currently-configured policies on this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskRouterCapability

public TaskRouterCapability(String accountSid,
                            String authToken,
                            String workspaceSid,
                            String channelId)

Create a new Capability object to authorize clients to interact with the TaskRouter service.

Parameters:

accountSid - Account to authorize actions for

authToken - Auth token for the account. Used to sign tokens and will not be included in the generated tokens.

workspaceSid - Workspace to authorize tokens for.

channelId - Authorized Channel

Method Detail

allowFetchSubresources

public void allowFetchSubresources()

Allow fetching all subresources of the defined resource

allowUpdates

public void allowUpdates()

Allow updating attributes of the defined resource

allowUpdatesSubresources

public void allowUpdatesSubresources()

Allow updating attributes of all subresources of the defined resource

allowDelete

public void allowDelete()

Allow deletion of the defined resource

allowDeleteSubresources

public void allowDeleteSubresources()

Allow deletion of any subresources of the defined resource

allowWorkerActivityUpdates

@Deprecated
public void allowWorkerActivityUpdates()

Deprecated. Please use {TaskRouterWorkerCapability.allowActivityUpdates} instead

Allow a worker to update its own activity status

Throws:

Exception

allowWorkerFetchAttributes

@Deprecated
public void allowWorkerFetchAttributes()

Deprecated. Please use {TaskRouterWorkerCapability} instead; added automatically in constructor

Allow a worker to read its own attributes.

Throws:

Exception

allowTaskReservationUpdates

@Deprecated
public void allowTaskReservationUpdates()

Deprecated. Please use {TaskRouterWorkerCapability.allowReservationUpdates} instead

Allow a worker to update task reservation status

Throws:

Exception

addPolicy

public TaskRouterCapability addPolicy(Policy policy)

addPolicy

public void addPolicy(String url,
                      String method,
                      Map<String,FilterRequirement> queryFilter,
                      Map<String,FilterRequirement> postFilter,
                      boolean allow)

Add policy to list of access policies

Parameters:

url - url of the resource

method - method to the resource

queryFilter - query filter parameters

postFilter - post filter parameters

allow - whether or not to allow access on this policy

allow

public void allow(String url,
                  String method,
                  Map<String,FilterRequirement> queryFilter,
                  Map<String,FilterRequirement> postFilter)

Add Allow access policy

Parameters:

url - url of the resource

method - method to the resource

queryFilter - query filter parameters

postFilter - post filter parameters

deny

public void deny(String url,
                 String method,
                 Map<String,FilterRequirement> queryFilter,
                 Map<String,FilterRequirement> postFilter)

Add Deny access policy

Parameters:

url - url of the resource

method - method to the resource

queryFilter - query filter parameters

postFilter - post filter parameters

generateToken

public String generateToken()
                     throws CapabilityToken.DomainException

Generate a capability token with the currently-configured policies on this object.

Returns:

JSON Web Token representing authorized capabilities

Throws:

DomainException

CapabilityToken.DomainException

generateToken

public String generateToken(long ttl)
                     throws CapabilityToken.DomainException

Generate a capability token with the currently-configured policies on this object.

Parameters:

ttl - Expiration time in seconds

Returns:

JSON Web Token representing authorized capabilities

Throws:

DomainException

CapabilityToken.DomainException