Skip to main content
Version: 2.1

ChatRoom

Reference to the chat room, which could be used later to send a message to the room.

Type

fdc3.chat.room

Schema

https://fdc3.finos.org/schemas/2.1/context/chatRoom.schema.json

Details

PropertyTypeRequiredExample Value
typestringYes'fdc3.chat.room'
providerNamestringYes'Symphony'
idobjectYes{ streamId: 'j75xqXy25NBOdacUI3FNBH', anyOtherKey: 'abcdef'}
urlstringNo'http://symphony.com/ref/room/j75xqXy25NBOdacUI3FNBH___pqSsuJRdA'
namestringNo'My new room'

The url is a universal url to access to the room. It could be opened from a browser, a mobile app, etc...

Example

const chatRoom = {
type: "fdc3.chat.room",
providerName: "Symphony",
id: {
streamId: "j75xqXy25NBOdacUI3FNBH"
}
url: "http://symphony.com/ref/room/j75xqXy25NBOdacUI3FNBH___pqSsuJRdA",
name: 'My new room'
};

//Chat rooms are returned by the StartChat intent as a result
const intentResolution = await fdc3.raiseIntent("StartChat", context);

try {
const chatRooms = await intentResolution.getResult():
} catch (error) {
//chat room were not created...
}

See Also

Other Types

Intents

FINOS Financial Objects