@capgo/capacitor-android-kiosk
Capacitor Android Kiosk Plugin for controlling kiosk mode and launcher functionality. This plugin is Android-only. For iOS kiosk mode, use the device's Guided Access feature.
Overview
Section titled “Overview”Capacitor Android Kiosk Plugin for controlling kiosk mode and launcher functionality. This plugin is Android-only. For iOS kiosk mode, use the device’s Guided Access feature.
Core Capabilities
Section titled “Core Capabilities”isInKioskMode- Checks if the app is currently running in kiosk mode.isSetAsLauncher- Checks if the app is set as the device launcher (home app).enterKioskMode- Enters kiosk mode, hiding system UI and blocking hardware buttons. Also starts a foreground keep-alive service so the app is less likely to be killed by the system. The app must be set as the device launcher for this to work effectively.exitKioskMode- Exits kiosk mode, restoring normal system UI and hardware button functionality. Also stops the foreground keep-alive service started in enterKioskMode().
Public API
Section titled “Public API”| Method | Description |
|---|---|
isInKioskMode | Checks if the app is currently running in kiosk mode. |
isSetAsLauncher | Checks if the app is set as the device launcher (home app). |
enterKioskMode | Enters kiosk mode, hiding system UI and blocking hardware buttons. Also starts a foreground keep-alive service so the app is less likely to be killed by the system. The app must be set as the device launcher for this to work effectively. |
exitKioskMode | Exits kiosk mode, restoring normal system UI and hardware button functionality. Also stops the foreground keep-alive service started in enterKioskMode(). |
setAsLauncher | Opens the device’s home screen settings to allow user to set this app as the launcher. This is required for full kiosk mode functionality. |
setAllowedKeys | Sets which hardware keys are allowed to function in kiosk mode. By default, all hardware keys are blocked in kiosk mode. |
getPluginVersion | Get the native Capacitor plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-android-kiosk.
Keep going from @capgo/capacitor-android-kiosk
Section titled “Keep going from @capgo/capacitor-android-kiosk”If you are using @capgo/capacitor-android-kiosk to plan dashboard and API operations, connect it with Using @capgo/capacitor-android-kiosk for the native capability in Using @capgo/capacitor-android-kiosk, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.