Inicio

Instalar

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 de escritorio.

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 aplicación de inicio (aplicación de inicio del dispositivo).

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

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

enterKioskMode

Inicia el modo de escritorio, 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 aplicación de inicio para que esto funcione de manera efectiva.

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

Sale de el modo de 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().

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

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

setAsLauncher

Abre la pantalla de ajustes de la pantalla de inicio del dispositivo para permitir al usuario establecer esta aplicación como la aplicación de arranque. Esto es necesario para la funcionalidad de 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 el modo kiosk. Por defecto, todas las teclas de hardware están bloqueadas en el 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 de tipo

EnterKioskModeOptions

Opciones de 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 las teclas de hardware permitidas en modo de kiosco.

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 a partir del plugin’s src/definitions.tsRe-ruta la sincronización cuando el público API cambia en la fuente.