ConversationData

This object represents data associated with a conversation.

The subject, photoUrl, custom and welcomeMessages properties can be set through ConversationBuilder.setAttributes.

Example

1{
2 "id": "alice_self",
3 "custom": {},
4 "subject": null,
5 "welcomeMessages": null,
6 "photoUrl": null,
7 "participants": {
8 "650d5ed0cae49": {
9 "access": "ReadWrite"
10 }
11 }
12}

Properties

Properties

NameTypeDescription
idstringThe ID of the conversation
customCustomDataContains custom metadata for the conversation
subjectstring | nullContains the conversation subject
photoUrlstring | nullContains the URL of a photo
welcomeMessagesstring[] | nullOne or more welcome messages displayed to the user as SystemMessage
participantsRecord<string, { access: "Read" \| "ReadWrite" }>A map of the access rights for the participants in this conversation.

This property is not guaranteed to be complete.
It always includes the current user, but does not always list other participants.

Used by