@ohos.enterprise.usbManager（USB管理）

本模块提供USB管理能力。

说明：

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

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

本模块接口仅对设备管理应用开放，且调用接口前需激活设备管理应用，具体请参考MDM Kit开发指南。

全局通用限制类策略由restrictions统一提供，若要全局禁用USB，请参考@ohos.enterprise.restrictions（限制类策略）。

导入模块

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

usbManager.addAllowedUsbDevices

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

添加USB设备可用白名单。

以下情况下，调用本接口会报策略冲突：

1. 已经通过setDisallowedPolicy接口禁用了设备USB能力。
2. 已经通过setUsbStorageDeviceAccessPolicy接口设置了USB存储设备访问策略为禁用。
3. 已经通过addDisallowedUsbDevices接口添加了禁止使用的USB设备类型。

需要权限： ohos.permission.ENTERPRISE_MANAGE_USB

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

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

移除USB设备可用白名单。

需要权限： ohos.permission.ENTERPRISE_MANAGE_USB

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

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>

获取USB设备可用白名单。

需要权限： ohos.permission.ENTERPRISE_MANAGE_USB

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

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

设置USB存储设备访问策略。

以下情况下，通过本接口设置USB存储设备访问策略为可读可写/只读，会报策略冲突：

1. 已经通过setDisallowedPolicy接口禁用了设备USB能力。
2. 已经通过addDisallowedUsbDevices接口将存储类型的USB设备添加为禁止使用的USB设备类型。

以下情况下，通过本接口设置USB存储设备访问策略为禁用，会报策略冲突：

1. 已经通过setDisallowedPolicy接口禁用了设备USB能力。
2. 已经通过addAllowedUsbDevices接口添加了USB设备可用白名单。

通过本接口设置，或者通过addDisallowedUsbDevices接口添加存储类型的USB设备，均可禁用USB存储设备。推荐使用后者。

需要权限： ohos.permission.ENTERPRISE_MANAGE_USB

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

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 set USB storage device access policy. Code: ${err.code}, message: ${err.message}`);
}

usbManager.getUsbStorageDeviceAccessPolicy

getUsbStorageDeviceAccessPolicy(admin: Want): UsbPolicy

获取USB存储设备访问策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_USB

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

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 to get USB storage device access policy. Code: ${err.code}, message: ${err.message}`);
}

usbManager.addDisallowedUsbDevices¹⁴⁺

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

添加禁止使用的USB设备类型。

以下情况下，调用本接口会报策略冲突：

1. 已经通过setDisallowedPolicy接口禁用了设备USB能力。
2. 已经通过addAllowedUsbDevices接口添加了USB设备可用白名单。

需要权限： ohos.permission.ENTERPRISE_MANAGE_USB

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

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

移除禁止使用的USB设备类型。

需要权限： ohos.permission.ENTERPRISE_MANAGE_USB

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

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

示例：

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>

获取禁止使用的USB设备类型。

需要权限： ohos.permission.ENTERPRISE_MANAGE_USB

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

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

示例：

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

USB设备ID信息。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

UsbDeviceType¹⁴⁺

USB设备类型信息。其中具体编号可查询：defined-class-codes。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

UsbPolicy

USB读写策略的枚举。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

Descriptor¹⁴⁺

USB描述符的枚举。

系统能力： 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（蓝牙管理）(系统接口)