跳过主要内容
返回到插件
@capgo/capacitor-android-kiosk
教程
@capgo/capacitor-android-kiosk

Android Kiosk

使用启动器功能和硬件键控制将Android设备锁定到kiosk模式

指南

安卓锁屏插件教程

使用@capgo/capacitor-android-kiosk

Capacitor安卓锁屏插件,用于控制锁屏模式和启动器功能。该插件仅适用于安卓。若要在iOS上使用锁屏模式,请使用设备的引导访问功能。

安装

bun add @capgo/capacitor-android-kiosk
bunx cap sync

此插件暴露的内容

  • isInKioskMode - 检查应用是否当前正在锁屏模式下运行。
  • isSetAsLauncher - 检查应用是否设置为设备启动器(主屏幕应用)。
  • enterKioskMode - 进入屏幕保护模式,隐藏系统UI并阻止硬件按钮。同时启动前台保持服务,以减少系统杀死应用的可能性。应用必须设置为设备启动器,才能有效工作。
  • exitKioskMode - 退出屏幕保护模式,恢复正常的系统UI和硬件按钮功能。同时停止前台保持服务,启动时enterKioskMode()中启动的。

- 示例用法

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');

- 全部参考

- 从使用@capgo/capacitor-android-kiosk继续

If you are using 使用 @capgo/capacitor-android-kiosk 为了规划仪表板和 @API 操作,连接它与 @capgo/capacitor-android-kiosk 查看 @capgo/capacitor-android-kiosk 的实现细节 开始 查看开始的实现细节 @API 概述 查看 @API 概述的实现细节 介绍 查看介绍的实现细节 @API 密钥 为 API 的实现细节提供 API Keys。