js-apis-device-manager.md 51.6 KB
Newer Older
1
# @ohos.distributedHardware.deviceManager (设备管理)
Z
zengyawen 已提交
2

3 4 5 6 7 8 9 10 11
本模块提供分布式设备管理能力。

系统应用可调用接口实现如下功能:

- 注册和解除注册设备上下线变化监听
- 发现周边不可信设备
- 认证和取消认证设备
- 查询可信设备列表
- 查询本地设备信息,包括设备名称,设备类型和设备标识
S
summer8999 已提交
12
- 发布设备发现
S
summer8999 已提交
13

14 15
> **说明:**
>
16 17
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口,三方应用不支持调用。
Z
zengyawen 已提交
18

Z
zengyawen 已提交
19 20

## 导入模块
Z
zengyawen 已提交
21

22
```js
Z
zengyawen 已提交
23 24 25 26
import deviceManager from '@ohos.distributedHardware.deviceManager';
```


Z
zengyawen 已提交
27 28 29
## deviceManager.createDeviceManager

createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager>): void
Z
zengyawen 已提交
30 31

创建一个设备管理器实例。
32 33 34

**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
35
**参数:**
@
@shi-xiaoxiao-iris 已提交
36

37 38 39 40
| 参数名     | 类型                                                 | 必填 | 说明                                                        |
| ---------- | ---------------------------------------------------- | ---- | ----------------------------------------------------------- |
| bundleName | string                                               | 是   | 指示应用程序的Bundle名称。                                  |
| callback   | AsyncCallback<[DeviceManager](#devicemanager)> | 是   | DeviceManager实例创建时调用的回调,返回设备管理器对象实例。 |
Z
zengyawen 已提交
41

@
@shi-xiaoxiao-iris 已提交
42
**错误码:**
@
@shi-xiaoxiao-iris 已提交
43

@
@shi-xiaoxiao-iris 已提交
44
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
45

@
@shi-xiaoxiao-iris 已提交
46
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
47 48 49
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600102 | Failed to obtain the service.                                   |
@
@shi-xiaoxiao-iris 已提交
50

@
@shi-xiaoxiao-iris 已提交
51
**示例:**
@
@shi-xiaoxiao-iris 已提交
52

53 54 55
  ```js
  try {
    deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => {
Z
zengyawen 已提交
56
      if (err) { 
57
        console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message);
58
        return;
Z
zengyawen 已提交
59 60
      }
      console.info("createDeviceManager success");
H
HelloCrease 已提交
61
      let dmInstance = data;
62 63
    });
  } catch(err) {
64
    console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message);
65
  }
Z
zengyawen 已提交
66 67
  ```

68
## DeviceInfo
Z
zengyawen 已提交
69

70
设备信息。
Z
zengyawen 已提交
71

72 73
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
74
| 名称                     | 类型                        | 必填   | 说明       |
H
HelloCrease 已提交
75 76 77 78 79
| ---------------------- | ------------------------- | ---- | -------- |
| deviceId               | string                    | 是    | 设备的唯一标识。 |
| deviceName             | string                    | 是    | 设备名称。    |
| deviceType             | [DeviceType](#devicetype) | 是    | 设备类型。    |
| networkId<sup>8+</sup> | string                    | 是    | 设备网络标识。  |
S
summer8999 已提交
80
| range<sup>9+</sup>     | number                    | 是    | 发现设备的距离。  |
W
wangxuanxuan 已提交
81
| authForm<sup>10+</sup> | [AuthForm](#authform)     | 是    | 设备认证类型  |
Z
zengyawen 已提交
82 83

## DeviceType
Z
zengyawen 已提交
84 85 86

表示设备类型的枚举类。

87 88
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
89
| 名称           | 值  | 说明   |
H
HelloCrease 已提交
90 91 92 93 94 95 96 97
| ------------ | ---- | ---- |
| SPEAKER      | 0x0A | 智能音箱 |
| PHONE        | 0x0E | 手机   |
| TABLET       | 0x11 | 平板   |
| WEARABLE     | 0x6D | 智能穿戴 |
| TV           | 0x9C | 智慧屏  |
| CAR          | 0x83 | 车    |
| UNKNOWN_TYPE | 0    | 未知设备 |
98

W
wuqi0105 已提交
99
## AuthForm<sup>10+</sup>
W
wangxuanxuan 已提交
100 101 102 103 104 105 106 107 108 109 110

表示设备认证类型的枚举类。

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

| 名称                 | 值  | 说明             |
| ------------------- | ---- | --------------- |
| INVALID_TYPE        | -1   | 设备没有认证 |
| PEER_TO_PEER        | 0    | 无账号设备点对点认证   |
| IDENTICAL_ACCOUNT   | 1    | 设备同账号认证   |
| ACROSS_ACCOUNT      | 2    | 设备跨账号认证 |
Z
zengyawen 已提交
111

112
## DeviceStateChangeAction
Z
zengyawen 已提交
113

114 115 116 117
表示设备状态变化的枚举。

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
118
| 名称      | 值  | 说明              |
H
HelloCrease 已提交
119
| ------- | ---- | --------------- |
S
summer8999 已提交
120 121 122
| ONLINE  | 0    | 设备物理上线状态。           |
| READY   | 1    | 设备可用状态,表示设备间信息已在分布式数据中同步完成, 可以运行分布式业务。 |
| OFFLINE | 2    | 设备物理下线状态。           |
H
HelloCrease 已提交
123
| CHANGE  | 3    | 设备信息更改。         |
124 125 126 127

## SubscribeInfo

发现信息。
Z
zengyawen 已提交
128

129 130
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
131
| 名称            | 类型                                | 必填   | 说明                |
H
HelloCrease 已提交
132 133
| ------------- | --------------------------------- | ---- | ----------------- |
| subscribeId   | number                            | 是    | 发现标识,用于标识不同的发现周期。 |
W
wuqi0105 已提交
134 135 136 137 138 139
| mode          | [DiscoverMode ](#discovermode)    | 是    | 发现模式。             |
| medium        | [ExchangeMedium](#exchangemedium) | 是    | 发现类型。             |
| freq          | [ExchangeFreq](#exchangefreq)     | 是    | 发现频率。             |
| isSameAccount | boolean                           | 是    | 是否同帐号。            |
| isWakeRemote  | boolean                           | 是    | 是否唤醒设备。           |
| capability    | [SubscribeCap](#subscribecap)     | 是    | 发现能力。             |
140 141 142 143 144 145 146 147


## DiscoverMode 

表示发现模式的枚举。

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
148
| 名称                    | 值  | 说明    |
H
HelloCrease 已提交
149
| --------------------- | ---- | ----- |
150
| DISCOVER_MODE_PASSIVE | 0x55 | 被动模式。 |
H
HelloCrease 已提交
151
| DISCOVER_MODE_ACTIVE  | 0xAA | 主动模式。 |
152 153 154 155 156 157 158 159


## ExchangeMedium 

表示发现类型的枚举。

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
160
| 名称   | 值  | 说明        |
H
HelloCrease 已提交
161 162 163 164 165
| ---- | ---- | --------- |
| AUTO | 0    | 自动发现类型。   |
| BLE  | 1    | 蓝牙发现类型。   |
| COAP | 2    | WiFi发现类型。 |
| USB  | 3    | USB发现类型。  |
166 167 168 169 170 171 172

## ExchangeFreq 

表示发现频率的枚举。

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
173
| 名称         | 值  | 说明    |
H
HelloCrease 已提交
174 175 176 177 178
| ---------- | ---- | ----- |
| LOW        | 0    | 低频率。  |
| MID        | 1    | 中频率。  |
| HIGH       | 2    | 高频率。  |
| SUPER_HIGH | 3    | 超高频率。 |
179 180 181 182 183 184 185 186


## SubscribeCap 

表示发现能力的枚举。

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
187
| 名称                        | 值  | 说明             |
H
HelloCrease 已提交
188 189 190
| ------------------------- | ---- | -------------- |
| SUBSCRIBE_CAPABILITY_DDMP | 0    | DDMP能力,后续会被废弃。 |
| SUBSCRIBE_CAPABILITY_OSD  | 1    | OSD能力。         |
191 192 193 194 195 196 197 198


## AuthParam

认证参数。

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
199
| 名称        | 类型                   | 必填   | 说明         |
H
HelloCrease 已提交
200 201
| --------- | -------------------- | ---- | ---------- |
| authType  | number               | 是    | 认证类型。      |
202
| extraInfo | {[key:string]&nbsp;:&nbsp;any} | 否    | 认证参数可扩展字段。 |
203 204 205 206 207 208 209

## AuthInfo

认证信息。

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
210
| 名称        | 类型                   | 必填   | 说明         |
H
HelloCrease 已提交
211 212 213
| --------- | -------------------- | ---- | ---------- |
| authType  | number               | 是    | 认证类型。      |
| token     | number               | 是    | 认证Token。   |
214
| extraInfo | {[key:string]&nbsp;:&nbsp;any} | 否    | 认证信息可扩展字段。 |
Z
zengyawen 已提交
215

@
@shi-xiaoxiao-iris 已提交
216
## PublishInfo<sup>9+</sup>
S
summer8999 已提交
217 218 219 220 221

发布设备参数

**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
222
| 名称          | 类型                              | 必填   | 说明                |
S
summer8999 已提交
223 224 225 226 227
| ------------- | --------------------------------- | ---- | ----------------- |
| publishId     | number                            | 是    | 发布设备标识,用于标识不同的发布周期。 |
| mode          | [DiscoverMode ](#discovermode)    | 是    | 发现模式。             |
| freq          | [ExchangeFreq](#exchangefreq)     | 是    | 发现频率。             |
| ranging       | boolean                           | 是    | 发布的设备是否支持测距能力。             |
Z
zengyawen 已提交
228 229

## DeviceManager
Z
zengyawen 已提交
230 231 232

设备管理实例,用于获取可信设备和本地设备的相关信息。在调用DeviceManager的方法前,需要先通过createDeviceManager构建一个DeviceManager实例dmInstance。

Z
zengyawen 已提交
233
### release
Z
zengyawen 已提交
234

Z
zengyawen 已提交
235
release(): void
Z
zengyawen 已提交
236

Z
zengyawen 已提交
237
设备管理实例不再使用后,通过该方法释放DeviceManager实例。
Z
zengyawen 已提交
238

史晓晓 已提交
239
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
240

241 242
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
243
**错误码:**
@
@shi-xiaoxiao-iris 已提交
244

@
@shi-xiaoxiao-iris 已提交
245
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
246

@
@shi-xiaoxiao-iris 已提交
247
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
248 249
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
250

@
@shi-xiaoxiao-iris 已提交
251
**示例:**
@
@shi-xiaoxiao-iris 已提交
252

253
  ```js
254 255 256
  try {
    dmInstance.release();
  } catch (err) {
257
    console.error("release errCode:" + err.code + ",errMessage:" + err.message);
258
  }
Z
zengyawen 已提交
259
  ```
Z
zengyawen 已提交
260

Z
zengyawen 已提交
261
### getTrustedDeviceListSync
Z
zengyawen 已提交
262

Z
zengyawen 已提交
263
getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt;
Z
zengyawen 已提交
264 265 266

同步获取所有可信设备列表。

史晓晓 已提交
267
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
268

269 270
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
271
**返回值:**
@
@shi-xiaoxiao-iris 已提交
272

H
HelloCrease 已提交
273 274
  | 名称                                     | 说明        |
  | -------------------------------------- | --------- |
Z
zengyawen 已提交
275 276
  | Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回可信设备列表。 |

@
@shi-xiaoxiao-iris 已提交
277
**错误码:**
@
@shi-xiaoxiao-iris 已提交
278

@
@shi-xiaoxiao-iris 已提交
279
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
280

@
@shi-xiaoxiao-iris 已提交
281
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
282 283
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
284

@
@shi-xiaoxiao-iris 已提交
285
**示例:**
@
@shi-xiaoxiao-iris 已提交
286

287
  ```js
288 289 290
  try {
    var deviceInfoList = dmInstance.getTrustedDeviceListSync();
  } catch (err) {
291
    console.error("getTrustedDeviceListSync errCode:" + err.code + ",errMessage:" + err.message);
292
  }
Z
zengyawen 已提交
293
  ```
Z
zengyawen 已提交
294

295 296 297 298 299 300
### getTrustedDeviceList<sup>8+</sup>

getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): void

获取所有可信设备列表。使用callback异步回调。

史晓晓 已提交
301
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
302

303 304
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
305
**参数:**
@
@shi-xiaoxiao-iris 已提交
306

@
@shi-xiaoxiao-iris 已提交
307
  | 参数名       | 类型                                     | 必填   | 说明                    |
H
HelloCrease 已提交
308 309
  | -------- | ---------------------------------------- | ---- | --------------------- |
  | callback | AsyncCallback&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | 是    | 获取所有可信设备列表的回调,返回设备信息。 |
310

@
@shi-xiaoxiao-iris 已提交
311
**错误码:**
@
@shi-xiaoxiao-iris 已提交
312

@
@shi-xiaoxiao-iris 已提交
313
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
314

@
@shi-xiaoxiao-iris 已提交
315
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
316 317
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
318

@
@shi-xiaoxiao-iris 已提交
319
**示例:**
@
@shi-xiaoxiao-iris 已提交
320

321
  ```js
322 323 324
  try {
    dmInstance.getTrustedDeviceList((err, data) => {
      if (err) {
325
        console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
326 327
        return;
      }
328
      console.log('get trusted device info: ' + JSON.stringify(data));
329
    });
330
  } catch (err) {
331
    console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
332
  }
333 334 335 336 337 338 339 340
  ```

### getTrustedDeviceList<sup>8+</sup>

getTrustedDeviceList(): Promise&lt;Array&lt;DeviceInfo&gt;&gt;

获取所有可信设备列表。使用Promise异步回调。

史晓晓 已提交
341
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
342

343 344
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
345
**返回值:**
@
@shi-xiaoxiao-iris 已提交
346

H
HelloCrease 已提交
347 348
  | 类型                                       | 说明                    |
  | ---------------------------------------- | --------------------- |
349 350
  | Promise&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | Promise实例,用于获取异步返回结果。 |

@
@shi-xiaoxiao-iris 已提交
351
**错误码:**
@
@shi-xiaoxiao-iris 已提交
352

@
@shi-xiaoxiao-iris 已提交
353
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
354

@
@shi-xiaoxiao-iris 已提交
355
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
356 357
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
358

@
@shi-xiaoxiao-iris 已提交
359
**示例:**
@
@shi-xiaoxiao-iris 已提交
360

361
  ```js
362 363 364
  dmInstance.getTrustedDeviceList().then((data) => {
    console.log('get trusted device info: ' + JSON.stringify(data));
    }).catch((err) => {
365
      console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
366
  });
367 368 369 370 371 372 373 374
  ```

### getLocalDeviceInfoSync<sup>8+</sup>

getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)

同步获取本地设备信息。

史晓晓 已提交
375
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
376

377 378
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
379
**返回值:**
@
@shi-xiaoxiao-iris 已提交
380

381 382 383
  | 名称                      | 说明              |
  | ------------------------- | ---------------- |
  | [DeviceInfo](#deviceinfo) | 返回本地设备列表。 |
384

@
@shi-xiaoxiao-iris 已提交
385
**错误码:**
@
@shi-xiaoxiao-iris 已提交
386

@
@shi-xiaoxiao-iris 已提交
387
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
388

@
@shi-xiaoxiao-iris 已提交
389
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
390 391
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
392

@
@shi-xiaoxiao-iris 已提交
393
**示例:**
@
@shi-xiaoxiao-iris 已提交
394

395
  ```js
396 397 398
  try {
    var deviceInfo = dmInstance.getLocalDeviceInfoSync();
  } catch (err) {
399
    console.error("getLocalDeviceInfoSync errCode:" + err.code + ",errMessage:" + err.message);
400
  }
401 402 403 404 405 406 407 408
  ```

### getLocalDeviceInfo<sup>8+</sup>

getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void

获取本地设备信息。使用callback异步回调。

史晓晓 已提交
409
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
410

411 412
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
413
**参数:**
@
@shi-xiaoxiao-iris 已提交
414

@
@shi-xiaoxiao-iris 已提交
415
  | 参数名       | 类型                                     | 必填   | 说明        |
H
HelloCrease 已提交
416 417
  | -------- | ---------------------------------------- | ---- | --------- |
  | callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是    | 获取本地设备信息。 |
418

@
@shi-xiaoxiao-iris 已提交
419
**错误码:**
@
@shi-xiaoxiao-iris 已提交
420

@
@shi-xiaoxiao-iris 已提交
421
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
422

@
@shi-xiaoxiao-iris 已提交
423
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
424 425
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
426

@
@shi-xiaoxiao-iris 已提交
427
**示例:**
@
@shi-xiaoxiao-iris 已提交
428

429
  ```js
430
  try {
431
    dmInstance.getLocalDeviceInfo((err, data) => {
432
    if (err) {
433
      console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
434
      return;
435
    }
436 437 438
      console.log('get local device info: ' + JSON.stringify(data));
    });
  } catch (err) {
439
    console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
440
  }
441 442 443 444 445 446 447 448
  ```

### getLocalDeviceInfo<sup>8+</sup>

getLocalDeviceInfo(): Promise&lt;DeviceInfo&gt;

获取本地设备信息。使用Promise异步回调。

史晓晓 已提交
449
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
450

451 452
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
453 454
**返回值:**

H
HelloCrease 已提交
455 456
  | 类型                                       | 说明                    |
  | ---------------------------------------- | --------------------- |
457 458
  | Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例,用于获取异步返回结果。 |

@
@shi-xiaoxiao-iris 已提交
459
**错误码:**
@
@shi-xiaoxiao-iris 已提交
460

@
@shi-xiaoxiao-iris 已提交
461
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
462

@
@shi-xiaoxiao-iris 已提交
463
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
464 465 466
| ------- | --------------------------------------------------------------- |
| 11600101| Failed to execute the function.                                 |

@
@shi-xiaoxiao-iris 已提交
467
**示例:**
@
@shi-xiaoxiao-iris 已提交
468

469
  ```js
470 471 472
  dmInstance.getLocalDeviceInfo().then((data) => {
    console.log('get local device info: ' + JSON.stringify(data));
  }).catch((err) => {
473
    console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
474
  });
475 476
  ```

S
summer8999 已提交
477 478
### getDeviceInfo<sup>10+</sup>

S
summer8999 已提交
479
getDeviceInfo(networkId: string, callback:AsyncCallback&lt;DeviceInfo&gt;): void
S
summer8999 已提交
480

S
summer8999 已提交
481
通过指定设备的网络标识获取该设备的信息。使用callback异步回调。
S
summer8999 已提交
482

史晓晓 已提交
483
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
484

S
summer8999 已提交
485 486 487 488 489 490
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

  | 参数名       | 类型                                     | 必填   | 说明        |
  | -------- | ---------------------------------------- | ---- | --------- |
S
summer8999 已提交
491
  | networkId| string                                   | 是   | 设备的网络标识。 |
S
summer8999 已提交
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
  | callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是    | 获取指定设备信息。 |

**错误码:**

以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)

| 错误码ID | 错误信息                                                        |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |

**示例:**

  ```js
  try {
    dmInstance.getDeviceInfo(networkId, (err, data) => {
    if (err) {
      console.error("getDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
      return;
    }
      console.log('get device info: ' + JSON.stringify(data));
    });
  } catch (err) {
    console.error("getDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
  }
  ```

### getDeviceInfo<sup>10+</sup>

S
summer8999 已提交
520
getDeviceInfo(networkId: string): Promise&lt;DeviceInfo&gt;
S
summer8999 已提交
521

S
summer8999 已提交
522
通过指定设备的网络标识获取该设备的信息。使用Promise异步回调。
S
summer8999 已提交
523

史晓晓 已提交
524
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
525

S
summer8999 已提交
526 527
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

S
summer8999 已提交
528 529 530 531 532 533
**参数:**

  | 参数名   | 类型                                     | 必填 | 说明        |
  | -------- | ---------------------------------------- | ---- | --------- |
  | networkId| string                                   | 是   | 设备的网络标识。 |
  
S
summer8999 已提交
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
**返回值:**

  | 类型                                       | 说明                    |
  | ---------------------------------------- | --------------------- |
  | Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例,用于获取异步返回结果。 |

**错误码:**

以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)

| 错误码ID | 错误信息                                                        |
| ------- | --------------------------------------------------------------- |
| 11600101| Failed to execute the function.                                 |

**示例:**

  ```js
  dmInstance.getDeviceInfo(networkId).then((data) => {
    console.log('get device info: ' + JSON.stringify(data));
  }).catch((err) => {
    console.error("getDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
  });
  ```

@
@shi-xiaoxiao-iris 已提交
558
### startDeviceDiscovery<sup>8+</sup>
559 560 561 562 563

startDeviceDiscovery(subscribeInfo: SubscribeInfo): void

发现周边设备。

史晓晓 已提交
564
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
565

566 567
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
568
**参数:**
@
@shi-xiaoxiao-iris 已提交
569

@
@shi-xiaoxiao-iris 已提交
570
  | 参数名            | 类型                       | 必填 | 说明    |
H
HelloCrease 已提交
571
  | ------------- | ------------------------------- | ---- | ----- |
572
  | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是   | 发现信息。|
573

@
@shi-xiaoxiao-iris 已提交
574
**错误码:**
@
@shi-xiaoxiao-iris 已提交
575

@
@shi-xiaoxiao-iris 已提交
576
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
577

@
@shi-xiaoxiao-iris 已提交
578
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
579 580 581 582
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600104 | Discovery invalid.                                              |

@
@shi-xiaoxiao-iris 已提交
583
**示例:**
@
@shi-xiaoxiao-iris 已提交
584

585
  ```js
586
  // 生成发现标识,随机数确保每次调用发现接口的标识不一致
587 588 589
  var subscribeId = Math.floor(Math.random() * 10000 + 1000);
  var subscribeInfo = {
      "subscribeId": subscribeId,
590 591 592
      "mode": 0xAA, // 主动模式
      "medium": 0,  // 自动发现类型,同时支持多种发现类型
      "freq": 2,    // 高频率
593 594 595 596
      "isSameAccount": false,
      "isWakeRemote": false,
      "capability": 1
  };
597 598 599
  try {
    dmInstance.startDeviceDiscovery(subscribeInfo); // 当有设备发现时,通过deviceFound回调通知给应用程序
  } catch (err) {
600
    console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
601
  }
602 603
  ```

@
@shi-xiaoxiao-iris 已提交
604
### startDeviceDiscovery<sup>9+</sup>
S
summer8999 已提交
605

S
summer8999 已提交
606
startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void
S
summer8999 已提交
607 608 609

发现周边设备。

史晓晓 已提交
610
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
611

S
summer8999 已提交
612 613
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
614
**参数:**
@
@shi-xiaoxiao-iris 已提交
615

@
@shi-xiaoxiao-iris 已提交
616
  | 参数名            | 类型                       | 必填   | 说明    |
617
  | ------------- | ------------------------------- | ---- | -----  |
S
summer8999 已提交
618
  | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是   | 发现信息。 |
619
  | filterOptions | string                          | 否   | 发现设备过滤信息。|
S
summer8999 已提交
620

@
@shi-xiaoxiao-iris 已提交
621
**错误码:**
@
@shi-xiaoxiao-iris 已提交
622

@
@shi-xiaoxiao-iris 已提交
623
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
624

@
@shi-xiaoxiao-iris 已提交
625
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
626 627 628 629
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600104 | Discovery invalid.                                              |

@
@shi-xiaoxiao-iris 已提交
630
**示例:**
@
@shi-xiaoxiao-iris 已提交
631

S
summer8999 已提交
632
  ```js
633
  // 生成发现标识,随机数确保每次调用发现接口的标识不一致
S
summer8999 已提交
634 635 636
  var subscribeId = Math.floor(Math.random() * 10000 + 1000);
  var subscribeInfo = {
      "subscribeId": subscribeId,
637 638 639
      "mode": 0xAA, // 主动模式
      "medium": 0,  // 自动发现类型,同时支持多种发现类型
      "freq": 2,    // 高频率
S
summer8999 已提交
640 641 642 643 644
      "isSameAccount": false,
      "isWakeRemote": false,
      "capability": 1
  };
  var filterOptions = {
S
summer8999 已提交
645
    "filter_op": "OR", // 可选, 默认"OR"
S
summer8999 已提交
646 647 648
    "filters": [
        {
            "type": "range",
S
summer8999 已提交
649
            "value": 50 // 需过滤发现设备的距离,单位(cm)
S
summer8999 已提交
650 651
        }
    ]
S
summer8999 已提交
652
  };
653 654 655
  try {
    dmInstance.startDeviceDiscovery(subscribeInfo, JSON.stringify(filterOptions)); // 当有设备发现时,通过deviceFound回调通知给应用程序
  } catch (err) {
656
    console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
657
  }
S
summer8999 已提交
658
  ```
@
@shi-xiaoxiao-iris 已提交
659

660 661 662 663 664 665
### stopDeviceDiscovery

stopDeviceDiscovery(subscribeId: number): void

停止发现周边设备。

史晓晓 已提交
666
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
667

668 669
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
670
**参数:**
@
@shi-xiaoxiao-iris 已提交
671

@
@shi-xiaoxiao-iris 已提交
672
  | 参数名          | 类型   | 必填   | 说明    |
H
HelloCrease 已提交
673 674
  | ----------- | ------ | ---- | ----- |
  | subscribeId | number | 是    | 发现标识。 |
675

@
@shi-xiaoxiao-iris 已提交
676
**错误码:**
@
@shi-xiaoxiao-iris 已提交
677

@
@shi-xiaoxiao-iris 已提交
678
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
679

@
@shi-xiaoxiao-iris 已提交
680
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
681 682
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
683

@
@shi-xiaoxiao-iris 已提交
684
**示例:**
@
@shi-xiaoxiao-iris 已提交
685

686
  ```js
687
  try {
688 689
    // stopDeviceDiscovery和startDeviceDiscovery需配对使用,入参需要和startDeviceDiscovery接口传入的subscribeId值相等
    var subscribeId = 12345;
690 691
    dmInstance.stopDeviceDiscovery(subscribeId);
  } catch (err) {
692
    console.error("stopDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
693
  }
694 695
  ```

@
@shi-xiaoxiao-iris 已提交
696
### publishDeviceDiscovery<sup>9+</sup>
S
summer8999 已提交
697

S
summer8999 已提交
698
publishDeviceDiscovery(publishInfo: PublishInfo): void
S
summer8999 已提交
699

S
summer8999 已提交
700
发布设备发现。
S
summer8999 已提交
701

史晓晓 已提交
702
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
703

S
summer8999 已提交
704 705
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
706
**参数:**
@
@shi-xiaoxiao-iris 已提交
707

@
@shi-xiaoxiao-iris 已提交
708
  | 参数名          | 类型                        | 必填 | 说明    |
S
summer8999 已提交
709 710 711
  | ------------- | ------------------------------- | ---- | ----- |
  | publishInfo   | [PublishInfo](#publishinfo)     | 是   | 发布设备发现信息。 |

@
@shi-xiaoxiao-iris 已提交
712
**错误码:**
@
@shi-xiaoxiao-iris 已提交
713

@
@shi-xiaoxiao-iris 已提交
714
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
715

@
@shi-xiaoxiao-iris 已提交
716
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
717 718 719
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600105 | Publish invalid.                                                |
@
@shi-xiaoxiao-iris 已提交
720

@
@shi-xiaoxiao-iris 已提交
721
**示例:**
@
@shi-xiaoxiao-iris 已提交
722

S
summer8999 已提交
723
  ```js
724
  // 生成发布标识,随机数确保每次调用发布接口的标识不一致
S
summer8999 已提交
725
  var publishId = Math.floor(Math.random() * 10000 + 1000);
S
summer8999 已提交
726
  var publishInfo = {
S
summer8999 已提交
727
      "publishId": publishId,
728 729
      "mode": 0xAA, // 主动模式
      "freq": 2,    // 高频率
730
      "ranging": true  // 支持发现时测距
S
summer8999 已提交
731
  };
732 733 734
  try {
    dmInstance.publishDeviceDiscovery(publishInfo); // 当有发布结果时,通过回调通知给应用程序
  } catch (err) {
735
    console.error("publishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
736
  }
S
summer8999 已提交
737
  ```
738

@
@shi-xiaoxiao-iris 已提交
739
### unPublishDeviceDiscovery<sup>9+</sup>
S
summer8999 已提交
740

S
summer8999 已提交
741
unPublishDeviceDiscovery(publishId: number): void
S
summer8999 已提交
742 743 744

停止发布设备发现。

史晓晓 已提交
745
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
746

S
summer8999 已提交
747 748
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
749
**参数:**
@
@shi-xiaoxiao-iris 已提交
750

@
@shi-xiaoxiao-iris 已提交
751
  | 参数名        | 类型 | 必填 | 说明  |
S
summer8999 已提交
752 753
  | ----------- | -------- | ---- | ----- |
  | publishId   | number   | 是   | 发布标识。 |
S
summer8999 已提交
754

@
@shi-xiaoxiao-iris 已提交
755
**错误码:**
@
@shi-xiaoxiao-iris 已提交
756

@
@shi-xiaoxiao-iris 已提交
757
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
758

@
@shi-xiaoxiao-iris 已提交
759
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
760 761
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
762

@
@shi-xiaoxiao-iris 已提交
763
**示例:**
@
@shi-xiaoxiao-iris 已提交
764

S
summer8999 已提交
765
  ```js
766
  try {
767 768
    // unPublishDeviceDiscovery和publishDeviceDiscovery配对使用,入参需要和publishDeviceDiscovery接口传入的publishId值相等
    var publishId = 12345;
769
    dmInstance.unPublishDeviceDiscovery(publishId);
770
  } catch (err) {
771
    console.error("unPublishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
772
  }
S
summer8999 已提交
773 774
  ```

775 776
### authenticateDevice

777
authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: AsyncCallback&lt;{deviceId: string, pinToken ?: number}&gt;): void
778 779 780

认证设备。

史晓晓 已提交
781
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
782

783 784
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
785
**参数:**
@
@shi-xiaoxiao-iris 已提交
786

@
@shi-xiaoxiao-iris 已提交
787
  | 参数名         | 类型                                     | 必填   | 说明      |
H
HelloCrease 已提交
788 789 790
  | ---------- | ---------------------------------------- | ---- | ------- |
  | deviceInfo | [DeviceInfo](#deviceinfo)                | 是    | 设备信息。   |
  | authParam  | [AuthParam](#authparam)                  | 是    | 认证参数。   |
791
  | callback   | AsyncCallback&lt;{deviceId:&nbsp;string,&nbsp;pinToken&nbsp;?:&nbsp;number}&gt; | 是    | 认证结果回调。 |
792

@
@shi-xiaoxiao-iris 已提交
793
**错误码:**
@
@shi-xiaoxiao-iris 已提交
794

@
@shi-xiaoxiao-iris 已提交
795
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
796

@
@shi-xiaoxiao-iris 已提交
797
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
798 799 800
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600103 | Authentication invalid.                                         |
@
@shi-xiaoxiao-iris 已提交
801

@
@shi-xiaoxiao-iris 已提交
802
**示例:**
@
@shi-xiaoxiao-iris 已提交
803

804
  ```js
805
  // 认证的设备信息,可以从发现的结果中获取
806 807 808
  var deviceInfo ={
      "deviceId": "XXXXXXXX",
      "deviceName": "",
809 810 811
      "deviceType": 0x0E,
      "networkId" : "xxxxxxx",
      "range" : 0
812
  };
813 814 815 816 817
  let extraInfo = {
          'targetPkgName': 'ohos.samples.xxx',
          'appName': 'xxx',
          'appDescription': 'xxx',
          'business': '0'
818
  }
819
  let authParam = {
820 821
      'authType': 1,// 认证类型: 1 - 无帐号PIN码认证
      'extraInfo': extraInfo
822
  }
823 824
  try {
    dmInstance.authenticateDevice(deviceInfo, authParam, (err, data) => {
825
      if (err) {
826
          console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
827 828
          return;
      }
@
@shi-xiaoxiao-iris 已提交
829 830
      console.info("authenticateDevice result:" + JSON.stringify(data));
      let token = data.pinToken;
831 832
    });
  } catch (err) {
833
    console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
834
  }
835 836 837 838 839 840 841 842
  ```

### unAuthenticateDevice<sup>8+</sup>

unAuthenticateDevice(deviceInfo: DeviceInfo): void

解除认证设备。

史晓晓 已提交
843
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
844

845 846
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
847
**参数:**
@
@shi-xiaoxiao-iris 已提交
848

@
@shi-xiaoxiao-iris 已提交
849
  | 参数名         | 类型                      | 必填   | 说明    |
H
HelloCrease 已提交
850 851
  | ---------- | ------------------------- | ---- | ----- |
  | deviceInfo | [DeviceInfo](#deviceinfo) | 是    | 设备信息。 |
852

@
@shi-xiaoxiao-iris 已提交
853
**错误码:**
@
@shi-xiaoxiao-iris 已提交
854

@
@shi-xiaoxiao-iris 已提交
855
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
856

@
@shi-xiaoxiao-iris 已提交
857
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
858 859
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
860

@
@shi-xiaoxiao-iris 已提交
861
**示例:**
@
@shi-xiaoxiao-iris 已提交
862

863
  ```js
864
  try {
865 866 867 868 869 870 871
    var deviceInfo ={
      "deviceId": "XXXXXXXX",
      "deviceName": "",
      "deviceType": 0x0E,
      "networkId" : "xxxxxxx",
      "range" : 0
    };
872 873
    dmInstance.unAuthenticateDevice(deviceInfo);
  } catch (err) {
874
    console.error("unAuthenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
875
  }
876 877 878 879
  ```

### verifyAuthInfo

880
verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback&lt;{deviceId: string, level: number}&gt;): void
881 882 883

验证认证信息。

史晓晓 已提交
884
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
885

886 887
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
888
**参数:**
@
@shi-xiaoxiao-iris 已提交
889

@
@shi-xiaoxiao-iris 已提交
890
  | 参数名       | 类型                                     | 必填   | 说明      |
H
HelloCrease 已提交
891 892
  | -------- | ---------------------------------------- | ---- | ------- |
  | authInfo | [AuthInfo](#authinfo)                    | 是    | 认证信息。   |
893
  | callback | AsyncCallback&lt;{deviceId:&nbsp;string,&nbsp;level:&nbsp;number}&gt; | 是    | 验证结果回调。 |
894

@
@shi-xiaoxiao-iris 已提交
895
**错误码:**
@
@shi-xiaoxiao-iris 已提交
896

@
@shi-xiaoxiao-iris 已提交
897
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
@
@shi-xiaoxiao-iris 已提交
898

@
@shi-xiaoxiao-iris 已提交
899
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
900 901
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
902

@
@shi-xiaoxiao-iris 已提交
903
**示例:**
@
@shi-xiaoxiao-iris 已提交
904

905 906 907
  ```js
  let authInfo = {
    "authType": 1,
908
    "token": 123456,
909 910
    "extraInfo": {}
  }
911 912
  try {
    dmInstance.verifyAuthInfo(authInfo, (err, data) => {
913
    if (err) {
914
        console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
915 916
        return;
    }
@
@shi-xiaoxiao-iris 已提交
917
    console.info("verifyAuthInfo result:" + JSON.stringify(data));
918 919
    });
  } catch (err) {
920
    console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
921
  }
922 923
  ```

@
@shi-xiaoxiao-iris 已提交
924
### setUserOperation<sup>9+</sup>
@
@shi-xiaoxiao-iris 已提交
925 926 927 928 929

setUserOperation(operateAction: number, params: string): void;

设置用户ui操作行为。

史晓晓 已提交
930
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
931

@
@shi-xiaoxiao-iris 已提交
932 933
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
934
**参数:**
@
@shi-xiaoxiao-iris 已提交
935

@
@shi-xiaoxiao-iris 已提交
936
  | 参数名       | 类型            | 必填  | 说明                |
937 938 939
  | ------------- | --------------- | ---- | ------------------- |
  | operateAction | number          | 是    | 用户操作动作。       |
  | params        | string          | 是    | 表示用户的输入参数。 |
@
@shi-xiaoxiao-iris 已提交
940

@
@shi-xiaoxiao-iris 已提交
941
**示例:**
@
@shi-xiaoxiao-iris 已提交
942 943

  ```js
@
@shi-xiaoxiao-iris 已提交
944 945 946 947 948 949 950 951 952 953
 try {
    /*
      operateAction = 0 - 允许授权
      operateAction = 1 - 取消授权
      operateAction = 2 - 授权框用户操作超时
      operateAction = 3 - 取消pin码框展示
      operateAction = 4 - 取消pin码输入框展示
      operateAction = 5 - pin码输入框确定操作
    */
    let operation = 0;
954
    dmInstance.setUserOperation(operation, "extra")
@
@shi-xiaoxiao-iris 已提交
955 956
    } catch (err) {
      console.error("setUserOperation errCode:" + err.code + ",errMessage:" + err.message);
@
@shi-xiaoxiao-iris 已提交
957 958 959
  }
  ```

W
wuqi0105 已提交
960
### requestCredentialRegisterInfo<sup>10+</sup>
W
wuqi0105 已提交
961

W
wuqi0105 已提交
962
requestCredentialRegisterInfo(requestInfo: string, callback: AsyncCallback<{registerInfo: string}>): void;
W
wuqi0105 已提交
963 964 965

获取凭据的注册信息。

史晓晓 已提交
966
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
967

W
wuqi0105 已提交
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

  | 参数名       | 类型            | 必填  | 说明                |
  | ------------- | --------------- | ---- | ------------------- |
  | requestInfo   | string          | 是    | 请求凭据信息。       |
  | callback      | AsyncCallback<{registerInfo: string}>         | 是    | 凭据的注册信息回调。 |

**示例:**

  ```js
  let credentialInfo = {
    "version" : "1.2.3",
    "userId" : "123"
  }
  try {
W
wuqi0105 已提交
985
    dmClass.requestCredentialRegisterInfo(credentialInfo, (data) => {
W
wuqi0105 已提交
986
      if (data) {
W
wuqi0105 已提交
987
          console.info("requestCredentialRegisterInfo result:" + JSON.stringify(data));
W
wuqi0105 已提交
988
      } else {
W
wuqi0105 已提交
989
          console.info.push("requestCredentialRegisterInfo result: data is null");
W
wuqi0105 已提交
990 991 992
      }
    });
  } catch (err) {
W
wuqi0105 已提交
993
    console.error("requestCredentialRegisterInfo err:" + err.code + "," + err.message);
W
wuqi0105 已提交
994 995 996 997 998 999 1000 1001 1002
  }
  ```

### importCredential<sup>10+</sup>

importCredential(credentialInfo: string, callback: AsyncCallback<{resultInfo: string}>): void;

导入凭据信息。

史晓晓 已提交
1003
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1004

W
wuqi0105 已提交
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

  | 参数名       | 类型            | 必填  | 说明                |
  | ------------- | --------------- | ---- | ------------------- |
  | credentialInfo| string          | 是    | 导入凭据信息。       |
  | callback      | AsyncCallback<{resultInfo: string}>           | 是    | 导入凭据结果回调。 |

**示例:**

  ```js
  let credentialInfo = {
    "processType" : 1,
    "authType" : 1,
    "userId" : "123",
    "deviceId" : "aaa",
    "version" : "1.2.3",
    "devicePk" : "0000",
    "credentialData" : 
    [
      {
        "credentialType" : 2,
        "credentialId" : "102",
        "serverPk" : "3059301306072A8648CE3D020106082A8648CE3D03",
        "pkInfoSignature" : "30440220490BCB4F822004C9A76AB8D97F80041FC0E",
        "pkInfo" : "",
        "authCode" : "",
        "peerDeviceId" : ""
      }
    ]
  }
  try {
    dmClass.importCredential(credentialInfo, (data) => {
      if (data) {
          console.info("importCredential result:" + JSON.stringify(data));
      } else {
          console.info.push("importCredential result: data is null");
      }
    });
  } catch (err) {
    console.error("importCredential err:" + err.code + "," + err.message);
  }
  ```

### deleteCredential<sup>10+</sup>

deleteCredential(queryInfo: string, callback: AsyncCallback<{resultInfo: string}>): void;

删除凭据信息。

史晓晓 已提交
1056
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1057

W
wuqi0105 已提交
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

  | 参数名       | 类型            | 必填  | 说明                |
  | ------------- | --------------- | ---- | ------------------- |
  | queryInfo     | string          | 是    | 删除凭据信息。       |
  | callback      | AsyncCallback<{resultInfo: string}>           | 是    | 删除凭据结果回调。 |

**示例:**

  ```js
  let queryInfo = {
    "processType" : 1,
    "authType" : 1,
    "userId" : "123"
  }
  try {
    dmClass.deleteCredential(queryInfo, (data) => {
      if (data) {
          console.info("deleteCredential result:" + JSON.stringify(data));
      } else {
          console.info.push("deleteCredential result: data is null");
      }
    });
  } catch (err) {
    console.error("deleteCredential err:" + err.code + "," + err.message);
  }
  ```

@
@shi-xiaoxiao-iris 已提交
1088
### on('uiStateChange')<sup>9+</sup>
@
@shi-xiaoxiao-iris 已提交
1089

1090
on(type: 'uiStateChange', callback: Callback&lt;{ param: string}&gt;): void;
@
@shi-xiaoxiao-iris 已提交
1091 1092 1093

ui状态变更回调。

史晓晓 已提交
1094
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1095

@
@shi-xiaoxiao-iris 已提交
1096 1097
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1098
**参数:**
@
@shi-xiaoxiao-iris 已提交
1099

@
@shi-xiaoxiao-iris 已提交
1100
  | 参数名      | 类型                             | 必填 | 说明                            |
@
@shi-xiaoxiao-iris 已提交
1101 1102
  | -------- | ------------------------------------ | ---- | ------------------------------ |
  | type     | string                                | 是  | 注册的设备管理器 ui 状态回调,以便在状态改变时通知应用。 |
1103
  | callback | Callback&lt;{&nbsp;param:&nbsp;string}&gt; | 是  | 指示要注册的设备管理器 ui 状态回调,返回ui状态。        |
@
@shi-xiaoxiao-iris 已提交
1104

@
@shi-xiaoxiao-iris 已提交
1105
**示例:**
@
@shi-xiaoxiao-iris 已提交
1106 1107 1108

  ```js
  try {
@
@shi-xiaoxiao-iris 已提交
1109
    dmInstance.on('uiStateChange', (data) => {
@
@shi-xiaoxiao-iris 已提交
1110 1111
    console.log("uiStateChange executed, dialog closed" + JSON.stringify(data))
    var tmpStr = JSON.parse(data.param)
1112 1113
    var isShow = tmpStr.verifyFailed
    console.log("uiStateChange executed, dialog closed" + isShow)
@
@shi-xiaoxiao-iris 已提交
1114 1115 1116 1117 1118 1119
  });
  } catch (err) {
    console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
  }
  ```

@
@shi-xiaoxiao-iris 已提交
1120
### off('uiStateChange')<sup>9+</sup>
@
@shi-xiaoxiao-iris 已提交
1121

1122
off(type: 'uiStateChange', callback?: Callback&lt;{ param: string}&gt;): void;
@
@shi-xiaoxiao-iris 已提交
1123

1124 1125
取消ui状态变更回调。

史晓晓 已提交
1126
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1127

@
@shi-xiaoxiao-iris 已提交
1128 1129
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1130
**参数:**
@
@shi-xiaoxiao-iris 已提交
1131

@
@shi-xiaoxiao-iris 已提交
1132
  | 参数名      | 类型                              | 必填 | 说明                            |
@
@shi-xiaoxiao-iris 已提交
1133 1134
  | -------- | ------------------------------------- | ---- | ------------------------------ |
  | type     | string                                | 是   | 取消注册的设备管理器 ui 状态回调。 |
1135
  | callback | Callback&lt;{&nbsp;param:&nbsp;string}&gt; | 否   | 指示要取消注册的设备管理器 ui 状态,返回UI状态。 |
@
@shi-xiaoxiao-iris 已提交
1136

@
@shi-xiaoxiao-iris 已提交
1137
**示例:**
@
@shi-xiaoxiao-iris 已提交
1138 1139 1140

  ```js
  try {
@
@shi-xiaoxiao-iris 已提交
1141
    dmInstance.off('uiStateChange');
@
@shi-xiaoxiao-iris 已提交
1142 1143 1144 1145 1146
  } catch (err) {
    console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
  }
  ```

Z
zengyawen 已提交
1147
### on('deviceStateChange')
Z
zengyawen 已提交
1148

1149
on(type: 'deviceStateChange',  callback: Callback&lt;{ action: DeviceStateChangeAction, device: DeviceInfo }&gt;): void
Z
zengyawen 已提交
1150

Z
zengyawen 已提交
1151 1152
注册设备状态回调。

史晓晓 已提交
1153
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1154

1155 1156
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1157
**参数:**
@
@shi-xiaoxiao-iris 已提交
1158

@
@shi-xiaoxiao-iris 已提交
1159
  | 参数名       | 类型                                     | 必填   | 说明                             |
H
HelloCrease 已提交
1160 1161
  | -------- | ---------------------------------------- | ---- | ------------------------------ |
  | type     | string                                   | 是    | 注册设备状态回调,固定为deviceStateChange。 |
1162
  | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是    | 指示要注册的设备状态回调,返回设备状态和设备信息。      |
Z
zengyawen 已提交
1163

@
@shi-xiaoxiao-iris 已提交
1164
**示例:**
@
@shi-xiaoxiao-iris 已提交
1165

1166
  ```js
1167 1168 1169 1170 1171
  try {
    dmInstance.on('deviceStateChange', (data) => {
      console.info("deviceStateChange on:" + JSON.stringify(data));
    });
  } catch (err) {
1172
    console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message);
1173
  }
Z
zengyawen 已提交
1174
  ```
Z
zengyawen 已提交
1175

Z
zengyawen 已提交
1176
### off('deviceStateChange')
Z
zengyawen 已提交
1177

1178
off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChangeAction, device: DeviceInfo }&gt;): void
Z
zengyawen 已提交
1179 1180 1181

取消注册设备状态回调。

史晓晓 已提交
1182
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1183

1184 1185
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1186
**参数:**
@
@shi-xiaoxiao-iris 已提交
1187

@
@shi-xiaoxiao-iris 已提交
1188
  | 参数名       | 类型                                     | 必填   | 说明                          |
H
HelloCrease 已提交
1189 1190
  | -------- | ---------------------------------------- | ---- | --------------------------- |
  | type     | string                                   | 是    | 根据应用程序的包名取消注册设备状态回调。        |
1191
  | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 否    | 指示要取消注册的设备状态回调,返回设备状态和设备信息。 |
Z
zengyawen 已提交
1192

@
@shi-xiaoxiao-iris 已提交
1193
**示例:**
@
@shi-xiaoxiao-iris 已提交
1194

1195
  ```js
1196 1197 1198 1199 1200
  try {
    dmInstance.off('deviceStateChange', (data) => {
      console.info('deviceStateChange' + JSON.stringify(data));
    });
  } catch (err) {
1201
    console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message);
1202
  }
Z
zengyawen 已提交
1203 1204
  ```

1205 1206
### on('deviceFound')

1207
on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: DeviceInfo }&gt;): void
1208 1209 1210

注册发现设备回调监听。

史晓晓 已提交
1211
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1212

1213 1214
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1215
**参数:**
@
@shi-xiaoxiao-iris 已提交
1216

@
@shi-xiaoxiao-iris 已提交
1217
  | 参数名       | 类型                                     | 必填   | 说明                         |
H
HelloCrease 已提交
1218 1219
  | -------- | ---------------------------------------- | ---- | -------------------------- |
  | type     | string                                   | 是    | 注册设备发现回调,以便在发现周边设备时通知应用程序。 |
1220
  | callback | Callback&lt;{&nbsp;subscribeId:&nbsp;number,&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是    | 注册设备发现的回调方法。               |
1221

@
@shi-xiaoxiao-iris 已提交
1222
**示例:**
@
@shi-xiaoxiao-iris 已提交
1223

1224
  ```js
1225 1226 1227 1228 1229
  try {
    dmInstance.on('deviceFound', (data) => {
      console.info("deviceFound:" + JSON.stringify(data));
    });
  } catch (err) {
1230
    console.error("deviceFound errCode:" + err.code + ",errMessage:" + err.message);
1231
  }
1232 1233 1234 1235
  ```

### off('deviceFound')

1236
off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: DeviceInfo }&gt;): void
1237 1238 1239

取消注册设备发现回调。

史晓晓 已提交
1240
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1241

1242 1243
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1244
**参数:**
@
@shi-xiaoxiao-iris 已提交
1245

@
@shi-xiaoxiao-iris 已提交
1246
  | 参数名       | 类型                                     | 必填   | 说明                          |
H
HelloCrease 已提交
1247 1248
  | -------- | ---------------------------------------- | ---- | --------------------------- |
  | type     | string                                   | 是    | 取消注册设备发现回调。                 |
1249
  | callback | Callback&lt;{&nbsp;subscribeId:&nbsp;number,&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 否    | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 |
1250

@
@shi-xiaoxiao-iris 已提交
1251
**示例:**
@
@shi-xiaoxiao-iris 已提交
1252

1253
  ```js
1254 1255 1256 1257 1258
  try {
    dmInstance.off('deviceFound', (data) => {
      console.info('deviceFound' + JSON.stringify(data));
    });
  } catch (err) {
1259
    console.error("deviceFound errCode:" + err.code + ",errMessage:" + err.message);
1260
  }
1261 1262 1263 1264
  ```

### on('discoverFail')

1265
on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: number }&gt;): void
1266 1267 1268

注册设备发现失败回调监听。

史晓晓 已提交
1269
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1270

1271 1272
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1273
**参数:**
@
@shi-xiaoxiao-iris 已提交
1274

@
@shi-xiaoxiao-iris 已提交
1275
  | 参数名       | 类型                                     | 必填   | 说明                             |
H
HelloCrease 已提交
1276 1277
  | -------- | ---------------------------------------- | ---- | ------------------------------ |
  | type     | string                                   | 是    | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 |
1278
  | callback | Callback&lt;{&nbsp;subscribeId:&nbsp;number,&nbsp;reason:&nbsp;number&nbsp;}&gt; | 是    | 注册设备发现失败的回调方法。                 |
1279

@
@shi-xiaoxiao-iris 已提交
1280
**示例:**
@
@shi-xiaoxiao-iris 已提交
1281

1282
  ```js
1283 1284
  try {
    dmInstance.on('discoverFail', (data) => {
1285
        console.info("discoverFail on:" + JSON.stringify(data));
1286
    });
1287
  } catch (err) {
1288
    console.error("discoverFail errCode:" + err.code + ",errMessage:" + err.message);
1289
  }
1290 1291 1292 1293
  ```

### off('discoverFail')

1294
off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason: number }&gt;): void
1295 1296 1297

取消注册设备发现失败回调。

史晓晓 已提交
1298
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1299

1300 1301
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1302
**参数:**
@
@shi-xiaoxiao-iris 已提交
1303

@
@shi-xiaoxiao-iris 已提交
1304
  | 参数名       | 类型                                     | 必填   | 说明                |
H
HelloCrease 已提交
1305 1306
  | -------- | ---------------------------------------- | ---- | ----------------- |
  | type     | string                                   | 是    | 取消注册设备发现失败回调。     |
1307
  | callback | Callback&lt;{&nbsp;subscribeId:&nbsp;number,&nbsp;reason:&nbsp;number&nbsp;}&gt; | 否    | 指示要取消注册的设备发现失败回调。 |
1308

@
@shi-xiaoxiao-iris 已提交
1309
**示例:**
@
@shi-xiaoxiao-iris 已提交
1310

1311
  ```js
1312 1313 1314 1315 1316
  try {
    dmInstance.off('discoverFail', (data) => {
      console.info('discoverFail' + JSON.stringify(data));
    });
  } catch (err) {
1317
    console.error("discoverFail errCode:" + err.code + ",errMessage:" + err.message);
1318
  }
1319 1320
  ```

@
@shi-xiaoxiao-iris 已提交
1321
### on('publishSuccess')<sup>9+</sup>
S
summer8999 已提交
1322

1323
on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): void
S
summer8999 已提交
1324 1325 1326

