From 10f1e44a65b2cf343bd615918dd5fb46c0fe1cbc Mon Sep 17 00:00:00 2001 From: Milind Chidrawar Date: Tue, 7 Jun 2022 15:15:47 +0100 Subject: [PATCH] add-create-interaction-intent --- docs/context/ref/Contact.md | 1 + docs/context/ref/ContactList.md | 1 + docs/context/ref/TimeRange.md | 3 ++ docs/intents/ref/CreateInteraction.md | 71 +++++++++++++++++++++++++++ docs/intents/spec.md | 1 + 5 files changed, 77 insertions(+) create mode 100644 docs/intents/ref/CreateInteraction.md diff --git a/docs/context/ref/Contact.md b/docs/context/ref/Contact.md index ff25878d8..ef01d47bc 100644 --- a/docs/context/ref/Contact.md +++ b/docs/context/ref/Contact.md @@ -52,6 +52,7 @@ Intents - [ViewResearch](../../intents/ref/ViewResearch) - [ViewInteractions](../../intents/ref/ViewInteractions) - [ViewOrders](../../intents/ref/ViewOrders) +- [CreateInteraction](../../intents/ref/CreateInteraction) FINOS Financial Objects - [Contact](https://fo.finos.org/docs/objects/contact) diff --git a/docs/context/ref/ContactList.md b/docs/context/ref/ContactList.md index d0082c659..3e0d65cfe 100644 --- a/docs/context/ref/ContactList.md +++ b/docs/context/ref/ContactList.md @@ -64,6 +64,7 @@ Other Types Intents - [StartChat](../../intents/ref/StartChat) - [StartCall](../../intents/ref/StartCall) +- [CreateInteraction](../../intents/ref/CreateInteraction) FINOS Financial Objects - [ContactList](https://fo.finos.org/docs/objects/contactlist) \ No newline at end of file diff --git a/docs/context/ref/TimeRange.md b/docs/context/ref/TimeRange.md index acbb6b757..15f5fa7bb 100644 --- a/docs/context/ref/TimeRange.md +++ b/docs/context/ref/TimeRange.md @@ -80,3 +80,6 @@ const timeRange = { Other Types - [Chart](Chart) + +Intents +- [CreateInteraction](../../intents/ref/CreateInteraction) \ No newline at end of file diff --git a/docs/intents/ref/CreateInteraction.md b/docs/intents/ref/CreateInteraction.md new file mode 100644 index 000000000..349334f6b --- /dev/null +++ b/docs/intents/ref/CreateInteraction.md @@ -0,0 +1,71 @@ +--- +id: CreateInteraction +sidebar_label: CreateInteraction +title: CreateInteraction +hide_title: true +--- +# `CreateInteraction` + +Create an interaction with a list of contacts. + +## Intent Name + +`CreateInteraction` + +## Display Name + +`Create Interaction` + +## Possible Contexts + +* [ContactList](../../context/ref/ContactList) + +## Example + +```js +const interaction = { + type: 'fdc3.interaction', + contacts: { + type: 'fdc3.contactList', + contacts: [ + { + type: 'fdc3.contact', + name: 'Jane Doe', + id: { + email: 'jane.doe@mail.com' + } + }, + { + type: 'fdc3.contact', + name: 'John Doe', + id: { + email: 'john.doe@mail.com' + } + }, + ] + }, + interactionType: 'Instant Message', + timeRange: { + type: 'fdc3.timeRange', + startTime: '2022-02-10T15:12:00Z' + }, + description: 'Laboris libero dapibus fames elit adipisicing eu, fermentum, dignissimos laboriosam, erat, risus qui deserunt. Praesentium! Reiciendis. Hic harum nostrud, harum potenti amet? Mauris. Pretium aliquid animi, eget eiusmod integer proident. Architecto ipsum blandit ducimus, possimus illum sunt illum necessitatibus ab litora sed, nonummy integer minus corrupti ducimus iste senectus accumsan, fugiat nostrud? Pede vero dictumst excepturi, iure earum consequuntur voluptatum', + initiator: { + type: 'fdc3.contact', + name: 'Jane Doe', + id: { + email: 'jane.doe@mail.com' + } + }, + source: 'Outlook' +} + +fdc3.raiseIntent('CreateInteraction', interaction) +``` + +## See Also + +Context +- [Contact](../../context/ref/Contact) +- [ContactList](../../context/ref/ContactList) +- [TimeRange](../../context/ref/TimeRange) diff --git a/docs/intents/spec.md b/docs/intents/spec.md index 5b2528b2e..9e4246ff3 100644 --- a/docs/intents/spec.md +++ b/docs/intents/spec.md @@ -141,6 +141,7 @@ A list of standardized intents are defined in the following pages: * [`ViewProfile`](ref/ViewProfile) * [`ViewQuote`](ref/ViewQuote) * [`ViewResearch`](ref/ViewResearch) +* [`CreateInteraction`](ref/CreateInteraction) ### Deprecated Intents