文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明
开发与测试开放能力API系统基础功能MDM Kit(企业设备管理服务)ArkTS API@ohos.enterprise.systemManager(系统管理)

@ohos.enterprise.systemManager(系统管理)

Phone12+PC/2in113+Tablet12+

本模块提供系统管理能力,包括NTP时间服务器设置、OTA升级策略管理、系统更新管理、按键事件处理策略、日志收集、设备激活锁管理等功能。适用于企业设备管理场景,帮助企业管理员统一管控设备系统配置、升级策略和安全策略,提升企业设备管理效率和安全性。

说明

本模块首批接口从API version 12开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

本模块接口仅对设备管理应用开放,且调用接口前需激活设备管理应用,具体请参考MDM Kit开发指南

导入模块

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';

systemManager.setNTPServer

Phone12+PC/2in113+Tablet12+

setNTPServer(admin: Want, server: string): void

设置NTP(Network Time Protocol)时间服务器。设置成功后,系统将使用指定的NTP服务器进行时间同步,校准系统时间。适用于企业设备需要统一时间同步的场景,确保企业设备时间与标准时间保持一致,避免因时间不准确导致的业务问题,如日志时间戳不一致、证书验证失败等。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 配置

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
server string NTP服务器地址(以","分隔,如"ntpserver1.com,ntpserver2.com"。最大长度96字节,包括null终止符(\0))。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let server: string = "ntpserver.com";
  10. try {
  11. systemManager.setNTPServer(wantTemp, server);
  12. console.info('Succeeded in setting NTPserver.');
  13. } catch (err) {
  14. console.error(`Failed to set ntp server. Code is ${err.code}, message is ${err.message}`);
  15. }

systemManager.getNTPServer

Phone12+PC/2in113+Tablet12+

getNTPServer(admin: Want): string

获取NTP时间服务器信息。适用于需要查询当前设备配置的NTP服务器地址的场景,用于验证时间同步配置是否正确,或在进行策略调整前获取当前配置。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
string string对象,返回NTP时间服务器信息。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let result: string = systemManager.getNTPServer(wantTemp);
  10. console.info(`Succeeded in getting NTP server. result: ${result}`);
  11. } catch (err) {
  12. console.error(`Failed to get ntp server. Code is ${err.code}, message is ${err.message}`);
  13. }

systemManager.setOtaUpdatePolicy

Phone12+PC/2in113+Tablet12+

setOtaUpdatePolicy(admin: Want, policy: OtaUpdatePolicy): void

设置升级策略。设置成功后,系统将按照指定的策略类型进行OTA升级处理,不同策略类型对应不同的升级行为。内网升级场景下,需要先调用systemManager.notifyUpdatePackages接口通知系统更新包,再调用该接口设置升级策略。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 独占

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
policy OtaUpdatePolicy 升级策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 默认升级策略
  9. let otaUpdatePolicy1: systemManager.OtaUpdatePolicy = {
  10. "policyType": systemManager.PolicyType.DEFAULT,
  11. "version": "version_1.0.0.0"
  12. };
  13. try {
  14. systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy1);
  15. console.info('Succeeded in setting ota update policy.');
  16. } catch (err) {
  17. console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
  18. }
  19. // 禁止升级
  20. let otaUpdatePolicy2: systemManager.OtaUpdatePolicy = {
  21. "policyType": systemManager.PolicyType.PROHIBIT,
  22. "version": "version_1.0.0.1"
  23. };
  24. try {
  25. systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy2);
  26. console.info('Succeeded in setting ota update policy.');
  27. } catch (err) {
  28. console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
  29. }
  30. // 强制升级
  31. let otaUpdatePolicy3: systemManager.OtaUpdatePolicy = {
  32. "policyType": systemManager.PolicyType.UPDATE_TO_SPECIFIC_VERSION,
  33. "version": "version_1.0.0.2",
  34. "latestUpdateTime": 1716343200 // 时间戳
  35. };
  36. try {
  37. systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy3);
  38. console.info('Succeeded in setting ota update policy.');
  39. } catch (err) {
  40. console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
  41. }
  42. // 指定时间窗口升级
  43. let otaUpdatePolicy4: systemManager.OtaUpdatePolicy = {
  44. "policyType": systemManager.PolicyType.WINDOWS,
  45. "version": "version_1.0.0.3",
  46. "installStartTime": 1716281049, // 时间戳
  47. "installEndTime": 1716343200 // 时间戳
  48. };
  49. try {
  50. systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy4);
  51. console.info('Succeeded in setting ota update policy.');
  52. } catch (err) {
  53. console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
  54. }
  55. // 延迟升级
  56. let otaUpdatePolicy5: systemManager.OtaUpdatePolicy = {
  57. "policyType": systemManager.PolicyType.POSTPONE,
  58. "version": "version_1.0.0.4",
  59. "delayUpdateTime": 5 // 单位(小时)
  60. };
  61. try {
  62. systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy5);
  63. console.info('Succeeded in setting ota update policy.');
  64. } catch (err) {
  65. console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
  66. }
  67. // 禁用公网升级
  68. let otaUpdatePolicy6: systemManager.OtaUpdatePolicy = {
  69. "policyType": systemManager.PolicyType.DEFAULT,
  70. "version": "version_1.0.0.5",
  71. "disableSystemOtaUpdate": true
  72. };
  73. try {
  74. systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy6);
  75. console.info('Succeeded in setting ota update policy.');
  76. } catch (err) {
  77. console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
  78. }

