com.twilio.chat

Class User

java.lang.Object

com.twilio.chat.User

public final class User
extends java.lang.Object

User info object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.UpdateReason Indicates reason for user info update.

Method Summary

Modifier and Type	Method and Description
void	dispose()
org.json.JSONObject	getAttributes() Custom attributes associated with the user info.
java.lang.String	getFriendlyName() Method that returns the friendlyName of the user info.
java.lang.String	getIdentity() Returns the identity of the user.
boolean	isNotifiable() Return user's push reachability.
boolean	isOnline() Return user's online status, if available.
boolean	isSubscribed() Check if this user receives real-time status updates.
void	setAttributes(org.json.JSONObject updatedAttributes, StatusListener listener) Updates the attribute data for this user info.
void	setFriendlyName(java.lang.String friendlyName, StatusListener listener) Updates the friendly name for this user info.
void	unsubscribe() Unsubscribe from this user, freeing up resources.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFriendlyName

public java.lang.String getFriendlyName()

Method that returns the friendlyName of the user info.

Returns:

the friendlyName.

setFriendlyName

public void setFriendlyName(java.lang.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.

getAttributes

public org.json.JSONObject getAttributes()

Custom attributes associated with the user info.

Returns:

the map of attributes.

setAttributes

public void setAttributes(org.json.JSONObject updatedAttributes,
                          StatusListener listener)

Updates the attribute data for this user info.

Parameters:

updatedAttributes - attributes to change.

listener - Listener that will receive callback with the result.

getIdentity

public java.lang.String getIdentity()

Returns the identity of the user.

Returns:

the identity.

isOnline

public boolean isOnline()

Return user's online status, if available.

Returns:

true if user is online, false otherwise.

isNotifiable

public boolean isNotifiable()

Return user's push reachability.

Returns:

true if user is reachable via push, false otherwise.

unsubscribe

public void unsubscribe()

Unsubscribe from this user, freeing up resources. User will no longer receive real-time status updates.

isSubscribed

public boolean isSubscribed()

Check if this user receives real-time status updates.

Returns:

true if user is subscribed, false otherwise.

dispose

public void dispose()