@ohos.enterprise.restrictions （限制类策略）(系统接口)

本模块提供设置通用限制类策略能力，包括禁用或启用设备打印、HDC等能力。

说明：

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

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

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

本模块接口均为系统接口。

导入模块

import restrictions from '@ohos.enterprise.restrictions';

restrictions.setPrinterDisabled

setPrinterDisabled(admin: Want, disabled: boolean, callback: AsyncCallback<void>): void

指定设备管理应用使设备禁用或启用打印能力。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_RESTRICT_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

restrictions.setPrinterDisabled(wantTemp, true, (err) => {
  if (err) {
    console.error(`Failed to set printer disabled. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in setting printer disabled');
})

restrictions.setPrinterDisabled

setPrinterDisabled(admin: Want, disabled: boolean): Promise<void>

指定设备管理应用使设备禁用或启用打印能力。使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_RESTRICT_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

restrictions.setPrinterDisabled(wantTemp, true).then(() => {
  console.info('Succeeded in setting printer disabled');
}).catch((err: BusinessError) => {
  console.error(`Failed to set printer disabled. Code is ${err.code}, message is ${err.message}`);
})

restrictions.isPrinterDisabled

isPrinterDisabled(admin: Want, callback: AsyncCallback<boolean>): void

指定设备管理应用查询设备打印能力是否被禁用。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_RESTRICT_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

restrictions.isPrinterDisabled(wantTemp, (err, result) => {
  if (err) {
    console.error(`Failed to query is the printing function disabled or not. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in querying is the printing function disabled : ${result}`);
})

restrictions.isPrinterDisabled

isPrinterDisabled(admin: Want): Promise<boolean>

指定设备管理应用查询设备打印能力是否被禁用。使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_RESTRICT_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

restrictions.isPrinterDisabled(wantTemp).then((result) => {
  console.info(`Succeeded in querying is the printing function disabled : ${result}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to query is the printing function disabled or not. Code is ${err.code}, message is ${err.message}`);
})

restrictions.setHdcDisabled

setHdcDisabled(admin: Want, disabled: boolean, callback: AsyncCallback<void>): void

指定设备管理应用使设备禁用或启用HDC。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_RESTRICT_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

restrictions.setHdcDisabled(wantTemp, true, (err) => {
  if (err) {
    console.error(`Failed to set hdc disabled. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in setting hdc disabled');
})

restrictions.setHdcDisabled

setHdcDisabled(admin: Want, disabled: boolean): Promise<void>

指定设备管理应用使设备禁用或启用HDC。使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_RESTRICT_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

restrictions.setHdcDisabled(wantTemp, true).then(() => {
  console.info('Succeeded in setting hdc disabled');
}).catch((err: BusinessError) => {
  console.error(`Failed to set hdc disabled. Code is ${err.code}, message is ${err.message}`);
})

restrictions.isHdcDisabled

isHdcDisabled(admin: Want, callback: AsyncCallback<boolean>): void

指定设备管理应用查询HDC是否被禁用。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_RESTRICT_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

restrictions.isHdcDisabled(wantTemp, (err, result) => {
  if (err) {
    console.error(`Failed to query is hdc disabled or not. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in querying is hdc disabled : ${result}`);
})

restrictions.isHdcDisabled

isHdcDisabled(admin: Want): Promise<boolean>

指定设备管理应用查询HDC是否被禁用。使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_RESTRICT_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

restrictions.isHdcDisabled(wantTemp).then((result) => {
  console.info(`Succeeded in querying is hdc disabled : ${result}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to query is hdc disabled or not. Code is ${err.code}, message is ${err.message}`);
})

restrictions.isMicrophoneDisabled¹¹⁺

isMicrophoneDisabled(admin: Want): boolean

指定设备管理应用查询麦克风是否被禁用。

需要权限： ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

try {
  let result = restrictions.isMicrophoneDisabled(wantTemp);
  console.info(`Succeeded in querying is microphone disabled : ${result}`);
} catch (err) {
  console.error(`Failed to query is microphone disabled or not. Code is ${err.code}, message is ${err.message}`);
}

restrictions.disableMicrophone¹¹⁺

disableMicrophone(admin: Want, disable: boolean): void

指定设备管理应用使设备禁用或启用麦克风。

需要权限： ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

try {
  restrictions.disableMicrophone(wantTemp, true);
  console.info('Succeeded in setting microphone disabled');
} catch (err) {
  console.error(`Failed to disable microphone. Code is ${err.code}, message is ${err.message}`);
}

restrictions.setFingerprintAuthDisabled¹¹⁺

setFingerprintAuthDisabled(admin: Want, disabled: boolean): void

以同步方法指定设备管理应用禁用或启用指纹认证。

需要权限： ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';

let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

try {
  restrictions.setFingerprintAuthDisabled(wantTemp, true);
  console.info('Succeeded in disabling the fingerprint auth');
} catch (err) {
  console.error(`Failed to disable fingerprint auth. Code: ${err.code}, message: ${err.message}`);
};

restrictions.isFingerprintAuthDisabled¹¹⁺

isFingerprintAuthDisabled(admin: Want): boolean

以同步方法指定设备管理应用查询指纹认证是否被禁用。

需要权限： ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';

let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

try {
  let result: boolean = restrictions.isFingerprintAuthDisabled(wantTemp);
  console.info(`Succeeded in getting the state of fingerprint auth. result : ${result}`);
} catch (err) {
  console.error(`Failed to get the state of fingerprint auth. Code: ${err.code}, message: ${err.message}`);
};