スタートガイド

インストール

AI-Assisted Setupを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次のコマンドを使用してください。

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-android-kiosk` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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

インポート

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

API オーバービュー

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');

setAsLauncher

デバイスのホーム画面設定を開いて、ユーザーにこのアプリを起動画面に設定できるようにします。 これは、キオスクモードの完全な機能を実現するために必要です。

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

await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app

setAllowedKeys

キオスクモードで機能するハードウェアキーのセットを設定します。 デフォルトでは、キオスクモードではすべてのハードウェアキーの機能がブロックされます。

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

// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
  volumeUp: true,
  volumeDown: true,
  back: false,
  home: false,
  recent: false
});

型の参照

EnterKioskModeOptions

キオスク モードのオプション enterKioskMode.

export interface EnterKioskModeOptions {
  /**
   * After reboot, start the app so you can call `enterKioskMode()` again. Best-effort only (OEM
   * behavior, force-stop). Omit to keep the saved value. Cleared when you call `exitKioskMode()`.
   */
  restoreAfterReboot?: boolean;

  /**
   * Periodically tries to bring the app to the foreground. Skipped while the screen is off. Often
   * blocked from the background on some devices—being the default launcher, relaxing battery limits,
   * and allowing exact alarms (where required) improve odds. Omit to keep the saved value.
   */
  relaunch?: boolean;

  /** Minutes between relaunch attempts when `relaunch` is on. Range 5–60; default 15. */
  relaunchIntervalMinutes?: number;
}

AllowedKeysOptions

ソース オブ トゥース

export interface AllowedKeysOptions {
  /**
   * Allow volume up button
   * @default false
   */
  volumeUp?: boolean;

  /**
   * Allow volume down button
   * @default false
   */
  volumeDown?: boolean;

  /**
   * Allow back button
   * @default false
   */
  back?: boolean;

  /**
   * Allow home button
   * @default false
   */
  home?: boolean;

  /**
   * Allow recent apps button
   * @default false
   */
  recent?: boolean;

  /**
   * Allow power button
   * @default false
   */
  power?: boolean;

  /**
   * Allow camera button (if present)
   * @default false
   */
  camera?: boolean;

  /**
   * Allow menu button (if present)
   * @default false
   */
  menu?: boolean;
}

「ソース オブ トゥース」のセクション

このページはプラグインのソースから生成されます src/definitions.ts. API の更新がアップストリームで変更された場合、再度 Sync を実行してください。

Getting Started から続けてください。

「Getting Started」を使用してダッシュボードと __CAPGO_KEEP_0__ のオペレーションを計画している場合、__CAPGO_KEEP_0__ を接続してください。 Getting Started Android キオスクプラグインを使用して、ダッシュボードと API 操作を計画し、接続する 「@capgo/capacitor-android-kiosk」の概要 「@capgo/capacitor-android-kiosk」の実装詳細 API APIの実装詳細について Introduction 「Getting Started」の実装詳細 API キー 実装詳細の API キー デバイス 実装詳細のデバイス