js-apis-device-manager.md 29.3 KB
Newer Older
Z
zengyawen 已提交
1
# 设备管理
Z
zengyawen 已提交
2

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

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

- 注册和解除注册设备上下线变化监听
- 发现周边不可信设备
- 认证和取消认证设备
- 查询可信设备列表
- 查询本地设备信息,包括设备名称,设备类型和设备标识
S
summer8999 已提交
12
- 发布设备发现
13 14
> **说明:**
>
15 16
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口,三方应用不支持调用。
Z
zengyawen 已提交
17

Z
zengyawen 已提交
18 19

## 导入模块
Z
zengyawen 已提交
20 21 22 23 24 25

```
import deviceManager from '@ohos.distributedHardware.deviceManager';
```


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

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

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

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

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

- 示例:
  ```
  deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => {     
      if (err) { 
          console.info("createDeviceManager err:" + JSON.stringify(err));    
          return;
      }
      console.info("createDeviceManager success");
H
HelloCrease 已提交
48
      let dmInstance = data;
Z
zengyawen 已提交
49 50 51
  });
  ```

52
## DeviceInfo
Z
zengyawen 已提交
53

54
设备信息。
Z
zengyawen 已提交
55

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

H
HelloCrease 已提交
58 59 60 61 62 63
| 名称                     | 类型                        | 必填   | 描述       |
| ---------------------- | ------------------------- | ---- | -------- |
| deviceId               | string                    | 是    | 设备的唯一标识。 |
| deviceName             | string                    | 是    | 设备名称。    |
| deviceType             | [DeviceType](#devicetype) | 是    | 设备类型。    |
| networkId<sup>8+</sup> | string                    | 是    | 设备网络标识。  |
S
summer8999 已提交
64
| range<sup>9+</sup>     | number                    | 是    | 发现设备的距离。  |
Z
zengyawen 已提交
65 66

## DeviceType
Z
zengyawen 已提交
67 68 69

表示设备类型的枚举类。

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

H
HelloCrease 已提交
72 73 74 75 76 77 78 79 80
| 名称           | 默认值  | 说明   |
| ------------ | ---- | ---- |
| SPEAKER      | 0x0A | 智能音箱 |
| PHONE        | 0x0E | 手机   |
| TABLET       | 0x11 | 平板   |
| WEARABLE     | 0x6D | 智能穿戴 |
| TV           | 0x9C | 智慧屏  |
| CAR          | 0x83 | 车    |
| UNKNOWN_TYPE | 0    | 未知设备 |
81

Z
zengyawen 已提交
82

83
## DeviceStateChangeAction
Z
zengyawen 已提交
84

85 86 87 88
表示设备状态变化的枚举。

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

H
HelloCrease 已提交
89 90 91 92 93 94
| 名称      | 默认值  | 说明              |
| ------- | ---- | --------------- |
| ONLINE  | 0    | 设备上线。           |
| READY   | 1    | 设备就绪,设备信息同步已完成。 |
| OFFLINE | 2    | 设备下线。           |
| CHANGE  | 3    | 设备信息更改。         |
95 96 97 98

## SubscribeInfo

发现信息。
Z
zengyawen 已提交
99

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

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


## DiscoverMode 

表示发现模式的枚举。

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

H
HelloCrease 已提交
119 120
| 名称                    | 默认值  | 说明    |
| --------------------- | ---- | ----- |
121
| DISCOVER_MODE_PASSIVE | 0x55 | 被动模式。 |
H
HelloCrease 已提交
122
| DISCOVER_MODE_ACTIVE  | 0xAA | 主动模式。 |
123 124 125 126 127 128 129 130


## ExchangeMedium 

表示发现类型的枚举。

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

H
HelloCrease 已提交
131 132 133 134 135 136
| 名称   | 默认值  | 说明        |
| ---- | ---- | --------- |
| AUTO | 0    | 自动发现类型。   |
| BLE  | 1    | 蓝牙发现类型。   |
| COAP | 2    | WiFi发现类型。 |
| USB  | 3    | USB发现类型。  |
137 138 139 140 141 142 143

## ExchangeFreq 

表示发现频率的枚举。

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

H
HelloCrease 已提交
144 145 146 147 148 149
| 名称         | 默认值  | 说明    |
| ---------- | ---- | ----- |
| LOW        | 0    | 低频率。  |
| MID        | 1    | 中频率。  |
| HIGH       | 2    | 高频率。  |
| SUPER_HIGH | 3    | 超高频率。 |
150 151 152 153 154 155 156 157


## SubscribeCap 

表示发现能力的枚举。

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

H
HelloCrease 已提交
158 159 160 161
| 名称                        | 默认值  | 说明             |
| ------------------------- | ---- | -------------- |
| SUBSCRIBE_CAPABILITY_DDMP | 0    | DDMP能力,后续会被废弃。 |
| SUBSCRIBE_CAPABILITY_OSD  | 1    | OSD能力。         |
162 163 164 165 166 167 168 169


## AuthParam

认证参数。

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

H
HelloCrease 已提交
170 171 172 173
| 名称        | 类型                   | 必填   | 描述         |
| --------- | -------------------- | ---- | ---------- |
| authType  | number               | 是    | 认证类型。      |
| extraInfo | {[key:string] : any} | 否    | 认证参数可扩展字段。 |
174 175 176 177 178 179 180

## AuthInfo

认证信息。

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

H
HelloCrease 已提交
181 182 183 184 185
| 名称        | 类型                   | 必填   | 描述         |
| --------- | -------------------- | ---- | ---------- |
| authType  | number               | 是    | 认证类型。      |
| token     | number               | 是    | 认证Token。   |
| extraInfo | {[key:string] : any} | 否    | 认证信息可扩展字段。 |
Z
zengyawen 已提交
186

S
summer8999 已提交
187 188 189 190 191 192 193 194 195 196 197 198
## PublishInfo

发布设备参数

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

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

## DeviceManager
Z
zengyawen 已提交
201 202 203 204

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


Z
zengyawen 已提交
205
### release
Z
zengyawen 已提交
206

Z
zengyawen 已提交
207
release(): void
Z
zengyawen 已提交
208

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

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

Z
zengyawen 已提交
213
- 示例:
214
  ```js
Z
zengyawen 已提交
215 216
  dmInstance.release();
  ```
Z
zengyawen 已提交
217 218


Z
zengyawen 已提交
219
### getTrustedDeviceListSync
Z
zengyawen 已提交
220

Z
zengyawen 已提交
221
getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt;
Z
zengyawen 已提交
222 223 224

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

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

Z
zengyawen 已提交
227
- 返回值:
H
HelloCrease 已提交
228 229
  | 名称                                     | 说明        |
  | -------------------------------------- | --------- |
Z
zengyawen 已提交
230 231 232
  | Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回可信设备列表。 |

- 示例:
233
  ```js
Z
zengyawen 已提交
234 235
  var deviceInfoList = dmInstance.getTrustedDeviceListSync();
  ```
Z
zengyawen 已提交
236 237


238 239 240 241 242 243 244 245 246
### getTrustedDeviceList<sup>8+</sup>

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

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

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

- 参数:
H
HelloCrease 已提交
247 248 249
  | 名称       | 参数类型                                     | 必填   | 说明                    |
  | -------- | ---------------------------------------- | ---- | --------------------- |
  | callback | AsyncCallback&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | 是    | 获取所有可信设备列表的回调,返回设备信息。 |
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

- 示例:
  ```js
  dmInstance.getTrustedDeviceList((err, data) => {
      console.log("getTrustedDeviceList err: " + JSON.stringify(err));
      console.log('get trusted device info: ' + JSON.stringify(data));
    }
  );
  ```

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

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

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

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

- 返回值:
H
HelloCrease 已提交
269 270
  | 类型                                       | 说明                    |
  | ---------------------------------------- | --------------------- |
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
  | Promise&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | Promise实例,用于获取异步返回结果。 |

- 示例:
  ```js
  dmInstance.getTrustedDeviceList().then((data) => { 
      console.log('get trusted device info: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getTrustedDeviceList err: " + JSON.stringify(err));
  });
  ```

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

getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)

