Other interfaces

Optional custom conversation meta data

The ID of the conversation

An optional URL to a photo which will be shown as the photo for the conversation.

An optional conversation subject which is displayed in the chat header

Legacy - please use subject instead.

Only select conversations that the current user as specific access to.

Must be an 2-element array of [operator, operand] structure. Valid operators are: "==", "!=", "oneOf", and "!oneOf".

The operand must be either a string (one of "ReadWrite", "Read" or "None") or an array of strings (for the oneOf operators).

Example:

Copy
// to remove conversations that the user has no access to anymore, do:
{ access: ["!=", "None"] }

Only select conversations that have particular custom fields set to particular values.

Copy
// only show conversations that have no category set:
{ custom: { category: "!exists" } }

// only show conversations of category "shoes"
{ custom: { category: ["==", "shoes"] } }

// only show conversations either category "shoes" or "sandals"
{ custom: { category: ["oneOf", ["shoes", "sandals"] ] } }

// only show conversations about shoes that are marked visible.
// this assumes you also have a custom field called `visibility`
{ custom: { category: ["==", "shoes"], visibility: ["==", "visible" ] } }

Set this field to only select conversations that have, or don't have any, unread messages.

Only select conversations that have the last message sent in a particular time interval.

Must be an 2-element array of [operator, operand] structure. Valid operators are: ">", "<", ">=", "<=", "between", and "!between".

The operand must be either a number or a 2-element array of numbers (for the between operators).

Example:

Copy
// to show only the conversations that have the last message sent after the UNIX timestamp 1679298371586
{ lastMessageTs: [">", 1679298371586] }

Only select conversations that have the subject set to particular values.

Must be an 2-element array of [operator, operand] structure. Valid operators are: "==", "!=", "oneOf", and "!oneOf".

The operand must be either a string or an array of strings (for the oneOf operators).

Example:

Copy
// to show only the conversations that have "Black leather boots" or "Hair Wax 5 Gallons" as the subject
{ subject: ["oneOf", ["Black leather boots", "Hair Wax 5 Gallons"]] }

The current conversation object

The current TalkJS User

The other participants in the conversation that are not the current user

Fullstory hostname

Fullstory organization ID

True if the event was triggered while an element was focused that can handle keyboard events.

The conversation that the user intends to leave

Determines whether the message field should automatically focus when the user navigates.

Defaults to "smart", which means that the message field gets focused whenever a conversation is selected, if possible without negative side effects. I.e. only when:

- The message field is inside the browser viewport (so focusing will not unexpectedly cause the page to scroll)

- The user is likely on a desktop/laptop computer (so focusing will not unexpectedly expand a mobile on-screen keyboard).

Note: If you need more control, consider setting autofocus to false and calling MessageField​.focus at appropriate times.

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.

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

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.

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:

Copy
// 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.

Only select messages that have particular custom fields set to particular values.

Copy
// Only show messages that have no category set:
{ custom: { category: "!exists" } }

// Only show messages of that have the category "shoes"
{ custom: { category: ["==", "shoes"] } }

// Only show messages that have the 'topic' either "inquiry" or "reservation"
{ custom: { topic: ["oneOf", ["inquiry", "reservation"] ] } }

// Only show messages about shoes that are marked visible.
// this assumes you also have a custom field called `visibility`
{ custom: { category: ["==", "shoes"], visibility: ["==", "visible" ] } }

Only show messages that were sent by users (web), through the REST API (rest), via reply-to-email (email) or via the import REST API (import).

For example:

Copy
// Don't show messages that were sent via the REST API
{ origin: ["!=", "rest"] }

Only show messages that are sent by a sender that has all of the given properties

For example:

Copy
// Only show messages sent by users with the role of 'admin' and if the user ID is 1.
{sender: {role: ["==", "admin"], id: ["==", "1"]}}

Only show messages of a given type, for example:

Copy
{type: ["==", "SystemMessage"]}

The current conversation object

The current TalkJS User

The other participants in the conversation that are not the current user

Only show messages from senders who have particular custom fields set to particular values.

Copy
// Only show messages from senders that have the field alternateRole set:
{custom: {alternateRole: "!exists" }}

// Only show messages from senders that have the field alternateRole set to "support":
{custom: {alternateRole: ["==", "support"]}}

Only show messages from a sender(s) with a given id.

For example:

Copy
// Don't show messages sent by user with ID 1
{sender: {id: ["!=", "1"]}}

Only show messages from senders with a given locale.

For example:

Copy
// Only show messages from senders with locale: en-GB or en-US
{sender: {locale: ["oneOf", ["en-GB", "en-US"]}}

Only show messages from senders who have a particular role.

For example:

Copy
// Only show messages from senders with role: Admin and locale: en-GB
{sender: {role: ["==", "Admin"], locale: ["==", "en-GB"]}}

The current conversation object

The current TalkJS user

The message that was sent

This function allows you to modify the contents of the message or its metadata before the message is sent

Only given if the message contains a file. An object with the URL and filesize (in bytes) of the given file.

The ID of the conversation that the message belongs to

The message ID of the message that was sent

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:

Copy
[51.481083, -3.178306]

Contains an Array of User​.id's that have read the message

Contains the user ID for the person that sent the message

Contains the message's text

Identifies the message as either a User message or System message

Conversation for which translation has been toggled

Boolean indicating if translation is enabled or not

Availability acts similarly to User​.welcomeMessage but appears as a system message.

Allows you to set custom metadata for the User

The unqiue ID which is used to identify the user in TalkJS

The locale field expects an IETF language tag. See the localization documentation.

The User's name which will be displayed on the TalkJS UI

An optional URL to a photo which will be displayed as the user's avatar

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.

The default message a user sees when starting a chat with that person

Machine-readable error code

Human-readable error message