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

앱이 현재 kiosk 모드에서 실행 중인지 확인합니다.

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

const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);

isSetAsLauncher

앱이 디바이스의 launcher(홈 앱)로 설정되어 있는지 확인합니다.

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

const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);

enterKioskMode

__CAPGO_KEEP_0__ 모드에 들어가서 시스템 UI와 하드웨어 버튼을 차단합니다. 또한 foreground keep-alive 서비스를 시작하여 앱이 시스템에 의해 죽히지 않도록 합니다. 이 기능이 효과적으로 작동하려면 앱을 디바이스의 런처로 설정해야 합니다.

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

__CAPGO_KEEP_0__ 모드에서 나옵니다. 시스템 UI와 하드웨어 버튼의 기능이 복원됩니다. foreground keep-alive 서비스를 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

__CAPGO_KEEP_0__ 모드에서 허용되는 하드웨어 키를 설정합니다. 기본적으로 kiosk 모드에서 모든 하드웨어 키가 차단됩니다.

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

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

Type Reference

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업스트림에서 pubic API이 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속하세요

Capgo를 사용 중이라면 시작하기 API 대시보드와 API 연산을 계획하기 위해 Capgo를 사용하여 @capgo/capacitor-android-kiosk Capgo를 사용하여 @capgo/capacitor-android-kiosk의 네이티브 기능 API 개요 API의 구현 세부 사항 소개 __CAPGO_KEEP_0__ 키 API의 구현 세부 사항 API 키 __CAPGO_KEEP_0__ __CAPGO_KEEP_1__