com.twilio.chat.ChannelDescriptor Class Reference

Contains channel information. More...

Public Member Functions
Getters
void	getChannel (CallbackListener< Channel > listener)
	Retrieve a full Channel object. More...
String	getSid ()
	Get channel SID. More...
String	getFriendlyName ()
	Get channel friendly name. More...
Attributes	getAttributes ()
	Get channel attributes. More...
String	getUniqueName ()
	Get channel unique name. More...
Date	getDateUpdated ()
	Get channel update date. More...
Date	getDateCreated ()
	Get channel create date. More...
String	getCreatedBy ()
	Get creator of the channel. More...
Channel.ChannelStatus	getStatus ()
	Get the current user's participation status on this channel. More...
Counts
long	getMembersCount ()
	Get number of members. More...
long	getMessagesCount ()
	Get number of messages. More...
long	getUnconsumedMessagesCount ()
	Get number of unconsumed messages. More...

Detailed Description

Contains channel information.

Unlike Channel, this information won't be updated in realtime. To have refreshed data, user should query channel descriptors again.

From the channel descriptor you could obtain full Channel object by calling getChannel().

Member Function Documentation

Attributes com.twilio.chat.ChannelDescriptor.getAttributes

(

)

Get channel attributes.

Returns

Channel's custom Attributes.

See also

Channel::getAttributes()

void com.twilio.chat.ChannelDescriptor.getChannel

(

CallbackListener< Channel >

listener

)

Retrieve a full Channel object.

Parameters

listener

Listener to receive Channel result.

String com.twilio.chat.ChannelDescriptor.getCreatedBy

(

)

Get creator of the channel.

Returns

Identity of the channel's creator.

See also

Channel::getCreatedBy()

Date com.twilio.chat.ChannelDescriptor.getDateCreated

(

)

Get channel create date.

Returns

Date this Channel was created.

See also

Channel::getDateCreatedAsDate()

Date com.twilio.chat.ChannelDescriptor.getDateUpdated

(

)

Get channel update date.

Returns

Date this Channel was last updated.

See also

Channel::getDateUpdatedAsDate()

String com.twilio.chat.ChannelDescriptor.getFriendlyName

(

)

Get channel friendly name.

Returns

Channel friendly name.

See also

Channel::getFriendlyName()

long com.twilio.chat.ChannelDescriptor.getMembersCount

(

)

Get number of members.

Returns

Number of members in the channel.

See also

Channel::getMembersCount()

long com.twilio.chat.ChannelDescriptor.getMessagesCount

(

)

Get number of messages.

Returns

Number of messages in the channel.

See also

Channel::getMessagesCount()

String com.twilio.chat.ChannelDescriptor.getSid

(

)

Get channel SID.

Returns

Channel SID.

See also

Channel::getSid()

Channel.ChannelStatus com.twilio.chat.ChannelDescriptor.getStatus

(

)

Get the current user's participation status on this channel.

Since for ChannelDescriptors the status is unknown this function will always return Channel::ChannelStatus::UNKNOWN.

Returns

Status of the channel.

See also

Channel::getStatus()

long com.twilio.chat.ChannelDescriptor.getUnconsumedMessagesCount

(

)

Get number of unconsumed messages.

Returns

Number of unconsumed messages in the channel.

See also

Channel::getUnconsumedMessagesCount()

String com.twilio.chat.ChannelDescriptor.getUniqueName

(

)

Get channel unique name.

Returns

Channel unique name.

See also

Channel::getUniqueName()