Inizia a utilizzare

Installazione

È possibile utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Poi utilizza il seguente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-android-kiosk` plugin in my project.

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del sistema operativo riportate di seguito:

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

Importa

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

API Panoramica

isInKioskMode

Verifica se l'applicazione è attualmente in esecuzione in modalità schermo unico.

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 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 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 immettiModalitàKiosk().

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

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

setAsLauncher

Apre la schermata di impostazioni del launcher del dispositivo per consentire all'utente di impostare questa app come launcher. Questo è richiesto per la 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 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 di tipo

EnterKioskModeOptions

Flag facoltativi 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 i tasti hardware consentiti 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;
}

Punto di verità

Questa pagina è generata dal plugin’s src/definitions.tsRiesegui nuovamente la sincronizzazione quando le informazioni pubbliche API cambiano in fase di sviluppo.

Continua da Getting Started

Se stai utilizzando Getting Started per pianificare dashboard e API operazioni, connettilo con Utilizzando @capgo/capacitor-android-kiosk per la capacità nativa in Utilizzando @capgo/capacitor-android-kiosk, API Overview per i dettagli di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.