注册发布设备发现回调监听。

史晓晓 已提交
1327
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1328

S
summer8999 已提交
1329 1330
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1331
**参数:**
@
@shi-xiaoxiao-iris 已提交
1332

@
@shi-xiaoxiao-iris 已提交
1333
  | 参数名     | 类型                                 | 必填 | 说明                       |
S
summer8999 已提交
1334
  | -------- | ---------------------------------------- | ---- | -------------------------- |
S
summer8999 已提交
1335
  | type     | string                                   | 是   | 注册发布设备成功回调,以便将发布成功时通知应用程序。 |
1336
  | callback | Callback&lt;{&nbsp;publishId:&nbsp;number&nbsp;}&gt;    | 是   | 注册设备发布成功的回调方法。               |
S
summer8999 已提交
1337

@
@shi-xiaoxiao-iris 已提交
1338

@
@shi-xiaoxiao-iris 已提交
1339
**示例:**
@
@shi-xiaoxiao-iris 已提交
1340

S
summer8999 已提交
1341
  ```js
1342 1343 1344 1345 1346
  try {
    dmInstance.on('publishSuccess', (data) => {
      console.info("publishSuccess:" + JSON.stringify(data));
    });
  } catch (err) {
1347
    console.error("publishSuccess errCode:" + err.code + ",errMessage:" + err.message);
1348
  }
S
summer8999 已提交
1349 1350
  ```

