com.twilio.ipmessaging

Interface Channel

public interface Channel

Container for channel object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Channel.ChannelStatus The Channel.ChannelStatus enum represents the various states of the member with respect to this channel
static class	Channel.ChannelType Enumeration indicating the channel's visibility.

Method Summary

Modifier and Type	Method and Description
void	declineInvitation(Constants.StatusListener listener) Declines an invite on this channel.
void	destroy(Constants.StatusListener listener) Destroys the current channel.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Custom attributes associated with the Channel.
java.lang.String	getFriendlyName() Method that returns the friendlyName of the channel.
ChannelListener	getListener() Method to retrieve ChannelListener for this Channel.
Members	getMembers() Method to get the channel members.
Messages	getMessages() Method to get messages.
java.lang.String	getSid() Method that returns the unique identifier for this channel.
Channel.ChannelStatus	getStatus() Returns the current user's status on this channel.
Channel.ChannelType	getType() Method to get the channel type.
java.lang.String	getUniqueName() Method that returns the unique Name of the channel.
void	join(Constants.StatusListener listener) Joins the current user to the channel.
void	leave(Constants.StatusListener listener) Leaves the current channel.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> updatedAttributes, Constants.StatusListener listener) Updates the attribute data for this channel.
void	setFriendlyName(java.lang.String friendlyName, Constants.StatusListener listener) Updates the friendly name for this channel.
void	setListener(ChannelListener listener) Method to set ChannelListener for this Channel.
void	setUniqueName(java.lang.String uniqueName, Constants.StatusListener listener) Updates the unique name for this channel.
void	typing() Called when Member starts typing on this channel.

Method Detail

getSid

java.lang.String getSid()

Method that returns the unique identifier for this channel.

Returns:

the sid.

getFriendlyName

java.lang.String getFriendlyName()

Method that returns the friendlyName of the channel.

Returns:

the firendlyName.

setFriendlyName

void setFriendlyName(java.lang.String friendlyName,
                     Constants.StatusListener listener)

Updates the friendly name for this channel.

Parameters:

friendlyName - updated friendly name.

getAttributes

java.util.Map<java.lang.String,java.lang.String> getAttributes()

Custom attributes associated with the Channel.

Returns:

the map of attributes.

setAttributes

void setAttributes(java.util.Map<java.lang.String,java.lang.String> updatedAttributes,
                   Constants.StatusListener listener)

Updates the attribute data for this channel.

Parameters:

updatedAttributes -

getMessages

Messages getMessages()

Method to get messages.

Returns:

Messages object for this channel.

getStatus

Channel.ChannelStatus getStatus()

Returns the current user's status on this channel.

Returns:

the channel status.

getListener

ChannelListener getListener()

Method to retrieve ChannelListener for this Channel.

Returns:

listener for this channel.

setListener

void setListener(ChannelListener listener)

Method to set ChannelListener for this Channel.

Parameters:

listener - A channel listener.

getMembers

Members getMembers()

Method to get the channel members.

Returns:

Set of Member objects.

getType

Channel.ChannelType getType()

Method to get the channel type.

Returns:

ChannelType of the channel.

getUniqueName

java.lang.String getUniqueName()

Method that returns the unique Name of the channel.

Returns:

the unique Name.

setUniqueName

void setUniqueName(java.lang.String uniqueName,
                   Constants.StatusListener listener)

Updates the unique name for this channel.

Parameters:

uniqueName - The new unique name for this channel.

listener - Listener that will receive callback with the result.

join

void join(Constants.StatusListener listener)

Joins the current user to the channel.

Parameters:

listener -

listener - Listener that will receive callback with the result.

leave

void leave(Constants.StatusListener listener)

Leaves the current channel.

Parameters:

listener - Listener that will receive callback with the result.

destroy

void destroy(Constants.StatusListener listener)

Destroys the current channel.

Parameters:

listener - Listener that will receive callback with the result.

declineInvitation

void declineInvitation(Constants.StatusListener listener)

Declines an invite on this channel.

Parameters:

listener - StatusListener to report status of the async operation via callback.

listener - Listener that will receive callback with the result.

typing

void typing()

Called when Member starts typing on this channel.