• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.kioskManager (Kiosk模式管理)(系统接口)
2<!--Kit: Ability Kit-->
3<!--Subsystem: Ability-->
4<!--Owner: @zhu-feimo-->
5<!--Designer: @ccllee1-->
6<!--Tester: @lixueqing513-->
7<!--Adviser: @huipeizi-->
8
9KioskManager模块提供Kiosk模式管理能力,包括系统进入/退出Kiosk模式操作、查询当前系统Kiosk模式状态。
10
11Kiosk模式是一种特殊的设备锁定模式,可以确保设备界面只服务于特定的交互场景。在这种模式下,用户只能使用特定的应用。例如,在银行ATM机上,用户只能通过ATM软件进行交易操作,而不能退出该软件或切换到其他应用。
12
13> **说明:**
14>
15> - 本模块首批接口从API version 20开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
16> - 本模块接口仅可在Stage模型下使用。
17> - 当前页面仅包含本模块的系统接口,其他公开接口参见[@ohos.app.ability.kioskManager (Kiosk模式管理)](js-apis-app-ability-kioskManager.md)。
18
19## 导入模块
20
21```ts
22import { kioskManager } from '@kit.AbilityKit';
23```
24
25## kioskManager.getKioskStatus
26
27getKioskStatus(): Promise&lt;KioskStatus&gt;
28
29获取系统Kiosk模式的状态信息(包括当前系统是否处于Kiosk模式、进入Kiosk模式应用的名称和UID。)使用Promise异步回调。
30
31**系统能力**: SystemCapability.Ability.AbilityRuntime.Core
32
33**系统接口:** 此接口为系统接口。
34
35**返回值:**
36
37| 类型 | 说明 |
38|------|------|
39| Promise&lt;[KioskStatus](./js-apis-app-ability-kioskManager.md#kioskstatus20)&gt; | Promise对象,返回当前Kiosk状态信息。 |
40
41**错误码**:
42
43以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](errorcode-ability.md)。
44
45| 错误码ID | 错误信息 |
46|---------|---------|
47| 202 | Not system application. |
48| 801 | Capability not supported. |
49| 16000050 | Internal error. |
50
51**示例**:
52
53```ts
54import { kioskManager } from '@kit.AbilityKit';
55import { hilog } from '@kit.PerformanceAnalysisKit';
56import { BusinessError } from '@kit.BasicServicesKit';
57
58@Entry
59@Component
60struct Index {
61  build() {
62    Column() {
63      Button('getKioskinfo').margin({ top: 10 })
64        .onClick(() => {
65          kioskManager.getKioskStatus()
66            .then((data: kioskManager.KioskStatus) => {
67              hilog.info(0x0000, 'testTag', '%{public}s', `getKioskinfo success: ${JSON.stringify(data)}`);
68            })
69            .catch((error: BusinessError) => {
70              hilog.error(0x0000, 'testTag', '%{public}s', `getKioskinfo failed:${JSON.stringify(error)}`);
71            });
72        })
73    }
74    .height('100%')
75    .width('100%')
76  }
77}
78```
79