com.twilio.rest.chat.v2

Class ServiceUpdater

java.lang.Object

com.twilio.base.Updater<Service>

com.twilio.rest.chat.v2.ServiceUpdater

public class ServiceUpdater
extends Updater<Service>

Constructor Summary

Constructors

Constructor and Description
ServiceUpdater(String pathSid) Construct a new ServiceUpdater.

Method Summary

Modifier and Type	Method and Description
ServiceUpdater	setConsumptionReportInterval(Integer consumptionReportInterval) DEPRECATED.
ServiceUpdater	setDefaultChannelCreatorRoleSid(String defaultChannelCreatorRoleSid) The channel role assigned to a channel creator when they join a new channel.
ServiceUpdater	setDefaultChannelRoleSid(String defaultChannelRoleSid) The channel role assigned to users when they are added to a channel.
ServiceUpdater	setDefaultServiceRoleSid(String defaultServiceRoleSid) The service role assigned to users when they are added to the service.
ServiceUpdater	setFriendlyName(String friendlyName) A descriptive string that you create to describe the resource..
ServiceUpdater	setLimitsChannelMembers(Integer limitsChannelMembers) The maximum number of Members that can be added to Channels within this Service.
ServiceUpdater	setLimitsUserChannels(Integer limitsUserChannels) The maximum number of Channels Users can be a Member of within this Service.
ServiceUpdater	setMediaCompatibilityMessage(String mediaCompatibilityMessage) The message to send when a media message has no text.
ServiceUpdater	setNotificationsAddedToChannelEnabled(Boolean notificationsAddedToChannelEnabled) Whether to send a notification when a member is added to a channel.
ServiceUpdater	setNotificationsAddedToChannelSound(String notificationsAddedToChannelSound) The name of the sound to play when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`..
ServiceUpdater	setNotificationsAddedToChannelTemplate(String notificationsAddedToChannelTemplate) The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`..
ServiceUpdater	setNotificationsInvitedToChannelEnabled(Boolean notificationsInvitedToChannelEnabled) Whether to send a notification when a user is invited to a channel.
ServiceUpdater	setNotificationsInvitedToChannelSound(String notificationsInvitedToChannelSound) The name of the sound to play when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`..
ServiceUpdater	setNotificationsInvitedToChannelTemplate(String notificationsInvitedToChannelTemplate) The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`..
ServiceUpdater	setNotificationsLogEnabled(Boolean notificationsLogEnabled) Whether to log notifications.
ServiceUpdater	setNotificationsNewMessageBadgeCountEnabled(Boolean notificationsNewMessageBadgeCountEnabled) Whether the new message badge is enabled.
ServiceUpdater	setNotificationsNewMessageEnabled(Boolean notificationsNewMessageEnabled) Whether to send a notification when a new message is added to a channel.
ServiceUpdater	setNotificationsNewMessageSound(String notificationsNewMessageSound) The name of the sound to play when a new message is added to a channel and `notifications.new_message.enabled` is `true`..
ServiceUpdater	setNotificationsNewMessageTemplate(String notificationsNewMessageTemplate) The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`..
ServiceUpdater	setNotificationsRemovedFromChannelEnabled(Boolean notificationsRemovedFromChannelEnabled) Whether to send a notification to a user when they are removed from a channel.
ServiceUpdater	setNotificationsRemovedFromChannelSound(String notificationsRemovedFromChannelSound) The name of the sound to play to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`..
ServiceUpdater	setNotificationsRemovedFromChannelTemplate(String notificationsRemovedFromChannelTemplate) The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`..
ServiceUpdater	setPostWebhookRetryCount(Integer postWebhookRetryCount) The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response.
ServiceUpdater	setPostWebhookUrl(String postWebhookUrl) The URL for post-event webhooks, which are called by using the `webhook_method`.
ServiceUpdater	setPostWebhookUrl(URI postWebhookUrl) The URL for post-event webhooks, which are called by using the `webhook_method`.
ServiceUpdater	setPreWebhookRetryCount(Integer preWebhookRetryCount) The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response.
ServiceUpdater	setPreWebhookUrl(String preWebhookUrl) The URL for pre-event webhooks, which are called by using the `webhook_method`.
ServiceUpdater	setPreWebhookUrl(URI preWebhookUrl) The URL for pre-event webhooks, which are called by using the `webhook_method`.
ServiceUpdater	setReachabilityEnabled(Boolean reachabilityEnabled) Whether to enable the Reachability Indicator for this Service instance.
ServiceUpdater	setReadStatusEnabled(Boolean readStatusEnabled) Whether to enable the Message Consumption Horizon feature.
ServiceUpdater	setTypingIndicatorTimeout(Integer typingIndicatorTimeout) How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received.
ServiceUpdater	setWebhookFilters(List<String> webhookFilters) The list of webhook events that are enabled for this Service instance.
ServiceUpdater	setWebhookFilters(String webhookFilters) The list of webhook events that are enabled for this Service instance.
ServiceUpdater	setWebhookMethod(HttpMethod webhookMethod) The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks.
Service	update(TwilioRestClient client) Make the request to the Twilio API to perform the update.

Methods inherited from class com.twilio.base.Updater

update, updateAsync, updateAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceUpdater

public ServiceUpdater(String pathSid)

Construct a new ServiceUpdater.

Parameters:

pathSid - The SID of the Service resource to update

Method Detail

setFriendlyName

public ServiceUpdater setFriendlyName(String friendlyName)

A descriptive string that you create to describe the resource..

Parameters:

friendlyName - A string to describe the resource

Returns:

this

setDefaultServiceRoleSid

public ServiceUpdater setDefaultServiceRoleSid(String defaultServiceRoleSid)

The service role assigned to users when they are added to the service. See the Role resource for more info about roles..

Parameters:

defaultServiceRoleSid - The service role assigned to users when they are added to the service

Returns:

this

setDefaultChannelRoleSid

public ServiceUpdater setDefaultChannelRoleSid(String defaultChannelRoleSid)

The channel role assigned to users when they are added to a channel. See the Role resource for more info about roles..

Parameters:

defaultChannelRoleSid - The channel role assigned to users when they are added to a channel

Returns:

this

setDefaultChannelCreatorRoleSid

public ServiceUpdater setDefaultChannelCreatorRoleSid(String defaultChannelCreatorRoleSid)

The channel role assigned to a channel creator when they join a new channel. See the Role resource for more info about roles..

Parameters:

defaultChannelCreatorRoleSid - The channel role assigned to a channel creator when they join a new channel

Returns:

this

setReadStatusEnabled

public ServiceUpdater setReadStatusEnabled(Boolean readStatusEnabled)

Whether to enable the Message Consumption Horizon feature. The default is `true`..

Parameters:

readStatusEnabled - Whether to enable the Message Consumption Horizon feature

Returns:

this

setReachabilityEnabled

public ServiceUpdater setReachabilityEnabled(Boolean reachabilityEnabled)

Whether to enable the Reachability Indicator for this Service instance. The default is `false`..

Parameters:

reachabilityEnabled - Whether to enable the Reachability Indicator feature for this Service instance

Returns:

this

setTypingIndicatorTimeout

public ServiceUpdater setTypingIndicatorTimeout(Integer typingIndicatorTimeout)

How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds..

Parameters:

typingIndicatorTimeout - How long in seconds to wait before assuming the user is no longer typing

Returns:

this

setConsumptionReportInterval

public ServiceUpdater setConsumptionReportInterval(Integer consumptionReportInterval)

DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints..

Parameters:

consumptionReportInterval - DEPRECATED

Returns:

this

setNotificationsNewMessageEnabled

public ServiceUpdater setNotificationsNewMessageEnabled(Boolean notificationsNewMessageEnabled)

Whether to send a notification when a new message is added to a channel. The default is `false`..

Parameters:

notificationsNewMessageEnabled - Whether to send a notification when a new message is added to a channel

Returns:

this

setNotificationsNewMessageTemplate

public ServiceUpdater setNotificationsNewMessageTemplate(String notificationsNewMessageTemplate)

The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`..

