Suggest Edits

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.

NOTE: A User object is created by calling either the getUser or getUserById methods of the Session object.

availabilityText

: String?

Availability acts similarly to welcomeMessage but appears as a system message.

custom

: Map<String, String?>?

Allows you to set custom metadata for the User

email

: List<String>?

One or more email address belonging to the User. The email addresses will be used for Email Notifications if they are enabled.

id

: String

The unqiue ID which is used to identify the user in TalkJS

locale

: String?

The locale field expects an IETF language tag. See the localization documentation.

name

: String

The User's name which will be displayed on the TalkJS UI

phone

: List<String>?

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).

photoUrl

: String?

An optional URL to a photo which will be displayed as the user's avatar

role

: String?

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.

welcomeMessage

: String?

The default message a user sees when starting a chat with that person