Class: App

This class represents a SiteKiosk App. It is launched via an AppManifest and provides several methods to obtain information about the configuration, the guid, the instance id, the mode, etc. It also offers methods to hide, show and close the app.

new App()

Methods

close()

Closes the app and removes it from the view hierarchy.

close()

Closes the app and removes it from the view hierarchy.

deletePrivateData(deleteTempFiles, deleteHistory, completed)

Deletes private data related to the application.
Parameters:
Name Type Description
deleteTempFiles boolean Whether to delete cached files
deleteHistory boolean Whether to delete the browsing history
completed siteKiosk.apps~App~deletePrivateDataCallback Callback, which will be invoked when private data has been deleted

deletePrivateData(deleteTempFiles, deleteHistory, completed)

Deletes private data related to the application.
Parameters:
Name Type Description
deleteTempFiles boolean Whether to delete cached files
deleteHistory boolean Whether to delete the browsing history
completed siteKiosk.apps~App~deletePrivateDataCallback Callback, which will be invoked when private data has been deleted

getConfig() → {string}

Gets the apps configuration, which is typically an XML formatted string.
Returns:
The app's configuration
Type
string

getConfig() → {string}

Gets the apps configuration, which is typically an XML formatted string.
Returns:
The app's configuration
Type
string

getGuid() → {string}

Gets the apps GUID.
Returns:
The GUID
Type
string

getGuid() → {string}

Gets the apps GUID.
Returns:
The GUID
Type
string

getId() → {number}

Gets the apps instance id.
Returns:
App instance id
Type
number

getId() → {number}

Gets the apps instance id.
Returns:
App instance id
Type
number

getMode() → {string}

Gets the apps mode e.g. "screensaver" or "app"
Returns:
The current mode
Type
string

getMode() → {string}

Gets the apps mode e.g. "screensaver" or "app"
Returns:
The current mode
Type
string

getNonImmersive() → {boolean}

Gets whether this app is not immersive.
Returns:
Whether this app is not immersive
Type
boolean

getNonImmersive() → {boolean}

Gets whether this app is not immersive.
Returns:
Whether this app is not immersive
Type
boolean

hide()

Moves the app to the background (hidden).

hide()

Moves the app to the background (hidden).

isActive() → {boolean}

Returns whether the app is active (resumed) or not (paused).
Returns:
Whether the app is active (resumed) or not (paused)
Type
boolean

isActive() → {boolean}

Returns whether the app is active (resumed) or not (paused).
Returns:
Whether the app is active (resumed) or not (paused)
Type
boolean

isForeground() → {boolean}

Returns whether the app is in the foreground (showing) or not (hidden).
Returns:
whether the app is in the foreground (showing) or not (hidden)
Type
boolean

isForeground() → {boolean}

Returns whether the app is in the foreground (showing) or not (hidden).
Returns:
whether the app is in the foreground (showing) or not (hidden)
Type
boolean

show()

Brings the app to foreground (showing).

show()

Brings the app to foreground (showing).

Type Definitions

deletePrivateDataCallback()

This callback will be called when private data has been deleted.

deletePrivateDataCallback()

This callback will be called when private data has been deleted.
This class represents a SiteKiosk App. It is launched via an AppManifest and provides several methods to obtain information about the configuration, the guid, the instance id, the mode, etc. It also offers methods to hide, show and close the app.

new App()

Methods

close()

Closes the app and removes it from the view hierarchy.

close()

Closes the app and removes it from the view hierarchy.

deletePrivateData(deleteTempFiles, deleteHistory, completed)

Deletes private data related to the application.
Parameters:
Name Type Description
deleteTempFiles boolean Whether to delete cached files
deleteHistory boolean Whether to delete the browsing history
completed siteKiosk.apps~App~deletePrivateDataCallback Callback, which will be invoked when private data has been deleted

deletePrivateData(deleteTempFiles, deleteHistory, completed)

Deletes private data related to the application.
Parameters:
Name Type Description
deleteTempFiles boolean Whether to delete cached files
deleteHistory boolean Whether to delete the browsing history
completed siteKiosk.apps~App~deletePrivateDataCallback Callback, which will be invoked when private data has been deleted

getConfig() → {string}

Gets the apps configuration, which is typically an XML formatted string.
Returns:
The app's configuration
Type
string

getConfig() → {string}

Gets the apps configuration, which is typically an XML formatted string.
Returns:
The app's configuration
Type
string

getGuid() → {string}

Gets the apps GUID.
Returns:
The GUID
Type
string

getGuid() → {string}

Gets the apps GUID.
Returns:
The GUID
Type
string

getId() → {number}

Gets the apps instance id.
Returns:
App instance id
Type
number

getId() → {number}

Gets the apps instance id.
Returns:
App instance id
Type
number

getMode() → {string}

Gets the apps mode e.g. "screensaver" or "app"
Returns:
The current mode
Type
string

getMode() → {string}

Gets the apps mode e.g. "screensaver" or "app"
Returns:
The current mode
Type
string

getNonImmersive() → {boolean}

Gets whether this app is not immersive.
Returns:
Whether this app is not immersive
Type
boolean

getNonImmersive() → {boolean}

Gets whether this app is not immersive.
Returns:
Whether this app is not immersive
Type
boolean

hide()

Moves the app to the background (hidden).

hide()

Moves the app to the background (hidden).

isActive() → {boolean}

Returns whether the app is active (resumed) or not (paused).
Returns:
Whether the app is active (resumed) or not (paused)
Type
boolean

isActive() → {boolean}

Returns whether the app is active (resumed) or not (paused).
Returns:
Whether the app is active (resumed) or not (paused)
Type
boolean

isForeground() → {boolean}

Returns whether the app is in the foreground (showing) or not (hidden).
Returns:
whether the app is in the foreground (showing) or not (hidden)
Type
boolean

isForeground() → {boolean}

Returns whether the app is in the foreground (showing) or not (hidden).
Returns:
whether the app is in the foreground (showing) or not (hidden)
Type
boolean

show()

Brings the app to foreground (showing).

show()

Brings the app to foreground (showing).

Type Definitions

deletePrivateDataCallback()

This callback will be called when private data has been deleted.

deletePrivateDataCallback()

This callback will be called when private data has been deleted.