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:
Methods
-
updateAttributes(attributes)
-
Update the UserInfo's attributes.
Parameters:
Name Type Description attributes
Object The new attributes object. Returns:
A Promise for the UserInfo- Type
- Promise.<(UserInfo|SessionError)>
-
updateFriendlyName(name)
-
Update the Users's friendlyName.
Parameters:
Name Type Description name
String The new friendlyName. Returns:
A Promise for the UserInfo- Type
- Promise.<(UserInfo|SessionError)>
Events
-
updated
-
Fired when the UserInfo's fields have been updated.
Parameters:
Name Type Description reason
String Name of the property which has changed