API: Access App Settings

Access Kiosk Pro's in-app settings menu through a JavaScript API call. Using an API Call to access settings can allow your content to trigger app settings after a different type of authentication request or using a different touch gesture than our standard Show Settings options. 

Requirements

Kiosk Pro Plus and Enterprise

  • 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
    • Show Settings > Allow Settings Access through API > On
    • JavaScript > Access JavaScript API = By Import


Triggers via API Functions

Trigger In-App Settings

This function triggers showing the app's in-app settings menu with or without the passcode configured in the app's settings.

Format
kp_InAppSettings_triggerInAppSettings(requirePasscode, callback);
		
Parameters
  • requirePasscode - [boolean] representing whether the app should request the passcode configured in app settings prior to displaying the in-app settings menu. Possible values are:
    • true - show native promptrequesting passcode
    • false - do not request passcode
  • callback - [string] the name of the callback to be triggered after the function has been executed
  • Callback format
    callback();
    		


    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/admin-settings-api
    • To download a .zip of sample code, click here.

    Change Log

    • Added in version 10.1

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