com.twilio.chat.Members Class Reference

Provides access to channel members and allows to add/remove members. More...

Public Member Functions
Getters
Channel	getChannel ()
	Return channel this member list belongs to. More...
List< Member >	getMembersList ()
	Obtain an array of members of this channel. More...
Member	getMember (String identity)
	Get a channel member by identity. More...
Actions
void	add (Member member, StatusListener listener)
	Add member to the channel. More...
void	addByIdentity (String identity, StatusListener listener)
	Add specified username to this channel without inviting. More...
void	invite (Member member, StatusListener listener)
	Invite specified member to this channel. More...
void	inviteByIdentity (String identity, StatusListener listener)
	Invite specified username to this channel. More...
void	remove (Member member, StatusListener listener)
	Remove specified member from this channel. More...
void	removeByIdentity (String identity, StatusListener listener)
	Remove specified username from this channel. More...

Detailed Description

Provides access to channel members and allows to add/remove members.

Member Function Documentation

void com.twilio.chat.Members.add	(	Member	member,
		StatusListener	listener
	)

Add member to the channel.

The member object could refer to the member in some different channel, the add will be performed based on the member's identity. If the member is already present in the channel roster an error will be returned.

Parameters

member	The identity of the member to be added to this member list.
listener	StatusListener to report status of the action.

void com.twilio.chat.Members.addByIdentity	(	String	identity,
		StatusListener	listener
	)

Add specified username to this channel without inviting.

If the member is already present in the channel roster an error will be returned.

Parameters

identity	The username to add to this channel.
listener	StatusListener to report status of the action.

Channel com.twilio.chat.Members.getChannel

(

)

Return channel this member list belongs to.

Returns

Channel for this member list.

Member com.twilio.chat.Members.getMember

(

String

identity

)

Get a channel member by identity.

Parameters

identity

The identity of the member to look up.

Returns

Member object in current channel, or null if not found.

List<Member> com.twilio.chat.Members.getMembersList

(

)

Obtain an array of members of this channel.

Returns

An array of Member objects representing the membership of the channel.

void com.twilio.chat.Members.invite	(	Member	member,
		StatusListener	listener
	)

Invite specified member to this channel.

Parameters

member	The member to invite to this channel.
listener	StatusListener to report status.

void com.twilio.chat.Members.inviteByIdentity	(	String	identity,
		StatusListener	listener
	)

Invite specified username to this channel.

Parameters

identity	The identity of the member to invite to this channel.
listener	StatusListener to report status.

void com.twilio.chat.Members.remove	(	Member	member,
		StatusListener	listener
	)

Remove specified member from this channel.

Parameters

member	The member to remove from this channel.
listener	StatusListener to report status.

void com.twilio.chat.Members.removeByIdentity	(	String	identity,
		StatusListener	listener
	)

Remove specified username from this channel.

Parameters

identity	The identity of the member to remove from this channel.
listener	StatusListener to report status.