Android キオスク Capacitor プラグイン

@capgo/capacitor-android-kiosk を使用

Capacitor Android Kiosk Plugin は、キオスクモードとランチャー機能を制御するためのプラグインです。このプラグインは Android 専用です。iOS のキオスクモードには、デバイスの Guided Access 機能を使用してください。

インストール

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

bunx cap sync プラグインのネイティブ code をネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

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

API の概要

実装例

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

リファレンス全文

• GitHub リポジトリ
• ドキュメント
• API リファレンス

@capgo/capacitor-android-kiosk を使った実装を続ける

以下を使用している場合： @capgo/capacitor-android-kiosk を使用する ダッシュボードと API の操作を計画するには、以下と連携してください @capgo/capacitor-android-kiosk @capgo/capacitor-android-kiosk の実装詳細については、 はじめに Getting Started の実装の詳細については、 API の概要 API Overview の実装の詳細については、 はじめに Introduction の実装詳細、および API キー API Keys の実装詳細についてはこちら。