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 real-time channel connection status |
notifiable |
Boolean | User push notification registration status |
Fires:
Methods
-
unsubscribe()
-
Removes User from subscription list.
Returns:
Promise of completion- Type
- Promise.<void>
-
updateAttributes(attributes)
-
Updates user attributes.
Parameters:
Name Type Description attributes
Object Updated attributes Returns:
- Type
- Promise.<(User|Error|SessionError)>
-
updateFriendlyName(friendlyName)
-
Update Users friendlyName.
Parameters:
Name Type Description friendlyName
String Updated friendlyName Returns:
- Type
- Promise.<(User|Error|SessionError)>