AboutSupportDeveloper GuideVersion 38.126.83.80

Interface AppMetadata

App definition as provided by the application directory

interface AppMetadata {
    appId?: string;
    description?: string;
    icons?: string[];
    images?: string[];
    name: string;
    title?: string;
    tooltip?: string;
    version?: string;
}

Properties

appId? description? icons? images? name title? tooltip? version?

Properties

Optional Readonly appId

appId?: string

The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root'

Optional Readonly description

description?: string

A longer, multi-paragraph description for the application that could include markup

Optional Readonly icons

icons?: string[]

A list of icon URLs for the application that can be used to render UI elements

Optional Readonly images

images?: string[]

A list of image URLs for the application that can be used to render UI elements

Readonly name

name: string

The unique app name that can be used with the open and raiseIntent calls.

Optional Readonly title

title?: string

A more user-friendly application title that can be used to render UI elements

Optional Readonly tooltip

tooltip?: string

A tooltip for the application that can be used to render UI elements

Optional Readonly version

version?: string

The Version of the application.

Settings

Theme

On This Page

appIddescriptioniconsimagesnametitletooltipversion