Class: AppManifest

This class represents an AppManifest. It is mainly used to launch apps, and is usually read from a JSON-file. For some more information on AppManifests have a look at the SiteKiosk Android sample Apps.

new AppManifest()

Example

//A manifest file in JSON format
{
     "guid": "81134d51-cd98-4e5e-bd31-e46340418c9a",
	    "modes": [
		    "launcherApp"
	    ],
	    "name": "VideoViewApp",
	    "version": "0.1",
	    "startupUrl": "index.html",
	    "stringTablePath": "VideoViewAppSettingsDescriptionStrings.xml",
	    "titleString": "VideoViewApp.Title",
	    "descriptionString": "VideoViewApp.Description",
	    "settingsDescriptionFileUrl": "VideoViewAppSettingsDescription.xml",
	    "iconUrl": "images/icon.png",
	    "permissions": [ ],
     "lockScreen": "true"
}

Methods

getBaseUri() → {string}

Gets the applications base URI. This URI is used as a base for all paths relative to the application.

Returns:

The applications base URI

Type: string

getBaseUri() → {string}

Gets the applications base URI. This URI is used as a base for all paths relative to the application.

Returns:

The applications base URI

Type: string

getDescription() → {string}

Gets the application description.

Returns:

The application description

Type: string

getDescription() → {string}

Gets the application description.

Returns:

The application description

Type: string

getGuid() → {string}

Gets the apps global unique identifier (GUID).

Returns:

The apps global unique identifier

Type: string

getGuid() → {string}

Gets the apps global unique identifier (GUID).

Returns:

The apps global unique identifier

Type: string

getIconScales() → {string}

Gets the applications icon scales as a comma separated string. e.g.: '@0.5x, @1x, @2x'

Returns:

The applications icon scales

Type: string

getIconUrl() → {string}

Gets the applications icon URL.

Returns:

The applications icon URL

Type: string

getIconUrl() → {string}

Gets the applications icon URL.

Returns:

The applications icon URL

Type: string

getModes() → {Array.<string>}

Gets all modes supported by this application.

Returns:

Array of strings, containing the supported modes

Type: Array.<string>

getModes() → {Array.<string>}

Gets all modes supported by this application.

Returns:

Array of strings, containing the supported modes

Type: Array.<string>

getName() → {string}

Gets the applications name.

Returns:

The applications name

Type: string

getName() → {string}

Gets the applications name.

Returns:

The applications name

Type: string

getNonImmersive() → {boolean}

Gets whether the app is not immersive.

Returns:

Whether the app is non immersive

Type: boolean

getNonImmersive() → {boolean}

Gets whether the app is not immersive.

Returns:

Whether the app is non immersive

Type: boolean

getOrder() → {number}

Gets the applications order. Use this to sort applications consistently.

Returns:

The order in which the application should appear in application lists

Type: number

getOrder() → {number}

Gets the applications order. Use this to sort applications consistently.

Returns:

The order in which the application should appear in application lists

Type: number

getTitle() → {string}

Gets the application title.

Returns:

The application title

Type: string

getTitle() → {string}

Gets the application title.

Returns:

The application title

Type: string

launch(config, mode, hidden, nonImmersive) → {siteKiosk.apps~App}

Launches the application.

Parameters:

Name	Type	Argument	Default	Description
`config`	string			The applications configuration: Typically XML
`mode`	string			The applications mode, which is "app" usually, but might be "screensaver" or any other custom mode the application supports
`hidden`	boolean	<optional>	false	Whether the application should be hidden right from the start on
`nonImmersive`	boolean	<optional>	false	Whether the application should not run in immersive mode

Returns:

The instance of the launched application

Type: siteKiosk.apps~App

launch(config, mode, hidden, nonImmersive) → {siteKiosk.apps~App}

Launches the application.

Parameters:

Name	Type	Argument	Default	Description
`config`	string			The applications configuration: Typically XML
`mode`	string			The applications mode, which is "app" usually, but might be "screensaver" or any other custom mode the application supports
`hidden`	boolean	<optional>	false	Whether the application should be hidden right from the start on
`nonImmersive`	boolean	<optional>	false	Whether the application should not run in immersive mode

