@ohos.enterprise.deviceSettings （设备设置管理）(系统接口)

本模块提供企业设备设置能力，包括获取设备息屏时间等。

说明：

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

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

本模块接口仅对设备管理应用开放，需将设备管理应用激活后调用。

当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.enterprise.deviceSettings。

导入模块

import { deviceSettings } from '@kit.MDMKit';

deviceSettings.setScreenOffTime¹¹⁺

setScreenOffTime(admin: Want, time: number): void

设置设备息屏时间。

需要权限： ohos.permission.ENTERPRISE_SET_SCREENOFF_TIME

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
try {
  deviceSettings.setScreenOffTime(wantTemp, 30000);
  console.info(`Succeeded in setting screen off time`);
} catch(err) {
  console.error(`Failed to set screen off time. Code: ${err.code}, message: ${err.message}`);
}

deviceSettings.getScreenOffTime

getScreenOffTime(admin: Want, callback: AsyncCallback<number>): void

获取设备息屏时间，使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_GET_SETTINGS

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

deviceSettings.getScreenOffTime(wantTemp, (err, result) => {
  if (err) {
    console.error(`Failed to get screen off time. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in getting screen off time, result : ${result}`);
});

deviceSettings.getScreenOffTime

getScreenOffTime(admin: Want): Promise<number>

获取设备息屏时间，使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_GET_SETTINGS

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import { Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

deviceSettings.getScreenOffTime(wantTemp).then((result) => {
  console.info(`Succeeded in getting screen off time, result : ${result}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get screen off time. Code: ${err.code}, message: ${err.message}`);
});

deviceSettings.installUserCertificate

installUserCertificate(admin: Want, certificate: CertBlob, callback: AsyncCallback<string>): void

安装用户证书，使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let certFileArray: Uint8Array = new Uint8Array();
// The variable context needs to be initialized in MainAbility's onCreate callback function
// test.cer needs to be placed in the rawfile directory
const context = this.getUIContext().getHostContext() as common.UIAbilityContext;
context.resourceManager.getRawFileContent("test.cer").then((value) => {
  certFileArray = value;
  deviceSettings.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" }, (err, result) => {
    if (err) {
      console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`);
    } else {
      console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`);
    }
  });
}).catch((error: BusinessError) => {
  console.error(`Failed to get row file content. message: ${error.message}`);
  return;
});

deviceSettings.installUserCertificate

installUserCertificate(admin: Want, certificate: CertBlob): Promise<string>

安装用户证书，使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let certFileArray: Uint8Array = new Uint8Array();
// The variable context needs to be initialized in MainAbility's onCreate callback function
// test.cer needs to be placed in the rawfile directory
const context = this.getUIContext().getHostContext() as common.UIAbilityContext;
context.resourceManager.getRawFileContent("test.cer").then((value) => {
  certFileArray = value
  deviceSettings.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" })
    .then((result) => {
      console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`);
    }).catch((err: BusinessError) => {
    console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`);
  })
}).catch((error: BusinessError) => {
  console.error(`Failed to get row file content. message: ${error.message}`);
  return;
});

CertBlob

证书信息。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

deviceSettings.uninstallUserCertificate

uninstallUserCertificate(admin: Want, certUri: string, callback: AsyncCallback<void>): void

卸载用户证书，使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let aliasStr = "certName"
deviceSettings.uninstallUserCertificate(wantTemp, aliasStr, (err) => {
  if (err) {
    console.error(`Failed to uninstall user certificate. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in uninstalling user certificate`);
});

deviceSettings.uninstallUserCertificate

uninstallUserCertificate(admin: Want, certUri: string): Promise<void>

卸载用户证书，使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import { Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let aliasStr = "certName"
deviceSettings.uninstallUserCertificate(wantTemp, aliasStr).then(() => {
  console.info(`Succeeded in uninstalling user certificate`);
}).catch((err: BusinessError) => {
  console.error(`Failed to uninstall user certificate. Code is ${err.code}, message is ${err.message}`);
});

deviceSettings.setPowerPolicy¹¹⁺

setPowerPolicy(admin: Want, powerScene: PowerScene, powerPolicy: PowerPolicy): void

设置电源策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SETTINGS

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
try {
  let delayTime = 0;
  let powerScene: deviceSettings.PowerScene = deviceSettings.PowerScene.TIME_OUT;
  let powerPolicyAction: deviceSettings.PowerPolicyAction = deviceSettings.PowerPolicyAction.AUTO_SUSPEND;
  let powerPolicy: deviceSettings.PowerPolicy = {powerPolicyAction, delayTime};
  deviceSettings.setPowerPolicy(wantTemp, powerScene, powerPolicy);
  console.info(`Succeeded in setting power polilcy`);
} catch (err) {
  console.error(`Failed to set power policy. Code: ${err.code}, message: ${err.message}`);
}

deviceSettings.getPowerPolicy¹¹⁺

getPowerPolicy(admin: Want, powerScene: PowerScene): PowerPolicy

获取电源策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SETTINGS

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
try {
  let powerScene: deviceSettings.PowerScene = deviceSettings.PowerScene.TIME_OUT;
  let powerPolicy: deviceSettings.PowerPolicy = deviceSettings.getPowerPolicy(wantTemp, powerScene);
  console.info(`Succeeded in getting power polilcy ${JSON.stringify(powerPolicy)}`);
} catch (err) {
  console.error(`Failed to get power policy. Code: ${err.code}, message: ${err.message}`);
}

PowerPolicy¹¹⁺

电源策略。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

PowerScene¹¹⁺

执行电源策略的场景。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

PowerPolicyAction¹¹⁺

执行电源策略的动作。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Mdm Kit（企业设备管理服务）

harmony 鸿蒙企业设备管理错误码

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility（企业设备管理扩展能力）

harmony 鸿蒙@ohos.enterprise.accountManager（账户管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.accountManager（账户管理）

harmony 鸿蒙@ohos.enterprise.adminManager（企业设备管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.adminManager (admin权限管理)

harmony 鸿蒙@ohos.enterprise.applicationManager（应用管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.applicationManager（应用管理）

harmony 鸿蒙@ohos.enterprise.bluetoothManager（蓝牙管理）(系统接口)