ChatInitSettings

A collection of settings to start a new chat conversation

Schema

https://fdc3.finos.org/schemas/next/context/chatInitSettings.schema.json (github)

Type

fdc3.chat.initSettings

Properties

chatName

type: string

Name to apply to the chat created

members

type: ContactList

Contacts to add to the chat

message

One of:

type: string

type: Message

An initial message to post in the chat when created.

options

type: object

Subproperties:

groupRecipients

type: boolean

if false a separate chat will be created for each member

isPublic

type: boolean

if true the room will be visible to everyone in the chat application

allowHistoryBrowsing

type: boolean

if true members will be allowed to browse past messages

allowMessageCopy

type: boolean

if true members will be allowed to copy/paste messages

allowAddUser

type: boolean

if true members will be allowed to add other members to the chat

Option settings that affect the creation of the chat

Example

{
  "type": "fdc3.chat.initSettings",
  "chatName": "Chat ABCD",
  "members": {
    "type": "fdc3.contactList",
    "contacts": [
      {
        "type": "fdc3.contact",
        "name": "Jane Doe",
        "id": {
          "email": "jane@mail.com"
        }
      },
      {
        "type": "fdc3.contact",
        "name": "John Doe",
        "id": {
          "email": "john@mail.com"
        }
      }
    ]
  },
  "options": {
    "groupRecipients": true,
    "isPublic": false,
    "allowHistoryBrowsing": true,
    "allowMessageCopy": true
  },
  "message": {
    "type": "fdc3.message",
    "text": {
      "text/plain": "Hey all, can we discuss the issue together? I attached a screenshot"
    },
    "entities": {
      "0": {
        "type": "fdc3.fileAttachment",
        "data": {
          "name": "myImage.png",
          "dataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII"
        }
      }
    }
  }
}