InboxOptions class

Annotations

• @JS()
• @anonymous

Constructors

InboxOptions()

Properties

chatSubtitleMode ↔ String?

Controls what text appears in the chat subtitle, right below the chat title. No subtitle is displayed when the conversation has no subject set or when set to null. Defaults to "subject".

getter/setter pair

chatTitleMode ↔ String?

Controls what text appears in the chat title, in the header above the messages. Defaults to "participants".

getter/setter pair

dir ↔ String?

Controls the text direction (for supporting right-to-left languages such as Arabic and Hebrew). TalkJS tries to determine the appropriate text direction from the parent page, but if that does not work or you want to explicitly control it, you can override it here. Defaults to "rtl". "rtl" | "ltr"

getter/setter pair

feedConversationTitleMode ↔ String?

Controls how a chat is displayed in the feed of chats.

getter/setter pair

feedFilter ↔ ConversationPredicate

Used to control which conversations are shown in the conversation feed, depending on access level, custom conversation attributes or message read status.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

messageField ↔ MessageFieldOptions?

Settings that affect the behavior of the message field

getter/setter pair

messageFilter ↔ MessagePredicate?

Used to control which messages are shown in the message list, depending on a type, origin or custom message attributes.

getter/setter pair

messageSuggestion ↔ String?

Sets the message input box to the given text. You can use this to suggest a certain initial message to be sent. The user can still edit it before hitting "send".

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selected ↔ dynamic

Makes the inbox start up with the given Conversation. Can be passed a value of the type ConversationBuilder (returned by getOrCreateConversation) or the string value of the conversation id. Conversation can be deselected on startup by passing a null value. Passing undefined means that the last conversation (or "no chats yet page") will be displayed.

getter/setter pair

showChatHeader ↔ bool?

Used to control if the Chat Header is displayed in the UI. Defaults to true.

getter/setter pair

showFeedHeader ↔ bool?

Controls if the feed header containing the toggle to enable desktop notifications is shown. Defaults to true.

getter/setter pair

showMobileBackButton ↔ bool?

Whether to show a "Back" button at the top of the chat screen on mobile devices.

getter/setter pair

showTranslationToggle ↔ dynamic

Set this to true to show a translation toggle in all conversations. Set this to "auto" to show a translation toggle in conversations where there are participants with different locales. This setting defaults to false, meaning that no toggles will be shown. In order to use this, you must be on the Premium plan, and set a Google Translate API key in the dashboard.

getter/setter pair

thirdparties ↔ ThirdPartyOptions

TalkJS leverages iframes behind the scenes and therefore not all services that you use in your app will work out of the box. This option adds support for a number of services to help you use them. Let us know if you're missing any.

getter/setter pair

translateConversations ↔ dynamic

TalkJS can translate conversations to the current user's locale using Google Translate. This option specifies which conversations should be translated in this UI. You can pass a boolean to enable/disable translation for all conversations, "auto" to enable translation on conversations where users have different locales, or you can pass an array of {@link ConversationBuilder}s or conversation Ids to be translated. This feature is only available on the Premium plan and above. Make sure you add your Google Translate API key in the dashboard.

getter/setter pair

useBrowserHistory ↔ bool?

Controls whether the user navigating between conversation should count as steps in the browser history. Defaults to true, which means that if the user clicks the browser's back button, they go back to the previous conversation (if any).

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