@
@shi-xiaoxiao-iris 已提交
1351
### off('publishSuccess')<sup>9+</sup>
S
summer8999 已提交
1352

1353
off(type: 'publishSuccess', callback?: Callback&lt;{ publishId: number }&gt;): void
S
summer8999 已提交
1354

S
summer8999 已提交
1355
取消注册设备发布成功回调。
S
summer8999 已提交
1356

史晓晓 已提交
1357
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1358

S
summer8999 已提交
1359 1360
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1361
**参数:**
@
@shi-xiaoxiao-iris 已提交
1362

@
@shi-xiaoxiao-iris 已提交
1363
  | 参数名     | 类型                                 | 必填 | 说明                          |
S
summer8999 已提交
1364
  | -------- | ---------------------------------------- | ---- | --------------------------- |
S
summer8999 已提交
1365
  | type     | string                                   | 是   | 取消注册设备发布成功回调。                 |
1366
  | callback | Callback&lt;{&nbsp;publishId:&nbsp;number&nbsp;}&gt;    | 否   | 指示要取消注册的设备发布成功回调。 |
S
summer8999 已提交
1367

@
@shi-xiaoxiao-iris 已提交
1368
**示例:**
@
@shi-xiaoxiao-iris 已提交
1369

S
summer8999 已提交
1370
  ```js
1371 1372 1373 1374 1375
  try {
    dmInstance.off('publishSuccess', (data) => {
      console.info('publishSuccess' + JSON.stringify(data));
    });
  } catch (err) {
1376
    console.error("publishSuccess errCode:" + err.code + ",errMessage:" + err.message);
1377
  }
S
summer8999 已提交
1378 1379
  ```

