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

Android Kiosk

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

ガイド

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

Using @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 - Android キオスクモードに移行し、システムUIとハードウェアボタンのブロックを実行します。 foreground keep-alive サービスも開始して、アプリがシステムによって殺される可能性を低くします。アプリはこの機能が有効になるため、デバイスのホームアプリとして設定する必要があります。
  • exitKioskMode - Android キオスクモードから脱出し、通常のシステムUIとハードウェアボタンの機能を復元します。 foreground keep-alive サービスも停止します。

例の使用

isInKioskMode

現在、Android キオスクモードで実行されているかどうかを確認します。

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

- Android キオスクモードに移行し、システムUIとハードウェアボタンのブロックを実行します。 foreground keep-alive サービスも開始して、アプリがシステムによって殺される可能性を低くします。アプリはこの機能が有効になるため、デバイスのホームアプリとして設定する必要があります。

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

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

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

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

フル リファレンス

Using @capgo/capacitor-android-kiosk から続けてください

Capacitorを使用している場合 Using @capgo/capacitor-android-kiosk to plan dashboard and API operations, connect it with @capgo/capacitor-android-kiosk for the implementation detail in @capgo/capacitor-android-kiosk, はじめに Capacitor Android Kioskの実装詳細についてははじめにを参照してください API Overview for the implementation detail in API Overview, 導入 Capacitor Android Kioskの実装詳細については導入を参照してください API Keys APIの実装詳細についてはAPIキーショートに。