가이드
Capacitor에서 Android Kiosk 사용 방법
@capgo/capacitor-android-kiosk 사용하기
키오스크 모드 및 런처 기능을 제어하기 위한 Capacitor Android Kiosk Plugin입니다. 이 플러그인은 Android 전용입니다. iOS 키오스크 모드는 기기의 Guided Access 기능을 사용하세요.
설치
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync 플러그인의 네이티브 code를 네이티브 프로젝트에 복사합니다. 플러그인을 업그레이드할 때마다 다시 실행하세요.
가져오기
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
API 한눈에 보기
| 메서드 | 설명 |
|---|---|
isInKioskMode |
앱이 현재 키오스크 모드로 실행 중인지 확인합니다. |
isSetAsLauncher |
앱이 기기 런처(홈 앱)로 설정되어 있는지 확인합니다. |
enterKioskMode |
키오스크 모드로 진입하여 시스템 UI를 숨기고 하드웨어 버튼을 차단합니다. 또한 포그라운드 keep-alive 서비스를 시작하여 시스템에 의해 앱이 종료될 가능성을 낮춥니다. 이 기능이 효과적으로 작동하려면 앱이 기기 런처로 설정되어 있어야 합니다. |
exitKioskMode |
키오스크 모드를 종료하고 일반 시스템 UI와 하드웨어 버튼 기능을 복구합니다. 또한 enterKioskMode()에서 시작된 포그라운드 keep-alive 서비스를 중지합니다. |
setAsLauncher |
사용자가 이 앱을 런처로 설정할 수 있도록 기기의 홈 화면 설정 페이지를 엽니다. 전체 키오스크 모드 기능을 사용하려면 이 설정이 반드시 필요합니다. |
setAllowedKeys |
키오스크 모드에서 작동을 허용할 하드웨어 키를 설정합니다. 기본적으로 키오스크 모드에서는 모든 하드웨어 키가 차단됩니다. |
예시
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를 숨기고 하드웨어 버튼을 차단합니다. 또한 포그라운드 keep-alive 서비스를 시작하여 시스템에 의해 앱이 종료될 가능성을 낮춥니다. 이 기능이 효과적으로 작동하려면 앱이 기기 런처로 설정되어 있어야 합니다.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
키오스크 모드를 종료하고 일반 시스템 UI와 하드웨어 버튼 기능을 복구합니다. 또한 enterKioskMode()에서 시작된 포그라운드 keep-alive 서비스를 중지합니다.
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
});
전체 레퍼런스
@capgo/capacitor-android-kiosk 사용법에서 계속하기
사용 중이라면 @capgo/capacitor-android-kiosk 사용하기 대시보드 및 API 운영을 계획하려면, 이를 다음과 연결하세요 @capgo/capacitor-android-kiosk 구현 세부 사항은 @capgo/capacitor-android-kiosk에서, 시작하기 Getting Started의 구현 상세 내용은 API 개요 구현 세부 사항은 API 개요에서 소개 Introduction의 구현 상세 내용은, 그리고 API 키 API Keys의 구현 상세 내용은