시작하기

설치

AI-Assisted 설치를 사용하여 플러그인을 설치할 수 있습니다. 다음 명령어를 사용하여 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.

컨텍스트: Capgo 마케팅 웹사이트. 역할: UI 레이블. 위치: 페이지 agent/[slug].astro. 메시지 키 `agents_page_copy_label` (Agent Page Copy Label).

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

EnterKiosk 모드 옵션 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에서 계속하기

Android Kiosk 모바일 키오스크 플러그인 시작하기 대시보드와 API 운영을 계획하고 싶다면 Using @capgo/capacitor-android-kiosk Using @capgo/capacitor-android-kiosk API 개요 API Overview 소개 __CAPGO_KEEP_0__ Keys API 키 for API 구현 세부 사항에 대한 기기 장치의 구현 세부 정보에 대해.