UserOptions class
- Annotations
-
- @JS()
- @anonymous
Constructors
- UserOptions()
-
factory
Properties
- availabilityText ↔ String?
-
Availability acts similarly to {@link User.welcomeMessage} but appears as a {@link https://talkjs.com/docs/Reference/Concepts/System_Messages.html | system message}.
getter/setter pair
- custom ↔ dynamic
-
Allows you to set custom metadata for the User
getter/setter pair
- email ↔ dynamic
-
One or more email address belonging to the User. The email addresses will be used for {@link https://talkjs.com/docs/Features/Notifications/Email_Notifications/index.html | Email Notifications}
if they are enabled.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- id ↔ dynamic
-
The unqiue ID which is used to identify the user in TalkJS
getter/setter pair
- locale ↔ String?
-
The locale field expects an {@link https://www.w3.org/International/articles/language-tags/ | IETF language tag}.
See the {@link https://talkjs.com/docs/Features/Multiple_Languages.html | localization documentation}.
getter/setter pair
- name ↔ String
-
The User's name which will be displayed on the TalkJS UI
getter/setter pair
- phone ↔ dynamic
-
One or more phone numbers belonging to the User. The phone number will be used for {@link https://talkjs.com/docs/Features/Notifications/SMS_Notifications.html | SMS Notifications }
(this feature requires standard plan and up).
getter/setter pair
- photoUrl ↔ String?
-
An optional URL to a photo which will be displayed as the user's avatar
getter/setter pair
- 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.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- welcomeMessage ↔ String?
-
The default message a user sees when starting a chat with that person
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited