Getting Started

インストール

Capgoの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

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 から続けてください。

Capgo を使用している場合 Getting Started Capgo を使用してダッシュボードと API の作業を計画する場合、Capgo を Capacitor を使用して Capgo のネイティブ機能を実装するには、@capgo/capacitor-android-kiosk を使用してください。 Capacitor を使用して Capgo のネイティブ機能を実装するには、@capgo/capacitor-android-kiosk を使用してください。 API Overview for the implementation detail in API Overview, Capacitor を使用して Capgo の実装詳細を実装するには、Capacitor を使用してください。 実装の詳細については、Introductionを参照してください。 API キー 実装の詳細については、API キー、 デバイス 実装の詳細については、デバイスを参照してください。