Guide
Comment utiliser Android Kiosk dans Capacitor
Tester sur l'appareil
Téléchargez l'application Capgo, puis scannez le QR code.
Utilisation de @capgo/capacitor-android-kiosk
Capacitor Plugin Android Kiosk pour contrôler le mode kiosque et les fonctionnalités du lanceur. Ce plugin est exclusif à Android. Pour le mode kiosque sur iOS, utilisez la fonctionnalité Guided Access 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';
Aperçu de API
| Méthode | Description |
|---|---|
isInKioskMode |
Vérifie si l'application s'exécute actuellement en mode kiosque. |
isSetAsLauncher |
Vérifie si l’application est définie comme lanceur d’appareil (application d’accueil). |
enterKioskMode |
Passe en mode kiosque en masquant l'interface système et en bloquant les boutons matériels. Démarre aussi un service foreground keep-alive pour limiter le risque que le système tue l'application. L'application doit être définie comme lanceur de l'appareil pour que cela fonctionne. |
exitKioskMode |
Quitte le mode kiosque, rétablissant l'interface système et les boutons matériels. Arrête également le service de maintien en premier plan lancé par enterKioskMode(). |
setAsLauncher |
Ouvre les paramètres de l'écran d'accueil de l'appareil pour que l'utilisateur puisse définir cette app comme lanceur. Nécessaire pour bénéficier de toutes les fonctionnalités du mode kiosque. |
setAllowedKeys |
Définit quelles touches physiques sont autorisées à fonctionner en mode kiosque. Par défaut, toutes les touches physiques sont bloquées en mode kiosque. |
Exemples
isInKioskMode()
Vérifie si l'application s'exécute 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 d’appareil (application d’accueil).
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
Passe en mode kiosque en masquant l'interface système et en bloquant les boutons matériels. Démarre aussi un service foreground keep-alive pour limiter le risque que le système tue l'application. L'application doit être définie comme lanceur de l'appareil pour que cela fonctionne.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
Quitte le mode kiosque, rétablissant l'interface système et les boutons matériels. Arrête également le service de maintien en 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 de l'écran d'accueil de l'appareil pour que l'utilisateur puisse définir cette app comme lanceur. Nécessaire pour bénéficier de toutes les fonctionnalités 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 physiques sont autorisées à fonctionner en mode kiosque. Par défaut, toutes les touches physiques 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 après « Utiliser @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’avec @capgo/capacitor-android-kiosk pour les détails d'implémentation dans @capgo/capacitor-android-kiosk, Prise en main pour les détails d'implémentation dans Getting Started Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble 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.