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 diff --git a/src/api/AppMetadata.ts b/src/api/AppMetadata.ts index 269ee984c..cc53c8101 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. An example of an appId might be 'app@sub.root' */ + 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;