Guía
Cómo usar Android Kiosk en Capacitor
Usando @capgo/capacitor-android-kiosk
Plugin de Android Kiosk de Capacitor para controlar el modo de kiosk y la funcionalidad del lanzador. Este plugin es solo para Android. Para el modo de kiosk de iOS, utilice la función de Acceso Guiado del dispositivo.
Instalar
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync Escribe el plugin nativo code en tus proyectos nativos. Ejecútalo de nuevo después de cada actualización del plugin.
Importar
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
API en resumen
| Metodo | Descripción |
|---|---|
isInKioskMode |
Verifica si la aplicación está ejecutándose actualmente en modo kiosk. |
isSetAsLauncher |
Checks if the app is set as the device launcher (home app). |
enterKioskMode |
Ingresa en modo kiosk, ocultando la interfaz de usuario del sistema y bloqueando los botones de hardware. También inicia un servicio de mantenimiento de primer plano para que la aplicación sea menos probable que sea eliminada por el sistema. La aplicación debe estar configurada como lanzador de dispositivos para que esto funcione de manera efectiva. |
exitKioskMode |
Sale de modo kiosk, restaurando la interfaz de usuario y la funcionalidad de los botones de hardware normales. También detiene el servicio de mantenimiento de primer plano iniciado en enterKioskMode(). |
setAsLauncher |
Abre la pantalla de ajustes de inicio del dispositivo para permitir al usuario configurar esta aplicación como lanzador. Esto es necesario para la funcionalidad de modo kiosk completo. |
setAllowedKeys |
Configura qué teclas de hardware están permitidas para funcionar en modo kiosk. Por defecto, todas las teclas de hardware están bloqueadas en modo kiosk. |
Ejemplos
isInKioskMode()
Verifica si la aplicación está ejecutándose actualmente en modo kiosk.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);
isSetAsLauncher()
Checks if the app is set as the device launcher (home app).
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
Enters kiosk mode, hiding system UI and blocking hardware buttons. Also starts a foreground keep-alive service so the app is less likely to be killed by the system. The app must be set as the device launcher for this to work effectively.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
Sale de modo de kiosk, restaurando la interfaz de usuario y la funcionalidad de los botones de hardware normales. También detiene el servicio de keep-alive de primer plano iniciado en enterKioskMode().
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');
setAsLauncher()
Abre la pantalla de ajustes de inicio del dispositivo para permitir al usuario configurar esta aplicación como la aplicación de arranque. Esto es necesario para la funcionalidad de modo kiosk completo.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app
setAllowedKeys()
Establece qué teclas de hardware están permitidas para funcionar en modo kiosk. Por defecto, todas las teclas de hardware están bloqueadas en modo 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
});
Referencia completa
Sigue adelante desde Using @capgo/capacitor-android-kiosk
Si estás utilizando Usando @capgo/capacitor-android-kiosk planificar la consola y las API operaciones, conecte con @capgo/capacitor-kiosk-android para los detalles de implementación en @capgo/capacitor-android-kiosk, Getting Started para los detalles de implementación en Inicio, Resumen de API para los detalles de implementación en Resumen de API, Introducción para los detalles de implementación en Introducción, y Claves de API para los detalles de implementación en API Keys.