Access API: Kiosk Mode

Added in 9.3

This JavaScript API allows you to check if Guided Access or Single App Mode are enabled.

Function

Callback

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' event.

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/kiosk-mode

Download Sample Code


kp_GuidedAccess_requestStatus

This function triggers a callback containing the status of Guided Access or Single App Mode.

Format
kp_GuidedAccess_requestStatus();
		


kp_GuidedAccess_statusOfGuidedAccessDidChange

This callback returns the status of Guided Access or Single App Mode.

Format
kp_GuidedAccess_statusOfGuidedAccessDidChange(isGAEnabled)
		
Return Values
  • 0 = disabled
  • 1 = enabled

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