From 2706cd1e9ca31fb9ed54fb0d8c7c789ca43732e6 Mon Sep 17 00:00:00 2001 From: Sean Harvey Date: Wed, 21 Oct 2020 17:02:55 -0400 Subject: [PATCH 1/3] Adds appId and version to type definition --- src/api/AppMetadata.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/api/AppMetadata.ts b/src/api/AppMetadata.ts index 269ee984c..14035ef05 100644 --- a/src/api/AppMetadata.ts +++ b/src/api/AppMetadata.ts @@ -10,6 +10,12 @@ export interface AppMetadata { /** The unique app name that can be used with the open and raiseIntent calls. */ readonly name: string; + /** The unique application identifier located within a specific application directory instance. */ + readonly appId?: string; + + /** The Version of the application. */ + readonly version?: string; + /** A more user-friendly application title that can be used to render UI elements */ readonly title?: string; From 5abd1d6ae1259c6babb332e835d094f9b3d5a79f Mon Sep 17 00:00:00 2001 From: Sean Harvey Date: Wed, 21 Oct 2020 17:09:25 -0400 Subject: [PATCH 2/3] Updates documentation with new properties --- docs/api/ref/AppMetadata.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/ref/AppMetadata.md b/docs/api/ref/AppMetadata.md index 410225740..2b5eae082 100644 --- a/docs/api/ref/AppMetadata.md +++ b/docs/api/ref/AppMetadata.md @@ -9,6 +9,8 @@ hide_title: true ```ts interface AppMetadata { name: string; + appId?: string; + version?: string; title?: string; tooltip?: string; description?: string; @@ -24,5 +26,7 @@ It always includes at least a `name` property, which can be used with [`open`](D Optionally, extra information from the app directory can be returned, to aid in rendering UI elements, e.g. a context menu. This includes a title, description, tooltip and icon and image URLs. +In situations where a desktop agent connects to multiple app directories or multiple versions of the same app exists in a single app directory, it may be neccessary to specify appId and version to target applications that share the same name. + #### See also * [`AppIntent.apps`](AppIntent) \ No newline at end of file From 5557a76a25623511b95e3502ecee7bf9ce96dd36 Mon Sep 17 00:00:00 2001 From: Sean Harvey <57105302+sean-ciq@users.noreply.github.com> Date: Wed, 11 Nov 2020 09:09:50 -0500 Subject: [PATCH 3/3] Add example of appId to comment Adding example of appId to comment based upon existing documentation https://fdc3.finos.org/docs/1.1/app-directory/discovery --- src/api/AppMetadata.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/api/AppMetadata.ts b/src/api/AppMetadata.ts index 14035ef05..cc53c8101 100644 --- a/src/api/AppMetadata.ts +++ b/src/api/AppMetadata.ts @@ -10,7 +10,7 @@ export interface AppMetadata { /** The unique app name that can be used with the open and raiseIntent calls. */ readonly name: string; - /** The unique application identifier located within a specific application directory instance. */ + /** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */ readonly appId?: string; /** The Version of the application. */