Module: siteKiosk.siteRemote.events

A module to notify SiteRemote server about events on the client. The event is identified by a status from the siteKiosk.siteRemote.events.statusType member. A table showing the available status types can be found below.

Example

//send reboot notification
siteKiosk.siteRemote.events.sendStatus(siteKiosk.siteRemove.events.statusType.reboot, "SiteKiosk");

Members

<static> statusType :number

Status types.
Type:
  • number
Properties:
Name Type Default Description
systemMin number 0
boot number 0
reboot number 1
shutdown number 2
standBy number 3
standByResume number 4
crashed number 5
monitorOn number 6
monitorOff number 7
systemMax number 7
userMin number 10
userLogon number 10
userLogoff number 11
userUnlock number 12
userLock number 13
userIdle number 14
userIdleResumed number 15
userLogonRemotely number 16
userLogoffRemotely number 17
userMax number 17
appStarted number 20
appMin number 20
appClosed number 21
appIdle number 22
appIdleResumed number 23
appCrashed number 24
appMax number 24

Methods

<static> sendStatus(statusType, source, delay)

Sends a status event to the server, to report system status changes e.g. when the monitor turned on and off.
Parameters:
Name Type Argument Description
statusType number The status type
source string The facility of event
delay number <optional>
The delay in seconds from now, when this event should be considered to be happened