574 StartChat: ChatInitSettings and ChatRoomRef #620

bertrand-s · 2022-03-08T14:15:42Z

I made several simplifications to the initial issue (574)

ChatInit was renamed ChatInitSettings
ChatInitSettings options are not chat-provider specific anymore
ChatInitSettings options support a new option (groupRecipients) that allows to create one room per recipients or one room with all members - this is why the proposal is to have StartChat return a list of ChatRoomRef
ChatRoomRef app is now an AppMetadata
ChatRoomRef id is a simple string

linux-foundation-easycla · 2022-03-08T14:15:46Z

The committers listed above are authorized under a signed CLA.

✅ login: bertrand-s / name: Bertrand Laporte (fec33de, 395b610)

ggeorgievx · 2022-03-16T13:11:58Z

docs/context/ref/ChatInitSettings.md

+| ------------------------------ | --------- | -------- | -------------------------------------------------------------------- |
+| `type`                         | string    | Yes      | `'fdc3.chat.initSettings'`                                           |
+| `chatName`                     | string    | No       | `'Instrumet XYZ'`                                                    |
+| `members`                      | Contact[] | No       | `[contact1, contact2]`                                               |


Maybe we could use ContactList instead of Contact[].

Yes - I though of this option, but I realised that ContactList adds extra verbosity (type, sub-structure, etc.) this is why I preferred the Contact[] option

@bertrand-s we're due to have a conversation at some point about the list types and whether there should be an easier / generic way to create them so they don't have to be explicit type (has been raised in meetings a few times). I'd prefer [] to List to be added to the base type name (but that's another conversation).

The APIs need a context type currently and can't take an array of them. Although this is embedded inside another type, I think it might be confusing / awkward in some situations for us to have a mixed convention on this (e.g. if the members were pulled out to send on to a CRM in another intent and then had to be converted into a ContactList).

OK - I will update the PR with Contact and ContactList then

docs/context/ref/ChatInitSettings.md

docs/intents/ref/StartChat.md

Co-authored-by: Hugh Troeger <troeger.hugh@gmail.com>

bertrand-s · 2022-04-01T15:54:14Z

As discussed with @rikoe during last meeting, I removed all references to ChatRoomRef, which could be re-introduced when Intent return values are supported

mistryvinay

Looks good to me.

mistryvinay · 2022-05-10T10:26:30Z

@finos/fdc3-maintainers any blockers for not approving?

kriswest

LGTM

kriswest · 2022-05-10T20:11:20Z

docs/context/ref/ChatInitSettings.md

+| Property                       | Type        | Required | Example Value                                                        |
+| ------------------------------ | ----------- | -------- | -------------------------------------------------------------------- |
+| `type`                         | string      | Yes      | `'fdc3.chat.initSettings'`                                           |
+| `chatName`                     | string      | No       | `'Instrumet XYZ'`                                                    |


kriswest · 2022-05-10T20:14:49Z

docs/context/spec.md

