com.twilio.conversations.Participant Interface Reference

Representation of a Conversation Participant object. More...

Classes
enum	Type
	Participant type. More...
enum	UpdateReason
	Indicates reason for participant info update. More...

Public Member Functions
Getters
String	getSid ()
	Returns unique identifier of a participant on a conversation. More...
Long	getLastReadMessageIndex ()
	Return participant's last read message index for this conversation. More...
String	getLastReadTimestamp ()
	Return participant's last read message timestamp for this conversation. More...
String	getDateCreated ()
	Get creation date of the participant as an ISO 8601 string. More...
Date	getDateCreatedAsDate ()
	Get creation date of the participant. More...
String	getDateUpdated ()
	Get update date of the participant as an ISO 8601 string. More...
Date	getDateUpdatedAsDate ()
	Get update date of the participant. More...
Conversation	getConversation ()
	Return conversation this participant belongs to. More...
String	getIdentity ()
	Return user identity for current participant. More...
Type	getType ()
	Return Type of current participant. More...
Attributes	getAttributes ()
Setters
void	setAttributes (Attributes attributes, StatusListener listener)
	Set attributes associated with this participant. More...
Actions
void	getAndSubscribeUser (CallbackListener< User > listener)
	Return subscribed user object for current participant. More...
void	remove (StatusListener listener)
	Remove this participant from conversation. More...

Detailed Description

Representation of a Conversation Participant object.

Member Function Documentation

void com.twilio.conversations.Participant.getAndSubscribeUser

(

CallbackListener< User >

listener

)

Return subscribed user object for current participant.

Parameters

listener

Listener to receive the resulting User or error.

Attributes com.twilio.conversations.Participant.getAttributes

(

)

Returns

custom Attributes associated with this participant.

Conversation com.twilio.conversations.Participant.getConversation

(

)

Return conversation this participant belongs to.

Returns

Conversation for this participant.

String com.twilio.conversations.Participant.getDateCreated

(

)

Get creation date of the participant as an ISO 8601 string.

Returns

Date when participant was created as a string in ISO 8601 format.

Date com.twilio.conversations.Participant.getDateCreatedAsDate

(

)

Get creation date of the participant.

Returns

Date when participant was created or null if date string could not be parsed.

String com.twilio.conversations.Participant.getDateUpdated

(

)

Get update date of the participant as an ISO 8601 string.

Returns

Date when participant was last updated as a string in ISO 8601 format.

Date com.twilio.conversations.Participant.getDateUpdatedAsDate

(

)

Get update date of the participant.

Returns

Date when participant was last updated or null if date string could not be parsed.

String com.twilio.conversations.Participant.getIdentity

(

)

Return user identity for current participant.

Returns

User identity of current participant.

Long com.twilio.conversations.Participant.getLastReadMessageIndex

(

)

Return participant's last read message index for this conversation.

Returns

read message index. Null if not set

See also

getLastReadTimestamp

String com.twilio.conversations.Participant.getLastReadTimestamp

(

)

Return participant's last read message timestamp for this conversation.

Returns

read message timestamp. Empty string if read index is not set

See also

getLastReadMessageIndex

String com.twilio.conversations.Participant.getSid

(

)

Returns unique identifier of a participant on a conversation.

Returns

The unique id of a participant.

Type com.twilio.conversations.Participant.getType

(

)

Return Type of current participant.

Returns

Type of current participant.

void com.twilio.conversations.Participant.remove

(

StatusListener

listener

)

Remove this participant from conversation.

Parameters

listener

StatusListener to report status.

void com.twilio.conversations.Participant.setAttributes	(	Attributes	attributes,
		StatusListener	listener
	)

Set attributes associated with this participant.

Passing null will reset participant attributes to an empty json object.

Parameters

attributes	The new developer-provided Attributes for this participant.
listener	Listener that will receive callback with the result.