User
A user of your app. TalkJS uses the id 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.
| Constructor | Create a TalkJS User |
Availability acts similarly to welcomeMessage but appears as a system message.
Allows you to set custom metadata for the User
One or more email address belonging to the User. The email addresses will be used for Email Notifications if they are enabled.
The unique ID which is used to identify the user in TalkJS
The locale field expects an IETF language tag. See the localization documentation.
The User's name which will be displayed on the TalkJS UI
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).
An optional URL to a photo which will be displayed as the user's avatar
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.
The default message a user sees when starting a chat with that person
Deprecated. Please use role instead.
new User(options)
Create a TalkJS User
Use this constructor to create or update user data. The user is synchronized with the TalkJS backend if they are the current user in a session. If they are not the current user, and they are part of an existing conversation, they will be synchronized when the UI is mounted.
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
interface UserOptions
The unqiue ID which is used to identify the user in TalkJS
The User's name which will be displayed on the TalkJS UI
Allows you to set custom metadata for the User
Set any property to null to delete the existing value (if any). When omitted or undefined, the existing value remains unchanged.
One or more email address belonging to the User. The email addresses will be used for Email Notifications if they are enabled.
Set to null to delete the existing value(s) (if any). When omitted or undefined, the existing value(s) remain unchanged.
The locale field expects an IETF language tag. See the localization documentation.
Set to null to delete the existing value (if any). When omitted or undefined, the existing value remains unchanged.
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).
Set to null to delete the existing value(s) (if any). When omitted or undefined, the existing value(s) remain unchanged.
An optional URL to a photo which will be displayed as the user's avatar
Set to null to delete the existing value (if any). When omitted or undefined, the existing value remains unchanged.
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.
Set to null to delete the existing value (if any). When omitted or undefined, the existing value remains unchanged.
The default message a user sees when starting a chat with that person
Set to null to delete the existing value (if any). When omitted or undefined, the existing value remains unchanged.
Availability acts similarly to User.welcomeMessage but appears as a system message.
Set to null to delete the existing value (if any). When omitted or undefined, the existing value remains unchanged.
Deprecated. Please use Conversation.welcomeMessages instead.
Deprecated. Please use role instead.