@
@shi-xiaoxiao-iris 已提交
1380
### on('publishFail')<sup>9+</sup>
S
summer8999 已提交
1381

1382
on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: number }&gt;): void
S
summer8999 已提交
1383 1384 1385

注册设备发布失败回调监听。

史晓晓 已提交
1386
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1387

S
summer8999 已提交
1388 1389
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1390
**参数:**
@
@shi-xiaoxiao-iris 已提交
1391

@
@shi-xiaoxiao-iris 已提交
1392
  | 参数名     | 类型                                              | 必填 | 说明                             |
S
summer8999 已提交
1393 1394
  | -------- | ----------------------------------------------------- | ---- | ------------------------------ |
  | type     | string                                                | 是   | 注册设备发布失败回调,以便在发布设备失败时通知应用程序。 |
1395
  | callback | Callback&lt;{&nbsp;publishId:&nbsp;number,&nbsp;reason:&nbsp;number&nbsp;}&gt; | 是   | 注册设备发布失败的回调方法。                 |
S
summer8999 已提交
1396

@
@shi-xiaoxiao-iris 已提交
1397
**示例:**
@
@shi-xiaoxiao-iris 已提交
1398

S
summer8999 已提交
1399
  ```js
1400 1401
  try {
    dmInstance.on('publishFail', (data) => {
1402
      console.info("publishFail on:" + JSON.stringify(data));
1403 1404
    });
  } catch (err) {
1405
    console.error("publishFail errCode:" + err.code + ",errMessage:" + err.message);
1406
  }
S
summer8999 已提交
1407 1408
  ```

