Chat Android SDK  5.1.0
com.twilio.chat.UserDescriptor Class Reference

Contains user information. More...

Public Member Functions

Getters
String getFriendlyName ()
 Get user friendly name. More...
 
Attributes getAttributes ()
 Get user attributes. More...
 
String getIdentity ()
 Get user identity. More...
 
boolean isOnline ()
 User online status. More...
 
boolean isNotifiable ()
 User notifiable status. More...
 
Actions
void subscribe (CallbackListener< User > listener)
 Subscribe to the user object. More...
 

Detailed Description

Contains user information.

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

From the user descriptor you could obtain full User object by calling subscribe().

Member Function Documentation

Attributes com.twilio.chat.UserDescriptor.getAttributes ( )

Get user attributes.

Returns
User's custom Attributes.
See also
User::getAttributes
String com.twilio.chat.UserDescriptor.getFriendlyName ( )

Get user friendly name.

Returns
User friendly name.
See also
User::getFriendlyName
String com.twilio.chat.UserDescriptor.getIdentity ( )

Get user identity.

Returns
User's identity.
See also
User::getIdentity
boolean com.twilio.chat.UserDescriptor.isNotifiable ( )

User notifiable status.

Returns
true if user can be notified, false otherwise.
See also
User::isNotifiable
boolean com.twilio.chat.UserDescriptor.isOnline ( )

User online status.

Returns
true if user is online, false otherwise.
See also
User::isOnline
void com.twilio.chat.UserDescriptor.subscribe ( CallbackListener< User listener)

Subscribe to the user object.

Parameters
listenerListener that will receive callback with the result.