com.twilio.sdk.resource.instance.ipmessaging

Class Channel

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.Channel

public class Channel
extends NextGenInstanceResource<TwilioIPMessagingClient>

Represents a single channel resource

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Member	createMember(Map<String,String> params) Create a single member
Message	createMessage(List<org.apache.http.NameValuePair> params) Create a message
Message	createMessage(Map<String,String> params) Create a message
boolean	delete() Deletes the channel
String	getAccountSid() The account sid that owns this channel
String	getAttributes() The attributes associated to this channel
String	getCreatedBy() The user who created this channel
Calendar	getDateCreated() The date when this channel was created
Calendar	getDateUpdated() The date when this channel was updated
String	getFriendlyName() The human readable name for this channel
Member	getMember(String sid) Get a single member
MemberList	getMembers() Initialize members without filters
MemberList	getMembers(Map<String,String> filters) Initialize members with filters
Message	getMessage(String sid) Fetch a single message
MessageList	getMessages() Initialize messages without filters
MessageList	getMessages(Map<String,String> filters) Initialize messages with filters
String	getServiceSid() The service sid that is associated to this channel
String	getSid() The unique identifier for this channel
String	getType() The type attribute for this channel
String	getUniqueName() The human readable unique name for this channel
String	getUrl() Absolute url of this channel

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

Channel

public Channel(TwilioIPMessagingClient client,
               String serviceSid,
               String sid)

Channel

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

Method Detail

getSid

public String getSid()

The unique identifier for this channel

Returns:

A sid string

getAccountSid

public String getAccountSid()

The account sid that owns this channel

Returns:

The account sid

getServiceSid

public String getServiceSid()

The service sid that is associated to this channel

Returns:

The service sid

getFriendlyName

public String getFriendlyName()

The human readable name for this channel

Returns:

A human readable string

getUniqueName

public String getUniqueName()

The human readable unique name for this channel

Returns:

A human readable string

getCreatedBy

public String getCreatedBy()

The user who created this channel

Returns:

The user sid

getAttributes

public String getAttributes()

The attributes associated to this channel

Returns:

The channel attributes

getType

public String getType()

The type attribute for this channel

Returns:

The type

getDateCreated

public Calendar getDateCreated()

The date when this channel was created

Returns:

The created date

getDateUpdated

public Calendar getDateUpdated()

The date when this channel was updated

Returns:

The updated date

getUrl

public String getUrl()

Absolute url of this channel

Returns:

The url of this channel

getMembers

public MemberList getMembers()

Initialize members without filters

Returns:

The members endpoint

getMember

public Member getMember(String sid)

Get a single member

Parameters:

sid - The member sid

Returns:

The fetched member

createMember

public Member createMember(Map<String,String> params)
                    throws TwilioRestException

Create a single member

Parameters:

params - The params to provide

Returns:

The created member

Throws:

TwilioRestException

getMembers

public MemberList getMembers(Map<String,String> filters)

Initialize members with filters

Parameters:

filters - The filters to apply

Returns:

The members endpoint

getMessages

public MessageList getMessages()

Initialize messages without filters

Returns:

The messages endpoint

getMessages

public MessageList getMessages(Map<String,String> filters)

Initialize messages with filters

Parameters:

filters - The filters to apply

Returns:

The messages endpoint

getMessage

public Message getMessage(String sid)

Fetch a single message

Parameters:

sid - The message sid

Returns:

The fetched message

createMessage

public Message createMessage(Map<String,String> params)
                      throws TwilioRestException

Create a message

Parameters:

params - The params to provide

Returns:

The created message

Throws:

TwilioRestException

createMessage

public Message createMessage(List<org.apache.http.NameValuePair> params)
                      throws TwilioRestException

Create a message

Parameters:

params - The params to provide

Returns:

The created message

Throws:

TwilioRestException

delete

public boolean delete()
               throws TwilioRestException

Deletes the channel

Returns:

True iff the delete is successful

Throws:

TwilioRestException