• Public
  • Public/Protected
  • All

Interface InboxOptions




Optional chatSubtitleMode

chatSubtitleMode: "subject" | "participants" | null

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

(also see ChatboxOptions.chatTitleMode and InboxOptions.feedConversationTitleMode)

Optional chatTitleMode

chatTitleMode: "subject" | "participants"

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

(also see ChatboxOptions.chatSubtitleMode and InboxOptions.feedConversationTitleMode)

Optional dir

dir: "rtl" | "ltr"

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

Optional feedConversationTitleMode

feedConversationTitleMode: "participants" | "subject" | "auto"

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

Note: when set to "subject" but a conversation has no subject set, then TalkJS falls back to "participants".

When not set, defaults to "auto", which means that in group conversations that have a subject set, the subject is displayed and otherwise the participants.

(also see ChatboxOptions.chatSubtitleMode and ChatboxOptions.chatTitleMode)

Optional feedFilter

feedFilter: ConversationFilter

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

See ConversationFilter for all available options.

You can also modify the filter on the fly using Inbox.setFeedFilter.


Optional messageSuggestion

messageSuggestion: undefined | string

Optional. 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".

Optional selected

selected: Conversation | ConversationBuilder | string | null

Optional. either a Conversation object (as returned from getOrCreateConversation) or the id field of a conversation. If given, makes the inbox start up with that conversation selected.

Optional showChatHeader

showChatHeader: undefined | true | false

Optional, defaults to true. Set to false to make TalkJS display the chat without its header (the upper bar that shows names and the user's photo).

Optional showFeedHeader

showFeedHeader: undefined | true | false

Optional, defaults to true. Set to false to make TalkJS display the chat feed without its header. On desktop, this header contains the toggle to enable desktop notifications, so you may want to implement that toggle yourself using Session.setDesktopNotificationEnabled.

Optional thirdparties

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.

Optional useBrowserHistory

useBrowserHistory: undefined | true | false

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

Generated using TypeDoc