@
@shi-xiaoxiao-iris 已提交
1409
### off('publishFail')<sup>9+</sup>
S
summer8999 已提交
1410

1411
off(type: 'publishFail', callback?: Callback&lt;{ publishId: number, reason: number }&gt;): void
S
summer8999 已提交
1412

S
summer8999 已提交
1413
取消注册设备发布失败回调。
S
summer8999 已提交
1414

史晓晓 已提交
1415
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1416

S
summer8999 已提交
1417 1418
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1419
**参数:**
@
@shi-xiaoxiao-iris 已提交
1420

@
@shi-xiaoxiao-iris 已提交
1421
  | 参数名     | 类型                                              | 必填 | 说明                |
S
summer8999 已提交
1422 1423
  | -------- | ----------------------------------------------------- | ---- | ----------------- |
  | type     | string                                                | 是   | 取消注册设备发布失败回调。     |
1424
  | callback | Callback&lt;{&nbsp;publishId:&nbsp;number,&nbsp;reason:&nbsp;number&nbsp;}&gt; | 否   | 指示要取消注册设备发布失败回调。 |
S
summer8999 已提交
1425

@
@shi-xiaoxiao-iris 已提交
1426
**示例:**
@
@shi-xiaoxiao-iris 已提交
1427

S
summer8999 已提交
1428
  ```js
1429 1430 1431 1432 1433
  try {
    dmInstance.off('publishFail', (data) => {
      console.info('publishFail' + JSON.stringify(data));
    });
  } catch (err) {
1434
    console.error("publishFail errCode:" + err.code + ",errMessage:" + err.message);
1435
  }
S
summer8999 已提交
1436
  ```
