Android Kiosk plugin Capacitor

Utilisation de @capgo/capacitor-android-kiosk

Plugin Android Kiosk de Capacitor pour le contrôle du mode kiosk et de la fonctionnalité de lancement. Ce plugin est uniquement pour Android. Pour le mode kiosk iOS, utilisez la fonctionnalité d'accès guidé du appareil.

Installer

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

bunx cap sync copie le code natif du plugin dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à jour du plugin.

Importer

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

API en un coup d'œil

Examples

isInKioskMode()

Vérifie si l'application est actuellement en mode kiosque.

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

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

isSetAsLauncher()

Vérifie si l'application est définie comme l'application d'accueil du dispositif.

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

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

enterKioskMode()

Entrez le mode kiosque, masquant l'interface utilisateur système et bloquant les boutons matériel. Il démarre également un service de maintenance de premier plan pour que l'application soit moins susceptible d'être tuée par le système. L'application doit être définie comme l'application de démarrage du dispositif pour que cela fonctionne efficacement.

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode()

Sortir du mode kiosque, rétablissant l'interface utilisateur système normale et la fonctionnalité des boutons matériel.

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

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

setAsLauncher()

Ouvrez l'écran de paramètres d'accueil du dispositif pour permettre à l'utilisateur de définir cette application comme l'application de démarrage. Cela est requis pour la fonctionnalité complète du mode kiosque.

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

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

setAllowedKeys()

Définit les clés matérielles autorisées à fonctionner en mode kiosque. Par défaut, toutes les clés matérielles sont bloquées en mode kiosque.

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

// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
  volumeUp: true,
  volumeDown: true,
  back: false,
  home: false,
  recent: false
});

Référence complète

• répertoire GitHub
• Documentation
• Référence de API

Continuez à partir de l'utilisation de @capgo/capacitor-android-kiosk

Si vous utilisez En utilisant @capgo/capacitor-android-kiosk pour planifier l'interface de bord et les opérations API, la connecter avec @capgo/capacitor-kiosque-android pour les détails d'implémentation dans @capgo/capacitor-android-kiosk Getting Started pour les détails d'implémentation dans Démarrage Vue d'ensemble de API pour les détails d'implémentation dans Vue d'ensemble de API Introduction pour les détails d'implémentation dans Introduction, et Clés de API pour les détails d'implémentation dans Clés de API