Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

589 intent proposal view interactions #625

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/context/ref/Contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Intents
- [StartChat](../../intents/ref/StartChat)
- [StartCall](../../intents/ref/StartCall)
- [ViewProfile](../../intents/ref/ViewProfile)
- [ViewInteractions](../../intents/ref/ViewInteractions)

FINOS Financial Objects
- [Contact](https://fo.finos.org/docs/objects/contact)
5 changes: 3 additions & 2 deletions docs/context/ref/Instrument.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ In general, the more identifiers an application can provide, the easier it will
is for at least one instrument identifier to be provided.

- Try to only use instrument identifiers as intended. E.g. the `ticker` property is meant for stock tickers specifically,
if the identifier you want to share is not a stock ticker, or one of the other standardised ones, rather define
if the identifier you want to share is not a stock ticker, or one of the other standardised ones, rather define
a property that makes it clear what value it is. This makes it easier for target applications.

## Type
Expand Down Expand Up @@ -76,6 +76,7 @@ Intents
- [ViewInstrument](../../intents/ref/ViewInstrument)
- [ViewNews](../../intents/ref/ViewNews)
- [ViewQuote](../../intents/ref/ViewQuote)
- [ViewInteractions](../../intents/ref/ViewInteractions)

FINOS Financial Objects
- [Instrument](https://fo.finos.org/docs/objects/instrument)
- [Instrument](https://fo.finos.org/docs/objects/instrument)
1 change: 1 addition & 0 deletions docs/context/ref/Organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Intents
- [ViewNews](../../intents/ref/ViewNews)
- [ViewAnalysis](../../intents/ref/viewAnalysis)
- [ViewProfile](../../intents/ref/ViewProfile)
- [ViewInteractions](../../intents/ref/ViewInteractions)

FINOS Financial Objects
- [Organization](https://fo.finos.org/docs/objects/organization)
48 changes: 48 additions & 0 deletions docs/intents/ref/ViewInteractions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
id: ViewInteractions
sidebar_label: ViewInteractions
title: ViewInteractions
hide_title: true
---
# `ViewInteractions`

Display interactions (calls, meetings, etc.) related to an individual, an instrument or organization provided as context.

## Intent Name

`ViewInteractions`

## Display Name

`View Interactions`

## Possible Contexts

* [Contact](../../context/ref/Contact)
* [Instrument](../../context/ref/Instrument)
* [Organization](../../context/ref/Organization)

## Example

```js
const contact = {
type: 'fdc3.contact',
name: 'Jane Doe',
id: {
email: 'jane@mail.com'
}
}

fdc3.raiseIntent('ViewInteractions', contact)
```

## See Also

Context
* [Contact](../../context/ref/Contact)
* [Instrument](../../context/ref/Instrument)
* [Organization](../../context/ref/Organization)

Intents
* [ViewProfile](ViewProfile)
* [ViewResearch](ViewResearch)
1 change: 1 addition & 0 deletions docs/intents/ref/ViewProfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@ Context

Intents
* [ViewHoldings](ViewHoldings)
* [ViewInteractions](ViewInteractions)
3 changes: 3 additions & 0 deletions docs/intents/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ However, there is a need for applications to ensure that their intents avoid col
### [ViewProfile](ref/ViewProfile)
* Expected context: Contact, Organization
* Expected behavior: Display basic profile information for individual or organization
### [ViewInteractions](ref/ViewInteractions)
* Expected context: Contact, Instrument, Organization
* Expected behavior: Display interactions (calls, meetings, etc.) related to an individual, an instrument or organization

## Deprecated Intents ##

Expand Down
1 change: 1 addition & 0 deletions src/intents/Intents.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ export enum Intents {
ViewAnalysis = 'ViewAnalysis',
ViewHoldings = 'ViewHoldings',
ViewProfile = 'ViewProfile',
ViewInteractions = 'ViewInteractions',
}
4 changes: 4 additions & 0 deletions src/intents/standard intents.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@
{
"name": "ViewProfile",
"displayName": "Profile"
},
{
"name": "ViewInteractions",
"displayName": "Interactions"
}
]
}
3 changes: 2 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
"intents/ref/ViewAnalysis",
"intents/ref/ViewInstrument",
"intents/ref/ViewHoldings",
"intents/ref/ViewProfile"
"intents/ref/ViewProfile",
"intents/ref/ViewInteractions"
]
},
{
Expand Down