Add ChatRoom

finos · Aug 5, 2022 · df75169 · df75169
1 parent 29ce01a
commit df75169
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 3 deletions.
diff --git a/docs/context/ref/ChatInitSettings.md b/docs/context/ref/ChatInitSettings.md
@@ -66,19 +66,22 @@ const initSettings = {
 }
 
 const res = fdc3.raiseIntent('StartChat', initSettings);
-const roomRefs = await res.getResult();
+
+// Return a reference to the room
+const chatRoom = await res.getResult();
 ```
 
 ## See Also
 
 Other Types
 
+- [ChatRoom](ChatRoom)
 - [ContactList](ContactList)
 
 Intents
-
 - [StartChat](../../intents/ref/StartChat)
 - [StartCall](../../intents/ref/StartCall)
+- [SendChatMessage](../../intents/ref/StartChat)
 - [ViewContact](../../intents/ref/ViewContact)
 
 FINOS Financial Objects

diff --git a/docs/context/ref/ChatRoom.md b/docs/context/ref/ChatRoom.md
@@ -0,0 +1,66 @@
+---
+id: ChatRoom
+sidebar_label: ChatRoom
+title: Contact
+hide_title: true
+---
+# `ChatRoom`
+
+Reference to a chat room.
+
+## Type
+
+`fdc3.chat.room`
+
+## Schema
+
+https://fdc3.finos.org/schemas/next/chatRoom.schema.json
+
+## Details
+
+| Property | Type | Required | Example Value |
+|-------------|---------|----------|-------------------|
+| `type` | string | Yes | `'fdc3.chat.room'` |
+| `providerName` | string | Yes | `'Symphony'` |
+| `id` | object | Yes | `{ roomId: 'j75xqXy25NBOdacUI3FNBH', anyOtherKey: 'abcdef'}` |
+| `uri` | string | No | `'http://symphony.com/ref/room/j75xqXy25NBOdacUI3FNBH___pqSsuJRdA'` |
+| `name` | string | No | `'My new room'` |
+
+The `uri` is an universal url to access to the room. It could be opened from a browser, a mobile app, etc...
+
+## Example
+
+```js
+const intentResolution = await fdc3.raiseIntent("StartChat", context);
+
+const chatRoom = intentResolution.getResult():
+
+/* // The chatRoom will be like:
+ chatRoom = {
+ type: "fdc3.chat.room",
+ providerName: "Symphony",
+ id: {
+ roomId: "j75xqXy25NBOdacUI3FNBH"
+ }
+ uri: "http://symphony.com/ref/room/j75xqXy25NBOdacUI3FNBH___pqSsuJRdA",
+ name: 'My new room'
+ };
+*/
+```
+
+## See Also
+
+Other Types
+- [ContactList](ContactList)
+
+Intents
+- [StartChat](../../intents/ref/StartChat)
+- [StartCall](../../intents/ref/StartCall)
+- [SendChatMessage](../../intents/ref/SendChatMessage)
+- [ViewProfile](../../intents/ref/ViewProfile)
+- [ViewResearch](../../intents/ref/ViewResearch)
+- [ViewInteractions](../../intents/ref/ViewInteractions)
+- [ViewOrders](../../intents/ref/ViewOrders)
+
+FINOS Financial Objects
+- [Contact](https://fo.finos.org/docs/objects/contact)
diff --git a/docs/intents/ref/StartChat.md b/docs/intents/ref/StartChat.md
@@ -60,16 +60,20 @@ const initSettings = {
 }
 
 const resolution = fdc3.raiseIntent('StartChat', initSettings);
-const chatRoomRefs = await resolution.getResult();
+
+// Return a reference to the room
+const chatRoom = await resolution.getResult();
 ```
 
 ## See Also
 
 Context
+- [ChatRoom](../../context/ref/ChatRoom)
 - [Contact](../../context/ref/Contact)
 - [ContactList](../../context/ref/ContactList)
 - [ChatInitSettings](../../context/ref/ChatInitSettings)
 
 Intents
+* [SendChatMessage](SendChatMessage)
 * [StartCall](StartCall)
 * [StartEmail](StartEmail)
diff --git a/website/static/schemas/next/chatRoom.schema.json b/website/static/schemas/next/chatRoom.schema.json
@@ -0,0 +1,15 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "https://fdc3.finos.org/schemas/next/chatRoom.schema.json",
+ "type": "object",
+ "title": "ChatRoom",
+ "allOf": [{ "$ref": "context.schema.json#" }],
+ "properties": {
+ "type": { "const": "fdc3.chat.room" },
+ "providerName": { "type": "string" },
+ "id": { "type": "object" },
+ "uri": { "type": "string" },
+ "name": { "type": "string" }
+ },
+ "required": ["type", "providerName", "id"]
+}