Guida
Come usare Android Kiosk in Capacitor
Utilizzo di @capgo/capacitor-android-kiosk
Il plugin Capacitor Android Kiosk serve per gestire la modalità kiosk e le funzionalità di launcher. Questo plugin è disponibile solo per Android. Per la modalità kiosk su iOS, utilizza la funzione Guided Access del dispositivo.
Installa
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync copia i code nativi del plugin nei tuoi progetti nativi. Eseguilo di nuovo dopo ogni aggiornamento del plugin.
Importa
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
API in breve
| Metodo | Descrizione |
|---|---|
isInKioskMode |
Verifica se l'app è attualmente in esecuzione in modalità kiosk. |
isSetAsLauncher |
Verifica se l'app è impostata come launcher del dispositivo (home app). |
enterKioskMode |
Attiva la modalità kiosk, nascondendo la UI di sistema e bloccando i tasti hardware. Avvia anche un servizio foreground keep-alive, così che il sistema abbia meno probabilità di chiudere l'app. Perché funzioni davvero, l'app deve essere impostata come launcher del dispositivo. |
exitKioskMode |
Disattiva la modalità kiosk, ripristinando la UI di sistema e i tasti hardware. Ferma anche il servizio foreground keep-alive avviato con enterKioskMode(). |
setAsLauncher |
Apre le impostazioni della schermata Home del dispositivo per consentire all'utente di impostare questa app come launcher. È necessario per il pieno funzionamento della modalità kiosk. |
setAllowedKeys |
Imposta quali tasti hardware possono funzionare in modalità kiosk. Di default, tutti i tasti hardware sono bloccati in modalità kiosk. |
Esempi
isInKioskMode()
Verifica se l'app è attualmente in esecuzione in modalità kiosk.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);
isSetAsLauncher()
Verifica se l'app è impostata come launcher del dispositivo (home app).
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
Attiva la modalità kiosk, nascondendo la UI di sistema e bloccando i tasti hardware. Avvia anche un servizio foreground keep-alive, così che il sistema abbia meno probabilità di chiudere l'app. Perché funzioni davvero, l'app deve essere impostata come launcher del dispositivo.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
Disattiva la modalità kiosk, ripristinando la UI di sistema e i tasti hardware. Ferma anche il servizio foreground keep-alive avviato con enterKioskMode().
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');
setAsLauncher()
Apre le impostazioni della schermata Home del dispositivo per consentire all'utente di impostare questa app come launcher. È necessario per il pieno funzionamento della modalità kiosk.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app
setAllowedKeys()
Imposta quali tasti hardware possono funzionare in modalità kiosk. Di default, tutti i tasti hardware sono bloccati in modalità kiosk.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
volumeUp: true,
volumeDown: true,
back: false,
home: false,
recent: false
});
Riferimento completo
Continua da Using @capgo/capacitor-android-kiosk
Se stai usando Utilizzo di @capgo/capacitor-android-kiosk per pianificare le operazioni della dashboard e di API, collegalo a @capgo/capacitor-android-kiosk per i dettagli di implementazione in @capgo/capacitor-android-kiosk, Per iniziare per i dettagli di implementazione nella guida introduttiva, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli implementativi nell'Introduzione, e Chiavi API per i dettagli implementativi in API Keys.