Readonly
appThe unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root'
Optional
Readonly
descriptionA longer, multi-paragraph description for the application that could include markup
Optional
Readonly
iconsA list of icon URLs for the application that can be used to render UI elements
Optional
Readonly
instanceAn optional instance identifier, indicating that this object represents a specific instance of the application described.
Optional
Readonly
instanceAn optional set of, implementation specific, metadata fields that can be used to disambiguate instances, such as a window title or screen position. Must only be set if instanceId
is set.
Optional
Readonly
nameThe 'friendly' app name.
This field was used with the open
and raiseIntent
calls in FDC3 <2.0, which now require an AppIdentifier
wth appId
set.
Note that for display purposes the title
field should be used, if set, in preference to this field.
Optional
Readonly
resultThe type of output returned for any intent specified during resolution. May express a particular context type (e.g. "fdc3.instrument"), channel (e.g. "channel") or a channel that will receive a specified type (e.g. "channel<fdc3.instrument>").
Optional
Readonly
screenshotsImages representing the app in common usage scenarios that can be used to render UI elements
Optional
Readonly
titleA more user-friendly application title that can be used to render UI elements
Optional
Readonly
tooltipA tooltip for the application that can be used to render UI elements
Optional
Readonly
versionThe Version of the application.
Extends an
AppIdentifier
, describing an application or instance of an application, with additional descriptive metadata that is usually provided by an FDC3 App Directory that the desktop agent connects to.The additional information from an app directory can aid in rendering UI elements, such as a launcher menu or resolver UI. This includes a title, description, tooltip and icon and screenshot URLs.
Note that as
AppMetadata
instances are alsoAppIdentifiers
they may be passed to theapp
argument offdc3.open
,fdc3.raiseIntent
etc.