Getting Started

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :

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

Importer

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

API Vue d'ensemble

isInKioskMode

Vérifie si l'application est actuellement exécutée en mode kiosque.

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

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

isSetAsLauncher

Vérifie si l'application est définie comme l'application de démarrage du dispositif (application d'accueil).

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

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

enterKioskMode

Entrez en mode kiosque, masquant l'interface utilisateur système et bloquant les boutons matériel. Cela démarre également un service de maintenance en premier plan pour que l'application soit moins susceptible d'être tuée par le système. L'application doit être définie comme l'application de démarrage du dispositif pour que cela fonctionne efficacement.

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

Sortir du mode kiosque, restaurant l'interface utilisateur système normale et la fonctionnalité des boutons matériel. Cela arrête également le service de maintenance en premier plan démarré dans enterKioskMode().

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

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

setAsLauncher

Ouvre l'écran d'accueil du dispositif pour permettre à l'utilisateur de définir cette application comme l'application de démarrage. Cela est requis pour une fonctionnalité de mode kiosque complète.

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

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

setAllowedKeys

Définit lesquels des boutons matériel sont autorisés à fonctionner en mode kiosque. Par défaut, tous les boutons matériel sont bloqués en mode kiosque.

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

// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
  volumeUp: true,
  volumeDown: true,
  back: false,
  home: false,
  recent: false
});

Référence de type

EnterKioskModeOptions

Options facultatives pour 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

Options de configuration pour les clés matérielles autorisées dans le mode kiosque.

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;
}

Source de vérité

Re-run the sync when the public __CAPGO_KEEP_0__ changes upstream. src/definitions.ts. Re-run the sync when the public API changes upstream.

Référence de type

Si vous utilisez Démarrage pour planifier l'interface de tableau de bord et les opérations API, connectez-le avec En utilisant @capgo/capacitor-android-kiosk pour la capacité native dans En utilisant @capgo/capacitor-android-kiosk, Vue d'ensemble de API pour les détails d'implémentation dans Vue d'ensemble de API, Introduction pour les détails d'implémentation dans Introduction, Clés de API pour les détails d'implémentation dans Clés de API, et Appareils pour le détail d'implémentation dans Appareils.