API: Check Lockdown State
Check if the device is currently locked to Kiosk Pro through Guided Access, Single App Mode, or Autonomous Single App Mode using our JavaScript API calls.
In this article
Requirements
- Integration of our JavaScript API into your webpage
- Sample code to run within the app and download for integration into your own project is available here.
- Best practices for working with the JavaScript API are available here.
- App Settings
- Content > JavaScript API > Access JavaScript API = By Import
Triggers via API Functions
Check Lockdown Status
This function triggers a callback that returns if a lockdown state (including Guided Access, Single App Mode, or Autonomous Single App Mode) is enabled.
| Format | kp_GuidedAccess_requestStatus(); |
| Triggers | kp_GuidedAccess_statusOfGuidedAccessDidChange |
Notifications via API Callbacks
On Lockdown State Change or API Request
This callback is triggered each time the device's lockdown state changes and also as result of calling kp_GuidedAccess_requestStatus.
| Format | kp_GuidedAccess_statusOfGuidedAccessDidChange(isGAEnabled) |
| Return Values |
|
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 kioskgroup.com/lockdown-state-api
- To download a .zip of sample code, click here.
Change Log
- Added in version 9.3