@@ -80,6 +80,13 @@ The identifier "foo" is proprietary, an application that can use it is free to d
 The following are standard FDC3 context types.
 __Note:__ The specification for these types are shared with the [FINOS Financial Objects](https://fo.finos.org) definitions, JSON schemas are hosted with FDC3.


Note for @greyseer256: this sentence is no longer correct once we merge in new types - and that group has changed focus/no longer maintains those definitions. Hence, its probably time to drop this

kriswest · 2022-05-10T20:25:16Z

Needs a CHANGELOG.md entry adding!

robmoffat · 2022-05-19T12:23:20Z

docs/context/ref/ChatInitSettings.md

@@ -0,0 +1,86 @@
+---
+id: ChatInitSettings


Suggest calling this ChatSettings? It seems like these settings would be relevant even after the chat had been created, and could be the basis for further, ongoing intents. e.g. EmailTranscript, CreateAppointment, RecordInCRM, etc. which could be handled by context listeners.

kriswest · 2022-05-19T12:35:41Z

As discussed in the meetings, it is expected that a ChatRoomRef type will be added later and returned by intents that create a chat and it's that type that would be used for those purposes @robmoffat. I think there's more on this in meeting minutes.

…

On Thu, 19 May 2022, 13:23 Rob Moffat, ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In docs/context/ref/ChatInitSettings.md <#620 (comment)>: > @@ -0,0 +1,86 @@ +--- +id: ChatInitSettings Suggest calling this ChatSettings? It seems like these settings would be relevant even after the chat had been created, and could be the basis for further, ongoing intents. e.g. EmailTranscript, CreateAppointment, RecordInCRM, etc. which could be handled by context listeners. — Reply to this email directly, view it on GitHub <#620 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAM7PBB3M4DSGXIU7A44CNLVKYXEPANCNFSM5QGPDALA> . You are receiving this because your review was requested.Message ID: ***@***.***>

robmoffat · 2022-05-19T16:25:06Z

Yes, that's very symphony-specific: there, rooms have names, chats are between ad-hoc groups of people.

I mean, there's an argument that there should be a single context object covering both but I expect somewhere you've already had that discussion before...

But, based on the idea that this should be context data, I still think we should follow the naming scheme we already have for other bits of context: Instrument, Organisation, Contact.

bertrand-s added 2 commits March 8, 2022 13:17

574 StartChat: ChatInitSettings and ChatRoomRef

fec33de

574 StartChat: ChatInitSettings and ChatRoomRef

395b610

kriswest added enhancement New feature or request context-data FDC3 Context Data Working Group intents Context Data & Intents Contexts & Intents Discussion Group labels Mar 16, 2022

kriswest requested review from kriswest, rikoe, donbasuno, ggeorgievx, hughtroeger, mattjamieson, mistryvinay and a team March 16, 2022 13:02

kriswest linked an issue Mar 16, 2022 that may be closed by this pull request

StartChat and SendChatMessage #574

Closed

ggeorgievx approved these changes Mar 16, 2022

View reviewed changes

574: change ChatInitSettings member type to ContactList

e8ba0f8

rikoe mentioned this pull request Mar 30, 2022

Context Data & Intents Discussion group - 31 March 2022 #643

Closed

15 tasks

hughtroeger approved these changes Mar 30, 2022

View reviewed changes

docs/context/ref/ChatInitSettings.md Outdated Show resolved Hide resolved

docs/context/ref/ChatInitSettings.md Outdated Show resolved Hide resolved

docs/intents/ref/StartChat.md Outdated Show resolved Hide resolved

bertrand-s and others added 4 commits March 31, 2022 15:05

Update docs/context/ref/ChatInitSettings.md

04d31a3

Co-authored-by: Hugh Troeger <troeger.hugh@gmail.com>

Update docs/context/ref/ChatInitSettings.md

8c850fd

Co-authored-by: Hugh Troeger <troeger.hugh@gmail.com>

Update docs/intents/ref/StartChat.md

4ca0635

Co-authored-by: Hugh Troeger <troeger.hugh@gmail.com>

Remove ChatRoomRef references

d4fe059

rikoe mentioned this pull request Apr 28, 2022

Context Data & Intents Discussion group - 28 April 2022 #680

Closed

24 tasks

mistryvinay approved these changes May 10, 2022

View reviewed changes

mistryvinay mentioned this pull request May 10, 2022

Context Data & Intents Discussion group - 12 May 2022 #703

Closed

29 tasks

kriswest approved these changes May 10, 2022

View reviewed changes

kriswest added this to the 2.0-candidates milestone May 17, 2022

mistryvinay changed the base branch from master to context-data-and-intents-consolidated-update-branch May 19, 2022 10:37

mistryvinay merged commit fef5c5e into finos:context-data-and-intents-consolidated-update-branch May 19, 2022

robmoffat reviewed May 19, 2022

View reviewed changes

symphony-jean-michael mentioned this pull request Jun 27, 2022

'ChatRoom' and 'SendChatMessage' #765

Closed

Yannick-Malins mentioned this pull request Jun 27, 2022

Chat Message Container #766

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

574 StartChat: ChatInitSettings and ChatRoomRef #620

574 StartChat: ChatInitSettings and ChatRoomRef #620

bertrand-s commented Mar 8, 2022

linux-foundation-easycla bot commented Mar 8, 2022 •

edited

Loading

ggeorgievx Mar 16, 2022

bertrand-s Mar 17, 2022

kriswest Mar 17, 2022

bertrand-s Mar 22, 2022

bertrand-s commented Apr 1, 2022

mistryvinay left a comment

mistryvinay commented May 10, 2022

kriswest left a comment

kriswest May 10, 2022

kriswest May 10, 2022

kriswest commented May 10, 2022 •

edited

Loading

robmoffat May 19, 2022

kriswest commented May 19, 2022 via email

robmoffat commented May 19, 2022 •

edited

Loading

	\| `chatName` \| string \| No \| `'Instrumet XYZ'` \|
	\| `chatName` \| string \| No \| `'Instrument XYZ'` \|

		@@ -80,6 +80,13 @@ The identifier "foo" is proprietary, an application that can use it is free to d
		The following are standard FDC3 context types.
		__Note:__ The specification for these types are shared with the [FINOS Financial Objects](https://fo.finos.org) definitions, JSON schemas are hosted with FDC3.

574 StartChat: ChatInitSettings and ChatRoomRef #620

574 StartChat: ChatInitSettings and ChatRoomRef #620

Conversation

bertrand-s commented Mar 8, 2022

linux-foundation-easycla bot commented Mar 8, 2022 • edited Loading

ggeorgievx Mar 16, 2022

Choose a reason for hiding this comment

bertrand-s Mar 17, 2022

Choose a reason for hiding this comment

kriswest Mar 17, 2022

Choose a reason for hiding this comment

bertrand-s Mar 22, 2022

Choose a reason for hiding this comment

bertrand-s commented Apr 1, 2022

mistryvinay left a comment

Choose a reason for hiding this comment

mistryvinay commented May 10, 2022

kriswest left a comment

Choose a reason for hiding this comment

kriswest May 10, 2022

Choose a reason for hiding this comment

kriswest May 10, 2022

Choose a reason for hiding this comment

kriswest commented May 10, 2022 • edited Loading

robmoffat May 19, 2022

Choose a reason for hiding this comment

kriswest commented May 19, 2022 via email

robmoffat commented May 19, 2022 • edited Loading

linux-foundation-easycla bot commented Mar 8, 2022 •

edited

Loading

kriswest commented May 10, 2022 •

edited

Loading

robmoffat commented May 19, 2022 •

edited

Loading