Skip to content

Commit 89e53cc

Browse files
authored
Merge pull request #273 from ChartIQ/feature/add-optional-properties-to-appmetadata
Add appId & version to AppMetadata
2 parents 135aed3 + 5557a76 commit 89e53cc

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/api/ref/AppMetadata.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ hide_title: true
99
```ts
1010
interface AppMetadata {
1111
name: string;
12+
appId?: string;
13+
version?: string;
1214
title?: string;
1315
tooltip?: string;
1416
description?: string;
@@ -24,5 +26,7 @@ It always includes at least a `name` property, which can be used with [`open`](D
2426
Optionally, extra information from the app directory can be returned, to aid in rendering UI elements, e.g. a context menu.
2527
This includes a title, description, tooltip and icon and image URLs.
2628

29+
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.
30+
2731
#### See also
2832
* [`AppIntent.apps`](AppIntent)

src/api/AppMetadata.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ export interface AppMetadata {
1010
/** The unique app name that can be used with the open and raiseIntent calls. */
1111
readonly name: string;
1212

13+
/** The unique application identifier located within a specific application directory instance. An example of an appId might be '[email protected]' */
14+
readonly appId?: string;
15+
16+
/** The Version of the application. */
17+
readonly version?: string;
18+
1319
/** A more user-friendly application title that can be used to render UI elements */
1420
readonly title?: string;
1521

0 commit comments

Comments
 (0)