Iniziare

Installa

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

Importa

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

API Panoramica

isInKioskMode

Verifica se l'app è attualmente in modalità schermo intero.

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

Immette modalità kiosk, nascondendo l'interfaccia utente del sistema e bloccando i pulsanti hardware. Inoltre avvia un servizio di mantenimento in primo piano per assicurare che l'app non 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 dalla modalità kiosk, ripristinando l'interfaccia utente del sistema e la funzionalità dei pulsanti hardware. Inoltre ferma il servizio di mantenimento in primo piano avviato in immettereModalitàKiosk().

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

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

setAsLauncher

Apre la schermata di impostazioni del dispositivo per consentire all'utente di impostare questa app come launcher. Ciò è richiesto per una funzionalità di 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 le chiavi hardware che sono consentite di funzionare in modalità kiosk. Di default, tutte le chiavi hardware sono bloccate 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 di tipo

EnterKioskModeOptions

Opzioni facoltative per 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

Opzioni di configurazione per le chiavi hardware consentite in modalità 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;
}

Fonte di verità

Questa pagina è generata dal plugin e può essere aggiornata manualmente. Riavvia la sincronizzazione quando le modifiche pubbliche __CAPGO_KEEP_0__ sono state apportate in fase di sviluppo. src/definitions.tsRiavvia la sincronizzazione quando le modifiche pubbliche API sono state apportate in fase di sviluppo.

Continua da Inizia

Se stai utilizzando Inizia per pianificare il dashboard e le operazioni API, collega Utilizza @capgo/capacitor-android-kiosk per la capacità nativa in Utilizza @capgo/capacitor-android-kiosk, API Overview per i dettagli di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione, API Keys per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.