Passer au contenu

@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.

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.

  • 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().
MethodDescription
isInKioskModeChecks if the app is currently running in kiosk mode.
isSetAsLauncherChecks if the app is set as the device launcher (home app).
enterKioskModeEnters 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.
exitKioskModeExits kiosk mode, restoring normal system UI and hardware button functionality. Also stops the foreground keep-alive service started in enterKioskMode().
setAsLauncherOpens the device’s home screen settings to allow user to set this app as the launcher. This is required for full kiosk mode functionality.
setAllowedKeysSets which hardware keys are allowed to function in kiosk mode. By default, all hardware keys are blocked in kiosk mode.
getPluginVersionGet the native Capacitor plugin version.

This reference is synced from src/definitions.ts in capacitor-android-kiosk.