Returns:

The instance of the launched application

Type: siteKiosk.apps~App

new AppManifest()

Example

//A manifest file in JSON format
{
     "guid": "81134d51-cd98-4e5e-bd31-e46340418c9a",
	    "modes": [
		    "launcherApp"
	    ],
	    "name": "VideoViewApp",
	    "version": "0.1",
	    "startupUrl": "index.html",
	    "stringTablePath": "VideoViewAppSettingsDescriptionStrings.xml",
	    "titleString": "VideoViewApp.Title",
	    "descriptionString": "VideoViewApp.Description",
	    "settingsDescriptionFileUrl": "VideoViewAppSettingsDescription.xml",
	    "iconUrl": "images/icon.png",
	    "permissions": [ ],
     "lockScreen": "true"
}

Methods

getBaseUri() → {string}

Gets the applications base URI. This URI is used as a base for all paths relative to the application.

Returns:

The applications base URI

Type: string

getBaseUri() → {string}

Gets the applications base URI. This URI is used as a base for all paths relative to the application.

Returns:

The applications base URI

Type: string

getDescription() → {string}

Gets the application description.

Returns:

The application description

Type: string

getDescription() → {string}

Gets the application description.

Returns:

The application description

Type: string

getGuid() → {string}

Gets the apps global unique identifier (GUID).

Returns:

The apps global unique identifier

Type: string

getGuid() → {string}

Gets the apps global unique identifier (GUID).

Returns:

The apps global unique identifier

Type: string

getIconScales() → {string}

Gets the applications icon scales as a comma separated string. e.g.: '@0.5x, @1x, @2x'

Returns:

The applications icon scales

Type: string

getIconUrl() → {string}

Gets the applications icon URL.

Returns:

The applications icon URL

Type: string

getIconUrl() → {string}

Gets the applications icon URL.

Returns:

The applications icon URL

Type: string

getModes() → {Array.<string>}

Gets all modes supported by this application.

Returns:

Array of strings, containing the supported modes

Type: Array.<string>

getModes() → {Array.<string>}

Gets all modes supported by this application.

Returns:

Array of strings, containing the supported modes

Type: Array.<string>

getName() → {string}

Gets the applications name.

Returns:

The applications name

Type: string

getName() → {string}

Gets the applications name.

Returns:

The applications name

Type: string

getNonImmersive() → {boolean}

Gets whether the app is not immersive.

Returns:

Whether the app is non immersive

Type: boolean

getNonImmersive() → {boolean}

Gets whether the app is not immersive.

Returns:

Whether the app is non immersive

Type: boolean

getOrder() → {number}

Gets the applications order. Use this to sort applications consistently.

Returns:

The order in which the application should appear in application lists

Type: number

getOrder() → {number}

Gets the applications order. Use this to sort applications consistently.

Returns:

The order in which the application should appear in application lists

Type: number

getTitle() → {string}

Gets the application title.

Returns:

The application title

Type: string

getTitle() → {string}

Gets the application title.

Returns:

The application title

Type: string

launch(config, mode, hidden, nonImmersive) → {siteKiosk.apps~App}

Launches the application.

Parameters:

Name	Type	Argument	Default	Description
`config`	string			The applications configuration: Typically XML
`mode`	string			The applications mode, which is "app" usually, but might be "screensaver" or any other custom mode the application supports
`hidden`	boolean	<optional>	false	Whether the application should be hidden right from the start on
`nonImmersive`	boolean	<optional>	false	Whether the application should not run in immersive mode

Returns:

The instance of the launched application

Type: siteKiosk.apps~App

launch(config, mode, hidden, nonImmersive) → {siteKiosk.apps~App}

Launches the application.

Parameters:

Name	Type	Argument	Default	Description
`config`	string			The applications configuration: Typically XML
`mode`	string			The applications mode, which is "app" usually, but might be "screensaver" or any other custom mode the application supports
`hidden`	boolean	<optional>	false	Whether the application should be hidden right from the start on
`nonImmersive`	boolean	<optional>	false	Whether the application should not run in immersive mode

Returns:

The instance of the launched application

Type: siteKiosk.apps~App