Docs

Log in or Sign up to view personalized docs

Other interfaces

Wednesday, November 18, 2020 4:24 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 MessageFieldOptions

interface SelectConversationEvent

Event data triggered from Inbox.on("selectConversation").

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

interface SentMessage

A message that was sent to TalkJS

class TalkError

TalkJS Error class, inherits from the global Error class.

interface ThirdPartyOptions

Used to configure supported third-party integrations with TalkJS. See third party integrations

interface TranslationToggledEvent

This event is triggered when the user toggles real-time message translation using the built-in toggle.

interface UserData

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
{     [name: string]: string | null } | null

optional		Optional custom conversation meta data
id
string
The ID of the conversation
photoUrl
string | null

optional		An optional URL to a photo which will be shown as the photo for the conversation.
subject
string | null

optional		An optional conversation subject which is displayed in the chat header
topicId
string
Legacy - please use subject instead.
welcomeMessages
Array<string> | null

optional

interface ConversationSelectedEvent

This represents the interface of the event triggered from Inbox.on("conversationSelected").

Properties

conversation
ConversationData | null
The current conversation object
me
UserData
The current TalkJS User

interface UserData

availabilityText
string | null
Availability acts similarly to User.welcomeMessage but appears as a system message.
custom
CustomData
Allows you to set custom metadata for the User
id
string | number
The unqiue ID which is used to identify the user in TalkJS
locale
string | null
The locale field expects an IETF language tag. See the localization documentation.
name
string
The User's name which will be displayed on the TalkJS UI
photoUrl
string | null
An optional URL to a photo which will be displayed as the user's avatar
role
string | null
TalkJS supports multiple sets of settings, called "roles". These allow you to change the behavior of TalkJS for different users. You have full control over which user gets which configuration.
welcomeMessage
string | null
The default message a user sees when starting a chat with that person
configuration
string | null

Deprecated. Please use role instead.

others
Array<UserData>

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 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, call this method before calling Inbox.mount

setVisible

Sets the visibility of the Message Field to a given value or to a certain predicate. See MessageFieldOptions.visible for examples.

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

None.

Returns

void

setText

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, call this method before calling Inbox.mount

Parameters

text
string

The text to be displayed in the message entry field

Returns

void

setVisible

messagefield.setVisible(visible)

Sets the visibility of the Message Field to a given value or to a certain predicate. See MessageFieldOptions.visible for examples.

Parameters

visible
boolean | ConversationPredicate

boolean or a more advanced predicate.

Returns

void

interface MessageFieldOptions

Properties

enterSendsMessage
boolean

optional		If set to true, pressing the enter key sends the message (if there is text in the message field). When set to false, the only way to send a message is by clicking or touching the "Send" button. Defaults to true.
placeholder
string

optional		Overrides the "placeholder" in the message field, which displays a dimmed text when no text has yet been entered. Defaults to "Say something..." (or a translation thereof).
spellcheck
boolean

optional		Specifies whether the spellcheck attribute is set on the message field. Note that setting this to true may also enable autocorrect on some mobile devices. Defaults to false.
visible
boolean | ConversationPredicate

optional		Determines whether the message field is visible. Pass either a boolean (false to hide it), or a ConversationPredicate. The latter approach lets you show/hide the message field based on properties of the current conversation. For example, to hide the message field when the current user has no write access to the current conversation, do the following: 
// this predicate holds iff the current user's `access` to the current conversation is
// set to "ReadWrite"`:
const showMessageField = { access: ["==", "ReadWrite"] };
session.createInbox(conversation, { messageField: { visible: showMessageField } });
Defaults to true.

interface SelectConversationEvent

Event data triggered from Inbox.on("selectConversation").

Methods

preventDefault

Prevents the clicked conversation from being selected.

Properties

conversation
ConversationData
The current conversation object

interface ConversationData

custom
CustomData
Contains custom metadata for the conversation if it was set using ConversationBuilder.custom.
id
string
The ID of the conversation
photoUrl
string | null
Contains the URL of a photo was set using ConversationBuilder.subject.
subject
string | null
Contains the conversation subject if it was set using ConversationBuilder.subject.
welcomeMessages
Array<string> | null
One or more welcome messages that will display to the user as a SystemMessage
topicId
string | null

Deprecated. Please use ConversationBuilder.subject instead.

me
UserData
The current TalkJS User

interface UserData

