API: Clear Data
These API calls allow you to clear the cache, cookies & session storage, and/or local storage manually through JavaScript, without using the Kiosk Pro app settings and returning to the homepage.
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
Clear Cache
This function clears the cache within Kiosk Pro.
| Format | kp_Browser_clearCache(); |
Clear Local Storage
This function clears HTML5 local storage within Kiosk Pro.
| Format | kp_Browser_clearLocalStorage(); |
Clear Cookies & Session Storage
This function clears any cookies & session storage within Kiosk Pro. Any cookies which are set to be retained through Retain Cookies On in the app's settings will not be cleared.
| Format | kp_Browser_clearCookies(); |
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/clear-data-api
- To download a .zip of sample code, click here.
Change Log
- Added in version 5.0. Ability to clear HTML5 local storage added in version 8.5.