同步获取本地设备信息。

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

- 返回值:
H
HelloCrease 已提交
291 292
  | 名称                                     | 说明        |
  | -------------------------------------- | --------- |
293
  | Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回本地设备列表。 |
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

- 示例:
  ```js
  var deviceInfo = dmInstance.getLocalDeviceInfoSync();
  ```


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

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

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

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

- 参数:
H
HelloCrease 已提交
310 311 312
  | 名称       | 参数类型                                     | 必填   | 说明        |
  | -------- | ---------------------------------------- | ---- | --------- |
  | callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是    | 获取本地设备信息。 |
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

- 示例:
  ```js
  dmInstance.getLocalDeviceInfo((err, data) => {
      console.log("getLocalDeviceInfo err: " + JSON.stringify(err));
      console.log('get local device info: ' + JSON.stringify(data));
    }
  );
  ```

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

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

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

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

- 返回值:
H
HelloCrease 已提交
332 333
  | 类型                                       | 说明                    |
  | ---------------------------------------- | --------------------- |
334 335 336 337 338 339 340 341 342 343 344
  | Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例,用于获取异步返回结果。 |

- 示例:
  ```js
  dmInstance.getLocalDeviceInfo().then((data) => { 
      console.log('get local device info: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getLocalDeviceInfo err: " + JSON.stringify(err));
  });
  ```

