@ohos.enterprise.usbManager (USB Management)

The usbManager module provides APIs for USB management.

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.

The global restriction policy is provided by restrictions. To disable USB globally, see @ohos.enterprise.restrictions (restriction policy).

Modules to Import

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

usbManager.addAllowedUsbDevices

addAllowedUsbDevices(admin: Want, usbDeviceIds: Array<UsbDeviceId>): void

Adds allowed USB devices.

A policy conflict is reported when this API is called in the following scenarios:

1. The USB capability of the device has been disabled using the setDisallowedPolicy API.
2. The USB storage device access policy has been disabled using the setUsbStorageDeviceAccessPolicy API.
3. Disallowed USB device types have been added using the addDisallowedUsbDevices API.

Required permission: ohos.permission.ENTERPRISE_MANAGE_USB

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 {
  let usbDeviceIds: Array<usbManager.UsbDeviceId> = [{
      vendorId: 1,
      productId: 1
  }];
  usbManager.addAllowedUsbDevices(wantTemp, usbDeviceIds);
  console.info(`Succeeded in adding allowed USB devices.`);
} catch (err) {
  console.error(`Failed to add allowed USB devices. Code: ${err.code}, message: ${err.message}`);
}

usbManager.removeAllowedUsbDevices

removeAllowedUsbDevices(admin: Want, usbDeviceIds: Array<UsbDeviceId>): void

Removes allowed USB devices.

Required permission: ohos.permission.ENTERPRISE_MANAGE_USB

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 {
  let usbDeviceIds: Array<usbManager.UsbDeviceId> = [{
      vendorId: 1,
      productId: 1
  }];
  usbManager.removeAllowedUsbDevices(wantTemp, usbDeviceIds);
  console.info(`Succeeded in removing allowed USB devices.`);
} catch (err) {
  console.error(`Failed to remove allowed USB devices. Code: ${err.code}, message: ${err.message}`);
}

usbManager.getAllowedUsbDevices

getAllowedUsbDevices(admin: Want): Array<UsbDeviceId>

Obtains allowed USB devices.

Required permission: ohos.permission.ENTERPRISE_MANAGE_USB

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<usbManager.UsbDeviceId> = usbManager.getAllowedUsbDevices(wantTemp);
  console.info(`Succeeded in getting allowed USB devices. Result: ${JSON.stringify(result)}`);
} catch (err) {
  console.error(`Failed to get allowed USB devices. Code: ${err.code}, message: ${err.message}`);
}

usbManager.setUsbStorageDeviceAccessPolicy

setUsbStorageDeviceAccessPolicy(admin: Want, usbPolicy: UsbPolicy): void

Sets the access policy of the USB storage device.

A policy conflict occurs when you set the USB storage device access policy to read, write, or read-only in the following scenarios:

1. The USB capability of the device has been disabled through setDisallowedPolicy.
2. A USB storage device has been disallowed to use through addDisallowedUsbDevices.

A policy conflict is reported if the USB storage device access policy is disabled by calling this API in the following scenarios:

1. The USB capability of the device has been disabled through setDisallowedPolicy.
2. Allowed USB devices have been added through addAllowedUsbDevices.

You can disable a USB storage device by calling this API or addDisallowedUsbDevices. The latter is recommended.

Required permission: ohos.permission.ENTERPRISE_MANAGE_USB

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 {
  let policy: usbManager.UsbPolicy = usbManager.UsbPolicy.DISABLED;
  usbManager.setUsbStorageDeviceAccessPolicy(wantTemp, policy);
  console.info(`Succeeded in setting USB storage device access policy.`);
} catch (err) {
  console.error(`Failed to setting USB storage device access policy. Code: ${err.code}, message: ${err.message}`);
}

usbManager.getUsbStorageDeviceAccessPolicy

getUsbStorageDeviceAccessPolicy(admin: Want): UsbPolicy

Obtains the access policy of the USB storage device.

Required permission: ohos.permission.ENTERPRISE_MANAGE_USB

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: usbManager.UsbPolicy = usbManager.getUsbStorageDeviceAccessPolicy(wantTemp);
  console.info(`Succeeded in getting USB storage device access policy. Result: ${JSON.stringify(result)}`);
} catch (err) {
  console.error(`Failed togetting USB storage device access policy. Code: ${err.code}, message: ${err.message}`);
}

usbManager.addDisallowedUsbDevices¹⁴⁺

addDisallowedUsbDevices(admin: Want, usbDevices: Array<UsbDeviceType>): void

Adds disallowed USB device types.

A policy conflict is reported when this API is called in the following scenarios:

1. The USB capability of the device has been disabled through setDisallowedPolicy.
2. The available USB devices have been added through addAllowedUsbDevices.

Required permission: ohos.permission.ENTERPRISE_MANAGE_USB

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 {
  let usbDevices: Array<usbManager.UsbDeviceType> = [{
      baseClass: 8,
      subClass: 0,
      protocol: 0,
      descriptor: usbManager.Descriptor.INTERFACE
  }];
  usbManager.addDisallowedUsbDevices(wantTemp, usbDevices);
  console.info(`Succeeded in adding disallowed USB devices.`);
} catch (err) {
  console.error(`Failed to add disallowed USB devices. Code: ${err.code}, message: ${err.message}`);
}

usbManager.removeDisallowedUsbDevices¹⁴⁺

removeDisallowedUsbDevices(admin: Want, usbDevices: Array<UsbDeviceType>): void

Removes the disallowed USB device types.

Required permission: ohos.permission.ENTERPRISE_MANAGE_USB

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 {
  let usbDevices: Array<usbManager.UsbDeviceType> = [{
      baseClass: 8,
      subClass: 0,
      protocol: 0,
      descriptor: usbManager.Descriptor.INTERFACE
  }];
  usbManager.removeDisallowedUsbDevices(wantTemp, usbDevices);
  console.info(`Succeeded in removing disallowed USB devices.`);
} catch (err) {
  console.error(`Failed to remove disallowed USB devices. Code: ${err.code}, message: ${err.message}`);
}

usbManager.getDisallowedUsbDevices¹⁴⁺

getDisallowedUsbDevices(admin: Want): Array<UsbDeviceType>

Obtains the disallowed USB device types.

Required permission: ohos.permission.ENTERPRISE_MANAGE_USB

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<usbManager.UsbDeviceType> = usbManager.getDisallowedUsbDevices(wantTemp);
  console.info(`Succeeded in getting disallowed USB devices. Result: ${JSON.stringify(result)}`);
} catch (err) {
  console.error(`Failed to get disallowed USB devices. Code: ${err.code}, message: ${err.message}`);
}

UsbDeviceId

Represents the USB device identity information.

System capability: SystemCapability.Customization.EnterpriseDeviceManager

UsbDeviceType¹⁴⁺

Represents the USB device type information. For details about the ID, see defined-class-codes.

System capability: SystemCapability.Customization.EnterpriseDeviceManager

UsbPolicy

Enumerates the USB access policies.

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Descriptor¹⁴⁺

Enumerates USB descriptors.

System capability: SystemCapability.Customization.EnterpriseDeviceManager

你可能感兴趣的鸿蒙文章

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)