Module: siteKiosk

// SiteKiosk will now restart after the escape gesture was performed
siteKiosk.onEscGesture(function() {
     siteKiosk.restart();
});

Members

<static> activityTracker :siteKiosk.activityTracker

Type:

• siteKiosk.activityTracker

<static> apps :siteKiosk.apps

Type:

• siteKiosk.apps

<static> config :siteKiosk.config

Type:

• siteKiosk.config

<static> crypto :siteKiosk.crypto

Type:

• siteKiosk.crypto

<static> devices :siteKiosk.devices

Type:

• siteKiosk.devices

<static> event :siteKiosk.event

Type:

• siteKiosk.event

<static> io :siteKiosk.io

Type:

• siteKiosk.io

<static> license :siteKiosk.license

Type:

• siteKiosk.license

<static> localization :siteKiosk.localization

Type:

• siteKiosk.localization

<static> log :siteKiosk.log

Type:

• siteKiosk.log

<static> maintenance :siteKiosk.maintenance

Type:

• siteKiosk.maintenance

<static> network :siteKiosk.network

Type:

• siteKiosk.network

<static> printing :siteKiosk.printing

Type:

• siteKiosk.printing

<static> security :siteKiosk.security

Type:

• siteKiosk.security

<static> siteRemote :siteKiosk.siteRemote

Type:

• siteKiosk.siteRemote

<static> surfTime :siteKiosk.surfTime

Type:

• siteKiosk.surfTime

<static> system :siteKiosk.system

Type:

• siteKiosk.system

<static> text.utf8Encoding :siteKiosk.text.utf8Encoding

Type:

• siteKiosk.text.utf8Encoding

<static> ui :siteKiosk.ui

Type:

• siteKiosk.ui

<static> version :siteKiosk.version

Type:

• siteKiosk.version

Methods

<static> deinstall(deleteSdCardContent)

Starts the deinstallation process, which might require user input.

Parameters:

Name	Type	Description
deleteSdCardContent	boolean	Whether the SiteKiosk SD card folder should be cleared

<static> deletePrivateData(deleteWebStorage, deleteCookies, completed)

Starts deletion of private data.

Parameters:

Name	Type	Argument	Description
deleteWebStorage	boolean		Whether the web storage should be deleted
deleteCookies	boolean		Whether cookies should be deleted
completed	siteKiosk~deletePrivateDataCallback	<optional>	Callback to be notified when the operation completes

<static> escape()

Opens the escape menu.

<static> getVersionName() → {string}

Returns the version string.

Returns:

The version string

Type

string

<static> isMock() → {boolean}

Returns whether the underlying object model is a mock.

Returns:

Whether the underlying object model is a mock

Type

boolean

<static> logout()

SiteKiosk logout.

<static> notifyRestartOpportunity()

Notifies SiteKiosk, to perform a restart if necessary.

<static> onBack(callback) → {siteKiosk~eventSubscription}

Registers a callback, will be called when the back button is pressed.

Parameters:

Name	Type	Description
callback	siteKiosk~backCallback	The callback, which will be triggered will be called when the back button is pressed

Returns:

Type

siteKiosk~eventSubscription

<static> onCommand(prefix, callback) → {siteKiosk~eventSubscription}

Registers a callback, will be called when an command is received.

Parameters:

Name	Type	Description
prefix	string	The command prefix to listen to
callback	siteKiosk~commandCallback	The callback, which will be called when an command is received

Returns:

Type

siteKiosk~eventSubscription

<static> onEmulatedDeviceData(callback) → {siteKiosk~eventSubscription}

Registers a callback that will be called when data is available from the configured keyboard device.

Parameters:

Name	Type	Description
callback	siteKiosk~callback	The callback which will be called when data is available.

Returns:

Type

siteKiosk~eventSubscription

<static> onEscGesture(callback) → {siteKiosk~eventSubscription}

Registers a callback, will be called when the escape gesture is being performed.

Parameters:

Name	Type	Description
callback	siteKiosk~escGestureCallback	The callback, which will be triggered will be called when the escape gesture is being performed

Returns:

Type

siteKiosk~eventSubscription

<static> onHome(callback) → {siteKiosk~eventSubscription}

Registers a callback, which will be triggered when the home button is being pressed.

Parameters:

Name	Type	Description
callback	siteKiosk~homeCallback	The callback, which will be triggered when the home button is being pressed

Returns:

Type

siteKiosk~eventSubscription

<static> onQuit(callback) → {siteKiosk~eventSubscription}

Registers a callback, will be called when SiteKiosk is quiting.

Parameters:

Name	Type	Description
callback	siteKiosk~callback	The callback, which will be called when an SiteKiosk is quitting.

Returns:

Type

siteKiosk~eventSubscription

<static> onReset(callback) → {siteKiosk~eventSubscription}

Registers a callback, will be called when SiteKiosk is quiting.

Parameters:

Name	Type	Description
callback	siteKiosk~callback	The callback, which will be called when an SiteKiosk is quitting.

Returns:

Type

siteKiosk~eventSubscription

<static> quit()

Quits SiteKiosk.

<static> restart()

Restarts SiteKiosk.

<static> showPasswordDialogOrQuit()

Displays the password dialog or quits SiteKiosk when no password has been set.

Type Definitions

backCallback()

This callback will be called when the back button is pressed.

commandCallback(command, params)

This callback will be called an command is received.

Parameters:

Name	Type	Description
command	string	The command name
params	Array	Additional params

deletePrivateDataCallback()

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

escGestureCallback()

This callback will be called when the escape gesture is being performed.

eventSubscription

An event subscription.

Type:

• Object

Properties:

Name	Type	Description
unbind	function	Unsubscribes the event

eventSubscription

An event subscription.

Type:

• Object

Properties:

Name	Type	Description
unbind	function	Unsubscribes the event

homeCallback()

This callback will be called when the home button is being pressed.