Other interfaces
Wednesday, July 17, 2019 4:51 AM| interface Conversation | Deprecated. Encapsulates an active conversation between two parties. |
| interface ConversationSelectedEvent | This represents the interface of the event triggered from Inbox.on("conversationSelected"). |
| interface MessageField | Encapsulates the message entry field tied to the currently selected conversation. |
| interface SendMessageEvent | The event triggered when listening for the sendMessage event on the Inbox, Chatbox and 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 |
| interface SentMessage | A message that was sent to TalkJS |
| interface ThirdPartyOptions | Used to configure supported third-party integrations with TalkJS. See third party integrations |
interface Conversation
Encapsulates an active conversation between two parties.Use this object to send system messages to the conversation or to programmatically select a conversation by passing it to Inbox.select.
Conversation objects are created with the deprecated Session.getOrStartConversation method.
Deprecated.
Properties
| custom CustomData optional | Optional custom conversation meta data |
| id string | The ID of the conversation |
| photoUrl string optional | An optional URL to a photo which will be shown as the photo for the conversation. |
| subject string optional | An optional conversation subject which is displayed in the chat header |
| topicId string | Legacy - please use subject instead. |
| welcomeMessages Array<string> optional |
interface ConversationSelectedEvent
This represents the interface of the event triggered from Inbox.on("conversationSelected").Properties
| conversation ConversationData | null | The current conversation object |
| me | The current TalkJS User |
| others Array<User> optional | The other participants in the conversation that are not the current user |
interface MessageField
Encapsulates the message entry field tied to the currently selected conversation.Methods
| focus | Focuses the message entry field. Note that on mobile devices, this will cause the on-screen keyboard to pop up, obscuring part of the screen. |
| setText | Sets the message entry field to |
Method Details
focus
messagefield.focus()Focuses the message entry field. Note that on mobile devices, this will cause the on-screen keyboard to pop up, obscuring part of the screen.
Parameters
Returns
voidsetText
messagefield.setText(text)Sets the message entry field to
text. Useful if you want to guide your user with message suggestions. If you want to start a UI with a given text showing immediately, consider passing InboxOptions.messageSuggestion to Session.createInbox (or createPopup or createChatbox). Parameters
| text string |
Returns
voidinterface SendMessageEvent
The event triggered when listening for the sendMessage event on the Inbox, Chatbox and 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 usingoverride(). Properties
| conversation | The current conversation object | ||||||||||||||||
interface ConversationData
| |||||||||||||||||
| me | The current TalkJS user | ||||||||||||||||
| message | The message that was sent | ||||||||||||||||
interface SentMessage
| |||||||||||||||||
| override ({
text,
custom
}: {
text?: string
custom?: CustomData
}) => void | This function allows you to modify the contents of the message or its metadata before the message is sent |
interface SentMessage
A message that was sent to TalkJSProperties
| attachment {
url: string
size: number
} optional | Only given if the message contains a file. An object with the URL and filesize (in bytes) of the given file. |
| conversationId string | The ID of the conversation that the message belongs to |
| id string | undefined | The message ID of the message that was sent |
| location [number, number] optional | Only given if the message contains a location. An array of two numbers which represent the longitude and latitude of this location, respectively. Only given if this message is a shared location. Example: |
| readBy string[] | Contains an Array of User.id's that have read the message |
| senderId string | Contains the user ID for the person that sent the message |
| text string optional | |
| type "UserMessage" | "SystemMessage" | Identifies the message as either a User message or System message |
interface ThirdPartyOptions
Used to configure supported third-party integrations with TalkJS. See third party integrationsProperties
| fullstory FullStoryOptions optional | |||||
interface FullStoryOptions
|