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.

Sign up for GitHub

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

Add appId & version to AppMetadata #273

Merged
merged 3 commits into from
Nov 13, 2020
Merged

Add appId & version to AppMetadata #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2706cd1
Adds appId and version to type definition
sean-ciq Oct 21, 2020
5abd1d6
Updates documentation with new properties
sean-ciq Oct 21, 2020
5557a76
Add example of appId to comment
sean-ciq Nov 11, 2020
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
4 changes: 4 additions & 0 deletions docs/api/ref/AppMetadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ hide_title: true
```ts
interface AppMetadata {
name: string;
appId?: string;
version?: string;
title?: string;
tooltip?: string;
description?: string;
Expand All @@ -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)
6 changes: 6 additions & 0 deletions src/api/AppMetadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down