User
Thursday, May 6, 2021 2:03 AMclass User
A user of your app. TalkJS uses theid to uniquely identify this user. All other fields of a User are allowed to vary over time and the TalkJS database will update its fields accordingly. Methods
| Constructor | Create a TalkJS User |
Properties
availabilityTextstring | null | Availability acts similarly to welcomeMessage but appears as a system message. |
custom{
[name: string]: string | null
} | null | Allows you to set custom metadata for the User |
string | Array<string> | null | One or more email address belonging to the User. The email addresses will be used for Email Notifications if they are enabled. |
idstring | The unqiue ID which is used to identify the user in TalkJS |
localestring | null | The locale field expects an IETF language tag. See the localization documentation. |
namestring | The User's name which will be displayed on the TalkJS UI |
phonestring | Array<string> | null | One or more phone numbers belonging to the User. The phone number will be used for SMS Notifications (this feature requires standard plan and up). |
photoUrlstring | null | An optional URL to a photo which will be displayed as the user's avatar |
rolestring | null | TalkJS supports multiple sets of settings, called "roles". These allow you to change the behavior of TalkJS for different users. You have full control over which user gets which configuration. |
welcomeMessagestring | null | The default message a user sees when starting a chat with that person |
configurationstring | null | Deprecated. Please use role instead. |
Method Details
Constructors
new User(options)Create a TalkJS User
Use this constructor to synchronize user data with the TalkJS backend.
The fields id, name and email are required. A warning will be emitted if role is not specified.
Set email to null if you want to use TalkJS without email fallback.
Parameters
options | |||||||||||||||||||||||
interface UserOptions
|
new User(id)Create a TalkJS User
Only use this constructor if you're sure that a user by the given id already exists in TalkJS (for instance, because you synchronized it via the REST API). Otherwise use the new User(options: object): constructor instead.
Parameters
idstring | number |