User

interface User
Content copied to clipboard

User info object

Types

UpdateReason
Link copied to clipboard
enum UpdateReason
Content copied to clipboard
Indicates reason for user info update.

Functions

getAttributes
Link copied to clipboard
abstract fun getAttributes(): Attributes
Content copied to clipboard
Custom attributes associated with this user.
getFriendlyName
Link copied to clipboard
abstract fun getFriendlyName(): String
Content copied to clipboard
Method that returns the friendlyName from the user info.
getIdentity
Link copied to clipboard
abstract fun getIdentity(): String
Content copied to clipboard
Returns the identity of the user.
isNotifiable
Link copied to clipboard
abstract fun isNotifiable(): Boolean
Content copied to clipboard
Return user's push reachability.
isOnline
Link copied to clipboard
abstract fun isOnline(): Boolean
Content copied to clipboard
Return user's online status, if available.
isSubscribed
Link copied to clipboard
abstract fun isSubscribed(): Boolean
Content copied to clipboard
Check if this user receives real-time status updates.
setAttributes
Link copied to clipboard
abstract fun setAttributes(attributes: Attributes, listener: StatusListener)
Content copied to clipboard
Set attributes associated with this user.
setFriendlyName
Link copied to clipboard
abstract fun setFriendlyName(friendlyName: String, listener: StatusListener)
Content copied to clipboard
Updates the friendly name for this user info.
unsubscribe
Link copied to clipboard
abstract fun unsubscribe()
Content copied to clipboard
Unsubscribe from this user, freeing up resources.