• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.enterprise.usbManager (USB管理)
2
3本模块提供USB管理能力。
4
5> **说明**:
6>
7> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8>
9> 本模块接口仅可在Stage模型下使用。
10>
11> 本模块接口仅对[设备管理应用](enterpriseDeviceManagement-overview.md#基本概念)开放,需将[设备管理应用激活](js-apis-enterprise-adminManager.md#adminmanagerenableadmin)后调用,实现相应功能。
12
13## 导入模块
14
15```ts
16import usbManager from '@ohos.enterprise.usbManager';
17```
18
19## usbManager.setUsbPolicy
20
21setUsbPolicy(admin: Want, usbPolicy: UsbPolicy, callback: AsyncCallback\<void>): void
22
23指定设备管理应用设置USB的读写策略。使用callback异步回调。
24
25**需要权限:** ohos.permission.ENTERPRISE_MANAGE_USB
26
27**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
28
29**系统API**: 此接口为系统接口。
30
31**参数:**
32
33| 参数名   | 类型                                  | 必填   | 说明      |
34| ----- | ----------------------------------- | ---- | ------- |
35| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
36| usbPolicy  | [UsbPolicy](#usbpolicy) | 是 | USB读写策略。 |
37| callback | AsyncCallback\<void> | 是 | 回调函数。当接口调用成功,err为null,否则为错误对象。 |
38
39**错误码**:
40
41以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
42
43| 错误码ID | 错误信息                                                                      |
44| ------- | ---------------------------------------------------------------------------- |
45| 9200001 | the application is not an administrator of the device.                       |
46| 9200002 | the administrator application does not have permission to manage the device. |
47
48**示例:**
49
50```ts
51import Want from '@ohos.app.ability.Want';
52let wantTemp: Want = {
53  bundleName: 'bundleName',
54  abilityName: 'abilityName',
55};
56let policy: usbManager.UsbPolicy = usbManager.UsbPolicy.READ_WRITE
57
58usbManager.setUsbPolicy(wantTemp, policy, (err) => {
59  if (err) {
60    console.error(`Failed to set usb policy. Code is ${err.code}, message is ${err.message}`);
61    return;
62  }
63  console.info('Succeeded in setting usb policy');
64})
65```
66
67## usbManager.setUsbPolicy
68
69setUsbPolicy(admin: Want, usbPolicy: UsbPolicy): Promise\<void>
70
71指定设备管理应用设置USB的读写策略。使用Promise异步回调。
72
73**需要权限:** ohos.permission.ENTERPRISE_MANAGE_USB
74
75**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
76
77**系统API**: 此接口为系统接口。
78
79**参数:**
80
81| 参数名   | 类型                                  | 必填   | 说明      |
82| ----- | ----------------------------------- | ---- | ------- |
83| admin | [Want](js-apis-app-ability-want.md) | 是    | 设备管理应用。 |
84| usbPolicy  | [UsbPolicy](#usbpolicy) | 是 | USB读写策略。 |
85
86**返回值:**
87
88| 类型   | 说明                                  |
89| ----- | ----------------------------------- |
90| Promise\<void> | 无返回结果的Promise对象。当指定设备管理应用设置USB策略失败时抛出错误对象。 |
91
92**错误码**:
93
94以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
95
96| 错误码ID | 错误信息                                                                      |
97| ------- | ---------------------------------------------------------------------------- |
98| 9200001 | the application is not an administrator of the device.                        |
99| 9200002 | the administrator application does not have permission to manage the device. |
100
101**示例:**
102
103```ts
104import Want from '@ohos.app.ability.Want';
105import { BusinessError } from '@ohos.base';
106let wantTemp: Want = {
107  bundleName: 'bundleName',
108  abilityName: 'abilityName',
109};
110let policy: usbManager.UsbPolicy = usbManager.UsbPolicy.READ_WRITE
111
112usbManager.setUsbPolicy(wantTemp, policy).then(() => {
113  console.info('Succeeded in setting usb policy');
114}).catch((err: BusinessError) => {
115  console.error(`Failed to set usb policy. Code is ${err.code}, message is ${err.message}`);
116})
117```
118
119## UsbPolicy
120
121USB读写策略的枚举。
122
123**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
124
125**系统API**: 此接口为系统接口。
126
127| 名称 | 值 | 说明 |
128| -------- | -------- | -------- |
129| READ_WRITE | 0 | 可读可写。 |
130| READ_ONLY | 1 | 只读。 |
131