Inbox class

The main messaging UI. Chats on the left, messages on the right. Create an Inbox through {@link Session.createInbox} and then call {@link Inbox.mount} to show it. @public

Annotations
  • @JS()
  • @anonymous

Constructors

Inbox()
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
messageField ↔ MessageField
Encapsulates the message entry field tied to the currently selected conversation.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createHtmlPanel(HtmlPanelOptions options) → dynamic
HTML Panels allow you to place a HTML document in an iframe in your chats, just above the entry box.
destroy() → void
Destroys an inbox and removes all event listeners it has running. Call this before removing the inbox container from the DOM.
mount(Element? container) → dynamic
Renders the UI inside a DOM element specified by container. container must either be a DOM Element (as returned by e.g. document.getElementById) or a JQuery object with a single element.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
off(String eventType, Function handler) → void
on(String eventType, Function handler) → void
select(dynamic conversation) → void
Switches the active conversation the conversation.
setFeedFilter(ConversationPredicate filter) → void
Used to control which conversations are shown in the conversation feed, depending on access level, custom conversation attributes or message read status.
setHighlightedWords(List<String> words) → void
The TalkJS search feature includes the ability to highlight certain words in messages. Call this method to highlight certain words without having the user invoke the search feature. Call again with an empty array to disable highlighting.
setMessageFilter(MessagePredicate filter) → void
Used to control which messages are shown in the message list, depending on a type, origin or custom message attributes.
setPresence(dynamic val) → void
Sets metadata for the current session.
setTranslationEnabledDefault(dynamic enabled) → void
Enable/disable translation by default. This setting is applied to any conversation for which you haven't set a specific value. @param enabled - Whether conversations should be translated by default or not. Pass "auto" to enable translation for conversations with users with different locales.
setTranslationEnabledForConversation(dynamic conversation, bool enabled) → void
Enable or disable translation for a conversation.
toggleDesktopNotifications(bool isEnabled) → void
Please use {@link Session.setDesktopNotificationEnabled} instead.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited