Vai al contenuto principale
@capgo/capacitor-android-kiosk API dei dispositivi Sorgente aperta

Android Kiosk Plugin Capacitor

Blocca dispositivi Android in modalità kiosk con funzionalità di launcher e controllo delle chiavi hardware

Installa

bun add @capgo/capacitor-android-kiosk bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/capacitor-android-kiosk
  • pnpm add @capgo/capacitor-android-kiosk
  • yarn add @capgo/capacitor-android-kiosk

Guida

Come utilizzare Android Kiosk in Capacitor

Testare su dispositivo

Scarica l'app Capgo, poi scansione il QR code.

Anteprima del plugin Android Kiosk QR code

Utilizzare @capgo/capacitor-android-kiosk

Plugin Android Kiosk di Capacitor per il controllo del modalità kiosk e della funzionalità del launcher. Questo plugin è disponibile solo per Android. Per la modalità kiosk su iOS, utilizzare la funzione Guided Access del dispositivo.

Installa

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

bunx cap sync Esegue una copia del nativo code del plugin nei tuoi progetti nativi. Esegui nuovamente dopo ogni aggiornamento del plugin.

Importa

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

Esegui API in un colpo solo

Metodo Descrizione
isInKioskMode Verifica se l'app è attualmente in modalità kiosk.
isSetAsLauncher Verifica se l'app è impostata come launcher del dispositivo (app di home).
enterKioskMode Avvia la modalità kiosk, nascondendo l'interfaccia utente di sistema e bloccando i pulsanti hardware. Inoltre, avvia un servizio di mantenimento in primo piano per ridurre la probabilità che l'app venga uccisa dal sistema. L'app deve essere impostata come launcher del dispositivo per funzionare efficacemente.
exitKioskMode Esci dal modalità kiosk, ripristinando l'interfaccia utente e le funzionalità dei pulsanti hardware normali. Inoltre, ferma il servizio di keep-alive in primo piano avviato in enterKioskMode().
setAsLauncher Apre la schermata di impostazioni di home del dispositivo per consentire all'utente di impostare questa app come launcher. Ciò è richiesto per la funzionalità della modalità kiosk completa.
setAllowedKeys Configura quali tasti hardware sono consentiti di funzionare in modalità kiosk. Di default, tutti i tasti hardware sono bloccati in modalità kiosk.

Esempi

isInKioskMode()

Verifica se l'app è in modalità kiosk attualmente.

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 (app di home).

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

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

enterKioskMode()

Immetti la modalità kiosk, nascondendo l'interfaccia utente del sistema e bloccando i pulsanti hardware. Inoltre, avvia un servizio di keep-alive in primo piano per ridurre la probabilità che l'app venga uccisa dal sistema. L'app deve essere impostata come launcher del dispositivo per funzionare efficacemente.

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode()

Esci dal modalità kiosk, ripristinando l'interfaccia utente e le funzionalità dei pulsanti hardware normali. Inoltre, ferma il servizio di keep-alive in primo piano avviato in enterKioskMode().

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

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

setAsLauncher()

Apre la schermata di impostazioni del dispositivo di home per consentire all'utente di impostare questa app come launcher. Ciò è richiesto per la funzionalità della modalità kiosk completa.

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 sono consentiti di 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 dall'uso di @capgo/capacitor-android-kiosk

__CAPGO_KEEP_0__ riferimento Utilizzando @capgo/capacitor-android-kiosk per pianificare la dashboard e le operazioni di API, connettilo con @capgo/capacitor-android-kiosk per i dettagli di implementazione in @capgo/capacitor-android-kiosk, Getting Started per i dettagli di implementazione in Avvio, Panoramica di API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, e Chiavi di API per i dettagli di implementazione in Chiavi di API.

FAQ

Domande frequenti

Come posso installare il plugin Android Kiosk in un'app Capacitor?

Run 'bun add @capgo/capacitor-android-kiosk' (o 'npm install @capgo/capacitor-android-kiosk'), poi esegui 'npm cap sync' per far sì che i progetti iOS e Android recuperino il nativo 'code'. Importalo da '@capgo/capacitor-android-kiosk' nel tuo'app 'code'.

Esegue @capgo/capacitor-android-kiosk con React, Vue e Angular?

Sì. Il pacchetto Android Kiosk è un pacchetto 'Capacitor', quindi funziona con qualsiasi framework web che esegue all'interno 'Capacitor', compresi Ionic, React, Vue, Angular, Svelte e JavaScript puro.

Qual è la versione di 'Capacitor' supportata da @capgo/capacitor-android-kiosk?

Le Capgo plugin seguono la versione maggiore di 'Capacitor': utilizza la versione plugin maggiore che corrisponde alla tua versione maggiore di 'Capacitor' (ad esempio plugin v8 con 'Capacitor' 8). La tabella di compatibilità nel README di 'GitHub' elenca le versioni mantenute.

Esegue @capgo/capacitor-android-kiosk gratuitamente e di pubblico dominio?

Sì. Il codice sorgente di 'code' è pubblico su 'GitHub' all'indirizzo https://github.com/Cap-go/capacitor-android-kiosk/ e il pacchetto è gratuito per l'installazione da 'npm'. I bug report e le richieste di pull sono accetti.

Posso aggiornare 'code' che utilizza Android Kiosk senza una revisione dell'App Store?

Installando o aggiornando il plugin cambia il nativo 'code', quindi richiede una nuova costruzione dello store. Dopo di che, le modifiche JavaScript, HTML e CSS che chiamano il plugin possono essere spediti immediatamente con 'Capgo' live updates.

Consegui Android Kiosk senza aspettare la revisione dell'app

Una volta che il plugin è presente nella tua store build, le Capgo aggiornamenti in tempo reale inviano i tuoi cambiamenti JavaScript, HTML e CSS agli utenti in pochi minuti.

Inizia con Capgo