systemManager.getOtaUpdatePolicy

Phone12+PC/2in113+Tablet12+

getOtaUpdatePolicy(admin: Want): OtaUpdatePolicy

查询升级策略。适用于需要获取当前设备OTA升级策略配置的场景,用于验证策略是否正确下发,或在进行策略调整前获取当前策略配置。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
OtaUpdatePolicy OtaUpdatePolicy对象,返回升级策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let policy: systemManager.OtaUpdatePolicy = systemManager.getOtaUpdatePolicy(wantTemp);
  10. console.info(`Succeeded in getting update policy: ${JSON.stringify(policy)}`);
  11. } catch (err) {
  12. console.error(`Failed to get update policy. Code is ${err.code}, message is ${err.message}`);
  13. }

systemManager.notifyUpdatePackages

Phone12+PC/2in113+Tablet12+

notifyUpdatePackages(admin: Want, packageInfo: UpdatePackageInfo): Promise<void>

通知系统更新包信息。内网升级场景下,需要先调用该接口通知系统更新包,再调用systemManager.setOtaUpdatePolicy设置升级策略。使用Promise异步回调。

说明

该接口比较耗时,当调用此接口后,后续如果在应用主线程调用其他同步接口时需要等待该接口异步返回。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
packageInfo UpdatePackageInfo

系统更新包信息。

说明: 传入的UpdatePackageInfo.packages.path必须是“update”开头的zip压缩包,传入其他形式的文件会报9201004错误码。

返回值:

展开
类型 说明
Promise<void> 无返回结果的Promise对象。当通知系统更新包失败时会抛出错误对象。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9201004 The update packages do not exist or analyzing failed.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. import { Want } from '@kit.AbilityKit';
  4. import { fileIo } from '@kit.CoreFileKit';
  5. let wantTemp: Want = {
  6. // 需根据实际情况进行替换
  7. bundleName: 'com.example.myapplication',
  8. abilityName: 'EnterpriseAdminAbility'
  9. };
  10. let notify: systemManager.NotifyDescription = {
  11. // 需根据实际情况进行替换
  12. "installTips": "installTips",
  13. "installTipsDetail": "installTips detail"
  14. };
  15. let description: systemManager.PackageDescription = {
  16. // 需根据实际情况进行替换
  17. "notify": notify
  18. };
  19. let updatePackages: Array<systemManager.Package> = [];
  20. // 应用沙箱路径,需根据实际情况进行替换
  21. let fileDir = "/xxxx/xxxx/";
  22. let path1: string = "update_sd_base.zip";
  23. let path2: string = "update_sd_cust_xxxxx_all_cn.zip";
  24. let path3: string = "update_sd_preload_xxxxx_all_cn_R1.zip";
  25. let fd1: number = fileIo.openSync(fileDir + path1, fileIo.OpenMode.READ_ONLY).fd;
  26. let fd2: number = fileIo.openSync(fileDir + "xxxxx/" + path2, fileIo.OpenMode.READ_ONLY).fd;
  27. let fd3: number = fileIo.openSync(fileDir + "xxxxx/" + path3, fileIo.OpenMode.READ_ONLY).fd;
  28. let package1: systemManager.Package = {
  29. // 需根据实际情况进行替换
  30. "type": systemManager.PackageType.FIRMWARE,
  31. "path": path1,
  32. "fd": fd1
  33. };
  34. let package2: systemManager.Package = {
  35. // 需根据实际情况进行替换
  36. "type": systemManager.PackageType.FIRMWARE,
  37. "path": path2,
  38. "fd": fd2
  39. };
  40. let package3: systemManager.Package = {
  41. // 需根据实际情况进行替换
  42. "type": systemManager.PackageType.FIRMWARE,
  43. "path": path3,
  44. "fd": fd3
  45. };
  46. updatePackages.push(package1);
  47. updatePackages.push(package2);
  48. updatePackages.push(package3);
  49. let updatePackageInfo: systemManager.UpdatePackageInfo = {
  50. // 需根据实际情况进行替换
  51. "version" : "1.0",
  52. "packages" : updatePackages,
  53. "description" : description
  54. };
  55. systemManager.notifyUpdatePackages(wantTemp, updatePackageInfo).then(() => {
  56. console.info('Succeeded in notifying update packages.');
  57. }).catch ((error: BusinessError) => {
  58. console.error(`Failed to notify update packages. Code is ${error.code},message is ${error.message}`);
  59. });

systemManager.getUpdateResult

Phone12+PC/2in113+Tablet12+

getUpdateResult(admin: Want, version: string): Promise<UpdateResult>

获取系统更新结果。使用Promise异步回调。适用于需要检查系统更新是否成功的场景,帮助企业管理员了解设备升级状态,及时处理更新失败的情况,确保设备系统版本符合企业要求。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
version string 更新包版本号。

返回值:

展开
类型 说明
Promise<UpdateResult> Promise对象,返回系统更新结果。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. import { Want } from '@kit.AbilityKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. systemManager.getUpdateResult(wantTemp, "1.0").then((result:systemManager.UpdateResult) => {
  10. console.info(`Succeeded in getting update result: ${JSON.stringify(result)}`);
  11. }).catch((error: BusinessError) => {
  12. console.error(`Get update result failed. Code is ${error.code},message is ${error.message}`);
  13. });

