Skip to content

Commit 8b58662

Browse files
committed
Add updated app metadata to documentation
1 parent 4bbba50 commit 8b58662

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/api/DesktopAgent.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,10 +189,20 @@ The Interface used to describe an Intent within the platform.
189189
```typescript
190190
interface AppMetadata {
191191
name: string;
192+
title?: string;
193+
tooltip?: string;
194+
description?: string;
195+
icons?: Array<string>;
196+
images?: Array<string>;
192197
}
193198
```
194199

195-
App metadata is Desktop Agent specific - but should always support a name property.
200+
App metadata is provided by the FDC3 App Directory that the desktop agent connects to.
201+
202+
It always includes at least a `name` property, which can be used with [`open`](#open) and [`raiseIntent`](#raiseIntent).
203+
204+
Optionally, extra information from the app directory can be returned, to aid in rendering UI elements, e.g. a context menu.
205+
This includes a title, description, tooltip and icon and image URLs.
196206

197207
### `IntentResolution`
198208

0 commit comments

Comments
 (0)