talkjs library

Classes

AppMetadata
App metadata, such as global custom fields for the entire app.
Chatbox
A messaging UI for just a single conversation
ChatboxOptions
ConversationAttributes
Conversation attributes that can be set using {@link ConversationBuilder.setAttributes} @public
ConversationBuilder
A Conversation Builder represents a conversation that is about to be created, fetched, or updated. You can use this object to set up or modify a conversation before showing it.
ConversationData
ConversationPredicate
Allows you to filter conversations down to a specific subset.
ConversationSelectedEvent
This represents the interface of the event triggered from {@link Inbox.on | Inbox.on("conversationSelected")}.
DesktopNotificationToggledEvent
This event is triggered when {@link https://talkjs.com/docs/Features/Notifications/Browser_Notifications.htm | desktop notifications} are toggled.
FullStoryOptions
GetOrStartOptionsA
GetOrStartOptionsB
HtmlPanel
HTML Panel HTML panels should only be created through {@link Inbox.createHtmlPanel}, {@link Chatbox.createHtmlPanel} or {@link Popup.createHtmlPanel}.
HtmlPanelOptions
Inbox
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
InboxOptions
Message
A TalkJS message, used as part of {@link Session.on}
MessageField
Encapsulates the message entry field tied to the currently selected conversation.
MessageFieldOptions
MessagePredicate
Lets you show only specific messages in the chat panel of a Chatbox, Inbox or Popup.
Participant
Contains information about an individual participant
ParticipationSettings
Specifies access and notification settings for a given user's participation to a given conversation. Used in {@link ConversationBuilder.setParticipant}. @public
A messaging UI for just a single conversation.
PopupOptions
SelectConversationEvent
Event data triggered from {@link Inbox.on | Inbox.on("selectConversation")}.
SendMessageEvent
@public The event triggered when listening for the sendMessage event on the {@link Inbox}, {@link Chatbox} and {@link Popup}. This event is triggered before the message is sent to TalkJS, allowing you to modify the contents of the message or its metadata by using override().
SendMessageOptions
SentMessage
A message that was sent to TalkJS
Session
A session represents a user's active browser tab. It also authenticates your app with TalkJS.
SessionOptions
TalkJs
TalkJsInbox
The main messaging UI. Chats on the left, messages on the right. Create an Inbox through Session.createInbox and then call mount to show it.
ThirdPartyOptions
Used to configure supported third-party integrations with TalkJS. See {@link https://talkjs.com/docs/Features/Customizations/Third_Party_Integrations.html | third party integrations }
TranslationToggledEvent
This event is triggered when the user toggles real-time message translation using the built-in toggle.
UIBox
UnreadConversation
Used as part of {@link Unreads.on}.
Unreads
This object can notify you when the amount of unread conversations changes. You can't instantiate it - instead, get an instance via {@link Session.unreads}.
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. @public
UserData
UserOptions

Properties

undefined → dynamic
no setter

Functions

addTalkJsScript() → void