メインコンテンツにジャンプ
Back to plugins
@capgo/capacitor-android-kiosk
チュートリアル
@capgo/capacitor-android-kiosk

Android Kiosk

Android デバイスをキオスクモードにロックし、起動画面とハードウェアキー制御機能を提供します。

ガイド

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

Capacitor の @capgo/capacitor-android-kiosk を使用

Capacitor Android Kiosk Plugin for controlling kiosk mode and launcher functionality. This plugin is Android-only. For iOS kiosk mode, use the device's Guided Access feature.

インストール

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

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

  • isInKioskMode - アプリが現在キオスク モードで実行されているかどうかを確認します。
  • isSetAsLauncher - アプリがデバイスの起動アプリ (ホーム アプリ) として設定されているかどうかを確認します。
  • enterKioskMode - システムUIとハードウェアボタンのブロックを含むキオスクモードにエントリします。 foreground keep-aliveサービスも開始するので、システムによってアプリが殺される可能性が低くなります。 この機能が有効に働くには、アプリをデバイスのホームアプリとして設定する必要があります。
  • exitKioskMode - キオスクモードから脱出します。システムUIとハードウェアボタンの通常の機能を復元します。 foreground keep-aliveサービスも停止します。

Example Usage

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とハードウェアボタンのブロックを含み、foreground keep-aliveサービスも開始します。 アプリをデバイスのホームアプリとして設定する必要があります。

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

キオスクモードから脱出します。システムUIとハードウェアボタンの通常の機能を復元します。 foreground keep-aliveサービスも停止します。

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

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

Full Reference

Keep going from Using @capgo/capacitor-android-kiosk

あなたが使用している場合 使用中の@capgo/capacitor-android-kiosk ダッシュボードとAPIの作業を計画するには、@API/__CAPGO_KEEP_1__-android-kiosk を@capgo/capacitor-android-kiosk の実装詳細については@capgo/capacitor-android-kiosk Getting Started の実装詳細についてはGetting Started API Overview の実装詳細についてはAPI Overview Introduction の実装詳細についてはIntroduction API Keys APIの実装詳細については、APIキーの詳細を参照してください。