メインコンテンツにジャンプ
プラグインに戻る
@capgo/capacitor-android-kiosk
チュートリアル
github.com/Cap-go

Android Kiosk

Androidデバイスをキオスクモードにロックし、ランチャー機能とハードウェアキーの制御を実現します。

ガイド

Android キオスクのチュートリアル

@capgo/capacitor-android-kiosk を使用して Android キオスク プラグインを実装する

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

インストール

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

このプラグインが公開するもの

  • isInKioskMode - アプリが現在キオスクモードで実行されているかどうかを確認します。
  • isSetAsLauncher - アプリがデバイスのホームアプリとして設定されているかどうかを確認します。
  • enterKioskMode - キオスクモードに切り替え、システムUIとハードウェアボタンの非表示、そしてシステムによってアプリが殺されるのを防ぐために、バックグラウンドでアプリを常駐させるサービスを開始します。アプリがホームアプリとして設定されている場合にのみ、有効に機能します。
  • exitKioskMode - キオスクモードから脱出、システムUIとハードウェアボタンの通常の機能を復元、そしてenterKioskMode()で開始されたバックグラウンドサービスを停止します。

使用例

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とハードウェアボタンの非表示、そしてシステムによってアプリが殺されるのを防ぐために、バックグラウンドでアプリを常駐させるサービスを開始します。アプリがホームアプリとして設定されている場合にのみ、有効に機能します。

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

キオスクモードから脱出、システムUIとハードウェアボタンの通常の機能を復元、そしてenterKioskMode()で開始されたバックグラウンドサービスを停止します。

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

await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');

完全なリファレンス

@capgo/capacitor-android-kioskを継続して使用

Capgoを使用している場合 Using @capgo/capacitor-android-kiosk CapgoのダッシュボードとAPIの操作を計画するには、CapgoをAPI/__CAPGO_KEEP_1__-android-kioskに接続する Capgoの実装詳細は@capgo/capacitor-android-kioskを参照 for the implementation detail in @capgo/capacitor-android-kiosk, Getting Startedの実装詳細 Capgoの概要 API Overview for the implementation detail in API Overview, イントロダクション イントロダクションの実装詳細については、 API キー API キーの実装詳細については、