systemManager.getUpdateAuthData19+

Phone19+PC/2in119+Tablet19+

getUpdateAuthData(admin: Want): Promise<string>

获取系统更新的鉴权数据,用于校验系统更新信息。使用Promise异步回调。适用于内网升级场景,企业管理员可以通过鉴权数据验证系统更新包的合法性和完整性,防止恶意更新包,提升系统安全性。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
Promise<string> Promise对象,返回系统更新的鉴权数据。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. import { Want } from '@kit.AbilityKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. systemManager.getUpdateAuthData(wantTemp).then((result: string) => {
  10. console.info(`Succeeded in getting update auth data: ${JSON.stringify(result)}`);
  11. }).catch((error: BusinessError) => {
  12. console.error(`Get update auth data failed. Code is ${error.code},message is ${error.message}`);
  13. });

systemManager.setOtaUpdateNonceEnable

PC/2in126.0.0+

setOtaUpdateNonceEnable(admin: Want, isEnable: boolean): void

设置OTA更新时Nonce的启用状态(默认为启用状态)。启用后,系统将在OTA更新过程中校验Nonce的有效性,从而防止重放攻击,提升系统安全性。

说明

为保障系统安全,若非内网升级等特殊业务需求,不建议禁用Nonce校验。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1企业设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 配置

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
isEnable boolean true表示启用OTA更新Nonce,false表示禁用OTA更新Nonce。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200016 Service timeout.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let isEnable: boolean = true;
  10. try {
  11. systemManager.setOtaUpdateNonceEnable(wantTemp, isEnable);
  12. console.info('Succeeded in setting OTA update Nonce enable.');
  13. } catch (err) {
  14. console.error(`Failed to set OTA update Nonce enable. Code is ${err.code}, message is ${err.message}`);
  15. }

systemManager.isOtaUpdateNonceEnable

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

isOtaUpdateNonceEnable(admin: Want): boolean

查询OTA更新Nonce是否启用。适用于需要验证设备OTA更新安全配置的场景,帮助企业管理员确认Nonce校验功能状态,保障系统更新安全性。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 配置

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
boolean 返回true表示OTA更新Nonce已启用,返回false表示OTA更新Nonce已禁用。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200016 Service timeout.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let result: boolean = systemManager.isOtaUpdateNonceEnable(wantTemp);
  10. console.info(`Succeeded in querying OTA update Nonce enable: ${result}`);
  11. } catch (err) {
  12. console.error(`Failed to query OTA update Nonce enable. Code is ${err.code}, message is ${err.message}`);
  13. }

systemManager.addDisallowedNearLinkProtocols20+

PC/2in120+

addDisallowedNearLinkProtocols(admin: Want, protocols: Array<NearLinkProtocol>, accountId: number): void

为指定用户添加禁用的星闪协议名单。NearLink Kit(星闪服务)提供一种低功耗、高速率的短距离通信服务,支持星闪设备之间的连接、数据交互。具体请参考NearLink Kit。本接口对键盘、手写笔等系统服务和系统应用不生效。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 合并

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
protocols Array<NearLinkProtocol> 星闪协议列表。
accountId number

用户ID,取值范围:大于等于0。

accountId可以通过getOsAccountLocalId等接口来获取。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let protocols: systemManager.NearLinkProtocol[] = [systemManager.NearLinkProtocol.SSAP,
  10. systemManager.NearLinkProtocol.DATA_TRANSFER];
  11. // 需根据实际情况进行替换
  12. let accountId: number = 100;
  13. try {
  14. systemManager.addDisallowedNearLinkProtocols(wantTemp, protocols, accountId);
  15. console.info('Succeeded in adding the disabled Starlink protocol list for the specified user.');
  16. } catch (err) {
  17. console.error(`Failed to add the disabled Starlink protocol list for the specified user. Code is ${err.code}, message is ${err.message}`);
  18. }

systemManager.removeDisallowedNearLinkProtocols20+

PC/2in120+

removeDisallowedNearLinkProtocols(admin: Want, protocols: Array<NearLinkProtocol>, accountId: number): void

为指定用户移除禁用的星闪协议名单。移除成功后,指定用户可以重新使用移除列表中的星闪协议进行通信,恢复相应的协议连接能力。使用场景:在企业设备管理场景下,管理员可通过此接口移除之前设置的星闪协议禁用策略,允许用户恢复使用星闪协议进行设备间通信。适用于需要恢复特定用户星闪通信能力的场景,帮助企业管理员灵活调整用户设备的星闪协议访问权限,满足不同业务场景的通信需求。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 合并

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
protocols Array<NearLinkProtocol> 星闪协议列表。
accountId number

用户ID,取值范围:大于等于0。

accountId可以通过getOsAccountLocalId等接口来获取。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let protocols: systemManager.NearLinkProtocol[] = [systemManager.NearLinkProtocol.SSAP,
  10. systemManager.NearLinkProtocol.DATA_TRANSFER];
  11. // 需根据实际情况进行替换
  12. let accountId: number = 100;
  13. try {
  14. systemManager.removeDisallowedNearLinkProtocols(wantTemp, protocols, accountId);
  15. console.info('Succeeded in removing the disabled Starlink protocol list for the specified user.');
  16. } catch (err) {
  17. console.error(`Failed to remove the disabled Starlink protocol list for the specified user. Code is ${err.code}, message is ${err.message}`);
  18. }

