Docs

Log in or Sign up to view personalized docs

ConversationBuilder

Thursday, May 6, 2021 2:03 AM

interface 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. Note: any changes you make here will not be sent to TalkJS immediately. Instead, instantiate a TalkJS UI using methods such as Session.createInbox.

Methods

sendMessage

Sends a text message in a given conversation.

setAttributes

Used to set certain attributes for a specific conversation

setParticipant

Sets a participant of the conversation.

Properties

custom
{     [name: string]: string | null } | null

optional

Allows custom conversation metadata to be stored in the form { [name: string]: string }

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 will be displayed in the chat header.

welcomeMessages
Array<string> | null

optional

Messages which are sent at the beginning of a chat. In this case the messages will appear as system messages.

Method Details

sendMessage

conversationBuilder.sendMessage(text, options): Promise<void>

Sends a text message in a given conversation.

Parameters

text
string

The message body that is to be sent.

options
SendMessageOptions

interface SendMessageOptions

custom
CustomData

optional

An object with any custom data that you may wish to associate with this message. The custom data is sent back to you via webhooks and the REST API.

Returns

Promise<void>

setAttributes

conversationBuilder.setAttributes(attributes)

Used to set certain attributes for a specific conversation

For example: 

conversation.setAttributes({subject: "Booking question"});
conversation.setAttributes({custom:
  {
    sold: "true",
    itemId: "720"
  }
});

Parameters

attributes
ConversationAttributes

interface ConversationAttributes

Conversation attributes that can be set using ConversationBuilder.setAttributes

custom
{     [key: string]: string | null } | null

optional

Custom metadata that is stored with the conversation

photoUrl
string | null

optional

The URL of a photo to be used for this conversation in the TalkJS UI in case there are more than 2 participants (TalkJS shows the photo of the other participant in a 1-on-1 conversation)

subject
string | null

optional

A human-readable subject of the conversation. Supports formatted links in a Markdown-style syntax, e.g. Beautiful <https://example.com/booking/18644|home by the sea>!. URLs and email addresses are made clickable, and emojis made to work cross-platform.

welcomeMessages
Array<string> | null

optional

Messages which are sent at the beginning of a chat. In this case the messages will appear as system messages.

Returns

void

setParticipant

conversationBuilder.setParticipant(user, settings)

Sets a participant of the conversation.

This method is idempotent and can be called multiple times.

Parameters

user
User

A User object that identifies the person who is a participant of the conversation. The user is uniquely identified by their id; all other fields (name, photo etc) are overwritten in the TalkJS database each time they change.

settings
Partial<ParticipationSettings>

optional

An optional setting of participation, can be an initial access right or if user should be notified.

interface ParticipationSettings

Specifies access and notification settings for a given user's participation to a given conversation. Used in ConversationBuilder.setParticipant.

access
"Read" | "ReadWrite"

optional

Specifies the participant's access permission for a conversation. See ConversationBuilder.setParticipant

notify
boolean

optional

Specifies the participants's notification settings. See ConversationBuilder.setParticipant

Returns

void