Parameters:

notificationsNewMessageTemplate - The template to use to create the notification text displayed when a new message is added to a channel

Returns:

this

setNotificationsNewMessageSound

public ServiceUpdater setNotificationsNewMessageSound(String notificationsNewMessageSound)

The name of the sound to play when a new message is added to a channel and `notifications.new_message.enabled` is `true`..

Parameters:

notificationsNewMessageSound - The name of the sound to play when a new message is added to a channel

Returns:

this

setNotificationsNewMessageBadgeCountEnabled

public ServiceUpdater setNotificationsNewMessageBadgeCountEnabled(Boolean notificationsNewMessageBadgeCountEnabled)

Whether the new message badge is enabled. The default is `false`..

Parameters:

notificationsNewMessageBadgeCountEnabled - Whether the new message badge is enabled

Returns:

this

setNotificationsAddedToChannelEnabled

public ServiceUpdater setNotificationsAddedToChannelEnabled(Boolean notificationsAddedToChannelEnabled)

Whether to send a notification when a member is added to a channel. The default is `false`..

Parameters:

notificationsAddedToChannelEnabled - Whether to send a notification when a member is added to a channel

Returns:

this

setNotificationsAddedToChannelTemplate

public ServiceUpdater setNotificationsAddedToChannelTemplate(String notificationsAddedToChannelTemplate)

The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`..

Parameters:

notificationsAddedToChannelTemplate - The template to use to create the notification text displayed when a member is added to a channel

Returns:

this

setNotificationsAddedToChannelSound

public ServiceUpdater setNotificationsAddedToChannelSound(String notificationsAddedToChannelSound)

The name of the sound to play when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`..

Parameters:

notificationsAddedToChannelSound - The name of the sound to play when a member is added to a channel

Returns:

this

setNotificationsRemovedFromChannelEnabled

public ServiceUpdater setNotificationsRemovedFromChannelEnabled(Boolean notificationsRemovedFromChannelEnabled)

Whether to send a notification to a user when they are removed from a channel. The default is `false`..

Parameters:

notificationsRemovedFromChannelEnabled - Whether to send a notification to a user when they are removed from a channel

Returns:

this