systemManager.getDisallowedNearLinkProtocols20+

PC/2in120+

getDisallowedNearLinkProtocols(admin: Want, accountId: number): Array<NearLinkProtocol>

获取指定用户下禁用的星闪协议名单。适用于需要查询用户当前星闪协议访问限制的场景,帮助企业管理员验证策略是否正确下发,或在进行策略调整前获取当前配置。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
accountId number

用户ID,取值范围:大于等于0。

accountId可以通过getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
Array<NearLinkProtocol> 指定用户下禁用的星闪协议名单。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let accountId: number = 100;
  10. try {
  11. let result: systemManager.NearLinkProtocol[] = systemManager.getDisallowedNearLinkProtocols(wantTemp, accountId);
  12. console.info(`Succeeded in querying the disabled Starlink protocol list for the specified user: ${result}`);
  13. } catch (err) {
  14. console.error(`Failed to query the disabled Starlink protocol list for the specified user. Code is ${err.code}, message is ${err.message}`);
  15. }

systemManager.setInstallLocalEnterpriseAppEnabled20+

PC/2in120+

setInstallLocalEnterpriseAppEnabled(admin: Want, isEnable: boolean): void

设置是否支持本地安装企业应用。设置为支持安装后,具备本地安装能力的PC/2in1企业设备可本地双击应用安装包,安装签名证书分发类型为enterprise_normal的企业应用。调用此接口前,此设备必须通过HEM商用部署

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1企业设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 从严管控。任意一个MDM应用设置支持本地安装企业应用,则综合策略即为支持本地安装企业应用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
isEnable boolean 是否支持本地安装企业应用。true表示支持,false表示不支持。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let isEnable: boolean = true;
  10. try {
  11. systemManager.setInstallLocalEnterpriseAppEnabled(wantTemp, isEnable);
  12. console.info('Succeeded in setting InstallLocalEnterpriseAppEnabled.');
  13. } catch (err) {
  14. console.error(`Failed to set installLocalEnterpriseAppEnabled. Code is ${err.code}, message is ${err.message}`);
  15. }

systemManager.getInstallLocalEnterpriseAppEnabled20+

PC/2in120+

getInstallLocalEnterpriseAppEnabled(admin: Want | null): boolean

查询是否支持本地安装企业应用。适用于需要验证设备本地安装企业应用功能是否开启的场景,帮助企业管理员确认策略配置状态,确保设备能够正常安装企业应用。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1企业设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null

企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

API version 24之前,调用本接口查询系统当前是否支持本地安装企业应用。当设备存在多个MDM应用时,传入admin查询对应admin设置的策略。从API version 24开始,admin新增支持传入null,传入null时查询整机实际生效的策略。

返回值:

展开
类型 说明
boolean 是否支持本地安装企业应用,true为支持,false为不支持。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let isEnable: boolean = systemManager.getInstallLocalEnterpriseAppEnabled(wantTemp);
  10. console.info('Succeeded in getting installLocalEnterpriseAppEnabled.');
  11. } catch (err) {
  12. console.error(`Failed to get installLocalEnterpriseAppEnabled. Code is ${err.code}, message is ${err.message}`);
  13. }

systemManager.setAutoUnlockAfterReboot20+

PC/2in120+

setAutoUnlockAfterReboot(admin: Want, isAllowed: boolean): void

设置设备重启自动解锁,仅针对无锁屏密码设备生效。适用于企业无人值守设备或需要快速重启恢复服务的场景,避免因手动解锁导致的设备停机时间,提升设备运维效率和业务连续性。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 从严管控,任意一个MDM应用设置设备重启自动解锁,则综合策略即为设备重启自动解锁。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
isAllowed boolean true表示设备重启后自动解锁,false表示设备重启后不自动解锁。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { systemManager } from '@kit.MDMKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. let isAllowed: boolean = true;
  9. try {
  10. systemManager.setAutoUnlockAfterReboot(wantTemp, isAllowed);
  11. console.info('Succeeded in setting setAutoUnlockAfterReboot.');
  12. } catch (err) {
  13. console.error(`Failed to set auto unlock after reboot. Code is ${err.code}, message is ${err.message}`);
  14. }

systemManager.getAutoUnlockAfterReboot20+

PC/2in120+

getAutoUnlockAfterReboot(admin: Want): boolean

获取设备是否重启自动解锁。适用于需要验证设备重启解锁策略是否正确配置的场景,帮助企业管理员确认设备自动解锁功能状态。

本接口通过传入Want查询对应企业设备管理应用设置的策略,如需查询实际生效的策略,请使用systemManager.getAutoUnlockAfterReboot接口。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
boolean 返回true表示设备重启后自动解锁,返回false表示设备重启后不自动解锁。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { systemManager } from '@kit.MDMKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let result: boolean = systemManager.getAutoUnlockAfterReboot(wantTemp);
  10. console.info(`Succeeded in getting auto unlock after reboot. result: ${result}`);
  11. } catch (err) {
  12. console.error(`Failed to get auto unlock after reboot. Code is ${err.code}, message is ${err.message}`);
  13. }

systemManager.getAutoUnlockAfterReboot

PC/2in126.0.0+

getAutoUnlockAfterReboot(admin: Want | null): boolean

获取设备是否重启自动解锁。适用于需要验证设备重启解锁策略是否正确配置的场景,帮助企业管理员确认设备自动解锁功能状态。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null

企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

