@ohos.enterprise.restrictions (Restrictions) (System API)

This restrictions module provides APIs for setting general restriction policies, including disabling or enabling the printer and OpenHarmony Device Connector (hdc) for devices.

NOTE

The initial APIs of this module are supported since API version 10. 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.

This topic describes only the system APIs provided by the module. For details about its public APIs, see @ohos.enterprise.restrictions.

Modules to Import

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

restrictions.setPrinterDisabled

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

Enables or disables the printing capability of the device. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.ENTERPRISE_RESTRICT_POLICY

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',
};

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>

Enables or disables the printing capability of the device. This API uses a promise to return the result.

Required permissions: ohos.permission.ENTERPRISE_RESTRICT_POLICY

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';
import { BusinessError } from '@kit.BasicServicesKit';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

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

Queries whether the printing capability of a device is disabled. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.ENTERPRISE_RESTRICT_POLICY

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',
};

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>

Queries whether the printing capability of a device is disabled. This API uses a promise to return the result.

Required permissions: ohos.permission.ENTERPRISE_RESTRICT_POLICY

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';
import { BusinessError } from '@kit.BasicServicesKit';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

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

Enables or disables HDC. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.ENTERPRISE_RESTRICT_POLICY

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',
};

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>

Enables or disables HDC on a device. This API uses a promise to return the result.

Required permissions: ohos.permission.ENTERPRISE_RESTRICT_POLICY

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';
import { BusinessError } from '@kit.BasicServicesKit';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

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

Queries whether HDC is disabled. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.ENTERPRISE_RESTRICT_POLICY

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',
};

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>

Queries whether HDC is disabled. This API uses a promise to return the result.

Required permissions: ohos.permission.ENTERPRISE_RESTRICT_POLICY

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';
import { BusinessError } from '@kit.BasicServicesKit';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

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

Queries whether the microphone is disabled.

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 = 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

Enables or disables the microphone.

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';
import { BusinessError } from '@kit.BasicServicesKit';
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

Enables or disables fingerprint authentication.

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.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

Queries whether fingerprint authentication is disabled.

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.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}`);
};

你可能感兴趣的鸿蒙文章

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)