@ohos.enterprise.restrictions (Restrictions)

This restrictions module provides APIs for disallowing general features of devices. You can globally disable or enable the features such as Bluetooth, HDC, USB, and Wi-Fi.

NOTE

The initial APIs of this module are supported since API version 12. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs of this module can be used only in the stage model.

The APIs of this module can be called only by a device administrator application that is enabled.

Modules to Import

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

restrictions.setDisallowedPolicy

setDisallowedPolicy(admin: Want, feature: string, disallow: boolean): void

Disallows a feature.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS or ohos.permission.PERSONAL_MANAGE_RESTRICTIONS¹⁵⁺

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Error codes

For details about the error codes, see Enterprise Device Management Error Codes and Universal Error Codes.

Example

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

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

restrictions.getDisallowedPolicy

getDisallowedPolicy(admin: Want, feature: string): boolean

Obtains a disabled feature.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS or ohos.permission.PERSONAL_MANAGE_RESTRICTIONS¹⁵⁺

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Return value

Error codes

For details about the error codes, see Enterprise Device Management Error Codes and Universal Error Codes.

Example

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

try {
  let result: boolean = restrictions.getDisallowedPolicy(wantTemp, 'printer');
  console.info(`Succeeded in querying is the printing function disabled : ${result}`);
} catch (err) {
  console.error(`Failed to set printer disabled. Code is ${err.code}, message is ${err.message}`);
}

restrictions.setDisallowedPolicyForAccount¹⁴⁺

setDisallowedPolicyForAccount(admin: Want, feature: string, disallow: boolean, accountId: number): void

Enables or disables a feature of a specified user.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Error codes

For details about the error codes, see Enterprise Device Management Error Codes and Universal Error Codes.

Example

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

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

restrictions.getDisallowedPolicyForAccount¹⁴⁺

getDisallowedPolicyForAccount(admin: Want, feature: string, accountId: number): boolean

Obtains the status of a feature of a specified user.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Return value

Error codes

For details about the error codes, see Enterprise Device Management Error Codes and Universal Error Codes.

Example

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

try {
  let result: boolean = restrictions.getDisallowedPolicyForAccount(wantTemp, 'fingerprint', 100);
  console.info(`Succeeded in querying is the fingerprint function disabled : ${result}`);
} catch (err) {
  console.error(`Failed to set fingerprint disabled. Code is ${err.code}, message is ${err.message}`);
}

restrictions.addDisallowedListForAccount¹⁴⁺

addDisallowedListForAccount(admin: Want, feature: string, list: Array<string>, accountId: number): void

Add a list of applications that are not allowed to use a feature for a specified user.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Error codes

For details about the error codes, see Enterprise Device Management Error Codes and Universal Error Codes.

Example

import { Want } from '@kit.AbilityKit';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let valueList:Array<string> = ["com.xx.aa.", "com.xx.bb"];
try {
  restrictions.addDisallowedListForAccount(wantTemp, 'snapshotSkip', valueList, 100);
  console.info('Succeeded in adding disallowed snapshotSkip feature');
} catch (err) {
  console.error(`Failed to add disallowed snapshotSkip feature. Code is ${err.code}, message is ${err.message}`);
}

restrictions.removeDisallowedListForAccount¹⁴⁺

removeDisallowedListForAccount(admin: Want, feature: string, list: Array<string>, accountId: number): void

Removes a list of applications that are not allowed to use a feature for a specified user.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Error codes

For details about the error codes, see Enterprise Device Management Error Codes and Universal Error Codes.

Example

import { Want } from '@kit.AbilityKit';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let valueList:Array<string> = ["com.xx.aa.", "com.xx.bb"];
try {
  restrictions.removeDisallowedListForAccount(wantTemp, 'snapshotSkip', valueList, 100);
  console.info('Succeeded in removing disallowed snapshotSkip feature');
} catch (err) {
  console.error(`Failed to remove disallowed snapshotSkip feature. Code is ${err.code}, message is ${err.message}`);
}

restrictions.getDisallowedListForAccount¹⁴⁺

getDisallowedListForAccount(admin: Want, feature: string, accountId: number): Array<string>

Obtains the list of applications that are not allowed to use a feature for a specified user.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Return value

Error codes

For details about the error codes, see Enterprise Device Management Error Codes and Universal Error Codes.

Example

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

try {
  let result: Array<string> = restrictions.getDisallowedListForAccount(wantTemp, 'snapshotSkip', 100);
  console.info('Succeeded in querying disallowed list for account');
} catch (err) {
  console.error(`Failed to query disallowed list for account. Code is ${err.code}, message is ${err.message}`);
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙MDM Kit

harmony 鸿蒙Enterprise Device Management Error Codes

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)

harmony 鸿蒙@ohos.enterprise.accountManager (Account Management) (System API)

harmony 鸿蒙@ohos.enterprise.accountManager (Account Management)

harmony 鸿蒙@ohos.enterprise.adminManager (Enterprise Device Management) (System API)

harmony 鸿蒙@ohos.enterprise.adminManager (Enterprise Device Management)

harmony 鸿蒙@ohos.enterprise.applicationManager (Application Management (System API)

harmony 鸿蒙@ohos.enterprise.applicationManager (Application Management)

harmony 鸿蒙@ohos.enterprise.bluetoothManager (Bluetooth Management) (System API)