com.twilio.rest.chat.v2.service

Class ChannelCreator

java.lang.Object

com.twilio.base.Creator<Channel>

com.twilio.rest.chat.v2.service.ChannelCreator

public class ChannelCreator
extends Creator<Channel>

Constructor Summary

Constructors

Constructor and Description
ChannelCreator(String pathServiceSid) Construct a new ChannelCreator.

Method Summary

Modifier and Type	Method and Description
Channel	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
ChannelCreator	setAttributes(String attributes) A valid JSON string that contains application-specific data..
ChannelCreator	setCreatedBy(String createdBy) The `identity` of the User that created the channel.
ChannelCreator	setDateCreated(ZonedDateTime dateCreated) The date, specified in ISO 8601 format, to assign to the resource as the date it was created.
ChannelCreator	setDateUpdated(ZonedDateTime dateUpdated) The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated.
ChannelCreator	setFriendlyName(String friendlyName) A descriptive string that you create to describe the new resource.
ChannelCreator	setType(Channel.ChannelType type) The visibility of the channel.
ChannelCreator	setUniqueName(String uniqueName) An application-defined string that uniquely identifies the resource.
ChannelCreator	setXTwilioWebhookEnabled(Channel.WebhookEnabledType xTwilioWebhookEnabled) The X-Twilio-Webhook-Enabled HTTP request header.

Methods inherited from class com.twilio.base.Creator

create, createAsync, createAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelCreator

public ChannelCreator(String pathServiceSid)

Construct a new ChannelCreator.

Parameters:

pathServiceSid - The SID of the Service to create the Channel resource under

Method Detail

setFriendlyName

public ChannelCreator setFriendlyName(String friendlyName)

A descriptive string that you create to describe the new resource. It can be up to 64 characters long..

Parameters:

friendlyName - A string to describe the new resource

Returns:

this

setUniqueName

public ChannelCreator setUniqueName(String uniqueName)

An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the Channel resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service..

Parameters:

uniqueName - An application-defined string that uniquely identifies the Channel resource

Returns:

this

setAttributes

public ChannelCreator setAttributes(String attributes)

A valid JSON string that contains application-specific data..

Parameters:

attributes - A valid JSON string that contains application-specific data

Returns:

this

setType

public ChannelCreator setType(Channel.ChannelType type)

The visibility of the channel. Can be: `public` or `private` and defaults to `public`..

Parameters:

type - The visibility of the channel

Returns:

this

setDateCreated

public ChannelCreator setDateCreated(ZonedDateTime dateCreated)

The date, specified in ISO 8601 format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source..

Parameters:

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

Returns:

this

setDateUpdated

public ChannelCreator setDateUpdated(ZonedDateTime dateUpdated)

The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used in cases where a Channel is being recreated from a backup/separate source and where a Message was previously updated..

Parameters:

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

Returns:

this

setCreatedBy

public ChannelCreator setCreatedBy(String createdBy)

The `identity` of the User that created the channel. Default is: `system`..

Parameters:

createdBy - The identity of the User that created the Channel

Returns:

this

setXTwilioWebhookEnabled

public ChannelCreator setXTwilioWebhookEnabled(Channel.WebhookEnabledType xTwilioWebhookEnabled)

The X-Twilio-Webhook-Enabled HTTP request header.

Parameters:

xTwilioWebhookEnabled - The X-Twilio-Webhook-Enabled HTTP request header

Returns:

this

create

public Channel create(TwilioRestClient client)

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

Specified by:

create in class Creator<Channel>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Channel