Panduan
Cara menggunakan Android Kiosk di Capacitor
Menggunakan @capgo/capacitor-android-kiosk
Plugin Capacitor Android Kiosk untuk mengontrol mode kiosk dan fungsi launcher. Plugin ini hanya untuk Android. Untuk mode kiosk iOS, gunakan fitur Guided Access perangkat.
Instal
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.
Impor
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
Sekilas tentang API
| Metode | Deskripsi |
|---|---|
isInKioskMode |
Mengecek apakah aplikasi sedang berjalan dalam mode kiosk. |
isSetAsLauncher |
Mengecek apakah aplikasi diatur sebagai launcher perangkat (home app). |
enterKioskMode |
Masuk ke mode kiosk, menyembunyikan UI sistem dan memblokir tombol hardware. Juga menjalankan foreground keep-alive service agar aplikasi tidak mudah dimatikan oleh sistem. Aplikasi harus diatur sebagai launcher perangkat agar ini bekerja efektif. |
exitKioskMode |
Keluar dari mode kiosk, mengembalikan UI sistem dan fungsi tombol hardware seperti normal. Juga menghentikan foreground keep-alive service yang dijalankan di enterKioskMode(). |
setAsLauncher |
Membuka pengaturan home screen perangkat agar pengguna dapat menetapkan aplikasi ini sebagai launcher. Ini diperlukan agar kiosk mode berfungsi penuh. |
setAllowedKeys |
Mengatur tombol hardware mana yang diizinkan berfungsi dalam kiosk mode. Secara default, semua tombol hardware diblokir dalam kiosk mode. |
Contoh
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 diatur sebagai launcher perangkat (home app).
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
Masuk ke mode kiosk, menyembunyikan UI sistem dan memblokir tombol hardware. Juga menjalankan foreground keep-alive service agar aplikasi tidak mudah dimatikan oleh sistem. Aplikasi harus diatur sebagai launcher perangkat agar ini bekerja efektif.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
Keluar dari mode kiosk, mengembalikan UI sistem dan fungsi tombol hardware seperti normal. Juga menghentikan foreground keep-alive service yang dijalankan di enterKioskMode().
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');
setAsLauncher()
Membuka pengaturan home screen perangkat agar pengguna dapat menetapkan aplikasi ini sebagai launcher. Ini diperlukan agar kiosk mode berfungsi 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 tombol hardware mana yang diizinkan berfungsi dalam kiosk mode. Secara default, semua tombol hardware diblokir dalam kiosk mode.
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 lengkap
Lanjutkan dari Menggunakan @capgo/capacitor-android-kiosk
Jika Anda menggunakan Menggunakan @capgo/capacitor-android-kiosk untuk merencanakan operasi dashboard dan API, hubungkan dengan @capgo/capacitor-android-kiosk untuk detail implementasi di @capgo/capacitor-android-kiosk, Panduan Memulai untuk detail implementasi di Getting Started, Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, dan Kunci API untuk detail implementasi di API Keys.