ガイド
Capacitor で Android Kiosk を使う方法
@capgo/capacitor-android-kiosk の使い方
Capacitor Android Kiosk Plugin は、キオスクモードとランチャー機能を制御するためのプラグインです。このプラグインは Android 専用です。iOS のキオスクモードでは、デバイスの「アクセスガイド」機能を使用してください。
インストール
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
API の概要
| メソッド | 説明 |
|---|---|
isInKioskMode |
アプリが現在キオスクモードで動作しているかを確認します。 |
isSetAsLauncher |
アプリがデバイスのランチャー（ホームアプリ）として設定されているかを確認します。 |
enterKioskMode |
キオスクモードを開始し、システムUIを非表示にしてハードウェアボタンを無効化します。また、システムによるアプリの強制終了を防ぐため、フォアグラウンドのkeep-aliveサービスを開始します。この機能を効果的に利用するには、アプリをデバイスのランチャーとして設定する必要があります。 |
exitKioskMode |
キオスクモードを終了し、通常のシステムUIとハードウェアボタンの機能を復元します。また、enterKioskMode() で開始されたフォアグラウンドのkeep-aliveサービスを停止します。 |
setAsLauncher |
デバイスのホーム画面設定を開き、ユーザーがこのアプリをランチャーとして設定できるようにします。フルキオスクモード機能を利用するにはこれが必要です。 |
setAllowedKeys |
キオスクモード中に動作を許可するハードウェアキーを設定します。デフォルトでは、キオスクモード中のすべてのハードウェアキーはブロックされます。 |
例
isInKioskMode()
アプリが現在キオスクモードで動作しているかを確認します。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);
isSetAsLauncher()
アプリがデバイスのランチャー（ホームアプリ）として設定されているかを確認します。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
キオスクモードを開始し、システムUIを非表示にしてハードウェアボタンを無効化します。また、システムによるアプリの強制終了を防ぐため、フォアグラウンドのkeep-aliveサービスを開始します。この機能を効果的に利用するには、アプリをデバイスのランチャーとして設定する必要があります。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
キオスクモードを終了し、通常のシステムUIとハードウェアボタンの機能を復元します。また、enterKioskMode() で開始されたフォアグラウンドのkeep-aliveサービスを停止します。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');
setAsLauncher()
デバイスのホーム画面設定を開き、ユーザーがこのアプリをランチャーとして設定できるようにします。フルキオスクモード機能を利用するにはこれが必要です。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app
setAllowedKeys()
キオスクモード中に動作を許可するハードウェアキーを設定します。デフォルトでは、キオスクモード中のすべてのハードウェアキーはブロックされます。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
volumeUp: true,
volumeDown: true,
back: false,
home: false,
recent: false
});
完全なリファレンス
@capgo/capacitor-android-kiosk の使用方法から続ける
使用している場合 @capgo/capacitor-android-kiosk の使い方 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-android-kiosk @capgo/capacitor-android-kiosk の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 API の概要 「API の概要」の実装の詳細については、 はじめに はじめにの実装詳細、および API キー API Keys の実装詳細については、