Anleitung
Android Kiosk in Capacitor nutzen
Auf dem Gerät testen
Lade die Capgo App herunter und scanne den QR code.
Nutzung von @capgo/capacitor-android-kiosk
Capacitor Android Kiosk Plugin zur Steuerung des Kiosk-Modus und der Launcher-Funktionen. Dieses Plugin ist nur für Android verfügbar. Für den iOS Kiosk-Modus nutzen Sie die Guided Access Funktion des Geräts.
Installieren
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.
Importieren
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
API auf einen Blick
| Methode | Beschreibung |
|---|---|
isInKioskMode |
Prüft, ob die App gerade im Kiosk-Modus läuft. |
isSetAsLauncher |
Prüft, ob die App als Standard-Launcher (Home-App) festgelegt ist. |
enterKioskMode |
Aktiviert den Kiosk-Modus, blendet die System-UI aus und blockiert Hardware-Buttons. Zudem wird ein Foreground-Service gestartet, um zu verhindern, dass das System die App beendet. Damit dies effektiv funktioniert, muss die App als Standard-Launcher festgelegt sein. |
exitKioskMode |
Beendet den Kiosk-Modus, stellt die System-UI und die Hardware-Buttons wieder her. Stoppt zudem den durch enterKioskMode() gestarteten Foreground-Service. |
setAsLauncher |
Öffnet die Startbildschirm-Einstellungen des Geräts, damit der Nutzer diese App als Launcher festlegen kann. Das ist für den vollständigen Kiosk-Modus erforderlich. |
setAllowedKeys |
Legt fest, welche Hardware-Tasten im Kiosk-Modus funktionieren dürfen. Standardmäßig sind alle Hardware-Tasten im Kiosk-Modus gesperrt. |
Beispiele
isInKioskMode()
Prüft, ob die App gerade im Kiosk-Modus läuft.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);
isSetAsLauncher()
Prüft, ob die App als Standard-Launcher (Home-App) festgelegt ist.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
Aktiviert den Kiosk-Modus, blendet die System-UI aus und blockiert Hardware-Buttons. Zudem wird ein Foreground-Service gestartet, um zu verhindern, dass das System die App beendet. Damit dies effektiv funktioniert, muss die App als Standard-Launcher festgelegt sein.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
Beendet den Kiosk-Modus, stellt die System-UI und die Hardware-Buttons wieder her. Stoppt zudem den durch enterKioskMode() gestarteten Foreground-Service.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');
setAsLauncher()
Öffnet die Startbildschirm-Einstellungen des Geräts, damit der Nutzer diese App als Launcher festlegen kann. Das ist für den vollständigen Kiosk-Modus erforderlich.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app
setAllowedKeys()
Legt fest, welche Hardware-Tasten im Kiosk-Modus funktionieren dürfen. Standardmäßig sind alle Hardware-Tasten im Kiosk-Modus gesperrt.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
volumeUp: true,
volumeDown: true,
back: false,
home: false,
recent: false
});
Vollständige Referenz
Weiter mit der Nutzung von @capgo/capacitor-android-kiosk
Wenn du es nutzt Nutzung von @capgo/capacitor-android-kiosk um Dashboard- und API-Operationen zu planen, verbinde es mit @capgo/capacitor-android-kiosk für die Implementierungsdetails in @capgo/capacitor-android-kiosk, Erste Schritte für die Implementierungsdetails in Erste Schritte, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung und API Schlüssel für die Implementierungsdetails in den API Keys.