com.twilio.rest.conversations.v1.service

Class Role

java.lang.Object

com.twilio.base.Resource

com.twilio.rest.conversations.v1.service.Role

All Implemented Interfaces:

Serializable

public class Role
extends Resource

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Role.RoleType

Method Summary

Modifier and Type	Method and Description
static RoleCreator	creator(String pathChatServiceSid, String friendlyName, Role.RoleType type, List<String> permission) Create a RoleCreator to execute create.
static RoleDeleter	deleter(String pathChatServiceSid, String pathSid) Create a RoleDeleter to execute delete.
boolean	equals(Object o)
static RoleFetcher	fetcher(String pathChatServiceSid, String pathSid) Create a RoleFetcher to execute fetch.
static Role	fromJson(InputStream json, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Converts a JSON InputStream into a Role object using the provided ObjectMapper.
static Role	fromJson(String json, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Converts a JSON String into a Role object using the provided ObjectMapper.
String	getAccountSid() Returns The SID of the Account that created the resource.
String	getChatServiceSid() Returns The SID of the Conversation Service that the resource is associated with.
ZonedDateTime	getDateCreated() Returns The ISO 8601 date and time in GMT when the resource was created.
ZonedDateTime	getDateUpdated() Returns The ISO 8601 date and time in GMT when the resource was last updated.
String	getFriendlyName() Returns The string that you assigned to describe the resource.
List<String>	getPermissions() Returns An array of the permissions the role has been granted.
String	getSid() Returns The unique string that identifies the resource.
Role.RoleType	getType() Returns The type of role.
URI	getUrl() Returns An absolute URL for this user role..
int	hashCode()
static RoleReader	reader(String pathChatServiceSid) Create a RoleReader to execute read.
static RoleUpdater	updater(String pathChatServiceSid, String pathSid, List<String> permission) Create a RoleUpdater to execute update.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

creator

public static RoleCreator creator(String pathChatServiceSid,
                                  String friendlyName,
                                  Role.RoleType type,
                                  List<String> permission)

Create a RoleCreator to execute create.

Parameters:

pathChatServiceSid - The SID of the Conversation Service to create the resource under

friendlyName - A string to describe the new resource

type - The type of role

permission - A permission the role should have

Returns:

RoleCreator capable of executing the create

updater

public static RoleUpdater updater(String pathChatServiceSid,
                                  String pathSid,
                                  List<String> permission)

Create a RoleUpdater to execute update.

Parameters:

pathChatServiceSid - The SID of the Conversation Service to update the resource from

pathSid - The SID of the Role resource to update

permission - A permission the role should have

Returns:

RoleUpdater capable of executing the update

deleter

public static RoleDeleter deleter(String pathChatServiceSid,
                                  String pathSid)

Create a RoleDeleter to execute delete.

Parameters:

pathChatServiceSid - The SID of the Conversation Service to delete the resource from

pathSid - The SID of the Role resource to delete

Returns:

RoleDeleter capable of executing the delete

fetcher

public static RoleFetcher fetcher(String pathChatServiceSid,
                                  String pathSid)

Create a RoleFetcher to execute fetch.

Parameters:

pathChatServiceSid - The SID of the Conversation Service to fetch the resource from

pathSid - The SID of the Role resource to fetch

Returns:

RoleFetcher capable of executing the fetch

reader

public static RoleReader reader(String pathChatServiceSid)

Create a RoleReader to execute read.

Parameters:

pathChatServiceSid - The SID of the Conversation Service to read the resources from

Returns:

RoleReader capable of executing the read

fromJson

public static Role fromJson(String json,
                            com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Converts a JSON String into a Role object using the provided ObjectMapper.

Parameters:

json - Raw JSON String

objectMapper - Jackson ObjectMapper

Returns:

Role object represented by the provided JSON

fromJson

public static Role fromJson(InputStream json,
                            com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Converts a JSON InputStream into a Role object using the provided ObjectMapper.

Parameters:

json - Raw JSON InputStream

objectMapper - Jackson ObjectMapper

Returns:

Role object represented by the provided JSON

getSid

public final String getSid()

Returns The unique string that identifies the resource.

Returns:

The unique string that identifies the resource

getAccountSid

public final String getAccountSid()

Returns The SID of the Account that created the resource.

Returns:

The SID of the Account that created the resource

getChatServiceSid

public final String getChatServiceSid()

Returns The SID of the Conversation Service that the resource is associated with.

Returns:

The SID of the Conversation Service that the resource is associated with

getFriendlyName

public final String getFriendlyName()

Returns The string that you assigned to describe the resource.

Returns:

The string that you assigned to describe the resource

getType

public final Role.RoleType getType()

Returns The type of role.

Returns:

The type of role

getPermissions

public final List<String> getPermissions()

Returns An array of the permissions the role has been granted.

Returns:

An array of the permissions the role has been granted

getDateCreated

public final ZonedDateTime getDateCreated()

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

The ISO 8601 date and time in GMT when the resource was created

getDateUpdated

public final ZonedDateTime getDateUpdated()

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

The ISO 8601 date and time in GMT when the resource was last updated

getUrl

public final URI getUrl()

Returns An absolute URL for this user role..

Returns:

An absolute URL for this user role.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object