js-apis-device-manager.md 32.9 KB
Newer Older
S
summer8999 已提交
1 2 3



Z
zengyawen 已提交
4
# 设备管理
Z
zengyawen 已提交
5

6 7 8 9 10 11 12 13 14
本模块提供分布式设备管理能力。

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

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

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

Z
zengyawen 已提交
22 23

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

25
```js
Z
zengyawen 已提交
26 27 28 29
import deviceManager from '@ohos.distributedHardware.deviceManager';
```


Z
zengyawen 已提交
30 31 32
## deviceManager.createDeviceManager

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

创建一个设备管理器实例。
35 36 37

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

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

- 示例:
45 46 47
  ```js
  try {
    deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => {
Z
zengyawen 已提交
48
      if (err) { 
49
        console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message);
50
        return;
Z
zengyawen 已提交
51 52
      }
      console.info("createDeviceManager success");
H
HelloCrease 已提交
53
      let dmInstance = data;
54 55
    });
  } catch(err) {
56
    console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message);
57
  }
Z
zengyawen 已提交
58 59
  ```

60
## DeviceInfo
Z
zengyawen 已提交
61

62
设备信息。
Z
zengyawen 已提交
63

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

H
HelloCrease 已提交
66 67 68 69 70 71
| 名称                     | 类型                        | 必填   | 描述       |
| ---------------------- | ------------------------- | ---- | -------- |
| deviceId               | string                    | 是    | 设备的唯一标识。 |
| deviceName             | string                    | 是    | 设备名称。    |
| deviceType             | [DeviceType](#devicetype) | 是    | 设备类型。    |
| networkId<sup>8+</sup> | string                    | 是    | 设备网络标识。  |
S
summer8999 已提交
72
| range<sup>9+</sup>     | number                    | 是    | 发现设备的距离。  |
Z
zengyawen 已提交
73 74

## DeviceType
Z
zengyawen 已提交
75 76 77

表示设备类型的枚举类。

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

H
HelloCrease 已提交
80 81 82 83 84 85 86 87 88
| 名称           | 默认值  | 说明   |
| ------------ | ---- | ---- |
| SPEAKER      | 0x0A | 智能音箱 |
| PHONE        | 0x0E | 手机   |
| TABLET       | 0x11 | 平板   |
| WEARABLE     | 0x6D | 智能穿戴 |
| TV           | 0x9C | 智慧屏  |
| CAR          | 0x83 | 车    |
| UNKNOWN_TYPE | 0    | 未知设备 |
89

Z
zengyawen 已提交
90

91
## DeviceStateChangeAction
Z
zengyawen 已提交
92

93 94 95 96
表示设备状态变化的枚举。

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

H
HelloCrease 已提交
97 98
| 名称      | 默认值  | 说明              |
| ------- | ---- | --------------- |
S
summer8999 已提交
99 100 101
| ONLINE  | 0    | 设备物理上线状态。           |
| READY   | 1    | 设备可用状态,表示设备间信息已在分布式数据中同步完成, 可以运行分布式业务。 |
| OFFLINE | 2    | 设备物理下线状态。           |
H
HelloCrease 已提交
102
| CHANGE  | 3    | 设备信息更改。         |
103 104 105 106

## SubscribeInfo

发现信息。
Z
zengyawen 已提交
107

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

H
HelloCrease 已提交
110 111 112 113 114 115 116 117 118
| 名称            | 类型                                | 必填   | 描述                |
| ------------- | --------------------------------- | ---- | ----------------- |
| subscribeId   | number                            | 是    | 发现标识,用于标识不同的发现周期。 |
| mode          | [DiscoverMode ](#discovermode)    | 否    | 发现模式。             |
| medium        | [ExchangeMedium](#exchangemedium) | 否    | 发现类型。             |
| freq          | [ExchangeFreq](#exchangefreq)     | 否    | 发现频率。             |
| isSameAccount | boolean                           | 否    | 是否同账号。            |
| isWakeRemote  | boolean                           | 否    | 是否唤醒设备。           |
| capability    | [SubscribeCap](#subscribecap)     | 否    | 发现能力。             |
119 120 121 122 123 124 125 126


## DiscoverMode 

表示发现模式的枚举。

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

H
HelloCrease 已提交
127 128
| 名称                    | 默认值  | 说明    |
| --------------------- | ---- | ----- |
129
| DISCOVER_MODE_PASSIVE | 0x55 | 被动模式。 |
H
HelloCrease 已提交
130
| DISCOVER_MODE_ACTIVE  | 0xAA | 主动模式。 |
131 132 133 134 135 136 137 138


## ExchangeMedium 

表示发现类型的枚举。

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

H
HelloCrease 已提交
139 140 141 142 143 144
| 名称   | 默认值  | 说明        |
| ---- | ---- | --------- |
| AUTO | 0    | 自动发现类型。   |
| BLE  | 1    | 蓝牙发现类型。   |
| COAP | 2    | WiFi发现类型。 |
| USB  | 3    | USB发现类型。  |
145 146 147 148 149 150 151

## ExchangeFreq 

表示发现频率的枚举。

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

H
HelloCrease 已提交
152 153 154 155 156 157
| 名称         | 默认值  | 说明    |
| ---------- | ---- | ----- |
| LOW        | 0    | 低频率。  |
| MID        | 1    | 中频率。  |
| HIGH       | 2    | 高频率。  |
| SUPER_HIGH | 3    | 超高频率。 |
158 159 160 161 162 163 164 165


## SubscribeCap 

表示发现能力的枚举。

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

H
HelloCrease 已提交
166 167 168 169
| 名称                        | 默认值  | 说明             |
| ------------------------- | ---- | -------------- |
| SUBSCRIBE_CAPABILITY_DDMP | 0    | DDMP能力,后续会被废弃。 |
| SUBSCRIBE_CAPABILITY_OSD  | 1    | OSD能力。         |
170 171 172 173 174 175 176 177


## AuthParam

认证参数。

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

H
HelloCrease 已提交
178 179 180 181
| 名称        | 类型                   | 必填   | 描述         |
| --------- | -------------------- | ---- | ---------- |
| authType  | number               | 是    | 认证类型。      |
| extraInfo | {[key:string] : any} | 否    | 认证参数可扩展字段。 |
182 183 184 185 186 187 188

## AuthInfo

认证信息。

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

H
HelloCrease 已提交
189 190 191 192 193
| 名称        | 类型                   | 必填   | 描述         |
| --------- | -------------------- | ---- | ---------- |
| authType  | number               | 是    | 认证类型。      |
| token     | number               | 是    | 认证Token。   |
| extraInfo | {[key:string] : any} | 否    | 认证信息可扩展字段。 |
Z
zengyawen 已提交
194

S
summer8999 已提交
195
## PublishInfo9+</sup>
S
summer8999 已提交
196 197 198 199 200 201 202 203 204 205 206

发布设备参数

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

| 名称          | 类型                              | 必填   | 描述                |
| ------------- | --------------------------------- | ---- | ----------------- |
| publishId     | number                            | 是    | 发布设备标识,用于标识不同的发布周期。 |
| mode          | [DiscoverMode ](#discovermode)    | 是    | 发现模式。             |
| freq          | [ExchangeFreq](#exchangefreq)     | 是    | 发现频率。             |
| ranging       | boolean                           | 是    | 发布的设备是否支持测距能力。             |
Z
zengyawen 已提交
207 208

## DeviceManager
Z
zengyawen 已提交
209 210 211 212

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


Z
zengyawen 已提交
213
### release
Z
zengyawen 已提交
214

Z
zengyawen 已提交
215
release(): void
Z
zengyawen 已提交
216

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

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

Z
zengyawen 已提交
221
- 示例:
222
  ```js
223 224 225
  try {
    dmInstance.release();
  } catch (err) {
226
    console.error("release errCode:" + err.code + ",errMessage:" + err.message);
227
  }
Z
zengyawen 已提交
228
  ```
Z
zengyawen 已提交
229 230


Z
zengyawen 已提交
231
### getTrustedDeviceListSync
Z
zengyawen 已提交
232

Z
zengyawen 已提交
233
getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt;
Z
zengyawen 已提交
234 235 236

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

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

Z
zengyawen 已提交
239
- 返回值:
H
HelloCrease 已提交
240 241
  | 名称                                     | 说明        |
  | -------------------------------------- | --------- |
Z
zengyawen 已提交
242 243 244
  | Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回可信设备列表。 |

- 示例:
245
  ```js
246 247 248
  try {
    var deviceInfoList = dmInstance.getTrustedDeviceListSync();
  } catch (err) {
249
    console.error("getTrustedDeviceListSync errCode:" + err.code + ",errMessage:" + err.message);
250
  }
Z
zengyawen 已提交
251
  ```
Z
zengyawen 已提交
252 253


254 255 256 257 258 259 260 261 262
### getTrustedDeviceList<sup>8+</sup>

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

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

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

- 参数:
H
HelloCrease 已提交
263 264 265
  | 名称       | 参数类型                                     | 必填   | 说明                    |
  | -------- | ---------------------------------------- | ---- | --------------------- |
  | callback | AsyncCallback&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | 是    | 获取所有可信设备列表的回调,返回设备信息。 |
266 267 268

- 示例:
  ```js
269 270 271
  try {
    dmInstance.getTrustedDeviceList((err, data) => {
      if (err) {
272
        console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
273 274
        return;
      }
275
      console.log('get trusted device info: ' + JSON.stringify(data));
276
    });
277
  } catch (err) {
278
    console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
279
  }
280 281 282 283 284 285 286 287 288 289 290
  ```

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

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

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

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

- 返回值:
H
HelloCrease 已提交
291 292
  | 类型                                       | 说明                    |
  | ---------------------------------------- | --------------------- |
293 294 295 296
  | Promise&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | Promise实例,用于获取异步返回结果。 |

- 示例:
  ```js
297 298
  try {
    dmInstance.getTrustedDeviceList().then((data) => {
@
@shi-xiaoxiao-iris 已提交
299
      console.log('get trusted device info: ' + JSON.stringify(data));
300
      }).catch((err) => {
301
        console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
302 303
    });
  } catch (err) {
304
      console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
305
  }
306 307 308 309 310 311 312 313 314 315 316
  ```

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

getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)

同步获取本地设备信息。

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

- 返回值:
H
HelloCrease 已提交
317 318
  | 名称                                     | 说明        |
  | -------------------------------------- | --------- |
319
  | Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回本地设备列表。 |
320 321 322

- 示例:
  ```js
323 324 325
  try {
    var deviceInfo = dmInstance.getLocalDeviceInfoSync();
  } catch (err) {
326
    console.error("getLocalDeviceInfoSync errCode:" + err.code + ",errMessage:" + err.message);
327
  }
328 329 330 331 332 333 334 335 336 337 338 339
  ```


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

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

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

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

- 参数:
H
HelloCrease 已提交
340 341 342
  | 名称       | 参数类型                                     | 必填   | 说明        |
  | -------- | ---------------------------------------- | ---- | --------- |
  | callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是    | 获取本地设备信息。 |
343 344 345

- 示例:
  ```js
346
  try {
347
    dmInstance.getLocalDeviceInfo((err, data) => {
348
    if (err) {
349
      console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
350
      return;
351
    }
352 353 354
      console.log('get local device info: ' + JSON.stringify(data));
    });
  } catch (err) {
355
    console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
356
  }
357 358 359 360 361 362 363 364 365 366 367
  ```

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

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

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

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

- 返回值:
H
HelloCrease 已提交
368 369
  | 类型                                       | 说明                    |
  | ---------------------------------------- | --------------------- |
370 371 372 373
  | Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例,用于获取异步返回结果。 |

- 示例:
  ```js
374 375
  try {
    dmInstance.getLocalDeviceInfo().then((data) => {
376
      console.log('get local device info: ' + JSON.stringify(data));
377
    }).catch((err) => {
378
      console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
379 380
    });
  } catch (err) {
381
    console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
382
  }
383 384
  ```

S
summer8999 已提交
385
### startDeviceDiscovery8+</sup>
386 387 388 389 390 391 392 393

startDeviceDiscovery(subscribeInfo: SubscribeInfo): void

发现周边设备。

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

- 参数:
H
HelloCrease 已提交
394 395 396
  | 名称            | 参数类型                            | 必填   | 说明    |
  | ------------- | ------------------------------- | ---- | ----- |
  | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是    | 发现信息。 |
397 398 399

- 示例:
  ```js
400
  // 生成发现标识,随机数确保每次调用发现接口的标识不一致
401 402 403
  var subscribeId = Math.floor(Math.random() * 10000 + 1000);
  var subscribeInfo = {
      "subscribeId": subscribeId,
404 405 406
      "mode": 0xAA, // 主动模式
      "medium": 0,  // 自动发现类型,同时支持多种发现类型
      "freq": 2,    // 高频率
407 408 409 410
      "isSameAccount": false,
      "isWakeRemote": false,
      "capability": 1
  };
411 412 413
  try {
    dmInstance.startDeviceDiscovery(subscribeInfo); // 当有设备发现时,通过deviceFound回调通知给应用程序
  } catch (err) {
414
    console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
415
  }
416 417
  ```

S
summer8999 已提交
418 419
### startDeviceDiscovery9+</sup>

S
summer8999 已提交
420
startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void
S
summer8999 已提交
421 422 423 424 425 426 427 428 429

发现周边设备。

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

- 参数:
  | 名称            | 参数类型                            | 必填   | 说明    |
  | ------------- | ------------------------------- | ---- | ----- |
  | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是   | 发现信息。 |
S
summer8999 已提交
430
  | filterOptions | string        | 否   | 发现设备过滤信息。|
S
summer8999 已提交
431 432 433

- 示例:
  ```js
434
  // 生成发现标识,随机数确保每次调用发现接口的标识不一致
S
summer8999 已提交
435 436 437
  var subscribeId = Math.floor(Math.random() * 10000 + 1000);
  var subscribeInfo = {
      "subscribeId": subscribeId,
438 439 440
      "mode": 0xAA, // 主动模式
      "medium": 0,  // 自动发现类型,同时支持多种发现类型
      "freq": 2,    // 高频率
S
summer8999 已提交
441 442 443 444 445
      "isSameAccount": false,
      "isWakeRemote": false,
      "capability": 1
  };
  var filterOptions = {
S
summer8999 已提交
446
    "filter_op": "OR", // 可选, 默认"OR"
S
summer8999 已提交
447 448 449
    "filters": [
        {
            "type": "range",
S
summer8999 已提交
450
            "value": 50 // 需过滤发现设备的距离,单位(cm)
S
summer8999 已提交
451 452
        }
    ]
S
summer8999 已提交
453
  };
454 455 456
  try {
    dmInstance.startDeviceDiscovery(subscribeInfo, JSON.stringify(filterOptions)); // 当有设备发现时,通过deviceFound回调通知给应用程序
  } catch (err) {
457
    console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
458
  }
S
summer8999 已提交
459 460
  ```
  
461 462 463 464 465 466 467 468 469
### stopDeviceDiscovery

stopDeviceDiscovery(subscribeId: number): void

停止发现周边设备。

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

- 参数:
H
HelloCrease 已提交
470 471 472
  | 名称          | 参数类型   | 必填   | 说明    |
  | ----------- | ------ | ---- | ----- |
  | subscribeId | number | 是    | 发现标识。 |
473 474 475

- 示例:
  ```js
476
  // 入参需要和startDeviceDiscovery接口传入的subscribeId配对使用
477 478 479
  try {
    dmInstance.stopDeviceDiscovery(subscribeId);
  } catch (err) {
480
    console.error("stopDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
481
  }
482 483
  ```

S
summer8999 已提交
484 485
### publishDeviceDiscovery9+</sup>

S
summer8999 已提交
486
publishDeviceDiscovery(publishInfo: PublishInfo): void
S
summer8999 已提交
487

S
summer8999 已提交
488
发布设备发现。
S
summer8999 已提交
489 490 491 492

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

- 参数:
S
summer8999 已提交
493
  | 名称          | 参数类型                        | 必填 | 说明    |
S
summer8999 已提交
494 495 496 497 498
  | ------------- | ------------------------------- | ---- | ----- |
  | publishInfo   | [PublishInfo](#publishinfo)     | 是   | 发布设备发现信息。 |

- 示例:
  ```js
499
  // 生成发布标识,随机数确保每次调用发布接口的标识不一致
S
summer8999 已提交
500
  var publishId = Math.floor(Math.random() * 10000 + 1000);
S
summer8999 已提交
501
  var publishInfo = {
S
summer8999 已提交
502
      "publishId": publishId,
503 504 505
      "mode": 0xAA, // 主动模式
      "freq": 2,    // 高频率
      "ranging": 1  // 支持发现时测距
S
summer8999 已提交
506
  };
507 508 509
  try {
    dmInstance.publishDeviceDiscovery(publishInfo); // 当有发布结果时,通过回调通知给应用程序
  } catch (err) {
510
    console.error("publishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
511
  }
S
summer8999 已提交
512 513
  ```
  
S
summer8999 已提交
514
### unPublishDeviceDiscovery9+</sup>
S
summer8999 已提交
515

S
summer8999 已提交
516
unPublishDeviceDiscovery(publishId: number): void
S
summer8999 已提交
517 518 519 520 521 522

停止发布设备发现。

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

- 参数:
S
summer8999 已提交
523 524 525
  | 名称        | 参数类型 | 必填 | 说明  |
  | ----------- | -------- | ---- | ----- |
  | publishId   | number   | 是   | 发布标识。 |
S
summer8999 已提交
526 527 528

- 示例:
  ```js
529
  // 入参需要和publishDeviceDiscovery接口传入的publishId配对使用
530
  try {
531
    dmInstance.unPublishDeviceDiscovery(publishId);
532
  } catch (err) {
533
    console.error("unPublishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
534
  }
S
summer8999 已提交
535 536
  ```

537 538 539 540 541 542 543 544 545
### authenticateDevice

authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: AsyncCallback<{deviceId: string, pinToken ?: number}>): void

认证设备。

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

- 参数:
H
HelloCrease 已提交
546 547 548 549 550
  | 名称         | 参数类型                                     | 必填   | 说明      |
  | ---------- | ---------------------------------------- | ---- | ------- |
  | deviceInfo | [DeviceInfo](#deviceinfo)                | 是    | 设备信息。   |
  | authParam  | [AuthParam](#authparam)                  | 是    | 认证参数。   |
  | callback   | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是    | 认证结果回调。 |
551 552 553

- 示例:
  ```js
554
  // 认证的设备信息,可以从发现的结果中获取
555 556 557 558 559 560
  var deviceInfo ={
      "deviceId": "XXXXXXXX",
      "deviceName": "",
      deviceType: 0x0E
  };
  let authParam = {
561
      "authType": 1, // 认证类型: 1 - 无账号PIN码认证
562 563
      "extraInfo": {} 
  }
564 565
  try {
    dmInstance.authenticateDevice(deviceInfo, authParam, (err, data) => {
566
      if (err) {
567
          console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
568 569 570 571
          return;
      }
      console.info(TAG + "authenticateDevice result:" + JSON.stringify(data));
      token = data.pinToken;
572 573
    });
  } catch (err) {
574
    console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
575
  }
576 577 578 579 580 581 582 583 584 585 586
  ```

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

unAuthenticateDevice(deviceInfo: DeviceInfo): void

解除认证设备。

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

- 参数:
H
HelloCrease 已提交
587 588 589
  | 名称         | 参数类型                      | 必填   | 说明    |
  | ---------- | ------------------------- | ---- | ----- |
  | deviceInfo | [DeviceInfo](#deviceinfo) | 是    | 设备信息。 |
590 591 592

- 示例:
  ```js
593 594 595
  try {
    dmInstance.unAuthenticateDevice(deviceInfo);
  } catch (err) {
596
    console.error("unAuthenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
597
  }
598 599 600 601 602 603 604 605 606 607 608 609
  ```


### verifyAuthInfo

verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void

验证认证信息。

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

- 参数:
H
HelloCrease 已提交
610 611 612 613
  | 名称       | 参数类型                                     | 必填   | 说明      |
  | -------- | ---------------------------------------- | ---- | ------- |
  | authInfo | [AuthInfo](#authinfo)                    | 是    | 认证信息。   |
  | authInfo | AsyncCallback<{ deviceId: string, level: number }> | 是    | 验证结果回调。 |
614 615 616 617 618 619 620 621

- 示例:
  ```js
  let authInfo = {
    "authType": 1,
    "token": xxxxxx,
    "extraInfo": {}
  }
622 623
  try {
    dmInstance.verifyAuthInfo(authInfo, (err, data) => {
624
    if (err) {
625
        console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
626 627 628
        return;
    }
    console.info(TAG + "verifyAuthInfo result:" + JSON.stringify(data));
629 630
    });
  } catch (err) {
631
    console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
632
  }
633 634 635
  ```


Z
zengyawen 已提交
636
### on('deviceStateChange')
Z
zengyawen 已提交
637

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

Z
zengyawen 已提交
640 641
注册设备状态回调。

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

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

Z
zengyawen 已提交
650
- 示例:
651
  ```js
652 653 654 655 656
  try {
    dmInstance.on('deviceStateChange', (data) => {
      console.info("deviceStateChange on:" + JSON.stringify(data));
    });
  } catch (err) {
657
    console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message);
658
  }
Z
zengyawen 已提交
659
  ```
Z
zengyawen 已提交
660 661


Z
zengyawen 已提交
662
### off('deviceStateChange')
Z
zengyawen 已提交
663

664
off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChangeAction, device: DeviceInfo }&gt;): void
Z
zengyawen 已提交
665 666 667

取消注册设备状态回调。

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

Z
zengyawen 已提交
670
- 参数:
H
HelloCrease 已提交
671 672 673 674
  | 名称       | 参数类型                                     | 必填   | 说明                          |
  | -------- | ---------------------------------------- | ---- | --------------------------- |
  | type     | string                                   | 是    | 根据应用程序的包名取消注册设备状态回调。        |
  | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;&nbsp;}&gt; | 是    | 指示要取消注册的设备状态回调,返回设备状态和设备信息。 |
Z
zengyawen 已提交
675 676

- 示例:
677
  ```js
678 679 680 681 682
  try {
    dmInstance.off('deviceStateChange', (data) => {
      console.info('deviceStateChange' + JSON.stringify(data));
    });
  } catch (err) {
683
    console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message);
684
  }
Z
zengyawen 已提交
685 686 687
  ```


688 689 690 691 692 693 694 695 696
### on('deviceFound')

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

注册发现设备回调监听。

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

- 参数:
H
HelloCrease 已提交
697 698 699 700
  | 名称       | 参数类型                                     | 必填   | 说明                         |
  | -------- | ---------------------------------------- | ---- | -------------------------- |
  | type     | string                                   | 是    | 注册设备发现回调,以便在发现周边设备时通知应用程序。 |
  | callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是    | 注册设备发现的回调方法。               |
701 702 703

- 示例:
  ```js
704 705 706 707 708
  try {
    dmInstance.on('deviceFound', (data) => {
      console.info("deviceFound:" + JSON.stringify(data));
    });
  } catch (err) {
709
    console.error("deviceFound errCode:" + err.code + ",errMessage:" + err.message);
710
  }
711 712 713 714 715 716 717 718 719 720 721
  ```

### off('deviceFound')

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

取消注册设备发现回调。

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

- 参数:
H
HelloCrease 已提交
722 723 724 725
  | 名称       | 参数类型                                     | 必填   | 说明                          |
  | -------- | ---------------------------------------- | ---- | --------------------------- |
  | type     | string                                   | 是    | 取消注册设备发现回调。                 |
  | callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是    | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 |
726 727 728

- 示例:
  ```js
729 730 731 732 733
  try {
    dmInstance.off('deviceFound', (data) => {
      console.info('deviceFound' + JSON.stringify(data));
    });
  } catch (err) {
734
    console.error("deviceFound errCode:" + err.code + ",errMessage:" + err.message);
735
  }
736 737 738 739 740 741 742 743 744 745 746
  ```

### on('discoverFail')

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

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

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

- 参数:
H
HelloCrease 已提交
747 748 749 750
  | 名称       | 参数类型                                     | 必填   | 说明                             |
  | -------- | ---------------------------------------- | ---- | ------------------------------ |
  | type     | string                                   | 是    | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 |
  | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是    | 注册设备发现失败的回调方法。                 |
751 752 753

- 示例:
  ```js
754 755
  try {
    dmInstance.on('discoverFail', (data) => {
756
        console.info("discoverFail on:" + JSON.stringify(data));
757
    });
758
  } catch (err) {
759
    console.error("discoverFail errCode:" + err.code + ",errMessage:" + err.message);
760
  }
761 762 763 764 765 766 767 768 769 770 771
  ```

### off('discoverFail')

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

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

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

- 参数:
H
HelloCrease 已提交
772 773 774 775
  | 名称       | 参数类型                                     | 必填   | 说明                |
  | -------- | ---------------------------------------- | ---- | ----------------- |
  | type     | string                                   | 是    | 取消注册设备发现失败回调。     |
  | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是    | 指示要取消注册的设备发现失败回调。 |
776 777 778

- 示例:
  ```js
779 780 781 782 783
  try {
    dmInstance.off('discoverFail', (data) => {
      console.info('discoverFail' + JSON.stringify(data));
    });
  } catch (err) {
784
    console.error("discoverFail errCode:" + err.code + ",errMessage:" + err.message);
785
  }
786 787
  ```

S
summer8999 已提交
788
### on('publishSuccess')9+</sup>
S
summer8999 已提交
789 790 791 792 793 794 795 796

on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): void

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

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

- 参数:
S
summer8999 已提交
797
  | 名称     | 参数类型                                 | 必填 | 说明                       |
S
summer8999 已提交
798
  | -------- | ---------------------------------------- | ---- | -------------------------- |
S
summer8999 已提交
799 800
  | type     | string                                   | 是   | 注册发布设备成功回调,以便将发布成功时通知应用程序。 |
  | callback | Callback&lt;{ publishId: number }&gt;    | 是   | 注册设备发布成功的回调方法。               |
S
summer8999 已提交
801 802 803

- 示例:
  ```js
804 805 806 807 808
  try {
    dmInstance.on('publishSuccess', (data) => {
      console.info("publishSuccess:" + JSON.stringify(data));
    });
  } catch (err) {
809
    console.error("publishSuccess errCode:" + err.code + ",errMessage:" + err.message);
810
  }
S
summer8999 已提交
811 812
  ```

S
summer8999 已提交
813
### off('publishSuccess')9+</sup>
S
summer8999 已提交
814 815 816

off(type: 'publishSuccess', callback?: Callback&lt;{ publishId: number }&gt;): void

S
summer8999 已提交
817
取消注册设备发布成功回调。
S
summer8999 已提交
818 819 820 821

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

- 参数:
S
summer8999 已提交
822
  | 名称     | 参数类型                                 | 必填 | 说明                          |
S
summer8999 已提交
823
  | -------- | ---------------------------------------- | ---- | --------------------------- |
S
summer8999 已提交
824 825
  | type     | string                                   | 是   | 取消注册设备发布成功回调。                 |
  | callback | Callback&lt;{ publishId: number }&gt;    | 是   | 指示要取消注册的设备发布成功回调。 |
S
summer8999 已提交
826 827 828

- 示例:
  ```js
829 830 831 832 833
  try {
    dmInstance.off('publishSuccess', (data) => {
      console.info('publishSuccess' + JSON.stringify(data));
    });
  } catch (err) {
834
    console.error("publishSuccess errCode:" + err.code + ",errMessage:" + err.message);
835
  }
S
summer8999 已提交
836 837
  ```

S
summer8999 已提交
838
### on('publishFail')9+</sup>
S
summer8999 已提交
839 840 841 842 843 844 845 846

on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: number }&gt;): void

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

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

- 参数:
S
summer8999 已提交
847 848 849 850
  | 名称     | 参数类型                                              | 必填 | 说明                             |
  | -------- | ----------------------------------------------------- | ---- | ------------------------------ |
  | type     | string                                                | 是   | 注册设备发布失败回调,以便在发布设备失败时通知应用程序。 |
  | callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是   | 注册设备发布失败的回调方法。                 |
S
summer8999 已提交
851 852 853

- 示例:
  ```js
854 855
  try {
    dmInstance.on('publishFail', (data) => {
856
      console.info("publishFail on:" + JSON.stringify(data));
857 858
    });
  } catch (err) {
859
    console.error("publishFail errCode:" + err.code + ",errMessage:" + err.message);
860
  }
S
summer8999 已提交
861 862
  ```

S
summer8999 已提交
863
### off('publishFail')9+</sup>
S
summer8999 已提交
864 865 866

off(type: 'publishFail', callback?: Callback&lt;{ publishId: number, reason: number }&gt;): void

S
summer8999 已提交
867
取消注册设备发布失败回调。
S
summer8999 已提交
868 869 870 871

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

- 参数:
S
summer8999 已提交
872 873 874
  | 名称     | 参数类型                                              | 必填 | 说明                |
  | -------- | ----------------------------------------------------- | ---- | ----------------- |
  | type     | string                                                | 是   | 取消注册设备发布失败回调。     |
S
summer8999 已提交
875
  | callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是   | 指示要取消注册设备发布失败回调。 |
S
summer8999 已提交
876 877 878

- 示例:
  ```js
879 880 881 882 883
  try {
    dmInstance.off('publishFail', (data) => {
      console.info('publishFail' + JSON.stringify(data));
    });
  } catch (err) {
884
    console.error("publishFail errCode:" + err.code + ",errMessage:" + err.message);
885
  }
S
summer8999 已提交
886
  ```
887

Z
zengyawen 已提交
888 889 890
### on('serviceDie')

on(type: 'serviceDie', callback: () =&gt; void): void
Z
zengyawen 已提交
891 892 893

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

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

Z
zengyawen 已提交
896
- 参数:
H
HelloCrease 已提交
897 898 899 900
  | 名称       | 参数类型                    | 必填   | 说明                                       |
  | -------- | ----------------------- | ---- | ---------------------------------------- |
  | type     | string                  | 是    | 注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
  | callback | ()&nbsp;=&gt;&nbsp;void | 是    | 注册serviceDie的回调方法。                       |
Z
zengyawen 已提交
901

Z
zengyawen 已提交
902
- 示例:
903
  ```js
904 905 906 907 908
  try {
    dmInstance.on("serviceDie", () => {
      console.info("serviceDie on");
    });
  } catch (err) {
909
    console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
910
  }
Z
zengyawen 已提交
911
  ```
Z
zengyawen 已提交
912 913


Z
zengyawen 已提交
914 915 916 917 918
### off('serviceDie')

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

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

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

Z
zengyawen 已提交
922
- 参数:
H
HelloCrease 已提交
923 924 925 926
  | 名称       | 参数类型                    | 必填   | 说明                                       |
  | -------- | ----------------------- | ---- | ---------------------------------------- |
  | type     | string                  | 是    | 取消注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
  | callback | ()&nbsp;=&gt;&nbsp;void | 否    | 取消注册serviceDie的回调方法。                     |
Z
zengyawen 已提交
927 928

- 示例:
929
  ```js
930 931 932 933 934
  try {
    dmInstance.off("serviceDie", () => {
      console.info("serviceDie off");
    });
  } catch (err) {
935
    console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
936
  }
937
  ```