当设备存在多个MDM应用时,传入Want时查询对应企业设备管理应用设置的策略,传入null时查询实际生效的策略。

返回值:

展开
类型 说明
boolean 返回true表示设备重启后自动解锁,返回false表示设备重启后不自动解锁。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. try {
  3. // 参数需根据实际情况进行替换
  4. systemManager.getAutoUnlockAfterReboot(null);
  5. console.info('Succeeded in getting auto unlock after reboot.');
  6. } catch (err) {
  7. console.error(`Failed to get auto unlock after reboot. Code is ${err.code}, message is ${err.message}`);
  8. }

systemManager.addKeyEventPolicies23+

Phone23+Tablet23+

addKeyEventPolicies(admin: Want, keyPolicies: Array<KeyEventPolicy>): void

添加按键事件处理策略。系统触发按键事件时,若匹配下发的按键事件策略,将通过EnterpriseAdminExtensionAbility.onKeyEvent回调通知MDM应用,并携带匹配策略的按键事件信息。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在Phone和Tablet设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
keyPolicies Array<KeyEventPolicy> 按键策略。支持物理按键(电源键、音量加、音量减),导航键(回退、主页、最近打开)。物理键支持任意组合为组合键,导航键不支持组合。组合键事件响应详见按键事件回调onKeyEvent接口。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200010 A conflict policy has been configured.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { systemManager } from '@kit.MDMKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. let keypolicy: Array<systemManager.KeyEventPolicy> = [
  9. {
  10. "keyCode": systemManager.KeyCode.POWER,
  11. "keyPolicy": systemManager.KeyPolicy.CUSTOM
  12. },
  13. {
  14. "keyCode": systemManager.KeyCode.VOLUME_UP,
  15. "keyPolicy": systemManager.KeyPolicy.CUSTOM
  16. }
  17. ];
  18. try {
  19. systemManager.addKeyEventPolicies(wantTemp, keypolicy);
  20. console.info('Succeeded in adding key event policies.');
  21. } catch (err) {
  22. console.error(`Failed to add key event policies. Code is ${err.code}, message is ${err.message}`);
  23. }

systemManager.removeKeyEventPolicies23+

Phone23+Tablet23+

removeKeyEventPolicies(admin: Want, keyCodes: Array<KeyCode>): void

删除按键事件处理策略。删除成功后,系统将恢复对指定按键事件的默认处理行为。适用于需要恢复按键默认行为的场景,帮助企业管理员灵活调整设备按键响应策略,满足不同业务场景的需求。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在Phone和Tablet设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
keyCodes Array<KeyCode> 按键编码。支持一次删除多条按键策略,删除不支持按键时返回9200012错误码。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { systemManager } from '@kit.MDMKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. let keyCodes: Array<systemManager.KeyCode> = [
  9. systemManager.KeyCode.POWER, systemManager.KeyCode.VOLUME_UP
  10. ];
  11. try {
  12. systemManager.removeKeyEventPolicies(wantTemp, keyCodes);
  13. console.info('Succeeded in removing key event policies.');
  14. } catch (err) {
  15. console.error(`Failed to remove key event policies. Code is ${err.code}, message is ${err.message}`);
  16. }

systemManager.getKeyEventPolicies23+

Phone23+Tablet23+

getKeyEventPolicies(admin: Want): Array<KeyEventPolicy>

获取按键事件处理策略。适用于需要查询当前按键事件处理策略配置的场景,帮助企业管理员验证策略是否正确下发,或在进行策略调整前获取当前配置。

本接口通过传入Want查询对应企业设备管理应用设置的策略,如需查询实际生效的策略,请使用systemManager.getKeyEventPolicies接口。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在Phone和Tablet设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
Array<KeyEventPolicy> 返回当前配置的按键事件策略列表。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { systemManager } from '@kit.MDMKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. let result: Array<systemManager.KeyEventPolicy> = [];
  9. try {
  10. result = systemManager.getKeyEventPolicies(wantTemp);
  11. console.info('Succeeded in getting key event policies.');
  12. } catch (err) {
  13. console.error(`Failed to get key event policies. Code is ${err.code}, message is ${err.message}`);
  14. }

systemManager.getKeyEventPolicies

Phone26.0.0+Tablet26.0.0+

getKeyEventPolicies(admin: Want | null): Array<KeyEventPolicy>

获取按键事件处理策略。适用于需要查询当前按键事件处理策略配置的场景,帮助企业管理员验证策略是否正确下发,或在进行策略调整前获取当前配置。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在Phone和Tablet设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null

企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

当设备存在多个MDM应用时,传入Want时查询对应企业设备管理应用设置的策略,传入null时查询实际生效的策略。

返回值:

展开
类型 说明
Array<KeyEventPolicy> 返回当前配置的按键事件策略列表。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. let result: Array<systemManager.KeyEventPolicy> = [];
  3. try {
  4. // 参数需根据实际情况进行替换
  5. result = systemManager.getKeyEventPolicies(null);
  6. console.info('Succeeded in getting key event policies.');
  7. } catch (err) {
  8. console.error(`Failed to get key event policies. Code is ${err.code}, message is ${err.message}`);
  9. }

systemManager.startCollectLog23+

PC/2in123+

startCollectLog(admin: Want): Promise<void>