S
summer8999 已提交
345
### startDeviceDiscovery
346 347 348 349 350 351 352 353

startDeviceDiscovery(subscribeInfo: SubscribeInfo): void

发现周边设备。

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

- 参数:
H
HelloCrease 已提交
354 355 356
  | 名称            | 参数类型                            | 必填   | 说明    |
  | ------------- | ------------------------------- | ---- | ----- |
  | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是    | 发现信息。 |
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

- 示例:
  ```js
  //生成发现标识,随机数确保每次调用发现接口的标识不一致
  var subscribeId = Math.floor(Math.random() * 10000 + 1000);
  var subscribeInfo = {
      "subscribeId": subscribeId,
      "mode": 0xAA, //主动模式
      "medium": 0,  //自动发现类型,同时支持多种发现类型
      "freq": 2,    //高频率
      "isSameAccount": false,
      "isWakeRemote": false,
      "capability": 1
  };
  dmInstance.startDeviceDiscovery(subscribeInfo); //当有设备发现时,通过deviceFound回调通知给应用程序
  ```

S
summer8999 已提交
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
### startDeviceDiscovery9+</sup>

startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions: string): void

发现周边设备。

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

- 参数:
  | 名称            | 参数类型                            | 必填   | 说明    |
  | ------------- | ------------------------------- | ---- | ----- |
  | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是   | 发现信息。 |
  | filterOptions | [string](#filteroptions)        | 否   | 发现设备过滤信息。|

- 示例:
  ```js
  //生成发现标识,随机数确保每次调用发现接口的标识不一致
  var subscribeId = Math.floor(Math.random() * 10000 + 1000);
  var subscribeInfo = {
      "subscribeId": subscribeId,
      "mode": 0xAA, //主动模式
      "medium": 0,  //自动发现类型,同时支持多种发现类型
      "freq": 2,    //高频率
      "isSameAccount": false,
      "isWakeRemote": false,
      "capability": 1
  };
  var filterOptions = {
S
summer8999 已提交
402
    "filter_op": "OR", // 可选, 默认"OR"
S
summer8999 已提交
403 404 405
    "filters": [
        {
            "type": "range",
S
summer8999 已提交
406
            "value": 50 // 需过滤发现设备的距离,单位(cm)
S
summer8999 已提交
407 408
        }
    ]
S
summer8999 已提交
409
  };
S
summer8999 已提交
410
  dmInstance.startDeviceDiscovery(subscribeInfo, JSON.stringify(filterOptions)); //当有设备发现时,通过deviceFound回调通知给应用程序
S
summer8999 已提交
411 412
  ```
  
413 414 415 416 417 418 419 420 421
### stopDeviceDiscovery

stopDeviceDiscovery(subscribeId: number): void

停止发现周边设备。

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

- 参数:
H
HelloCrease 已提交
422 423 424
  | 名称          | 参数类型   | 必填   | 说明    |
  | ----------- | ------ | ---- | ----- |
  | subscribeId | number | 是    | 发现标识。 |
425 426 427 428 429 430 431

- 示例:
  ```js
  //入参需要和startDeviceDiscovery接口传入的subscribeId配对使用
  dmInstance.stopDeviceDiscovery(subscribeId);
  ```

S
summer8999 已提交
432 433
### publishDeviceDiscovery9+</sup>

S
summer8999 已提交
434
publishDeviceDiscovery(publishInfo: PublishInfo): void
S
summer8999 已提交
435

S
summer8999 已提交
436
发布设备发现。
S
summer8999 已提交
437 438 439 440

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

- 参数:
S
summer8999 已提交
441
  | 名称          | 参数类型                        | 必填 | 说明    |
S
summer8999 已提交
442 443 444 445 446
  | ------------- | ------------------------------- | ---- | ----- |
  | publishInfo   | [PublishInfo](#publishinfo)     | 是   | 发布设备发现信息。 |

- 示例:
  ```js
S
summer8999 已提交
447
  //生成发布标识,随机数确保每次调用发布接口的标识不一致
S
summer8999 已提交
448
  var publishId = Math.floor(Math.random() * 10000 + 1000);
S
summer8999 已提交
449
  var publishInfo = {
S
summer8999 已提交
450 451 452 453 454
      "publishId": publishId,
      "mode": 0xAA, //主动模式
      "freq": 2,    //高频率
      "ranging": 1  //支持发现时测距
  };
S
summer8999 已提交
455
  dmInstance.publishDeviceDiscovery(publishInfo); //当有发布结果时,通过回调通知给应用程序
S
summer8999 已提交
456 457
  ```
  
S
summer8999 已提交
458
### unPublishDeviceDiscovery
S
summer8999 已提交
459

S
summer8999 已提交
460
unPublishDeviceDiscovery(publishId: number): void
S
summer8999 已提交
461 462 463 464 465 466

停止发布设备发现。

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

- 参数:
S
summer8999 已提交
467 468 469
  | 名称        | 参数类型 | 必填 | 说明  |
  | ----------- | -------- | ---- | ----- |
  | publishId   | number   | 是   | 发布标识。 |
S
summer8999 已提交
470 471 472 473

- 示例:
  ```js
  //入参需要和publishDeviceDiscovery接口传入的publishId配对使用
S
summer8999 已提交
474
  dmInstance.unPublishDeviceDiscovery(publishId);
S
summer8999 已提交
475 476
  ```

477 478 479 480 481 482 483 484 485
### authenticateDevice

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

认证设备。

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

- 参数:
H
HelloCrease 已提交
486 487 488 489 490
  | 名称         | 参数类型                                     | 必填   | 说明      |
  | ---------- | ---------------------------------------- | ---- | ------- |
  | deviceInfo | [DeviceInfo](#deviceinfo)                | 是    | 设备信息。   |
  | authParam  | [AuthParam](#authparam)                  | 是    | 认证参数。   |
  | callback   | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是    | 认证结果回调。 |
491 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 520 521 522

- 示例:
  ```js
  //认证的设备信息,可以从发现的结果中获取
  var deviceInfo ={
      "deviceId": "XXXXXXXX",
      "deviceName": "",
      deviceType: 0x0E
  };
  let authParam = {
      "authType": 1, //认证类型: 1 - 无账号PIN码认证
      "extraInfo": {} 
  }
  dmInstance.authenticateDevice(deviceInfo, authParam, (err, data) => {
      if (err) {
          console.info(TAG + "authenticateDevice err:" + JSON.stringify(err));
          return;
      }
      console.info(TAG + "authenticateDevice result:" + JSON.stringify(data));
      token = data.pinToken;
  });
  ```

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

unAuthenticateDevice(deviceInfo: DeviceInfo): void

解除认证设备。

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

- 参数:
H
HelloCrease 已提交
523 524 525
  | 名称         | 参数类型                      | 必填   | 说明    |
  | ---------- | ------------------------- | ---- | ----- |
  | deviceInfo | [DeviceInfo](#deviceinfo) | 是    | 设备信息。 |
526 527 528

- 示例:
  ```js
W
wangyb0625 已提交
529
  dmInstance.unAuthenticateDevice(deviceInfo);
530 531 532 533 534 535 536 537 538 539 540 541
  ```


### verifyAuthInfo

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

验证认证信息。

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

- 参数:
H
HelloCrease 已提交
542 543 544 545
  | 名称       | 参数类型                                     | 必填   | 说明      |
  | -------- | ---------------------------------------- | ---- | ------- |
  | authInfo | [AuthInfo](#authinfo)                    | 是    | 认证信息。   |
  | authInfo | AsyncCallback<{ deviceId: string, level: number }> | 是    | 验证结果回调。 |
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563

- 示例:
  ```js
  let authInfo = {
    "authType": 1,
    "token": xxxxxx,
    "extraInfo": {}
  }
  dmInstance.verifyAuthInfo(authInfo, (err, data) => {
    if (err) {
        console.info(TAG + "verifyAuthInfo err:" + JSON.stringify(err));
        return;
    }
    console.info(TAG + "verifyAuthInfo result:" + JSON.stringify(data));
  });
  ```


Z
zengyawen 已提交
564
### on('deviceStateChange')
Z
zengyawen 已提交
565

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

Z
zengyawen 已提交
568 569
注册设备状态回调。

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

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

Z
zengyawen 已提交
578
- 示例:
579
  ```js
Z
zengyawen 已提交
580 581 582 583 584
  dmInstance.on('deviceStateChange', (data) => {      
        console.info("deviceStateChange on:" + JSON.stringify(data));
      }
  );
  ```
Z
zengyawen 已提交
585 586


Z
zengyawen 已提交
587
### off('deviceStateChange')
Z
zengyawen 已提交
588

589
off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChangeAction, device: DeviceInfo }&gt;): void
Z
zengyawen 已提交
590 591 592

取消注册设备状态回调。

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

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

- 示例:
602
  ```js
Z
zengyawen 已提交
603 604 605 606 607 608 609
  dmInstance.off('deviceStateChange', (data) => {      
        console.info('deviceStateChange' + JSON.stringify(data));
     }
  );
  ```


610 611 612 613 614 615 616 617 618
### on('deviceFound')

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

注册发现设备回调监听。

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

- 参数:
H
HelloCrease 已提交
619 620 621 622
  | 名称       | 参数类型                                     | 必填   | 说明                         |
  | -------- | ---------------------------------------- | ---- | -------------------------- |
  | type     | string                                   | 是    | 注册设备发现回调,以便在发现周边设备时通知应用程序。 |
  | callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是    | 注册设备发现的回调方法。               |
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640

- 示例:
  ```js
  dmInstance.on('deviceFound', (data) => {
        console.info("deviceFound:" + JSON.stringify(data));
      }
  );
  ```

### off('deviceFound')

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

取消注册设备发现回调。

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

- 参数:
H
HelloCrease 已提交
641 642 643 644
  | 名称       | 参数类型                                     | 必填   | 说明                          |
  | -------- | ---------------------------------------- | ---- | --------------------------- |
  | type     | string                                   | 是    | 取消注册设备发现回调。                 |
  | callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是    | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 |
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662

- 示例:
  ```js
  dmInstance.off('deviceFound', (data) => {      
        console.info('deviceFound' + JSON.stringify(data));
      }
  );
  ```

### on('discoverFail')

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

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

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

- 参数:
H
HelloCrease 已提交
663 664 665 666
  | 名称       | 参数类型                                     | 必填   | 说明                             |
  | -------- | ---------------------------------------- | ---- | ------------------------------ |
  | type     | string                                   | 是    | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 |
  | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是    | 注册设备发现失败的回调方法。                 |
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684

- 示例:
  ```js
  dmInstance.on('discoverFail', (data) => {
        this.log("discoverFail on:" + JSON.stringify(data));
      }
  );
  ```

### off('discoverFail')

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

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

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

- 参数:
H
HelloCrease 已提交
685 686 687 688
  | 名称       | 参数类型                                     | 必填   | 说明                |
  | -------- | ---------------------------------------- | ---- | ----------------- |
  | type     | string                                   | 是    | 取消注册设备发现失败回调。     |
  | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是    | 指示要取消注册的设备发现失败回调。 |
689 690 691 692 693 694 695 696 697

- 示例:
  ```js
  dmInstance.off('deviceFound', (data) => {      
        console.info('deviceFound' + JSON.stringify(data));
      }
  );
  ```

S
summer8999 已提交
698 699 700 701 702 703 704 705 706
### on('publishSuccess')

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

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

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

- 参数:
S
summer8999 已提交
707
  | 名称     | 参数类型                                 | 必填 | 说明                       |
S
summer8999 已提交
708
  | -------- | ---------------------------------------- | ---- | -------------------------- |
S
summer8999 已提交
709 710
  | type     | string                                   | 是   | 注册发布设备成功回调,以便将发布成功时通知应用程序。 |
  | callback | Callback&lt;{ publishId: number }&gt;    | 是   | 注册设备发布成功的回调方法。               |
S
summer8999 已提交
711 712 713 714 715 716 717 718 719 720 721 722 723

- 示例:
  ```js
  dmInstance.on('publishSuccess', (data) => {
        console.info("publishSuccess:" + JSON.stringify(data));
      }
  );
  ```

### off('publishSuccess')

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

S
summer8999 已提交
724
取消注册设备发布成功回调。
S
summer8999 已提交
725 726 727 728

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

- 参数:
S
summer8999 已提交
729
  | 名称     | 参数类型                                 | 必填 | 说明                          |
S
summer8999 已提交
730
  | -------- | ---------------------------------------- | ---- | --------------------------- |
S
summer8999 已提交
731 732
  | type     | string                                   | 是   | 取消注册设备发布成功回调。                 |
  | callback | Callback&lt;{ publishId: number }&gt;    | 是   | 指示要取消注册的设备发布成功回调。 |
S
summer8999 已提交
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750

- 示例:
  ```js
  dmInstance.off('publishSuccess', (data) => {      
        console.info('publishSuccess' + JSON.stringify(data));
      }
  );
  ```

### on('publishFail')

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

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

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

- 参数:
S
summer8999 已提交
751 752 753 754
  | 名称     | 参数类型                                              | 必填 | 说明                             |
  | -------- | ----------------------------------------------------- | ---- | ------------------------------ |
  | type     | string                                                | 是   | 注册设备发布失败回调,以便在发布设备失败时通知应用程序。 |
  | callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是   | 注册设备发布失败的回调方法。                 |
S
summer8999 已提交
755 756 757 758 759 760 761 762 763 764 765 766 767

- 示例:
  ```js
  dmInstance.on('publishFail', (data) => {
        this.log("publishFail on:" + JSON.stringify(data));
      }
  );
  ```

### off('publishFail')

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

S
summer8999 已提交
768
取消注册设备发布失败回调。
S
summer8999 已提交
769 770 771 772

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

- 参数:
S
summer8999 已提交
773 774 775
  | 名称     | 参数类型                                              | 必填 | 说明                |
  | -------- | ----------------------------------------------------- | ---- | ----------------- |
  | type     | string                                                | 是   | 取消注册设备发布失败回调。     |
S
summer8999 已提交
776
  | callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是   | 指示要取消注册设备发布失败回调。 |
S
summer8999 已提交
777 778 779 780 781 782 783 784

- 示例:
  ```js
  dmInstance.off('publishFail', (data) => {      
        console.info('publishFail' + JSON.stringify(data));
      }
  );
  ```
785

Z
zengyawen 已提交
786 787 788
### on('serviceDie')

on(type: 'serviceDie', callback: () =&gt; void): void
Z
zengyawen 已提交
789 790 791

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

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

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

Z
zengyawen 已提交
800
- 示例:
801
  ```js
Z
zengyawen 已提交
802 803 804 805 806
  dmInstance.on("serviceDie", () => {      
        console.info("serviceDie on");
     }
  );
  ```
Z
zengyawen 已提交
807 808


Z
zengyawen 已提交
809 810 811 812 813
### off('serviceDie')

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

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

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

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

- 示例:
824
  ```js
Z
zengyawen 已提交
825 826 827 828
  dmInstance.off("serviceDie", () => {      
        console.info("serviceDie off");
    }
  );
829
  ```