Inicio

Instalación

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

Importar

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

API Resumen

isInKioskMode

Verifica si la aplicación está actualmente ejecutándose en modo kiosk.

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

const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);

isSetAsLauncher

Verifica si la aplicación está configurada como launcher del dispositivo (aplicación de inicio).

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

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

enterKioskMode

Ingresa en modo kiosco, 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 configurarse como lanzador del dispositivo para que esto funcione de manera efectiva.

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

Sale del modo kiosco, restaurando la interfaz de usuario del sistema y la funcionalidad de los botones de hardware. También detiene el servicio de mantenimiento de primer plano iniciado en modoKiosco().

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

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

setAsLauncher

Abre la pantalla de ajustes del dispositivo para que el usuario pueda configurar esta aplicación como lanzador. Esto es necesario para la funcionalidad completa del modo kiosco.

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

await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app

setAllowedKeys

Establece cuáles teclas de hardware están permitidas para funcionar en modo kiosco. Por defecto, todas las teclas de hardware están bloqueadas en modo kiosco.

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 de tipos

EnterKioskModeOptions

Banderas opcionales para enterKioskMode.

export interface EnterKioskModeOptions {
  /**
   * After reboot, start the app so you can call `enterKioskMode()` again. Best-effort only (OEM
   * behavior, force-stop). Omit to keep the saved value. Cleared when you call `exitKioskMode()`.
   */
  restoreAfterReboot?: boolean;

  /**
   * Periodically tries to bring the app to the foreground. Skipped while the screen is off. Often
   * blocked from the background on some devices—being the default launcher, relaxing battery limits,
   * and allowing exact alarms (where required) improve odds. Omit to keep the saved value.
   */
  relaunch?: boolean;

  /** Minutes between relaunch attempts when `relaunch` is on. Range 5–60; default 15. */
  relaunchIntervalMinutes?: number;
}

AllowedKeysOptions

Opciones de configuración para teclas de hardware permitidas en modo de kiosk.

export interface AllowedKeysOptions {
  /**
   * Allow volume up button
   * @default false
   */
  volumeUp?: boolean;

  /**
   * Allow volume down button
   * @default false
   */
  volumeDown?: boolean;

  /**
   * Allow back button
   * @default false
   */
  back?: boolean;

  /**
   * Allow home button
   * @default false
   */
  home?: boolean;

  /**
   * Allow recent apps button
   * @default false
   */
  recent?: boolean;

  /**
   * Allow power button
   * @default false
   */
  power?: boolean;

  /**
   * Allow camera button (if present)
   * @default false
   */
  camera?: boolean;

  /**
   * Allow menu button (if present)
   * @default false
   */
  menu?: boolean;
}

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.ts. Re-ejecutar la sincronización cuando el público API cambia en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola de dashboard y operaciones API, conecta con Usando @capgo/capacitor-android-kiosk para la capacidad nativa en Usando @capgo/capacitor-android-kiosk, API Overview para el detalle de implementación en API Overview, Introducción para el detalle de implementación en Introducción, API Keys para los detalles de implementación en las API Claves, y Dispositivos para los detalles de implementación en Dispositivos.