Trigger API: Idle Time Limit

This section of the API includes functions which allow you to pause the Idle Time Limit (for example, while a visitor is watching a video and may not be expected to interact with the screen) and also to trigger the Idle Time Limit manually at any time.

Functions

Callbacks

Related Settings

Requirements

  • Access JavaScript API
    • By Import - recommended, works both online & offline, requires inclusion of kiosk_functions.js prior to any of the following calls.
    • By Injection - only works offline, may not be available 'onload'.
  • Timer Settings > Idle Time Limit = a value greater than zero

Sample Code

This sample code relies on the JavaScript APIs built into Kiosk Pro and will not run successfully in other browsers or within our in-app help interface.  
To run sample code, set the app's homepage to http://www.kioskproapp.com/delay-idle

Download Sample Code


kp_IdleTimer_fire

This function immediately triggers the idle timer, returning the visitor to the homepage, wiping navigation history, and clearing cache and/or cookies (if these are configured to clear in Kiosk Pro's settings).

Format
kp_IdleTimer_fire();
		

KioskShouldDisableIdleTimer

This callback is launched by Kiosk Pro every time the idle timer is fired. If you want the idle timer to skip, this method must return 'yes'. Any other value will allow execution of the idle timer & return to the Homepage.

If a native JavaScript alert, prompt, or confirmation dialog is being shown when the idle timer fires, Kiosk Pro is unable to evaluate the result of this callback.  In that instance, the idle timer will execute regardless of what this callback is set to return.

Format
KioskShouldDisableIdleTimer();
		

Example

function KioskShouldDisableIdleTimer() {
    var shouldSkipAction = "NO";
    if (condition) {
        shouldSkipAction = "YES";
    }
    return shouldSkipAction;
}

While the function above will prevent the idle timer from firing and refreshing to the homepage, there are other timers that will continue to run that can also cause this type of refresh. These include 'Refresh Homepage' and remote update of settings and/or local files, both of which trigger a refresh when new content is detected.

Still stuck? How can we help? How can we help?