com.twilio.rest.ipmessaging.v2

Class ServiceUpdater

java.lang.Object

com.twilio.base.Updater<Service>

com.twilio.rest.ipmessaging.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) The consumption_report_interval.
ServiceUpdater	setDefaultChannelCreatorRoleSid(String defaultChannelCreatorRoleSid) Channel role assigned to creator of channel when joining for first time.
ServiceUpdater	setDefaultChannelRoleSid(String defaultChannelRoleSid) Channel role assigned on channel join (see [Roles](https://www.twilio.com/docs/chat/api/roles) data model for the details).
ServiceUpdater	setDefaultServiceRoleSid(String defaultServiceRoleSid) The default_service_role_sid.
ServiceUpdater	setFriendlyName(String friendlyName) Human-readable name for this service instance.
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 media.compatibility_message.
ServiceUpdater	setNotificationsAddedToChannelEnabled(Boolean notificationsAddedToChannelEnabled) The notifications.added_to_channel.enabled.
ServiceUpdater	setNotificationsAddedToChannelSound(String notificationsAddedToChannelSound) The notifications.added_to_channel.sound.
ServiceUpdater	setNotificationsAddedToChannelTemplate(String notificationsAddedToChannelTemplate) The notifications.added_to_channel.template.
ServiceUpdater	setNotificationsInvitedToChannelEnabled(Boolean notificationsInvitedToChannelEnabled) The notifications.invited_to_channel.enabled.
ServiceUpdater	setNotificationsInvitedToChannelSound(String notificationsInvitedToChannelSound) The notifications.invited_to_channel.sound.
ServiceUpdater	setNotificationsInvitedToChannelTemplate(String notificationsInvitedToChannelTemplate) The notifications.invited_to_channel.template.
ServiceUpdater	setNotificationsLogEnabled(Boolean notificationsLogEnabled) The notifications.log_enabled.
ServiceUpdater	setNotificationsNewMessageBadgeCountEnabled(Boolean notificationsNewMessageBadgeCountEnabled) The notifications.new_message.badge_count_enabled.
ServiceUpdater	setNotificationsNewMessageEnabled(Boolean notificationsNewMessageEnabled) The notifications.new_message.enabled.
ServiceUpdater	setNotificationsNewMessageSound(String notificationsNewMessageSound) The notifications.new_message.sound.
ServiceUpdater	setNotificationsNewMessageTemplate(String notificationsNewMessageTemplate) The notifications.new_message.template.
ServiceUpdater	setNotificationsRemovedFromChannelEnabled(Boolean notificationsRemovedFromChannelEnabled) The notifications.removed_from_channel.enabled.
ServiceUpdater	setNotificationsRemovedFromChannelSound(String notificationsRemovedFromChannelSound) The notifications.removed_from_channel.sound.
ServiceUpdater	setNotificationsRemovedFromChannelTemplate(String notificationsRemovedFromChannelTemplate) The notifications.removed_from_channel.template.
ServiceUpdater	setPostWebhookRetryCount(Integer postWebhookRetryCount) Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses.
ServiceUpdater	setPostWebhookUrl(String postWebhookUrl) The webhook URL for POST-Event webhooks.
ServiceUpdater	setPostWebhookUrl(URI postWebhookUrl) The webhook URL for POST-Event webhooks.
ServiceUpdater	setPreWebhookRetryCount(Integer preWebhookRetryCount) Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses.
ServiceUpdater	setPreWebhookUrl(String preWebhookUrl) The webhook URL for PRE-Event webhooks.
ServiceUpdater	setPreWebhookUrl(URI preWebhookUrl) The webhook URL for PRE-Event webhooks.
ServiceUpdater	setReachabilityEnabled(Boolean reachabilityEnabled) `true` if the reachability feature should be enabled.
ServiceUpdater	setReadStatusEnabled(Boolean readStatusEnabled) `true` if the member read status feature is enabled, `false` if not.
ServiceUpdater	setTypingIndicatorTimeout(Integer typingIndicatorTimeout) The duration in seconds indicating the timeout after "started typing" event when client should assume that user is not typing anymore even if no "ended typing" message 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 webhook request format to use.
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

Method Detail

setFriendlyName

public ServiceUpdater setFriendlyName(String friendlyName)

Human-readable name for this service instance.

Parameters:

friendlyName - Human-readable name for this service instance

Returns:

this

setDefaultServiceRoleSid

public ServiceUpdater setDefaultServiceRoleSid(String defaultServiceRoleSid)

The default_service_role_sid.

Parameters:

defaultServiceRoleSid - The default_service_role_sid

Returns:

this

setDefaultChannelRoleSid

public ServiceUpdater setDefaultChannelRoleSid(String defaultChannelRoleSid)

Channel role assigned on channel join (see [Roles](https://www.twilio.com/docs/chat/api/roles) data model for the details).

Parameters:

defaultChannelRoleSid - Channel role assigned on channel join

Returns:

this

setDefaultChannelCreatorRoleSid

public ServiceUpdater setDefaultChannelCreatorRoleSid(String defaultChannelCreatorRoleSid)

Channel role assigned to creator of channel when joining for first time.

Parameters:

defaultChannelCreatorRoleSid - Channel role assigned to creator of channel when joining for first time

Returns:

this

setReadStatusEnabled

public ServiceUpdater setReadStatusEnabled(Boolean readStatusEnabled)

`true` if the member read status feature is enabled, `false` if not. Defaults to `true`..

Parameters:

readStatusEnabled - true if the member read status feature is enabled, false if not.

Returns:

this

setReachabilityEnabled

public ServiceUpdater setReachabilityEnabled(Boolean reachabilityEnabled)

`true` if the reachability feature should be enabled. Defaults to `false`.

Parameters:

reachabilityEnabled - true if the reachability feature should be enabled.

Returns:

this

setTypingIndicatorTimeout

public ServiceUpdater setTypingIndicatorTimeout(Integer typingIndicatorTimeout)

The duration in seconds indicating the timeout after "started typing" event when client should assume that user is not typing anymore even if no "ended typing" message received.

Parameters:

typingIndicatorTimeout - The duration in seconds indicating the timeout after "started typing" event when client should assume that user is not typing anymore even if no "ended typing" message received

Returns:

this

setConsumptionReportInterval

public ServiceUpdater setConsumptionReportInterval(Integer consumptionReportInterval)

The consumption_report_interval.

Parameters:

consumptionReportInterval - The consumption_report_interval

Returns:

this

setNotificationsNewMessageEnabled

public ServiceUpdater setNotificationsNewMessageEnabled(Boolean notificationsNewMessageEnabled)

The notifications.new_message.enabled.

Parameters:

notificationsNewMessageEnabled - The notifications.new_message.enabled

Returns:

this

setNotificationsNewMessageTemplate

public ServiceUpdater setNotificationsNewMessageTemplate(String notificationsNewMessageTemplate)

The notifications.new_message.template.

Parameters:

notificationsNewMessageTemplate - The notifications.new_message.template

Returns:

this

setNotificationsNewMessageSound

public ServiceUpdater setNotificationsNewMessageSound(String notificationsNewMessageSound)

The notifications.new_message.sound.

Parameters:

notificationsNewMessageSound - The notifications.new_message.sound

Returns:

this

setNotificationsNewMessageBadgeCountEnabled

public ServiceUpdater setNotificationsNewMessageBadgeCountEnabled(Boolean notificationsNewMessageBadgeCountEnabled)

The notifications.new_message.badge_count_enabled.

Parameters:

notificationsNewMessageBadgeCountEnabled - The notifications.new_message.badge_count_enabled

Returns:

this

setNotificationsAddedToChannelEnabled

public ServiceUpdater setNotificationsAddedToChannelEnabled(Boolean notificationsAddedToChannelEnabled)

The notifications.added_to_channel.enabled.

Parameters:

notificationsAddedToChannelEnabled - The notifications.added_to_channel.enabled

Returns:

this

setNotificationsAddedToChannelTemplate

public ServiceUpdater setNotificationsAddedToChannelTemplate(String notificationsAddedToChannelTemplate)

The notifications.added_to_channel.template.

Parameters:

notificationsAddedToChannelTemplate - The notifications.added_to_channel.template

Returns:

this

setNotificationsAddedToChannelSound

public ServiceUpdater setNotificationsAddedToChannelSound(String notificationsAddedToChannelSound)

The notifications.added_to_channel.sound.

Parameters:

notificationsAddedToChannelSound - The notifications.added_to_channel.sound

Returns:

this

setNotificationsRemovedFromChannelEnabled

public ServiceUpdater setNotificationsRemovedFromChannelEnabled(Boolean notificationsRemovedFromChannelEnabled)

The notifications.removed_from_channel.enabled.

Parameters:

notificationsRemovedFromChannelEnabled - The notifications.removed_from_channel.enabled

Returns:

this

setNotificationsRemovedFromChannelTemplate

public ServiceUpdater setNotificationsRemovedFromChannelTemplate(String notificationsRemovedFromChannelTemplate)

The notifications.removed_from_channel.template.

Parameters:

notificationsRemovedFromChannelTemplate - The notifications.removed_from_channel.template

Returns:

this

setNotificationsRemovedFromChannelSound

public ServiceUpdater setNotificationsRemovedFromChannelSound(String notificationsRemovedFromChannelSound)

The notifications.removed_from_channel.sound.

Parameters:

notificationsRemovedFromChannelSound - The notifications.removed_from_channel.sound

Returns:

this

setNotificationsInvitedToChannelEnabled

public ServiceUpdater setNotificationsInvitedToChannelEnabled(Boolean notificationsInvitedToChannelEnabled)

The notifications.invited_to_channel.enabled.

Parameters:

notificationsInvitedToChannelEnabled - The notifications.invited_to_channel.enabled

Returns:

this

setNotificationsInvitedToChannelTemplate

public ServiceUpdater setNotificationsInvitedToChannelTemplate(String notificationsInvitedToChannelTemplate)

The notifications.invited_to_channel.template.

Parameters:

notificationsInvitedToChannelTemplate - The notifications.invited_to_channel.template

Returns:

this

setNotificationsInvitedToChannelSound

public ServiceUpdater setNotificationsInvitedToChannelSound(String notificationsInvitedToChannelSound)

The notifications.invited_to_channel.sound.

Parameters:

notificationsInvitedToChannelSound - The notifications.invited_to_channel.sound

Returns:

this

setPreWebhookUrl

public ServiceUpdater setPreWebhookUrl(URI preWebhookUrl)

The webhook URL for PRE-Event webhooks. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details..

Parameters:

preWebhookUrl - The webhook URL for PRE-Event webhooks.

Returns:

this

setPreWebhookUrl

public ServiceUpdater setPreWebhookUrl(String preWebhookUrl)

The webhook URL for PRE-Event webhooks. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details..

Parameters:

preWebhookUrl - The webhook URL for PRE-Event webhooks.

Returns:

this

setPostWebhookUrl

public ServiceUpdater setPostWebhookUrl(URI postWebhookUrl)

The webhook URL for POST-Event webhooks. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details..

Parameters:

postWebhookUrl - The webhook URL for POST-Event webhooks.

Returns:

this

setPostWebhookUrl

public ServiceUpdater setPostWebhookUrl(String postWebhookUrl)

The webhook URL for POST-Event webhooks. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details..

Parameters:

postWebhookUrl - The webhook URL for POST-Event webhooks.

Returns:

this

setWebhookMethod

public ServiceUpdater setWebhookMethod(HttpMethod webhookMethod)

The webhook request format to use. Must be POST or GET. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details..

Parameters:

webhookMethod - The webhook request format to use.

Returns:

this

setWebhookFilters

public ServiceUpdater setWebhookFilters(List<String> webhookFilters)

The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/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](https://www.twilio.com/docs/chat/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. The maximum allowed value is 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. The maximum value allowed is 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 media.compatibility_message.

Parameters:

mediaCompatibilityMessage - The media.compatibility_message

Returns:

this

setPreWebhookRetryCount

public ServiceUpdater setPreWebhookRetryCount(Integer preWebhookRetryCount)

Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry count is 0 times..

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)

Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry count is 0 times..

Parameters:

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

Returns:

this

setNotificationsLogEnabled

public ServiceUpdater setNotificationsLogEnabled(Boolean notificationsLogEnabled)

The notifications.log_enabled.

Parameters:

notificationsLogEnabled - The notifications.log_enabled

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