Getting Started

Salin sebuah prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-android-kiosk`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/android-kiosk/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Judul bagian “Instalasi”

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

Import

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

API Pengantar

`isInKioskMode`

Mengecek apakah aplikasi sedang berjalan dalam mode kiosk.

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

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

`isSetAsLauncher`

Mengecek apakah aplikasi telah ditetapkan sebagai launcher perangkat (aplikasi utama).

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

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

`enterKioskMode`

Masuk ke mode kiosk, menyembunyikan antarmuka pengguna sistem dan menghalangi tombol perangkat keras. Juga memulai layanan keep-alive di depan untuk mencegah aplikasi dibunuh oleh sistem. Aplikasi harus ditetapkan sebagai launcher perangkat untuk ini bekerja efektif.

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

await CapacitorAndroidKiosk.enterKioskMode();

`exitKioskMode`

Keluar dari mode kiosk, mengembalikan antarmuka pengguna sistem normal dan fungsi tombol perangkat keras. Juga menghentikan layanan keep-alive di depan yang dimulai di masukKioskMode().

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

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

`setAsLauncher`

Buka layar utama perangkat pengaturan untuk memungkinkan pengguna menetapkan aplikasi ini sebagai launcher. Ini diperlukan untuk fungsi mode kiosk penuh.

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

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

`setAllowedKeys`

Mengatur kunci perangkat keras yang diizinkan untuk berfungsi dalam mode kiosk. Dengan default, semua kunci perangkat keras diblokir dalam mode 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
});

Referensi Tipe

`EnterKioskModeOptions`

Bendera Opsional untuk 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`

Pilihan Konfigurasi untuk Kunci Perangkat Lunak yang Diperbolehkan dalam Mode 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;
}

Sumber Kebenaran

Halaman ini dibuat dari plugin’s. src/definitions.tsRe-run sinkronisasi ketika publik API berubah secara upstream.

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan operasi API, hubungkannya dengan Menggunakan @capgo/capacitor-android-kiosk untuk kemampuan asli dalam Menggunakan @capgo/capacitor-android-kiosk, API Ringkasan untuk detail implementasi dalam API Ringkasan, Pendahuluan untuk detail implementasi dalam Pendahuluan, API Kunci untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Perangkat.