开始收集设备上已生成并存储至硬盘的FaultType类型的faultlog日志,不支持收集未存储至硬盘的faultlog日志、应用业务日志和系统运行日志。使用Promise异步回调。

  • 调用接口后,系统会启动一个日志收集任务,任务启动后接口立即返回。任务可能会因为系统性能等原因导致收集失败。
  • 允许多个MDM应用调用,不同MDM应用在不同用户下收集的日志分开保存,互不影响。同一时间只允许一个MDM应用启动日志收集任务,在任务执行完成前调用本接口会返回错误码9201009,任务执行完成后,允许其他MDM应用调用。
  • 任务执行完成后,通过EnterpriseAdminExtensionAbility.onLogCollected回调函数通知给MDM应用,系统将已收集的日志文件挂载到MDM应用沙箱路径,MDM应用可以在回调函数中读取已收集的日志。
  • 如果日志收集任务执行超过5分钟,EnterpriseAdminExtensionAbility.onLogCollected回调函数会返回日志收集任务失败。
  • 应用取走日志后,建议调用systemManager.finishLogCollected删除已收集到的日志。

需要权限: ohos.permission.ENTERPRISE_READ_LOG

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 允许多个MDM应用调用,不同MDM应用在不同用户下收集的日志分开保存,互不影响。同一时间只允许一个MDM应用启动日志收集任务,在任务执行完成前调用本接口会返回错误码9201009,任务执行完成后,允许其他MDM应用调用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
Promise<void> 无返回结果的Promise对象。当收集日志任务创建失败时,会抛出错误对象。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9201009 Collecting logs, please try again later.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. import { systemManager } from '@kit.MDMKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. systemManager.startCollectLog(wantTemp).then(() => {
  10. console.info('Succeeded in starting collect log');
  11. }).catch((err: BusinessError) => {
  12. console.error(`Failed to start collect log. Code: ${err.code}, message: ${err.message}`);
  13. });

systemManager.finishLogCollected23+

PC/2in123+

finishLogCollected(admin: Want): void

删除本MDM应用在当前用户下收集到的设备日志。

说明

在应用调用startCollectLog开始收集日志后,收到EnterpriseAdminExtensionAbility.onLogCollected回调时,建议立即拷贝或者处理日志,并调用此接口删除收集到的日志。

若不调用本接口,设备日志会占用系统存储空间,不影响下一次调用startCollectLog启动日志收集任务。

需要权限: ohos.permission.ENTERPRISE_READ_LOG

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { systemManager } from '@kit.MDMKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. systemManager.finishLogCollected(wantTemp);
  10. console.info('Succeeded in finishing log collected.');
  11. } catch (err) {
  12. console.error(`Failed to finish log collected. Code is ${err.code}, message is ${err.message}`);
  13. }

systemManager.setActivationLockDisabled24+

PC/2in124+

setActivationLockDisabled(admin: Want, isDisabled: boolean, credential?: string): Promise<void>

禁用/启用设备激活锁。使用Promise异步回调。设备激活锁被禁用后,将无法使用查找设备功能。该功能只适用于特定设备(只支持PC/2in1企业设备)。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 配置

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
isDisabled boolean 是否禁用激活锁。true表示禁用,false表示启用。
credential string 禁用凭据。当设置禁用时该参数必须填写有效凭据,设置启用时为空。

返回值:

展开
类型 说明
Promise<void> 无返回结果的Promise对象。当设置禁用/启用失败时,会抛出错误对象。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
9200016 Service timeout.
9201011 The credential of the activation lock is invalid.
9201012 Failed to enable or disable the activation lock.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. import { systemManager } from '@kit.MDMKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. // 需根据实际情况进行替换
  10. let credential: string = "XXX";
  11. let isDisabled: boolean = true;
  12. systemManager.setActivationLockDisabled(wantTemp, isDisabled, credential).then(() => {
  13. console.info('Succeeded in setting activation lock status.');
  14. }).catch((err: BusinessError) => {
  15. console.error(`Failed to set activation lock status. Code: ${err.code}, message: ${err.message}`);
  16. });

systemManager.isActivationLockDisabled24+

PC/2in124+

isActivationLockDisabled(admin: Want): Promise<boolean>

获取设备激活锁禁用状态。使用Promise异步回调。适用于需要验证设备激活锁功能状态的场景,帮助企业管理员确认设备的安全配置,特别是在设备转让或回收时需要了解激活锁状态。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
Promise<boolean> Promise对象,返回当前设备激活锁的禁用状态。返回true表示设备激活锁处于禁用状态,查找设备功能无法使用;返回false表示设备激活锁处于启用状态,可以正常使用设备查找功能。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200016 Service timeout.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. import { systemManager } from '@kit.MDMKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. systemManager.isActivationLockDisabled(wantTemp).then(result => {
  10. console.info(`Succeeded in getting activation lock status: ${JSON.stringify(result)}`);
  11. }).catch((err: BusinessError) => {
  12. console.error(`Failed to set activation lock status. Code: ${err.code}, message: ${err.message}`);
  13. });

systemManager.setInstallLocalEnterpriseAppEnabledForAccount24+

PC/2in124+

setInstallLocalEnterpriseAppEnabledForAccount(admin: Want, isEnable: boolean, accountId: number): void

设置指定用户下是否支持本地安装企业应用。在具备本地安装能力的PC/2in1企业设备上下发支持本地企业应用策略后,用户可以在桌面或者文件管理器直接双击企业应用安装包,即可直接安装企业应用。调用此接口前,此设备必须通过HEM商用部署

