はじめから始める

Install

CapgoのAI-Assistedセットアップを使用してプラグインをインストールできます。次のコマンドを使用して、CapgoスキルをAIツールに追加します。

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

npm install @capgo/capacitor-android-kiosk
npx cap sync

インポート

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

クイックスタート

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

await CapacitorAndroidKiosk.enterKioskMode();

よくある間違い

• ランチャーランチャー: 正確なキオスクロックのためにアプリをデフォルトのランチャーとして設定します。
• MDMMDM: フィートビルドを出荷する前にエスケープホッチを検証します。
• iOSiOS: サポートされていません。

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 がアップストリームで変更されたときに、再度同期を実行してください。

続けて「Getting Started」

あなたが「Getting Started」を使用して ダッシュボードと __CAPGO_KEEP_0__ の作業を計画している場合、 「@API/__CAPGO_KEEP_1__-android-kiosk」 「@capgo/capacitor-android-kiosk」 Capacitorのネイティブ機能の使用のために@capgo/capacitor-android-kioskを使用します。 API まとめ API まとめの実装詳細については 導入 導入の実装詳細については API キー API キーの実装詳細については、 デバイス デバイスの実装詳細については