js-apis-device-manager.md 50.1 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

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

59
## DeviceInfo
Z
zengyawen 已提交
60

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

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

@
@shi-xiaoxiao-iris 已提交
65
| 名称                     | 类型                        | 必填   | 说明       |
H
HelloCrease 已提交
66 67 68 69 70
| ---------------------- | ------------------------- | ---- | -------- |
| deviceId               | string                    | 是    | 设备的唯一标识。 |
| deviceName             | string                    | 是    | 设备名称。    |
| deviceType             | [DeviceType](#devicetype) | 是    | 设备类型。    |
| networkId<sup>8+</sup> | string                    | 是    | 设备网络标识。  |
S
summer8999 已提交
71
| range<sup>9+</sup>     | number                    | 是    | 发现设备的距离。  |
W
wangxuanxuan 已提交
72
| authForm<sup>10+</sup> | [AuthForm](#authform)     | 是    | 设备认证类型  |
Z
zengyawen 已提交
73 74

## DeviceType
Z
zengyawen 已提交
75 76 77

表示设备类型的枚举类。

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

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

W
wuqi0105 已提交
90
## AuthForm<sup>10+</sup>
W
wangxuanxuan 已提交
91 92 93 94 95 96 97 98 99 100 101

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

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

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

103
## DeviceStateChangeAction
Z
zengyawen 已提交
104

105 106 107 108
表示设备状态变化的枚举。

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

@
@shi-xiaoxiao-iris 已提交
109
| 名称      | 值  | 说明              |
H
HelloCrease 已提交
110
| ------- | ---- | --------------- |
S
summer8999 已提交
111 112 113
| ONLINE  | 0    | 设备物理上线状态。           |
| READY   | 1    | 设备可用状态,表示设备间信息已在分布式数据中同步完成, 可以运行分布式业务。 |
| OFFLINE | 2    | 设备物理下线状态。           |
H
HelloCrease 已提交
114
| CHANGE  | 3    | 设备信息更改。         |
115 116 117 118

## SubscribeInfo

发现信息。
Z
zengyawen 已提交
119

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

@
@shi-xiaoxiao-iris 已提交
122
| 名称            | 类型                                | 必填   | 说明                |
H
HelloCrease 已提交
123 124
| ------------- | --------------------------------- | ---- | ----------------- |
| subscribeId   | number                            | 是    | 发现标识,用于标识不同的发现周期。 |
W
wuqi0105 已提交
125 126 127
| mode          | [DiscoverMode ](#discovermode)    | 是    | 发现模式。             |
| medium        | [ExchangeMedium](#exchangemedium) | 是    | 发现类型。             |
| freq          | [ExchangeFreq](#exchangefreq)     | 是    | 发现频率。             |
史晓晓 已提交
128 129
| isSameAccount | boolean                           | 否    | 是否同帐号。            |
| isWakeRemote  | boolean                           | 否    | 是否唤醒设备。           |
W
wuqi0105 已提交
130
| capability    | [SubscribeCap](#subscribecap)     | 是    | 发现能力。             |
131 132 133 134 135 136 137 138


## DiscoverMode 

表示发现模式的枚举。

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

@
@shi-xiaoxiao-iris 已提交
139
| 名称                    | 值  | 说明    |
H
HelloCrease 已提交
140
| --------------------- | ---- | ----- |
141
| DISCOVER_MODE_PASSIVE | 0x55 | 被动模式。 |
H
HelloCrease 已提交
142
| DISCOVER_MODE_ACTIVE  | 0xAA | 主动模式。 |
143 144 145 146 147 148 149 150


## ExchangeMedium 

表示发现类型的枚举。

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

@
@shi-xiaoxiao-iris 已提交
151
| 名称   | 值  | 说明        |
H
HelloCrease 已提交
152 153 154 155 156
| ---- | ---- | --------- |
| AUTO | 0    | 自动发现类型。   |
| BLE  | 1    | 蓝牙发现类型。   |
| COAP | 2    | WiFi发现类型。 |
| USB  | 3    | USB发现类型。  |
157 158 159 160 161 162 163

## ExchangeFreq 

表示发现频率的枚举。

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

@
@shi-xiaoxiao-iris 已提交
164
| 名称         | 值  | 说明    |
H
HelloCrease 已提交
165 166 167 168 169
| ---------- | ---- | ----- |
| LOW        | 0    | 低频率。  |
| MID        | 1    | 中频率。  |
| HIGH       | 2    | 高频率。  |
| SUPER_HIGH | 3    | 超高频率。 |
170 171 172 173 174 175 176 177


## SubscribeCap 

表示发现能力的枚举。

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

@
@shi-xiaoxiao-iris 已提交
178
| 名称                        | 值  | 说明             |
H
HelloCrease 已提交
179 180 181
| ------------------------- | ---- | -------------- |
| SUBSCRIBE_CAPABILITY_DDMP | 0    | DDMP能力,后续会被废弃。 |
| SUBSCRIBE_CAPABILITY_OSD  | 1    | OSD能力。         |
182 183 184 185 186 187 188 189


## AuthParam

认证参数。

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

@
@shi-xiaoxiao-iris 已提交
190
| 名称        | 类型                   | 必填   | 说明         |
H
HelloCrease 已提交
191 192
| --------- | -------------------- | ---- | ---------- |
| authType  | number               | 是    | 认证类型。      |
W
wangxuanxuan 已提交
193
| extraInfo | {[key:string]&nbsp;:&nbsp;any} | 否    | 认证参数可扩展字段。可选,默认为undefined。 |
194 195 196 197 198 199 200

## AuthInfo

认证信息。

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

@
@shi-xiaoxiao-iris 已提交
201
| 名称        | 类型                   | 必填   | 说明         |
H
HelloCrease 已提交
202 203 204
| --------- | -------------------- | ---- | ---------- |
| authType  | number               | 是    | 认证类型。      |
| token     | number               | 是    | 认证Token。   |
W
wangxuanxuan 已提交
205
| extraInfo | {[key:string]&nbsp;:&nbsp;any} | 否    | 认证信息可扩展字段。可选,默认为undefined。 |
Z
zengyawen 已提交
206

@
@shi-xiaoxiao-iris 已提交
207
## PublishInfo<sup>9+</sup>
S
summer8999 已提交
208 209 210 211 212

发布设备参数

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

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

## DeviceManager
Z
zengyawen 已提交
221 222 223

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

Z
zengyawen 已提交
224
### release
Z
zengyawen 已提交
225

Z
zengyawen 已提交
226
release(): void
Z
zengyawen 已提交
227

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

史晓晓 已提交
230
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
231

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

@
@shi-xiaoxiao-iris 已提交
234
**错误码:**
@
@shi-xiaoxiao-iris 已提交
235

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

@
@shi-xiaoxiao-iris 已提交
238
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
239 240
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
241

@
@shi-xiaoxiao-iris 已提交
242
**示例:**
@
@shi-xiaoxiao-iris 已提交
243

244
  ```js
245 246 247
  try {
    dmInstance.release();
  } catch (err) {
248
    console.error("release errCode:" + err.code + ",errMessage:" + err.message);
249
  }
Z
zengyawen 已提交
250
  ```
Z
zengyawen 已提交
251

Z
zengyawen 已提交
252
### getTrustedDeviceListSync
Z
zengyawen 已提交
253

Z
zengyawen 已提交
254
getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt;
Z
zengyawen 已提交
255 256 257

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

史晓晓 已提交
258
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
259

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

@
@shi-xiaoxiao-iris 已提交
262
**返回值:**
@
@shi-xiaoxiao-iris 已提交
263

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

@
@shi-xiaoxiao-iris 已提交
268
**错误码:**
@
@shi-xiaoxiao-iris 已提交
269

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

@
@shi-xiaoxiao-iris 已提交
272
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
273 274
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
275

@
@shi-xiaoxiao-iris 已提交
276
**示例:**
@
@shi-xiaoxiao-iris 已提交
277

278
  ```js
279 280 281
  try {
    var deviceInfoList = dmInstance.getTrustedDeviceListSync();
  } catch (err) {
282
    console.error("getTrustedDeviceListSync errCode:" + err.code + ",errMessage:" + err.message);
283
  }
Z
zengyawen 已提交
284
  ```
Z
zengyawen 已提交
285

W
wuxiaodong02 已提交
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
### getTrustedDeviceListSync<sup>10+</sup>

getTrustedDeviceListSync(isRefresh: boolean): Array&lt;DeviceInfo&gt;

打开软总线系统端的心跳模式,让周围处于下线状态的可信设备快速上线,同时刷新已上线的可信设备列表。

**需要权限**:ohos.permission.ACCESS_SERVICE_DM

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

**参数:**

| 参数名        | 类型                               | 必填 | 说明                                |
| ------------- | --------------------------------- | ---- | ---------------------------------- |
|   isRefresh   | boolean                           | 是   | 是否打开心跳模式,刷新可信列表。      |

**返回值:**

| 名称                                     | 说明            |
| -------------------------------------- | ---------------- |
| Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回可信设备列表。 |

**错误码:**

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

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

**示例:**

  ```js
  try {
    var deviceInfoList = dmInstance.getTrustedDeviceListSync(true);
  } catch (err) {
    console.error("getTrustedDeviceListSync errCode:" + err.code + ",errMessage:" + err.message);
  }
  ```

326 327 328 329 330 331
### getTrustedDeviceList<sup>8+</sup>

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

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

史晓晓 已提交
332
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
333

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

@
@shi-xiaoxiao-iris 已提交
336
**参数:**
@
@shi-xiaoxiao-iris 已提交
337

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

@
@shi-xiaoxiao-iris 已提交
342
**示例:**
@
@shi-xiaoxiao-iris 已提交
343

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

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

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

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

史晓晓 已提交
364
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
365

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

@
@shi-xiaoxiao-iris 已提交
368
**返回值:**
@
@shi-xiaoxiao-iris 已提交
369

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

@
@shi-xiaoxiao-iris 已提交
374
**示例:**
@
@shi-xiaoxiao-iris 已提交
375

376
  ```js
377 378 379
  dmInstance.getTrustedDeviceList().then((data) => {
    console.log('get trusted device info: ' + JSON.stringify(data));
    }).catch((err) => {
380
      console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
381
  });
382 383 384 385 386 387 388 389
  ```

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

getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)

同步获取本地设备信息。

史晓晓 已提交
390
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
391

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

@
@shi-xiaoxiao-iris 已提交
394
**返回值:**
@
@shi-xiaoxiao-iris 已提交
395

396 397 398
  | 名称                      | 说明              |
  | ------------------------- | ---------------- |
  | [DeviceInfo](#deviceinfo) | 返回本地设备列表。 |
399

@
@shi-xiaoxiao-iris 已提交
400
**错误码:**
@
@shi-xiaoxiao-iris 已提交
401

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

@
@shi-xiaoxiao-iris 已提交
404
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
405 406
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
407

@
@shi-xiaoxiao-iris 已提交
408
**示例:**
@
@shi-xiaoxiao-iris 已提交
409

410
  ```js
411 412 413
  try {
    var deviceInfo = dmInstance.getLocalDeviceInfoSync();
  } catch (err) {
414
    console.error("getLocalDeviceInfoSync errCode:" + err.code + ",errMessage:" + err.message);
415
  }
416 417 418 419 420 421 422 423
  ```

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

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

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

史晓晓 已提交
424
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
425

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

@
@shi-xiaoxiao-iris 已提交
428
**参数:**
@
@shi-xiaoxiao-iris 已提交
429

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

@
@shi-xiaoxiao-iris 已提交
434
**示例:**
@
@shi-xiaoxiao-iris 已提交
435

436
  ```js
437
  try {
438
    dmInstance.getLocalDeviceInfo((err, data) => {
439
    if (err) {
440
      console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
441
      return;
442
    }
443 444 445
      console.log('get local device info: ' + JSON.stringify(data));
    });
  } catch (err) {
446
    console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
447
  }
448 449 450 451 452 453 454 455
  ```

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

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

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

史晓晓 已提交
456
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
457

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

@
@shi-xiaoxiao-iris 已提交
460 461
**返回值:**

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

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

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

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

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

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

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

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

**参数:**

  | 参数名       | 类型                                     | 必填   | 说明        |
  | -------- | ---------------------------------------- | ---- | --------- |
S
summer8999 已提交
490
  | networkId| string                                   | 是   | 设备的网络标识。 |
S
summer8999 已提交
491 492 493 494 495 496
  | callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是    | 获取指定设备信息。 |

**示例:**

  ```js
  try {
W
wangxuanxuan 已提交
497 498
    // 设备网络标识,可以从可信设备列表中获取
    let networkId = "xxxxxxx"
S
summer8999 已提交
499 500 501 502 503 504 505 506 507 508 509 510 511 512
    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 已提交
513
getDeviceInfo(networkId: string): Promise&lt;DeviceInfo&gt;
S
summer8999 已提交
514

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

史晓晓 已提交
517
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
518

S
summer8999 已提交
519 520
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

S
summer8999 已提交
521 522 523 524 525 526
**参数:**

  | 参数名   | 类型                                     | 必填 | 说明        |
  | -------- | ---------------------------------------- | ---- | --------- |
  | networkId| string                                   | 是   | 设备的网络标识。 |
  
S
summer8999 已提交
527 528 529 530 531 532 533 534 535
**返回值:**

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

**示例:**

  ```js
W
wangxuanxuan 已提交
536 537
  // 设备网络标识,可以从可信设备列表中获取
  let networkId = "xxxxxxx"
S
summer8999 已提交
538 539 540 541 542 543 544
  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 已提交
545
### startDeviceDiscovery<sup>8+</sup>
546 547 548

startDeviceDiscovery(subscribeInfo: SubscribeInfo): void

W
wangxuanxuan 已提交
549
发现周边设备。发现状态持续两分钟,超过两分钟,会停止发现,最大发现数量99个。
550

史晓晓 已提交
551
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
552

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

@
@shi-xiaoxiao-iris 已提交
555
**参数:**
@
@shi-xiaoxiao-iris 已提交
556

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

@
@shi-xiaoxiao-iris 已提交
561
**错误码:**
@
@shi-xiaoxiao-iris 已提交
562

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

@
@shi-xiaoxiao-iris 已提交
565
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
566 567 568 569
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600104 | Discovery invalid.                                              |

@
@shi-xiaoxiao-iris 已提交
570
**示例:**
@
@shi-xiaoxiao-iris 已提交
571

572
  ```js
573
  // 生成发现标识,随机数确保每次调用发现接口的标识不一致
574 575 576
  var subscribeId = Math.floor(Math.random() * 10000 + 1000);
  var subscribeInfo = {
      "subscribeId": subscribeId,
577 578 579
      "mode": 0xAA, // 主动模式
      "medium": 0,  // 自动发现类型,同时支持多种发现类型
      "freq": 2,    // 高频率
580 581 582 583
      "isSameAccount": false,
      "isWakeRemote": false,
      "capability": 1
  };
584 585 586
  try {
    dmInstance.startDeviceDiscovery(subscribeInfo); // 当有设备发现时,通过deviceFound回调通知给应用程序
  } catch (err) {
587
    console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
588
  }
589 590
  ```

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

S
summer8999 已提交
593
startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void
S
summer8999 已提交
594

W
wangxuanxuan 已提交
595
发现周边设备。发现状态持续两分钟,超过两分钟,会停止发现,最大发现数量99个。
S
summer8999 已提交
596

史晓晓 已提交
597
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
598

S
summer8999 已提交
599 600
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
601
**参数:**
@
@shi-xiaoxiao-iris 已提交
602

@
@shi-xiaoxiao-iris 已提交
603
  | 参数名            | 类型                       | 必填   | 说明    |
604
  | ------------- | ------------------------------- | ---- | -----  |
S
summer8999 已提交
605
  | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是   | 发现信息。 |
W
wangxuanxuan 已提交
606
  | filterOptions | string                          | 否   | 发现设备过滤信息。可选,默认为undefined,发现未上线设备。|
S
summer8999 已提交
607

@
@shi-xiaoxiao-iris 已提交
608
**错误码:**
@
@shi-xiaoxiao-iris 已提交
609

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

@
@shi-xiaoxiao-iris 已提交
612
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
613 614 615 616
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600104 | Discovery invalid.                                              |

@
@shi-xiaoxiao-iris 已提交
617
**示例:**
@
@shi-xiaoxiao-iris 已提交
618

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

647 648 649 650 651 652
### stopDeviceDiscovery

stopDeviceDiscovery(subscribeId: number): void

停止发现周边设备。

史晓晓 已提交
653
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
654

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

@
@shi-xiaoxiao-iris 已提交
657
**参数:**
@
@shi-xiaoxiao-iris 已提交
658

@
@shi-xiaoxiao-iris 已提交
659
  | 参数名          | 类型   | 必填   | 说明    |
H
HelloCrease 已提交
660 661
  | ----------- | ------ | ---- | ----- |
  | subscribeId | number | 是    | 发现标识。 |
662

@
@shi-xiaoxiao-iris 已提交
663
**错误码:**
@
@shi-xiaoxiao-iris 已提交
664

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

@
@shi-xiaoxiao-iris 已提交
667
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
668 669
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
670

@
@shi-xiaoxiao-iris 已提交
671
**示例:**
@
@shi-xiaoxiao-iris 已提交
672

673
  ```js
674
  try {
675 676
    // stopDeviceDiscovery和startDeviceDiscovery需配对使用,入参需要和startDeviceDiscovery接口传入的subscribeId值相等
    var subscribeId = 12345;
677 678
    dmInstance.stopDeviceDiscovery(subscribeId);
  } catch (err) {
679
    console.error("stopDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
680
  }
681 682
  ```

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

S
summer8999 已提交
685
publishDeviceDiscovery(publishInfo: PublishInfo): void
S
summer8999 已提交
686

W
wangxuanxuan 已提交
687
发布设备发现。发布状态持续两分钟,超过两分钟会停止发布。
S
summer8999 已提交
688

史晓晓 已提交
689
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
690

S
summer8999 已提交
691 692
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
693
**参数:**
@
@shi-xiaoxiao-iris 已提交
694

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

@
@shi-xiaoxiao-iris 已提交
699
**错误码:**
@
@shi-xiaoxiao-iris 已提交
700

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

@
@shi-xiaoxiao-iris 已提交
703
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
704 705 706
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600105 | Publish invalid.                                                |
@
@shi-xiaoxiao-iris 已提交
707

@
@shi-xiaoxiao-iris 已提交
708
**示例:**
@
@shi-xiaoxiao-iris 已提交
709

S
summer8999 已提交
710
  ```js
711
  // 生成发布标识,随机数确保每次调用发布接口的标识不一致
S
summer8999 已提交
712
  var publishId = Math.floor(Math.random() * 10000 + 1000);
S
summer8999 已提交
713
  var publishInfo = {
S
summer8999 已提交
714
      "publishId": publishId,
715 716
      "mode": 0xAA, // 主动模式
      "freq": 2,    // 高频率
717
      "ranging": true  // 支持发现时测距
S
summer8999 已提交
718
  };
719 720 721
  try {
    dmInstance.publishDeviceDiscovery(publishInfo); // 当有发布结果时,通过回调通知给应用程序
  } catch (err) {
722
    console.error("publishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
723
  }
S
summer8999 已提交
724
  ```
725

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

S
summer8999 已提交
728
unPublishDeviceDiscovery(publishId: number): void
S
summer8999 已提交
729 730 731

停止发布设备发现。

史晓晓 已提交
732
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
733

S
summer8999 已提交
734 735
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
736
**参数:**
@
@shi-xiaoxiao-iris 已提交
737

@
@shi-xiaoxiao-iris 已提交
738
  | 参数名        | 类型 | 必填 | 说明  |
S
summer8999 已提交
739 740
  | ----------- | -------- | ---- | ----- |
  | publishId   | number   | 是   | 发布标识。 |
S
summer8999 已提交
741

@
@shi-xiaoxiao-iris 已提交
742
**错误码:**
@
@shi-xiaoxiao-iris 已提交
743

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

@
@shi-xiaoxiao-iris 已提交
746
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
747 748
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
749

@
@shi-xiaoxiao-iris 已提交
750
**示例:**
@
@shi-xiaoxiao-iris 已提交
751

S
summer8999 已提交
752
  ```js
753
  try {
754 755
    // unPublishDeviceDiscovery和publishDeviceDiscovery配对使用,入参需要和publishDeviceDiscovery接口传入的publishId值相等
    var publishId = 12345;
756
    dmInstance.unPublishDeviceDiscovery(publishId);
757
  } catch (err) {
758
    console.error("unPublishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
759
  }
S
summer8999 已提交
760 761
  ```

762 763
### authenticateDevice

764
authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: AsyncCallback&lt;{deviceId: string, pinToken ?: number}&gt;): void
765 766 767

认证设备。

史晓晓 已提交
768
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
769

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

@
@shi-xiaoxiao-iris 已提交
772
**参数:**
@
@shi-xiaoxiao-iris 已提交
773

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

@
@shi-xiaoxiao-iris 已提交
780
**示例:**
@
@shi-xiaoxiao-iris 已提交
781

782
  ```js
783
  // 认证的设备信息,可以从发现的结果中获取
784 785 786
  var deviceInfo ={
      "deviceId": "XXXXXXXX",
      "deviceName": "",
787 788 789
      "deviceType": 0x0E,
      "networkId" : "xxxxxxx",
      "range" : 0
790
  };
791 792 793 794 795
  let extraInfo = {
          'targetPkgName': 'ohos.samples.xxx',
          'appName': 'xxx',
          'appDescription': 'xxx',
          'business': '0'
796
  }
797
  let authParam = {
798 799
      'authType': 1,// 认证类型: 1 - 无帐号PIN码认证
      'extraInfo': extraInfo
800
  }
801 802
  try {
    dmInstance.authenticateDevice(deviceInfo, authParam, (err, data) => {
803
      if (err) {
804
          console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
805 806
          return;
      }
@
@shi-xiaoxiao-iris 已提交
807 808
      console.info("authenticateDevice result:" + JSON.stringify(data));
      let token = data.pinToken;
809 810
    });
  } catch (err) {
811
    console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
812
  }
813 814 815 816 817 818 819 820
  ```

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

unAuthenticateDevice(deviceInfo: DeviceInfo): void

解除认证设备。

史晓晓 已提交
821
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
822

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

@
@shi-xiaoxiao-iris 已提交
825
**参数:**
@
@shi-xiaoxiao-iris 已提交
826

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

@
@shi-xiaoxiao-iris 已提交
831
**错误码:**
@
@shi-xiaoxiao-iris 已提交
832

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

@
@shi-xiaoxiao-iris 已提交
835
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
836 837
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
838

@
@shi-xiaoxiao-iris 已提交
839
**示例:**
@
@shi-xiaoxiao-iris 已提交
840

841
  ```js
842
  try {
843 844 845 846 847 848 849
    var deviceInfo ={
      "deviceId": "XXXXXXXX",
      "deviceName": "",
      "deviceType": 0x0E,
      "networkId" : "xxxxxxx",
      "range" : 0
    };
850 851
    dmInstance.unAuthenticateDevice(deviceInfo);
  } catch (err) {
852
    console.error("unAuthenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
853
  }
854 855 856 857
  ```

### verifyAuthInfo

858
verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback&lt;{deviceId: string, level: number}&gt;): void
859 860 861

验证认证信息。

史晓晓 已提交
862
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
863

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

@
@shi-xiaoxiao-iris 已提交
866
**参数:**
@
@shi-xiaoxiao-iris 已提交
867

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

@
@shi-xiaoxiao-iris 已提交
873
**示例:**
@
@shi-xiaoxiao-iris 已提交
874

875 876 877
  ```js
  let authInfo = {
    "authType": 1,
878
    "token": 123456,
879 880
    "extraInfo": {}
  }
881 882
  try {
    dmInstance.verifyAuthInfo(authInfo, (err, data) => {
883
    if (err) {
884
        console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
885 886
        return;
    }
@
@shi-xiaoxiao-iris 已提交
887
    console.info("verifyAuthInfo result:" + JSON.stringify(data));
888 889
    });
  } catch (err) {
890
    console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
891
  }
892 893
  ```

@
@shi-xiaoxiao-iris 已提交
894
### setUserOperation<sup>9+</sup>
@
@shi-xiaoxiao-iris 已提交
895 896 897 898 899

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

设置用户ui操作行为。

史晓晓 已提交
900
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
901

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

@
@shi-xiaoxiao-iris 已提交
904
**参数:**
@
@shi-xiaoxiao-iris 已提交
905

@
@shi-xiaoxiao-iris 已提交
906
  | 参数名       | 类型            | 必填  | 说明                |
907 908 909
  | ------------- | --------------- | ---- | ------------------- |
  | operateAction | number          | 是    | 用户操作动作。       |
  | params        | string          | 是    | 表示用户的输入参数。 |
@
@shi-xiaoxiao-iris 已提交
910

@
@shi-xiaoxiao-iris 已提交
911
**示例:**
@
@shi-xiaoxiao-iris 已提交
912 913

  ```js
@
@shi-xiaoxiao-iris 已提交
914 915 916 917 918 919 920 921 922 923
 try {
    /*
      operateAction = 0 - 允许授权
      operateAction = 1 - 取消授权
      operateAction = 2 - 授权框用户操作超时
      operateAction = 3 - 取消pin码框展示
      operateAction = 4 - 取消pin码输入框展示
      operateAction = 5 - pin码输入框确定操作
    */
    let operation = 0;
924
    dmInstance.setUserOperation(operation, "extra")
@
@shi-xiaoxiao-iris 已提交
925 926
    } catch (err) {
      console.error("setUserOperation errCode:" + err.code + ",errMessage:" + err.message);
@
@shi-xiaoxiao-iris 已提交
927 928 929
  }
  ```

W
wuqi0105 已提交
930
### requestCredentialRegisterInfo<sup>10+</sup>
W
wuqi0105 已提交
931

W
wuqi0105 已提交
932
requestCredentialRegisterInfo(requestInfo: string, callback: AsyncCallback<{registerInfo: string}>): void;
W
wuqi0105 已提交
933 934 935

获取凭据的注册信息。

史晓晓 已提交
936
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
937

W
wuqi0105 已提交
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

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

**示例:**

  ```js
  let credentialInfo = {
    "version" : "1.2.3",
    "userId" : "123"
  }
  try {
W
wangxuanxuan 已提交
955
    dmInstance.requestCredentialRegisterInfo(credentialInfo, (data) => {
W
wuqi0105 已提交
956
      if (data) {
W
wuqi0105 已提交
957
          console.info("requestCredentialRegisterInfo result:" + JSON.stringify(data));
W
wuqi0105 已提交
958
      } else {
W
wangxuanxuan 已提交
959
          console.info("requestCredentialRegisterInfo result: data is null");
W
wuqi0105 已提交
960 961 962
      }
    });
  } catch (err) {
W
wuqi0105 已提交
963
    console.error("requestCredentialRegisterInfo err:" + err.code + "," + err.message);
W
wuqi0105 已提交
964 965 966 967 968 969 970 971 972
  }
  ```

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

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

导入凭据信息。

史晓晓 已提交
973
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
974

W
wuqi0105 已提交
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
**系统能力**: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 {
W
wangxuanxuan 已提交
1008
    dmInstance.importCredential(credentialInfo, (data) => {
W
wuqi0105 已提交
1009 1010 1011
      if (data) {
          console.info("importCredential result:" + JSON.stringify(data));
      } else {
W
wangxuanxuan 已提交
1012
          console.info("importCredential result: data is null");
W
wuqi0105 已提交
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
      }
    });
  } catch (err) {
    console.error("importCredential err:" + err.code + "," + err.message);
  }
  ```

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

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

删除凭据信息。

史晓晓 已提交
1026
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1027

W
wuqi0105 已提交
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

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

**示例:**

  ```js
  let queryInfo = {
    "processType" : 1,
    "authType" : 1,
    "userId" : "123"
  }
  try {
W
wangxuanxuan 已提交
1046
    dmInstance.deleteCredential(queryInfo, (data) => {
W
wuqi0105 已提交
1047 1048 1049
      if (data) {
          console.info("deleteCredential result:" + JSON.stringify(data));
      } else {
W
wangxuanxuan 已提交
1050
          console.info("deleteCredential result: data is null");
W
wuqi0105 已提交
1051 1052 1053 1054 1055 1056 1057
      }
    });
  } catch (err) {
    console.error("deleteCredential err:" + err.code + "," + err.message);
  }
  ```

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

1060
on(type: 'uiStateChange', callback: Callback&lt;{ param: string}&gt;): void;
@
@shi-xiaoxiao-iris 已提交
1061 1062 1063

ui状态变更回调。

史晓晓 已提交
1064
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1065

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

@
@shi-xiaoxiao-iris 已提交
1068
**参数:**
@
@shi-xiaoxiao-iris 已提交
1069

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

@
@shi-xiaoxiao-iris 已提交
1075
**示例:**
@
@shi-xiaoxiao-iris 已提交
1076 1077 1078

  ```js
  try {
@
@shi-xiaoxiao-iris 已提交
1079
    dmInstance.on('uiStateChange', (data) => {
@
@shi-xiaoxiao-iris 已提交
1080 1081
    console.log("uiStateChange executed, dialog closed" + JSON.stringify(data))
    var tmpStr = JSON.parse(data.param)
1082 1083
    var isShow = tmpStr.verifyFailed
    console.log("uiStateChange executed, dialog closed" + isShow)
@
@shi-xiaoxiao-iris 已提交
1084 1085 1086 1087 1088 1089
  });
  } catch (err) {
    console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
  }
  ```

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

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

1094 1095
取消ui状态变更回调。

史晓晓 已提交
1096
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1097

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

@
@shi-xiaoxiao-iris 已提交
1100
**参数:**
@
@shi-xiaoxiao-iris 已提交
1101

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

@
@shi-xiaoxiao-iris 已提交
1107
**示例:**
@
@shi-xiaoxiao-iris 已提交
1108 1109 1110

  ```js
  try {
@
@shi-xiaoxiao-iris 已提交
1111
    dmInstance.off('uiStateChange');
@
@shi-xiaoxiao-iris 已提交
1112 1113 1114 1115 1116
  } catch (err) {
    console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
  }
  ```

Z
zengyawen 已提交
1117
### on('deviceStateChange')
Z
zengyawen 已提交
1118

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

Z
zengyawen 已提交
1121 1122
注册设备状态回调。

史晓晓 已提交
1123
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1124

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

@
@shi-xiaoxiao-iris 已提交
1127
**参数:**
@
@shi-xiaoxiao-iris 已提交
1128

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

@
@shi-xiaoxiao-iris 已提交
1134
**示例:**
@
@shi-xiaoxiao-iris 已提交
1135

1136
  ```js
1137 1138 1139 1140 1141
  try {
    dmInstance.on('deviceStateChange', (data) => {
      console.info("deviceStateChange on:" + JSON.stringify(data));
    });
  } catch (err) {
1142
    console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message);
1143
  }
Z
zengyawen 已提交
1144
  ```
Z
zengyawen 已提交
1145

Z
zengyawen 已提交
1146
### off('deviceStateChange')
Z
zengyawen 已提交
1147

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

取消注册设备状态回调。

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

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

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

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

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

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

1175 1176
### on('deviceFound')

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

注册发现设备回调监听。

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

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

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

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

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

1194
  ```js
1195 1196 1197 1198 1199
  try {
    dmInstance.on('deviceFound', (data) => {
      console.info("deviceFound:" + JSON.stringify(data));
    });
  } catch (err) {
1200
    console.error("deviceFound errCode:" + err.code + ",errMessage:" + err.message);
1201
  }
1202 1203 1204 1205
  ```

### off('deviceFound')

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

取消注册设备发现回调。

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

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

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

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

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

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

### on('discoverFail')

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

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

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

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

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

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

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

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

### off('discoverFail')

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

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

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

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

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

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

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

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

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

1293
on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): void
S
summer8999 已提交
1294 1295 1296

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

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

S
summer8999 已提交
1299 1300
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

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

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

@
@shi-xiaoxiao-iris 已提交
1308

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

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

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

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

S
summer8999 已提交
1325
取消注册设备发布成功回调。
S
summer8999 已提交
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

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

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

1352
on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: number }&gt;): void
S
summer8999 已提交
1353 1354 1355

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Z
zengyawen 已提交
1408 1409 1410
### on('serviceDie')

on(type: 'serviceDie', callback: () =&gt; void): void
Z
zengyawen 已提交
1411 1412 1413

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

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

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

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

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

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

1427
  ```js
1428 1429 1430 1431 1432
  try {
    dmInstance.on("serviceDie", () => {
      console.info("serviceDie on");
    });
  } catch (err) {
1433
    console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
1434
  }
Z
zengyawen 已提交
1435
  ```
Z
zengyawen 已提交
1436

Z
zengyawen 已提交
1437 1438 1439 1440 1441
### off('serviceDie')

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

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

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

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

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

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

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

1456
  ```js
1457 1458 1459 1460 1461
  try {
    dmInstance.off("serviceDie", () => {
      console.info("serviceDie off");
    });
  } catch (err) {
1462
    console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
1463
  }
1464
  ```