メインコンテンツへスキップ

@capgo/capacitor-android-kiosk

キオスクモードとランチャー制御により、Androidデバイスを単一のアプリに固定します。

@capgo/capacitor-android-kiosk キオスクモード、ランチャーの固定、ハードウェアキーポリシーにより、Capacitor の体験に特化したタブレット管理を実現します。

プラットフォームサポート備考
iOSといいえAndroid向け
AndroidでははいREADMEに沿ったDevice ownerプロビジョニング
Webいいえ該当なし
  • isInKioskMode - アプリが現在キオスクモードで動作しているかを確認します。
  • isSetAsLauncher - アプリがデバイスのランチャー(ホームアプリ)として設定されているかを確認します。
  • enterKioskMode - キオスクモードを開始し、システムUIを非表示にしてハードウェアボタンを無効化します。また、システムによるアプリの強制終了を防ぐため、フォアグラウンドのkeep-aliveサービスを開始します。この機能を効果的に動作させるには、アプリをデバイスのランチャーとして設定する必要があります。
  • exitKioskMode - キオスクモードを終了し、通常のシステムUIとハードウェアボタンの機能を復元します。また、enterKioskMode() で開始されたフォアグラウンドのkeep-aliveサービスを停止します。
メソッド説明
isInKioskModeアプリが現在キオスクモードで動作しているかを確認します。
isSetAsLauncherアプリがデバイスのランチャー(ホームアプリ)として設定されているかを確認します。
enterKioskModeキオスクモードを開始し、システムUIを非表示にしてハードウェアボタンを無効化します。また、システムによるアプリの強制終了を防ぐため、フォアグラウンドのkeep-aliveサービスを開始します。この機能を効果的に利用するには、アプリをデバイスのランチャーとして設定する必要があります。
exitKioskModeキオスクモードを終了し、通常のシステムUIとハードウェアボタンの機能を復元します。また、enterKioskMode() で開始されたフォアグラウンドのkeep-aliveサービスを停止します。
setAsLauncherユーザーがこのアプリをランチャーとして設定できるよう、デバイスのホーム画面設定を開きます。キオスクモードの全機能を利用するには、この設定が必要です。
setAllowedKeysキオスクモード中に動作を許可するハードウェアキーを設定します。デフォルトでは、キオスクモード中のすべてのハードウェアキーはブロックされます。
getPluginVersionネイティブの Capacitor プラグインのバージョンを取得します。

このリファレンスは以下から同期されています: src/definitions.ts における capacitor-android-kiosk.

使用している場合 @capgo/capacitor-android-kiosk ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-android-kiosk の使い方 「@capgo/capacitor-android-kiosk の使い方」のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。