Getting Started

インストール

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;
}

真実の源

このページはプラグインの設定から生成されます。 公開 __CAPGO_KEEP_0__ がアップストリームで変更された場合に再度 Sync を実行してください。 src/definitions.ts. Re-run the sync when the public API changes upstream.

「Getting Started」から続けて

Capgoを使用している場合 Getting Started APIと連携することで、ダッシュボードとAPIの操作を計画できます。 capgo/capacitor-android-kioskを使用して、@capgo/capacitor-android-kioskのネイティブ機能を実装します。 for the native capability in Using @capgo/capacitor-android-kiosk, APIの実装詳細については、APIの概要を参照してください。 for the implementation detail in API Overview, 実装詳細については、概要を参照してください。 __CAPGO_KEEP_0__のキー APIの実装詳細については、APIのキーを参照してください。 for the implementation detail in API Keys, and Devices デバイスの実装詳細について。