1437

Z
zengyawen 已提交
1438 1439 1440
### on('serviceDie')

on(type: 'serviceDie', callback: () =&gt; void): void
Z
zengyawen 已提交
1441 1442 1443

注册设备管理服务死亡监听。

史晓晓 已提交
1444
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1445

1446 1447
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1448
**参数:**
@
@shi-xiaoxiao-iris 已提交
1449

@
@shi-xiaoxiao-iris 已提交
1450
  | 参数名       | 类型                    | 必填   | 说明                                       |
H
HelloCrease 已提交
1451 1452 1453
  | -------- | ----------------------- | ---- | ---------------------------------------- |
  | type     | string                  | 是    | 注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
  | callback | ()&nbsp;=&gt;&nbsp;void | 是    | 注册serviceDie的回调方法。                       |
Z
zengyawen 已提交
1454

@
@shi-xiaoxiao-iris 已提交
1455
**示例:**
@
@shi-xiaoxiao-iris 已提交
1456

1457
  ```js
1458 1459 1460 1461 1462
  try {
    dmInstance.on("serviceDie", () => {
      console.info("serviceDie on");
    });
  } catch (err) {
1463
    console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
1464
  }
Z
zengyawen 已提交
1465
  ```
Z
zengyawen 已提交
1466

Z
zengyawen 已提交
1467 1468 1469 1470 1471
### off('serviceDie')

off(type: 'serviceDie', callback?: () =&gt; void): void

取消注册设备管理服务死亡监听。
Z
zengyawen 已提交
1472

史晓晓 已提交
1473
**需要权限**:ohos.permission.ACCESS_SERVICE_DM。
1474

1475 1476
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1477
**参数:**
@
@shi-xiaoxiao-iris 已提交
1478

@
@shi-xiaoxiao-iris 已提交
1479
  | 参数名       | 类型                    | 必填   | 说明                                       |
H
HelloCrease 已提交
1480 1481 1482
  | -------- | ----------------------- | ---- | ---------------------------------------- |
  | type     | string                  | 是    | 取消注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
  | callback | ()&nbsp;=&gt;&nbsp;void | 否    | 取消注册serviceDie的回调方法。                     |
Z
zengyawen 已提交
1483

@
@shi-xiaoxiao-iris 已提交
1484
**示例:**
@
@shi-xiaoxiao-iris 已提交
1485

1486
  ```js
1487 1488 1489 1490 1491
  try {
    dmInstance.off("serviceDie", () => {
      console.info("serviceDie off");
    });
  } catch (err) {
1492
    console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
1493
  }
1494
  ```