Zum Hauptinhalt springen
Zurück zu Plugins
@capgo/capacitor-android-kiosk
Tutorial
von github.com/Cap-go

Android Kiosk

Schließen Sie Android-Geräte in Kiosk-Modus mit Launcher-Funktion und Hardware-Tastensteuerung ab

Richtlinie

Tutorial für Android-Kiosk

Mit @capgo/capacitor-android-kiosk

Capacitor Android-Kiosk-Plugin zum Steuern des Kiosk-Modus und der Launcher-Funktion. Dieser Plugin ist nur für Android verfügbar. Für den iOS-Kiosk-Modus verwenden Sie die Funktion Guided Access des Geräts.

Installieren

bun add @capgo/capacitor-android-kiosk
bunx cap sync

Was dieser Plugin freigibt

  • isInKioskMode - Überprüft, ob die App derzeit im Kiosk-Modus läuft.
  • isSetAsLauncher - Überprüft, ob die App als Geräte-Startseite (Home-App) festgelegt ist.
  • enterKioskMode - Setzt den Kiosk-Modus ein, versteckt die System-UI und blockiert die Hardware-Tasten. Außerdem startet ein Hintergrund-Service, der die App weniger wahrscheinlich durch das System töten lässt. Die App muss als Geräte-Startseite festgelegt sein, damit dies effektiv funktioniert.
  • exitKioskMode - Beendet das Kiosk-Modus, wodurch die normale System-UI und die Funktion der Hardware-Tasten wiederhergestellt werden. Außerdem wird der Vordergrund-Keep-Alive-Dienst, der in enterKioskMode() gestartet wurde, gestoppt.

Beispielanwendung

isInKioskMode

Überprüft, ob die App derzeit im Kiosk-Modus läuft.

import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';

const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);

isSetAsLauncher

Überprüft, ob die App als Geräte-Startseite (Home-App) festgelegt ist.

import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';

const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);

enterKioskMode

Gibt den Kiosk-Modus ein, indem die System-UI und die Hardware-Tasten blockiert werden. Außerdem wird ein Vordergrund-Keep-Alive-Dienst gestartet, damit die App weniger wahrscheinlich vom System beendet wird. Die App muss als Geräte-Startseite festgelegt sein, damit dies effektiv funktioniert.

import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

Beendet den Kiosk-Modus, wodurch die normale System-UI und die Funktion der Hardware-Tasten wiederhergestellt werden. Außerdem wird der Vordergrund-Keep-Alive-Dienst, der in enterKioskMode() gestartet wurde, gestoppt.

import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';

await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');

Vollständige Referenz