Module: siteKiosk.siteRemote.scriptJob

This modules allows to subscribe to script jobs being sent to this machine.

Methods

<static> finish(Specifies, code, description)

Notifies SiteRemote, that an script job has been completed.
Parameters:
Name Type Argument Default Description
Specifies string the id if the SiteRemote job, to mark as finished.
code number <optional>
 0 The error code of the SiteRemote job, where 0 indicates no error
description string <optional>
 "" An error description

<static> onAdded(addedCallback, abortCallback)

Subscribes to new scrip jobs being added to this machine. This is exclusive. Only one subscriber will gets these events. The last subscriber wins.
Parameters:
Name Type Description
addedCallback siteKiosk.siteRemote.scriptJob~addedCallback A callback being invoked, when a script job has been added
abortCallback siteKiosk.siteRemote.scriptJob~abortCallback A callback being invoked, when a script job has been aborted

Type Definitions

abortCallback()

This callback is being invoked, when a script job has been aborted.

addedCallback(script)

This callback is being invoked, when a script job has been added.
Parameters:
Name Type Description
script string The script to execute