Skip to content

@capgo/capacitor-android-kiosk

Capacitor Android Kiosk プラグインは、キオスクモードとランチャー機能を制御するために使用されます。このプラグインは Android 限定です。iOS キオスクモードの場合は、デバイスのガイドドアクセス機能を使用してください。

Capacitor Android キオスク プラグインは、キオスクモードと起動画面の機能を制御するために使用されます。このプラグインは、Android専用です。iOSのキオスクモードの場合は、デバイスのガイド付きアクセス機能を使用してください。

  • isInKioskMode - アプリが現在キオスクモードで実行されているかどうかを確認します。
  • isSetAsLauncher - アプリがデバイスの起動画面(ホームアプリ)として設定されているかどうかを確認します。
  • enterKioskMode - キオスクモードに切り替え、システムUIを非表示にしてハードウェアボタンの操作をブロックします。さらに、フォアグラウンドキープアライブサービスを開始して、アプリがシステムによって殺される可能性を低くします。アプリが起動画面として設定されている場合にのみ、この機能が効果的に機能します。
  • exitKioskMode - キオスクモードから脱出、通常のシステムUIとハードウェアボタンの機能を復元します。さらに、フォアグラウンドキープアライブサービスを停止します。
メソッド説明
isInKioskMode現在のアプリがキオスクモードで実行されているかどうかを確認します。
isSetAsLauncher現在のデバイスのホームアプリとして設定されているかどうかを確認します。
enterKioskModeキオスクモードに移行し、システムUIとハードウェアボタンのブロックを開始します。さらに、フォアグラウンドキープアライブサービスを開始することで、アプリがシステムによって殺される可能性を低くします。この機能が有効に働くには、アプリがデバイスのホームアプリとして設定されている必要があります。
exitKioskModeキオスクモードを終了し、通常のシステムUIとハードウェアボタンの機能を復元します。さらに、フォアグラウンドキープアライブサービスを停止することで、enterKioskMode()で開始したサービスを停止します。
setAsLauncherデバイスのホーム画面設定を開き、ユーザーがこのアプリをホームアプリとして設定できるようにします。この機能が完全に有効になるには、このアプリをホームアプリとして設定する必要があります。
setAllowedKeysキオスクモードで機能するハードウェアキーのセットを設定します。デフォルトでは、キオスクモードではすべてのハードウェアキーがブロックされます。
getPluginVersionネイティブCapacitorプラグインのバージョンを取得します。

このリファレンスはSyncdからSyncd src/definitions.ts in capacitor-android-kiosk.