com.twilio.conversations.User Interface Reference

User info object. More...

Classes
enum	UpdateReason
	Indicates reason for user info update. More...

Public Member Functions
Getters
String	getFriendlyName ()
	Method that returns the friendlyName from the user info. More...
Attributes	getAttributes ()
	Custom attributes associated with this user. More...
String	getIdentity ()
	Returns the identity of the user. More...
boolean	isOnline ()
	Return user's online status, if available. More...
boolean	isNotifiable ()
	Return user's push reachability. More...
boolean	isSubscribed ()
	Check if this user receives real-time status updates. More...
Setters
void	setFriendlyName (String friendlyName, StatusListener listener)
	Updates the friendly name for this user info. More...
void	setAttributes (Attributes attributes, StatusListener listener)
	Set attributes associated with this user. More...
Actions
void	unsubscribe ()
	Unsubscribe from this user, freeing up resources. More...

Detailed Description

User info object.

Member Function Documentation

Attributes com.twilio.conversations.User.getAttributes

(

)

Custom attributes associated with this user.

Returns

the user Attributes.

String com.twilio.conversations.User.getFriendlyName

(

)

Method that returns the friendlyName from the user info.

Returns

the friendlyName.

String com.twilio.conversations.User.getIdentity

(

)

Returns the identity of the user.

Returns

the identity.

boolean com.twilio.conversations.User.isNotifiable

(

)

Return user's push reachability.

Returns

true if user is reachable via push, false otherwise.

boolean com.twilio.conversations.User.isOnline

(

)

Return user's online status, if available.

Returns

true if user is online, false otherwise.

boolean com.twilio.conversations.User.isSubscribed

(

)

Check if this user receives real-time status updates.

Returns

true if user is subscribed, false otherwise.

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

Set attributes associated with this user.

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

Parameters

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

void com.twilio.conversations.User.setFriendlyName	(	String	friendlyName,
		StatusListener	listener
	)

Updates the friendly name for this user info.

Parameters

friendlyName	updated friendly name.
listener	Listener that will receive callback with the result.

void com.twilio.conversations.User.unsubscribe

(

)

Unsubscribe from this user, freeing up resources.

User will no longer receive real-time status updates.