仅支持enterprise_normal或enterprise_mdm签名类型的企业应用。

说明

满足以下任意条件,PC/2in1企业设备在当前用户下即支持本地安装企业应用:

  1. 已通过setInstallLocalEnterpriseAppEnabled开启离线安装器;
  2. 已通过本接口设置当前用户支持本地安装企业应用。

本地安装能力依赖华为应用市场。仅7.2.1.300及以上版本的应用市场支持安装MDM应用(分发类型为enterprise_mdm的应用);仅7.1.6.300及以上版本的应用市场支持普通企业应用(分发类型为enterprise_normal的应用)。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1企业设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 从严管控。任意一个MDM应用设置支持本地安装企业应用,则综合策略即为支持本地安装企业应用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
isEnable boolean 是否支持本地安装企业应用。true表示支持,false表示不支持。
accountId number

用户ID,取值范围:大于等于0。

accountId可以通过getOsAccountLocalId等接口来获取。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let isEnable: boolean = true;
  10. let accountId: number = 100;
  11. try {
  12. systemManager.setInstallLocalEnterpriseAppEnabledForAccount(wantTemp, isEnable, accountId);
  13. console.info('Succeeded in setting InstallLocalEnterpriseAppEnabledForAccount.');
  14. } catch (err) {
  15. console.error(`Failed to set installLocalEnterpriseAppEnabledForAccount. Code is ${err.code}, message is ${err.message}`);
  16. }

systemManager.getInstallLocalEnterpriseAppEnabledForAccount24+

PC/2in124+

getInstallLocalEnterpriseAppEnabledForAccount(admin: Want | null, accountId: number): boolean

查询指定用户是否支持本地安装企业应用。适用于需要验证特定用户本地安装企业应用功能是否开启的场景,帮助企业管理员确认策略配置状态,确保用户能够正常安装企业应用。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1企业设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null

企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

当设备存在多个MDM应用时,传入admin查询对应admin设置的策略。传入null时查询整机实际生效的策略。

accountId number

用户ID,取值范围:大于等于0。

