765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent #794

symphony-jean-michael · 2022-08-05T09:31:24Z

This PR:

updates the 'StartChat' intent to return a reference to the new created Chat room (ChatRoom)
supports the possibility to send messages in existing chats (New intent 'SendChatMessage')

See initial discussion #765

linux-foundation-easycla · 2022-08-05T09:31:28Z

The committers listed above are authorized under a signed CLA.

✅ login: symphony-jean-michael / name: Jean-Michael Legait (df75169, 4501ef2, d30e3e9)

netlify · 2022-08-05T09:31:35Z

✅ Deploy Preview for lambent-kulfi-cf51a7 ready!

Name	Link
🔨 Latest commit	`6a62c40`
🔍 Latest deploy log	https://app.netlify.com/sites/lambent-kulfi-cf51a7/deploys/636cfc4f7ce5550008a05541
😎 Deploy Preview	https://deploy-preview-794--lambent-kulfi-cf51a7.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

website/static/schemas/next/chatMessage.schema.json

docs/context/ref/ChatMessage.md

fix typo for roomId.

mistryvinay

LGTM, need another maintainer to also confirm.

kriswest

Added some suggestions to clarify a few things. Overall looks pretty good

kriswest · 2022-09-01T12:47:26Z

docs/context/ref/ChatRoom.md

+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'
+ };
+*/


I'd flip the order of the code and context example (to match convention on other pages). See https://fdc3.finos.org/docs/context/ref/Chart for an example

Suggested change

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'

};

*/

const chatRoom = {

type: "fdc3.chat.room",

providerName: "Symphony",

id: {

roomId: "j75xqXy25NBOdacUI3FNBH"

}

uri: "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 chatRoom = await intentResolution.getResult():

} catch (error) {

//chat room was not created...

}

docs/context/ref/ChatRoom.md

kriswest · 2022-09-01T12:50:43Z

docs/context/ref/ChatRoom.md

+---
+# `ChatRoom`
+
+Reference to a chat room.


Add detail on why we need one (to send further messages to the room? to log in a CRM maybe?)

Additional text added.

kriswest · 2022-09-01T12:54:38Z

docs/context/ref/ChatRoom.md