setNotificationsRemovedFromChannelTemplate

public ServiceUpdater setNotificationsRemovedFromChannelTemplate(String notificationsRemovedFromChannelTemplate)

The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`..

Parameters:

notificationsRemovedFromChannelTemplate - The template to use to create the notification text displayed to a user when they are removed

Returns:

this

setNotificationsRemovedFromChannelSound

public ServiceUpdater setNotificationsRemovedFromChannelSound(String notificationsRemovedFromChannelSound)

The name of the sound to play to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`..

Parameters:

notificationsRemovedFromChannelSound - The name of the sound to play to a user when they are removed from a channel

Returns:

this

setNotificationsInvitedToChannelEnabled

public ServiceUpdater setNotificationsInvitedToChannelEnabled(Boolean notificationsInvitedToChannelEnabled)

Whether to send a notification when a user is invited to a channel. The default is `false`..

Parameters:

notificationsInvitedToChannelEnabled - Whether to send a notification when a user is invited to a channel

Returns:

this

setNotificationsInvitedToChannelTemplate

public ServiceUpdater setNotificationsInvitedToChannelTemplate(String notificationsInvitedToChannelTemplate)

The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`..

Parameters:

notificationsInvitedToChannelTemplate - The template to use to create the notification text displayed when a user is invited to a channel

Returns:

this

setNotificationsInvitedToChannelSound

public ServiceUpdater setNotificationsInvitedToChannelSound(String notificationsInvitedToChannelSound)

The name of the sound to play when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`..

Parameters:

notificationsInvitedToChannelSound - The name of the sound to play when a user is invited to a channel

Returns:

this

setPreWebhookUrl

public ServiceUpdater setPreWebhookUrl(URI preWebhookUrl)

The URL for pre-event webhooks, which are called by using the `webhook_method`. See Webhook Events for more details..

Parameters:

preWebhookUrl - The webhook URL for pre-event webhooks

Returns:

this

setPreWebhookUrl

public ServiceUpdater setPreWebhookUrl(String preWebhookUrl)

The URL for pre-event webhooks, which are called by using the `webhook_method`. See Webhook Events for more details..

Parameters:

preWebhookUrl - The webhook URL for pre-event webhooks

Returns:

this

setPostWebhookUrl

public ServiceUpdater setPostWebhookUrl(URI postWebhookUrl)

The URL for post-event webhooks, which are called by using the `webhook_method`. See Webhook Events for more details..

Parameters:

postWebhookUrl - The URL for post-event webhooks

Returns:

this

setPostWebhookUrl

public ServiceUpdater setPostWebhookUrl(String postWebhookUrl)

The URL for post-event webhooks, which are called by using the `webhook_method`. See Webhook Events for more details..

Parameters:

postWebhookUrl - The URL for post-event webhooks

Returns:

this

setWebhookMethod

public ServiceUpdater setWebhookMethod(HttpMethod webhookMethod)

The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See Webhook Events for more details..

Parameters:

webhookMethod - The HTTP method to use for both PRE and POST webhooks

Returns:

this

setWebhookFilters

public ServiceUpdater setWebhookFilters(List<String> webhookFilters)

The list of webhook events that are enabled for this Service instance. See Webhook Events for more details..

Parameters:

webhookFilters - The list of webhook events that are enabled for this Service instance

Returns:

this

setWebhookFilters

public ServiceUpdater setWebhookFilters(String webhookFilters)

The list of webhook events that are enabled for this Service instance. See Webhook Events for more details..

Parameters:

webhookFilters - The list of webhook events that are enabled for this Service instance

Returns:

this

setLimitsChannelMembers

public ServiceUpdater setLimitsChannelMembers(Integer limitsChannelMembers)

The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000..

Parameters:

limitsChannelMembers - The maximum number of Members that can be added to Channels within this Service

Returns:

this

setLimitsUserChannels

public ServiceUpdater setLimitsUserChannels(Integer limitsUserChannels)

The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000..

Parameters:

limitsUserChannels - The maximum number of Channels Users can be a Member of within this Service

Returns:

this

setMediaCompatibilityMessage

public ServiceUpdater setMediaCompatibilityMessage(String mediaCompatibilityMessage)

The message to send when a media message has no text. Can be used as placeholder message..

Parameters:

mediaCompatibilityMessage - The message to send when a media message has no text

Returns:

this

setPreWebhookRetryCount

public ServiceUpdater setPreWebhookRetryCount(Integer preWebhookRetryCount)

The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried..

Parameters:

preWebhookRetryCount - Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses

Returns:

this

setPostWebhookRetryCount

public ServiceUpdater setPostWebhookRetryCount(Integer postWebhookRetryCount)

The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried..

Parameters:

postWebhookRetryCount - The number of times calls to the `post_webhook_url` will be retried

Returns:

this

setNotificationsLogEnabled

public ServiceUpdater setNotificationsLogEnabled(Boolean notificationsLogEnabled)

Whether to log notifications. The default is `false`..

Parameters:

notificationsLogEnabled - Whether to log notifications

Returns:

this

update

public Service update(TwilioRestClient client)

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

Specified by:

update in class Updater<Service>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Updated Service