Android-Kiosk Capacitor-Plugin

Verwendung von @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

bunx cap sync kopiert die native code des Plugins in Ihre native Projekte. Führen Sie es erneut durch, nachdem jede Plugin-Upgrade durchgeführt wurde.

Importieren

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

API im Überblick

Beispiele

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()

Setzt den Kiosk-Modus ein, versteckt die System-UI und blockiert die Hardware-Tasten. Außerdem startet ein Vordergrund-Keep-Alive-Dienst, 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, restauriert die normale System-UI und die Funktionalität der Hardware-Tasten. Außerdem stoppt der Vordergrund-Keep-Alive-Dienst, der in enterKioskMode() gestartet wurde.

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

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

setAsLauncher()

Öffnet die Einstellungen der Geräte-Hauptseite, um dem Benutzer zu ermöglichen, diese App als Launcher zu setzen. Dies ist erforderlich für die volle Funktionalität des Kiosk-Modus.

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

await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app

setAllowedKeys()

Ermöglicht die Funktion bestimmter Hardware-Tasten in Kiosk-Modus. Standardmäßig sind alle Hardware-Tasten in Kiosk-Modus blockiert.

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

• GitHub-Repository
• Dokumentation
• API-Referenz

Fortfahren von Using @capgo/capacitor-android-kiosk

Wenn Sie Using verwenden Verwendung von @capgo/capacitor-android-kiosk um das Dashboard und API-Operationen zu planen, verbinden Sie es mit @capgo/capacitor-android-kiosk zur Implementierungsdetail in @capgo/capacitor-android-kiosk, Anleitung zum Starten für die Implementierungsdetails in Getting Started API Übersicht für die Implementierungsdetails in API Übersicht Einführung für die Implementierungsdetails in Einführung und API Schlüssel für die Implementierungsdetails in API Schlüssel