+| `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...


Suggested change

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

The `uri` field should be populated with a URL to access the room, which may be used outside of the context of a Desktop Agent (for example in a browser, mobile application etc.).

Minor comment: is it expected to be a URL or URI? All URLs are URIs but not all URIs are URLs (although I don't know many people that are clear on the distinction). If its always expected to be retreivable in a browser (taking you to a web page where you can access teh item) rather than just acting as an identity, then its a URL (and should be named as such).

Are we okay with the updated text @kriswest ?

docs/intents/ref/SendChatMessage.md

docs/context/ref/ChatMessage.md

…essage

symphony-jean-michael · 2022-09-02T07:05:04Z

@kriswest I updated the PR taking into account your remarks. Could you have a second look? Thanks

mistryvinay

Have left some comments on some minor changes that may still be outstanding.

mistryvinay · 2022-10-04T11:59:46Z

Are we still pending an updated description of use-cases for starting a chat?

765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent #794
- Deal with review comments and suggestions.
- Consider expanding the description of StartChat to include more details on use-cases for starting a chat from a different application (e.g. a research app or OMS)

symphony-jean-michael · 2022-10-04T13:05:02Z

Hi @mistryvinay

"Deal with review comments and suggestions."
It seems to me that I've taken into account all the comments and updated the PR accordingly. Could you tell me which comment you're referring to?
"Consider expanding the description of StartChat to include more details on use-cases for starting a chat from a different application (e.g. a research app or OMS)"
Sorry, but I don't really know what to add. You want me to add a message in StartChat explaining why a user would want to start a chat from another application, right? Do you have an idea of a description to add? It would be very helpful for me. 😅

mistryvinay · 2022-10-06T11:55:40Z

Hi @mistryvinay

"Deal with review comments and suggestions."
It seems to me that I've taken into account all the comments and updated the PR accordingly. Could you tell me which comment you're referring to?

"Consider expanding the description of StartChat to include more details on use-cases for starting a chat from a different application (e.g. a research app or OMS)"
Sorry, but I don't really know what to add. You want me to add a message in StartChat explaining why a user would want to start a chat from another application, right? Do you have an idea of a description to add? It would be very helpful for me. 😅

Currently we have:

# `StartChat`

Initiate a chat with a contact, a list of contacts or detailed initialization settings.

Maybe something along the lines of:

# `StartChat`

Initiate a chat with a contact, a list of contacts or detailed initialization settings.  This could be launched from within another application. For example initiating a chat from a research or OMS application.

symphony-jean-michael · 2022-10-28T14:43:17Z

Hi @mistryvinay
Thank you for your feedback. I updated the PR accordingly.

mistryvinay

LGTM.

mistryvinay · 2022-10-04T11:27:59Z

docs/context/ref/ChatRoom.md

+---
+# `ChatRoom`
+
+Reference to a chat room.


Additional text added.

docs/context/ref/ChatRoom.md

mistryvinay · 2022-10-04T11:29:48Z

src/context/schemas/chatRoom.schema.json

+ "type": { "const": "fdc3.chat.room" },
+ "providerName": { "type": "string" },
+ "id": { "type": "object" },
+ "uri": { "type": "string" },


Does this need to be updated to url now?

mistryvinay · 2022-10-04T11:30:34Z

website/static/schemas/next/chatRoom.schema.json

+ "type": { "const": "fdc3.chat.room" },
+ "providerName": { "type": "string" },
+ "id": { "type": "object" },
+ "uri": { "type": "string" },


Same for this row, should this be updated to url?

kriswest · 2022-11-03T12:35:51Z

Add a CHANGELOG.md entry in the unreleased section please

…hema

symphony-jean-michael · 2022-11-10T13:29:59Z

Hi @kriswest @mistryvinay
I've updated the PR accordingly to your remarks. Can you have a second look, please?
Thanks

symphony-jean-michael · 2022-12-08T13:20:05Z

FYI, this PR is included in new one #882

symphony-jean-michael added 3 commits August 5, 2022 11:08

Add ChatRoom

df75169

Add SendChatMessage Intent

4501ef2

Add ChatMessage context

d30e3e9

symphony-jean-michael changed the title ~~WIP: Feature/SendChatMessage~~ WIP: 'ChatRoom' and 'SendChatMessage' Aug 5, 2022

symphony-jean-michael commented Aug 5, 2022

View reviewed changes

website/static/schemas/next/chatMessage.schema.json Show resolved Hide resolved

symphony-jean-michael commented Aug 5, 2022

View reviewed changes

docs/context/ref/ChatMessage.md Show resolved Hide resolved

symphony-jean-michael changed the title ~~WIP: 'ChatRoom' and 'SendChatMessage'~~ 'ChatRoom' and 'SendChatMessage' Aug 5, 2022

symphony-jean-michael marked this pull request as ready for review August 5, 2022 09:54

Add ChatRoom and ChatMessage to the documentation

44c2d61

symphony-jean-michael mentioned this pull request Aug 8, 2022

767 Add ViewChat Intent #796

Closed

symphony-jean-michael added 2 commits August 8, 2022 15:36

Add ChatRoom and SendChatMessage in Typescript

bc31906

Link ChatRoom and ChatMessage schemas in main schema

3afbfec

mistryvinay added enhancement New feature or request intents Context Data & Intents Contexts & Intents Discussion Group labels Aug 17, 2022

mistryvinay added this to the 2.1-candidates milestone Aug 24, 2022

mistryvinay linked an issue Aug 24, 2022 that may be closed by this pull request

'ChatRoom' and 'SendChatMessage' #765

Closed

mistryvinay changed the title ~~'ChatRoom' and 'SendChatMessage'~~ 765 'ChatRoom' and 'SendChatMessage' Aug 24, 2022

mistryvinay requested review from kriswest, hughtroeger and a team August 24, 2022 09:48

Update ChatMessage.md

f2c89da

fix typo for roomId.

mistryvinay approved these changes Aug 24, 2022

View reviewed changes

mistryvinay requested a review from a team August 24, 2022 10:04

mistryvinay mentioned this pull request Aug 30, 2022

Context Data & Intents Discussion group - 1 Sep 2022 #809

Closed

15 tasks

hughtroeger approved these changes Aug 31, 2022

View reviewed changes

kriswest changed the title ~~765 'ChatRoom' and 'SendChatMessage'~~ 765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent Sep 1, 2022

kriswest requested changes Sep 1, 2022

View reviewed changes

symphony-jean-michael added 6 commits September 1, 2022 17:48

Flip the order of the example

1d7f05b

Update links

81dfc54

Replace URI with URL

24ecdfe

Update description

91f9a67

Merge remote-tracking branch 'upstream/master' into feature/SendChatM…

ca41bfe

…essage

Update description

82229d9

symphony-jean-michael requested a review from kriswest September 23, 2022 08:13

mistryvinay approved these changes Oct 4, 2022

View reviewed changes

mistryvinay mentioned this pull request Oct 4, 2022

Context Data & Intents Discussion group - 6 Oct 2022 #826

Closed

14 tasks

Update StartChat description

58ab363

mistryvinay reviewed Oct 31, 2022

View reviewed changes

symphony-jean-michael added 2 commits November 10, 2022 14:20

Remove unnecessary 'type' because it's already required by context sc…

bfc8c03

…hema

Add SendChatMessage, ChatRoom and ChatMessage in the Changelog

6a62c40

mistryvinay mentioned this pull request Nov 16, 2022

Context Data & Intents Discussion group - 3 Nov 2022 #845

Closed

12 tasks

symphony-jean-michael mentioned this pull request Dec 8, 2022

Symphony PRs in FDC3 2.1 candidates #882

Merged

symphony-jean-michael closed this Dec 12, 2022

kriswest modified the milestones: 2.1-candidates, 2.1 Apr 27, 2023

kriswest removed this from the 2.1 milestone Jul 25, 2023

bingenito mentioned this pull request Nov 6, 2023

Update to FDC3 2.1 finos/fdc3-dotnet#74

Open

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent #794

765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent #794

symphony-jean-michael commented Aug 5, 2022 •

edited

Loading

linux-foundation-easycla bot commented Aug 5, 2022 •

edited

Loading

netlify bot commented Aug 5, 2022 •

edited

Loading

mistryvinay left a comment

kriswest left a comment

kriswest Sep 1, 2022

kriswest Sep 1, 2022

mistryvinay Oct 4, 2022

kriswest Sep 1, 2022

mistryvinay Oct 4, 2022

symphony-jean-michael commented Sep 2, 2022

mistryvinay left a comment •

edited

Loading

mistryvinay commented Oct 4, 2022

symphony-jean-michael commented Oct 4, 2022

mistryvinay commented Oct 6, 2022

symphony-jean-michael commented Oct 28, 2022

mistryvinay left a comment

mistryvinay Oct 4, 2022

mistryvinay Oct 4, 2022

mistryvinay Oct 4, 2022

kriswest commented Nov 3, 2022

symphony-jean-michael commented Nov 10, 2022

symphony-jean-michael commented Dec 8, 2022

	The `uri` is an universal url to access to the room. It could be opened from a browser, a mobile app, etc...
	The `uri` field should be populated with a URL to access the room, which may be used outside of the context of a Desktop Agent (for example in a browser, mobile application etc.).

765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent #794

765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent #794

Conversation

symphony-jean-michael commented Aug 5, 2022 • edited Loading

linux-foundation-easycla bot commented Aug 5, 2022 • edited Loading

netlify bot commented Aug 5, 2022 • edited Loading

✅ Deploy Preview for lambent-kulfi-cf51a7 ready!

mistryvinay left a comment

Choose a reason for hiding this comment

kriswest left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

symphony-jean-michael commented Sep 2, 2022

mistryvinay left a comment • edited Loading

Choose a reason for hiding this comment

mistryvinay commented Oct 4, 2022

symphony-jean-michael commented Oct 4, 2022

mistryvinay commented Oct 6, 2022

symphony-jean-michael commented Oct 28, 2022

mistryvinay left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kriswest commented Nov 3, 2022

symphony-jean-michael commented Nov 10, 2022

symphony-jean-michael commented Dec 8, 2022

symphony-jean-michael commented Aug 5, 2022 •

edited

Loading

linux-foundation-easycla bot commented Aug 5, 2022 •

edited

Loading

netlify bot commented Aug 5, 2022 •

edited

Loading

mistryvinay left a comment •

edited

Loading