Documentation

Class: User

User

Extended user information Note that User#online and User#notifiable properties are eligible to use only if reachability function enabled. You may check if it is enabled by reading value of Client~reachabilityEnabled
Properties:
Name Type Description
identity String User identity
friendlyName String User friendly name. Null if not set
attributes Object Object with custom attributes for user
online Boolean User realtime channel connection status
notifiable Boolean User push notification registration status
Fires:
  • User#event:updated

Methods

unsubscribe()

Unsubscribe, results in removing from subscription list
Returns:
Promise of completion
Type
Promise.<void>

updateAttributes(attributes)

Update the User's attributes.:
Parameters:
Name Type Description
attributes Object The new attributes object.
Returns:
A Promise for the User
Type
Promise.<(User|Error|SessionError)>

updateFriendlyName(friendlyName)

Update the Users's friendlyName.
Parameters:
Name Type Description
friendlyName String The new friendlyName.
Returns:
A Promise for the User
Type
Promise.<(User|Error|SessionError)>