From 3c2c52c9db8c5a5fade6e58d91bc25f64fa2fd35 Mon Sep 17 00:00:00 2001 From: Kris West Date: Mon, 13 Jun 2022 11:41:11 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Matt Jamieson <10372+mattjamieson@users.noreply.github.com> --- docs/api/spec.md | 4 ++-- src/api/DesktopAgent.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/spec.md b/docs/api/spec.md index d68ab0ce6..7507c891c 100644 --- a/docs/api/spec.md +++ b/docs/api/spec.md @@ -153,11 +153,11 @@ let {appId, instanceId} = implementationMetadata.appMetadata; ### Reference apps or app instance(s) and retrieve their metadata -To construct workflows between applications, you need to be able to reference specific applications and instance of those applications. +To construct workflows between applications, you need to be able to reference specific applications and instances of those applications. From version 2.0 of the FDC3 Standard, Desktop Agent functions that reference or return information about other applications do so via an [`AppIdentifier`](ref/Types#appidentifier) type. [`AppIdentifier`](ref/Types#appidentifier) references specific applications via an `appId` from an [App Directory](../app-directory/overview) record and instances of that application via an `instanceId` assigned by the Desktop Agent. -Additional metadata for an application can be retrieved via the [`fdc3.getAppMetadata(appIdentifier)`](ref/DesktopAgent#getappmetadata) function, which returns an [`AppMetadata`](ref/Metadata#appmetadata) object. The additional metadata may include a title, description, icons, etc., which may be used for display purposes. +Additional metadata for an application can be retrieved via the [`fdc3.getAppMetadata(appIdentifier)`](ref/DesktopAgent#getappmetadata) function, which returns an [`AppMetadata`](ref/Metadata#appmetadata) object. The additional metadata may include a title, description, icons, etc., which may be used for display purposes. Identifiers for instances of an application may be retrieved via the [`fdc3.findInstances(appIdentifier)`](ref/DesktopAgent#findinstances) function. diff --git a/src/api/DesktopAgent.ts b/src/api/DesktopAgent.ts index 35ba44ece..ef338e9fb 100644 --- a/src/api/DesktopAgent.ts +++ b/src/api/DesktopAgent.ts @@ -53,7 +53,7 @@ export interface DesktopAgent { * Find out more information about a particular intent by passing its name, and optionally its context and/or a desired result context type. * * `findIntent` is effectively granting programmatic access to the Desktop Agent's resolver. - * It returns a promise resolving to the intent, its metadata and metadata about the apps and app instances that registered it is returned. + * It returns a promise resolving to the intent, its metadata and metadata about the apps and app instances that registered that intent. * This can be used to raise the intent against a specific app or app instance. * * If the resolution fails, the promise will return an `Error` with a string from the `ResolveError` enumeration. @@ -309,7 +309,7 @@ export interface DesktopAgent { * //Handle a raised intent and log the originating app metadata * const listener = fdc3.addIntentListener('StartChat', (contact, metadata) => { * console.log(`Received intent StartChat\nContext: ${contact}\nOriginating app: ${metadata?.source}`); - * return; + * return; * }); * * //Handle a raised intent and return Context data via a promise