accountId可以通过getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
boolean 是否支持本地安装企业应用,true为支持,false为不支持。当admin为null时,查询系统当前是否支持本地安装企业应用。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { systemManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let accountId: number = 100;
  10. try {
  11. let isEnable: boolean = systemManager.getInstallLocalEnterpriseAppEnabledForAccount(wantTemp, accountId);
  12. console.info('Succeeded in getting installLocalEnterpriseAppEnabled.');
  13. } catch (err) {
  14. console.error(`Failed to get installLocalEnterpriseAppEnabled. Code is ${err.code}, message is ${err.message}`);
  15. }

SystemUpdateInfo

Phone12+PC/2in113+Tablet12+

待更新的系统版本信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
versionName string 待更新的系统版本名称。
firstReceivedTime number 第一次收到系统更新包的时间(单位:秒)。
packageType string 待更新的系统更新包类型,类型分为normal和patch类型。

OtaUpdatePolicy

Phone12+PC/2in113+Tablet12+

升级策略。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
policyType PolicyType 表示升级策略类型。
version string 表示待升级软件版本号。
latestUpdateTime number 表示最晚升级时间(时间戳)。
delayUpdateTime number 表示延迟升级时间(单位:小时)。
installStartTime number 表示指定安装窗口起始时间(时间戳)。
installEndTime number 表示指定安装窗口结束时间(时间戳)。
disableSystemOtaUpdate20+ boolean 表示是否禁用在公网环境下升级。true表示禁用公网升级,false表示不禁用公网升级。如果作为systemManager.setOtaUpdatePolicy的入参,该字段可缺省,缺省时保持当前配置不变。当前配置可通过systemManager.getOtaUpdatePolicy接口获取。禁用公网升级后,可以采用内网升级。推荐使用restrictions.setDisallowedPolicy禁用公网升级。

PolicyType

Phone12+PC/2in113+Tablet12+

升级策略类型枚举。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
DEFAULT 0 默认升级策略。周期弹框提醒用户升级。周期从24小时开始逐渐延长。
PROHIBIT 1 禁止升级策略。
UPDATE_TO_SPECIFIC_VERSION 2 强制升级策略。需指定最晚升级时间(latestUpdateTime)参数。1. 距离最晚升级时间大于48小时未升级,提醒弹框每24小时常规提醒一次。2. 距离最晚升级时间小于48小时未升级,每隔X小时周期提醒安装升级,消息处于通知中心,且不可移除。3. 超过最晚升级时间还未升级,弹出闲时强制升级提醒。
WINDOWS 3 指定时间窗口升级策略。需指定时间窗口参数(installStartTime、installEndTime)。时间窗口必须大于5分钟。1. 配置时间窗口[A,B],获取到窗口中的随机升级时间C,到达时间后满足空闲条件,自动升级。2. 配置时间窗口[A,B],获取到窗口中的随机升级时间C,到达时间后不满足空闲条件,B-C大于半小时,在C和B之间重新刷新一个随机时间D,到达D时间后满足空闲条件,自动升级。3. 配置时间窗口[A,B],获取到窗口中的随机升级时间C,到达时间后不满足空闲条件,B-C大于半小时,在C和B之间重新刷新一个随机时间D,到达D时间后不满足空闲条件,24小时后再检测,即窗口任务推迟到下一个[A,B]窗口。4. 配置时间[A,B],获取到窗口中的随机升级时间C,到达时间后不满足空闲条件,B-C小于或等于半小时,24小时后再检测,即窗口任务推迟到下一个[A,B]窗口。
POSTPONE 4 延迟升级策略。延迟指定时间(delayUpdateTime)后进入DEFAULT模式,周期提示用户升级。

UpdatePackageInfo

Phone12+PC/2in113+Tablet12+

系统更新包信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
version string 系统更新包版本号。
packages Array<Package> 系统更新包详情。
description PackageDescription 系统更新包描述信息。
authInfo19+ string 系统更新包的鉴权信息。

Package

Phone12+PC/2in113+Tablet12+

系统更新包详情。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
type PackageType 系统更新包类型。
path string 系统更新包文件路径。若传入fd参数,该参数传入更新包文件名。
fd number 系统更新包文件句柄。当前不支持只传入path参数,需要传入fd。

PackageDescription

Phone12+PC/2in113+Tablet12+

系统更新包描述信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
notify NotifyDescription 企业自定义更新通知说明。

NotifyDescription

Phone12+PC/2in113+Tablet12+

企业自定义更新通知说明。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
installTips string 企业自定义更新提示。
installTipsDetail string 企业自定义更新提示详情。

UpdateResult

Phone12+PC/2in113+Tablet12+

系统更新结果信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
version string 系统当前版本号。
status UpdateStatus 系统更新状态。
errorInfo ErrorInfo 系统更新错误信息。

ErrorInfo

Phone12+PC/2in113+Tablet12+

系统更新错误信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
code number 错误码。
message string 错误描述信息。

PackageType

Phone12+PC/2in113+Tablet12+

系统更新包类型。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
FIRMWARE 1 固件。

UpdateStatus

Phone12+PC/2in113+Tablet12+

系统更新状态。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
NO_UPDATE_PACKAGE -4 指定版本系统更新包不存在。
UPDATE_WAITING -3 系统更新包等待安装中。
UPDATING -2 正在更新。
UPDATE_FAILURE -1 更新失败。
UPDATE_SUCCESS 0 更新成功。

NearLinkProtocol20+

Phone20+PC/2in120+Tablet20+

星闪协议枚举。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
SSAP 0 SSAP(SparkLink Service Access Protocol)协议。具体请参考SSAP协议
DATA_TRANSFER 1 数据传输协议。具体请参考Data Transfer协议

KeyEventPolicy23+

Phone23+PC/2in123+Tablet23+

按键事件处理策略。按键事件发生时,仅拦截响应已下发按键事件处理策略的按键。对于未下发按键事件处理策略的按键事件,系统执行原先的响应逻辑。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
keyCode KeyCode 按键编码。
keyPolicy KeyPolicy 按键策略。

KeyCode23+

Phone23+PC/2in123+Tablet23+

按键编码。添加按键事件处理策略addKeyEventPolicies、删除按键事件处理策略removeKeyEventPolicies、获取按键事件处理策略getKeyEventPolicies和按键事件回调onKeyEvent接口通过按键编码映射到设备对应实际按键。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
POWER 0 电源键。
VOLUME_UP 1 音量加。
VOLUME_DOWN 2 音量减。
BACK 3 导航键-回退。
HOME 4 导航键-主页。
RECENT 5 导航键-最近打开。

KeyPolicy23+

Phone23+PC/2in123+Tablet23+

按键策略。MDM应用下发按键策略的按键编码与系统按键事件匹配后的系统行为。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
INTERCEPTION 0 拦截消息。设置后仅会拦截当前按键事件,系统不会再处理该事件,按键回调接口也不会响应按键事件。例如:下发电源键拦截策略后,按电源键无任何响应,无法关机,无法锁屏,仅影响开机状态下电源键事件,关机时可通过电源键正常开机。
CUSTOM 1 拦截并转发消息。 设置后会拦截当前按键事件,系统不会再处理该事件,同时通过EnterpriseAdminExtensionAbility.onKeyEvent回调接口将发生的按键事件通知给MDM应用,通知MDM应用处理该事件的过程不会阻塞系统后续的其他事件处理。

KeyEvent23+

Phone23+PC/2in123+Tablet23+

按键事件。EnterpriseAdminExtensionAbility.onKeyEvent按键事件回调触发时,传递当前按键事件信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
keyCode KeyCode 按键编码。
keyAction KeyAction 按键动作。
actionTime number 按键动作发生时间,系统开机后微秒级时间戳。当按键长按时后续按键事件该参数不发生改变,应用可以通过该时间来判断该事件是否属于长按事件,以执行长按事件逻辑处理。
keyItems Array<KeyItem> 其他按键信息,当前按键事件发生时,其他正在被按下的按键信息。

KeyAction23+

Phone23+PC/2in123+Tablet23+

按键动作。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
UNKNOWN -1 除按下和抬起动作以外,其他按键动作。
DOWN 0 按键按下动作。
UP 1 按键抬起动作。

KeyItem23+

Phone23+PC/2in123+Tablet23+

其他按键信息。当前KeyCode事件发生时,其他已被按下的按键信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
keyCode KeyCode 按键编码。
pressed boolean 按键动作。按键是否被按下。true:按下;false:抬起
downTime number 按键动作发生时间,系统开机后微秒级时间戳。导航按键不支持组合扩展,发生时间显示为0。
在 开发与测试 开放能力API 中进行搜索
请输入您想要搜索的关键词