com.twilio.sdk.resource.instance.ipmessaging

Class Service

java.lang.Object

com.twilio.sdk.resource.Resource<C>

com.twilio.sdk.resource.InstanceResource<C>

com.twilio.sdk.resource.NextGenInstanceResource<TwilioIPMessagingClient>

com.twilio.sdk.resource.instance.ipmessaging.Service

public class Service
extends NextGenInstanceResource<TwilioIPMessagingClient>

Represents service for ip messaging

Constructor Summary

Constructors

Constructor and Description
Service(TwilioIPMessagingClient client, Map<String,Object> properties)
Service(TwilioIPMessagingClient client, String sid)

Method Summary

Modifier and Type	Method and Description
Channel	createChannel(List<org.apache.http.NameValuePair> params) Create a channel
Channel	createChannel(Map<String,String> params) Create a channel
Role	createRole(List<org.apache.http.NameValuePair> params) Create a role
Role	createRole(Map<String,String> params) Create a role
User	createUser(Map<String,String> params) Create a user
boolean	delete() Deletes the service
String	getAccountSid() The account sid that owns this service
Channel	getChannel(String sid) Get a single channel
ChannelList	getChannels() Initialize channels without a filter
ChannelList	getChannels(Map<String,String> filters) Initialize channels with a filter
Integer	getConsumptionReportInterval() Returns the Consumption Report Interval of the Service
Calendar	getDateCreated() The date when this service was created
Calendar	getDateUpdated() The date when this service was updated
String	getDefaultChannelRoleSid() Default channel role assigned on channel join
String	getDefaultServiceRoleSid() Default service role assigned on initial user creation
String	getFriendlyName() The human readable name for this service
Boolean	getReadStatusEnabled() Returns read status enabled flag
Role	getRole(String sid) Get a role
RoleList	getRoles() Initialize roles without a filter
RoleList	getRoles(Map<String,String> filters) Initialize roles with a filter
String	getSid() The unique identifier for this service
Integer	getTypingIndicatorTimeout() Timeout after “started typing” event when client should assume that user is not typing anymore even if no “ended typing” message received
String	getUrl() Absolute url of this service
User	getUser(String sid) Get a user
UserList	getUsers() Initialize users without a filter
UserList	getUsers(Map<String,String> filters) Initialize users with a filter
Object	getWebhooks() Webhooks triggered on given method

Methods inherited from class com.twilio.sdk.resource.InstanceResource

getCastedObject, getObject, getProperty, getPropertyAsInteger, toJSON, 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

Service

public Service(TwilioIPMessagingClient client,
               String sid)

Service

public Service(TwilioIPMessagingClient client,
               Map<String,Object> properties)

Method Detail

getSid

public String getSid()

The unique identifier for this service

Returns:

A sid string

getAccountSid

public String getAccountSid()

The account sid that owns this service

Returns:

The account sid

getFriendlyName

public String getFriendlyName()

The human readable name for this service

Returns:

A human readable string

getDefaultServiceRoleSid

public String getDefaultServiceRoleSid()

Default service role assigned on initial user creation

Returns:

The default service role

getDefaultChannelRoleSid

public String getDefaultChannelRoleSid()

Default channel role assigned on channel join

Returns:

The default channel role

getReadStatusEnabled

public Boolean getReadStatusEnabled()

Returns read status enabled flag

Returns:

The read status

getTypingIndicatorTimeout

public Integer getTypingIndicatorTimeout()

Timeout after “started typing” event when client should assume that user is not typing anymore even if no “ended typing” message received

Returns:

An integer in seconds

getConsumptionReportInterval

public Integer getConsumptionReportInterval()

Returns the Consumption Report Interval of the Service

Returns:

The consumption report interval

getWebhooks

public Object getWebhooks()

Webhooks triggered on given method

Returns:

Webhooks

getUrl

public String getUrl()

Absolute url of this service

Returns:

The url of this service

getDateCreated

public Calendar getDateCreated()

The date when this service was created

Returns:

The created date

getDateUpdated

public Calendar getDateUpdated()

The date when this service was updated

Returns:

The updated date

getChannels

public ChannelList getChannels()

Initialize channels without a filter

Returns:

Channels endpoint

getChannels

public ChannelList getChannels(Map<String,String> filters)

Initialize channels with a filter

Returns:

Channels endpoint

getChannel

public Channel getChannel(String sid)

Get a single channel

Parameters:

sid - The channel sid

Returns:

The channel

getRoles

public RoleList getRoles()

Initialize roles without a filter

Returns:

Roles endpoint

getRoles

public RoleList getRoles(Map<String,String> filters)

Initialize roles with a filter

Parameters:

filters - The filters to apply

Returns:

Roles endpoint

getRole

public Role getRole(String sid)

Get a role

Parameters:

sid - The role sid

Returns:

The role

createRole

public Role createRole(Map<String,String> params)
                throws TwilioRestException

Create a role

Parameters:

params - The params to provide

Returns:

The role

Throws:

TwilioRestException

createRole

public Role createRole(List<org.apache.http.NameValuePair> params)
                throws TwilioRestException

Create a role

Parameters:

params - The params to provide

Returns:

The role

Throws:

TwilioRestException

getUsers

public UserList getUsers()

Initialize users without a filter

Returns:

Users endpoint

getUser

public User getUser(String sid)

Get a user

Parameters:

sid - The user sid

Returns:

The user instance

getUsers

public UserList getUsers(Map<String,String> filters)

Initialize users with a filter

Parameters:

filters - The filters to apply

Returns:

Users endpoint

createUser

public User createUser(Map<String,String> params)
                throws TwilioRestException

Create a user

Parameters:

params - The params to provide

Returns:

The created user

Throws:

TwilioRestException - thrown when an error occurs

delete

public boolean delete()
               throws TwilioRestException

Deletes the service

Returns:

True iff the delete is successful

Throws:

TwilioRestException

createChannel

public Channel createChannel(Map<String,String> params)
                      throws TwilioRestException

Create a channel

Parameters:

params - The params to create with

Returns:

The created channel

Throws:

TwilioRestException - thrown when an error occurs

createChannel

public Channel createChannel(List<org.apache.http.NameValuePair> params)
                      throws TwilioRestException

Create a channel

Parameters:

params - The params to create with

Returns:

The created channel

Throws:

TwilioRestException - thrown when an error occurs