Guide
Comment utiliser Android Kiosk dans Capacitor
Tester sur un appareil
Téléchargez l'application Capgo, puis scannez le QR code.
Utiliser @capgo/capacitor-android-kiosk
Le plugin Android Kiosk Capacitor permet de contrôler le mode kiosque et les fonctionnalités du launcher. Ce plugin est réservé à Android. Pour le mode kiosque sur iOS, utilisez la fonction Accès guidé de l'appareil.
Installer
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
API en un coup d'œil
| Méthode | Description |
|---|---|
isInKioskMode |
Vérifie si l'application est actuellement en mode kiosque. |
isSetAsLauncher |
Vérifie si l'application est définie comme lanceur de l'appareil (home app). |
enterKioskMode |
Active le mode kiosque en masquant l'interface système et en bloquant les boutons physiques. Démarre également un service de premier plan (foreground) pour éviter que le système ne tue l'application. L'application doit être définie comme lanceur de l'appareil pour un fonctionnement optimal. |
exitKioskMode |
Désactive le mode kiosque, rétablissant l'interface système et les boutons physiques. Arrête également le service de premier plan lancé par enterKioskMode(). |
setAsLauncher |
Ouvre les paramètres d'accueil de l'appareil pour permettre à l'utilisateur de définir cette application comme lanceur. Cette étape est requise pour bénéficier de toutes les fonctionnalités du mode kiosque. |
setAllowedKeys |
Définit quelles touches physiques sont autorisées en mode kiosque. Par défaut, toutes les touches physiques sont bloquées en mode kiosque. |
Exemples
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 lanceur de l'appareil (home app).
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
Active le mode kiosque en masquant l'interface système et en bloquant les boutons physiques. Démarre également un service de premier plan (foreground) pour éviter que le système ne tue l'application. L'application doit être définie comme lanceur de l'appareil pour un fonctionnement optimal.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
Désactive le mode kiosque, rétablissant l'interface système et les boutons physiques. Arrête également le service de premier plan lancé par enterKioskMode().
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');
setAsLauncher()
Ouvre les paramètres d'accueil de l'appareil pour permettre à l'utilisateur de définir cette application comme lanceur. Cela est requis pour les fonctionnalités complètes 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 quelles touches matérielles sont autorisées en mode kiosque. Par défaut, toutes les touches 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
Continuer avec l'utilisation de @capgo/capacitor-android-kiosk
Si vous utilisez Utilisation de @capgo/capacitor-android-kiosk pour planifier les opérations du dashboard et de API, connectez-l’à @capgo/capacitor-android-kiosk pour les détails d'implémentation dans @capgo/capacitor-android-kiosk, Premiers pas pour les détails d'implémentation dans Premiers pas, Aperçu de API pour les détails d'implémentation dans l'aperçu de API, Introduction pour les détails d'implémentation dans l'Introduction, et Clés API pour les détails d'implémentation dans les clés API.