availabilityText
string | null
Availability acts similarly to User.welcomeMessage but appears as a system message.
custom
CustomData
Allows you to set custom metadata for the User
id
string | number
The unqiue ID which is used to identify the user in TalkJS
locale
string | null
The locale field expects an IETF language tag. See the localization documentation.
name
string
The User's name which will be displayed on the TalkJS UI
photoUrl
string | null
An optional URL to a photo which will be displayed as the user's avatar
role
string | null
TalkJS supports multiple sets of settings, called "roles". These allow you to change the behavior of TalkJS for different users. You have full control over which user gets which configuration.
welcomeMessage
string | null
The default message a user sees when starting a chat with that person
configuration
string | null

Deprecated. Please use role instead.

others
Array<UserData>
The other participants in the conversation that are not the current user

Method Details

preventDefault

selectconversationevent.preventDefault()

Prevents the clicked conversation from being selected.

Parameters

None.

Returns

void

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

Properties

conversation
ConversationData
The current conversation object

interface ConversationData

custom
CustomData
Contains custom metadata for the conversation if it was set using ConversationBuilder.custom.
id
string
The ID of the conversation
photoUrl
string | null
Contains the URL of a photo was set using ConversationBuilder.subject.
subject
string | null
Contains the conversation subject if it was set using ConversationBuilder.subject.
welcomeMessages
Array<string> | null
One or more welcome messages that will display to the user as a SystemMessage
topicId
string | null

Deprecated. Please use ConversationBuilder.subject instead.

me
UserData
The current TalkJS user

interface UserData

availabilityText
string | null
Availability acts similarly to User.welcomeMessage but appears as a system message.
custom
CustomData
Allows you to set custom metadata for the User
id
string | number
The unqiue ID which is used to identify the user in TalkJS
locale
string | null
The locale field expects an IETF language tag. See the localization documentation.
name
string
The User's name which will be displayed on the TalkJS UI
photoUrl
string | null
An optional URL to a photo which will be displayed as the user's avatar
role
string | null
TalkJS supports multiple sets of settings, called "roles". These allow you to change the behavior of TalkJS for different users. You have full control over which user gets which configuration.
welcomeMessage
string | null
The default message a user sees when starting a chat with that person
configuration
string | null

Deprecated. Please use role instead.

message
SentMessage
The message that was sent

interface SentMessage

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: 
[51.481083, -3.178306]
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		Contains the message's text
type
"UserMessage" | "SystemMessage"
Identifies the message as either a User message or System message
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 TalkJS

Properties

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: 
[51.481083, -3.178306]
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		Contains the message's text
type
"UserMessage" | "SystemMessage"
Identifies the message as either a User message or System message

class TalkError

TalkJS Error class, inherits from the global Error class.

TalkJS methods may throw (or reject promises with) instances of this class if specific catchable information can be provided through the code property.

Properties

code
ErrorCode
Machine-readable error code
message
string
Human-readable error message

interface ThirdPartyOptions

Used to configure supported third-party integrations with TalkJS. See third party integrations

Properties

fullstory
FullStoryOptions

optional

interface FullStoryOptions

host
string

optional		Fullstory hostname
org
string
Fullstory organization ID

interface TranslationToggledEvent

This event is triggered when the user toggles real-time message translation using the built-in toggle.

Properties

conversation
ConversationData
Conversation for which translation has been toggled

interface ConversationData

custom
CustomData
Contains custom metadata for the conversation if it was set using ConversationBuilder.custom.
id
string
The ID of the conversation
photoUrl
string | null
Contains the URL of a photo was set using ConversationBuilder.subject.
subject
string | null
Contains the conversation subject if it was set using ConversationBuilder.subject.
welcomeMessages
Array<string> | null
One or more welcome messages that will display to the user as a SystemMessage
topicId
string | null

Deprecated. Please use ConversationBuilder.subject instead.

isEnabled
boolean
Boolean indicating if translation is enabled or not

interface UserData

Properties

availabilityText
string | null
Availability acts similarly to User.welcomeMessage but appears as a system message.
custom
CustomData
Allows you to set custom metadata for the User

interface CustomData

[key]
string

optional		Any number of key/value pairs of your choosing to be stored along with the associated resource. You can use custom data for all kinds of purposes, such as customizing a user's email notification text, transmitting contextual user data, or making email login tokens. Both the key and the value must be strings; arbitrarily deeply nested JSON is not supported. Example: 
{"country":"nl", "itemId": "720"}
id
string | number
The unqiue ID which is used to identify the user in TalkJS
locale
string | null
The locale field expects an IETF language tag. See the localization documentation.
name
string
The User's name which will be displayed on the TalkJS UI
photoUrl
string | null
An optional URL to a photo which will be displayed as the user's avatar
role
string | null
TalkJS supports multiple sets of settings, called "roles". These allow you to change the behavior of TalkJS for different users. You have full control over which user gets which configuration.
welcomeMessage
string | null
The default message a user sees when starting a chat with that person
configuration
string | null

Deprecated. Please use role instead.