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

史晓晓 已提交
3
本模块能力暂时可继续使用,但是暂停维护,建议使用新接口进行开发。新接口说明参见[@ohos.distributedDeviceManager](js-apis-distributedDeviceManager.md)
史晓晓 已提交
4

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

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

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

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

Z
zengyawen 已提交
21 22

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

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


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

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

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

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

@
@shi-xiaoxiao-iris 已提交
37
**参数:**
@
@shi-xiaoxiao-iris 已提交
38

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

@
@shi-xiaoxiao-iris 已提交
44
**示例:**
@
@shi-xiaoxiao-iris 已提交
45

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

61
## DeviceInfo
Z
zengyawen 已提交
62

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

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

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

## DeviceType
Z
zengyawen 已提交
77 78 79

表示设备类型的枚举类。

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

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

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

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

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

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

105
## DeviceStateChangeAction
Z
zengyawen 已提交
106

107 108 109 110
表示设备状态变化的枚举。

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

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

## SubscribeInfo

发现信息。
Z
zengyawen 已提交
121

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

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


## DiscoverMode 

表示发现模式的枚举。

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

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


## ExchangeMedium 

表示发现类型的枚举。

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

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

## ExchangeFreq 

表示发现频率的枚举。

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

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


## SubscribeCap 

表示发现能力的枚举。

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

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


## AuthParam

认证参数。

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

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

## AuthInfo

认证信息。

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

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

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

发布设备参数

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

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

## DeviceManager
Z
zengyawen 已提交
223 224 225

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

Z
zengyawen 已提交
226
### release
Z
zengyawen 已提交
227

Z
zengyawen 已提交
228
release(): void
Z
zengyawen 已提交
229

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

史晓晓 已提交
232
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
233

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

@
@shi-xiaoxiao-iris 已提交
236
**错误码:**
@
@shi-xiaoxiao-iris 已提交
237

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

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

@
@shi-xiaoxiao-iris 已提交
244
**示例:**
@
@shi-xiaoxiao-iris 已提交
245

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

Z
zengyawen 已提交
254
### getTrustedDeviceListSync
Z
zengyawen 已提交
255

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

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

史晓晓 已提交
260
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
261

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

@
@shi-xiaoxiao-iris 已提交
264
**返回值:**
@
@shi-xiaoxiao-iris 已提交
265

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

@
@shi-xiaoxiao-iris 已提交
270
**错误码:**
@
@shi-xiaoxiao-iris 已提交
271

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

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

@
@shi-xiaoxiao-iris 已提交
278
**示例:**
@
@shi-xiaoxiao-iris 已提交
279

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

W
wuxiaodong02 已提交
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 326 327
### 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);
  }
  ```

328 329 330 331 332 333
### getTrustedDeviceList<sup>8+</sup>

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

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

史晓晓 已提交
334
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
335

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

@
@shi-xiaoxiao-iris 已提交
338
**参数:**
@
@shi-xiaoxiao-iris 已提交
339

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

@
@shi-xiaoxiao-iris 已提交
344
**示例:**
@
@shi-xiaoxiao-iris 已提交
345

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

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

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

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

史晓晓 已提交
366
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
367

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

@
@shi-xiaoxiao-iris 已提交
370
**返回值:**
@
@shi-xiaoxiao-iris 已提交
371

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

@
@shi-xiaoxiao-iris 已提交
376
**示例:**
@
@shi-xiaoxiao-iris 已提交
377

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

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

getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)

同步获取本地设备信息。

史晓晓 已提交
392
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
393

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

@
@shi-xiaoxiao-iris 已提交
396
**返回值:**
@
@shi-xiaoxiao-iris 已提交
397

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

@
@shi-xiaoxiao-iris 已提交
402
**错误码:**
@
@shi-xiaoxiao-iris 已提交
403

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

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

@
@shi-xiaoxiao-iris 已提交
410
**示例:**
@
@shi-xiaoxiao-iris 已提交
411

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

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

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

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

史晓晓 已提交
426
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
427

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

@
@shi-xiaoxiao-iris 已提交
430
**参数:**
@
@shi-xiaoxiao-iris 已提交
431

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

@
@shi-xiaoxiao-iris 已提交
436
**示例:**
@
@shi-xiaoxiao-iris 已提交
437

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

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

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

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

史晓晓 已提交
458
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
459

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

@
@shi-xiaoxiao-iris 已提交
462 463
**返回值:**

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

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

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

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

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

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

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

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

**参数:**

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

**示例:**

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

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

史晓晓 已提交
519
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
520

S
summer8999 已提交
521 522
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

S
summer8999 已提交
523 524 525 526 527 528
**参数:**

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

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

**示例:**

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

startDeviceDiscovery(subscribeInfo: SubscribeInfo): void

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

史晓晓 已提交
553
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
554

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

@
@shi-xiaoxiao-iris 已提交
557
**参数:**
@
@shi-xiaoxiao-iris 已提交
558

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

@
@shi-xiaoxiao-iris 已提交
563
**错误码:**
@
@shi-xiaoxiao-iris 已提交
564

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

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

@
@shi-xiaoxiao-iris 已提交
572
**示例:**
@
@shi-xiaoxiao-iris 已提交
573

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

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

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

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

史晓晓 已提交
599
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
600

S
summer8999 已提交
601 602
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
603
**参数:**
@
@shi-xiaoxiao-iris 已提交
604

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

@
@shi-xiaoxiao-iris 已提交
610
**错误码:**
@
@shi-xiaoxiao-iris 已提交
611

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

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

@
@shi-xiaoxiao-iris 已提交
619
**示例:**
@
@shi-xiaoxiao-iris 已提交
620

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

649 650 651 652 653 654
### stopDeviceDiscovery

stopDeviceDiscovery(subscribeId: number): void

停止发现周边设备。

史晓晓 已提交
655
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
656

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

@
@shi-xiaoxiao-iris 已提交
659
**参数:**
@
@shi-xiaoxiao-iris 已提交
660

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

@
@shi-xiaoxiao-iris 已提交
665
**错误码:**
@
@shi-xiaoxiao-iris 已提交
666

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

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

@
@shi-xiaoxiao-iris 已提交
673
**示例:**
@
@shi-xiaoxiao-iris 已提交
674

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

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

S
summer8999 已提交
687
publishDeviceDiscovery(publishInfo: PublishInfo): void
S
summer8999 已提交
688

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

史晓晓 已提交
691
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
692

S
summer8999 已提交
693 694
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
695
**参数:**
@
@shi-xiaoxiao-iris 已提交
696

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

@
@shi-xiaoxiao-iris 已提交
701
**错误码:**
@
@shi-xiaoxiao-iris 已提交
702

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

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

@
@shi-xiaoxiao-iris 已提交
710
**示例:**
@
@shi-xiaoxiao-iris 已提交
711

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

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

S
summer8999 已提交
730
unPublishDeviceDiscovery(publishId: number): void
S
summer8999 已提交
731 732 733

停止发布设备发现。

史晓晓 已提交
734
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
735

S
summer8999 已提交
736 737
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
738
**参数:**
@
@shi-xiaoxiao-iris 已提交
739

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

@
@shi-xiaoxiao-iris 已提交
744
**错误码:**
@
@shi-xiaoxiao-iris 已提交
745

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

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

@
@shi-xiaoxiao-iris 已提交
752
**示例:**
@
@shi-xiaoxiao-iris 已提交
753

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

764 765
### authenticateDevice

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

认证设备。

史晓晓 已提交
770
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
771

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

@
@shi-xiaoxiao-iris 已提交
774
**参数:**
@
@shi-xiaoxiao-iris 已提交
775

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

@
@shi-xiaoxiao-iris 已提交
782
**示例:**
@
@shi-xiaoxiao-iris 已提交
783

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

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

unAuthenticateDevice(deviceInfo: DeviceInfo): void

解除认证设备。

史晓晓 已提交
823
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
824

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

@
@shi-xiaoxiao-iris 已提交
827
**参数:**
@
@shi-xiaoxiao-iris 已提交
828

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

@
@shi-xiaoxiao-iris 已提交
833
**错误码:**
@
@shi-xiaoxiao-iris 已提交
834

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

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

@
@shi-xiaoxiao-iris 已提交
841
**示例:**
@
@shi-xiaoxiao-iris 已提交
842

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

### verifyAuthInfo

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

验证认证信息。

史晓晓 已提交
864
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
865

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

@
@shi-xiaoxiao-iris 已提交
868
**参数:**
@
@shi-xiaoxiao-iris 已提交
869

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

@
@shi-xiaoxiao-iris 已提交
875
**示例:**
@
@shi-xiaoxiao-iris 已提交
876

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

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

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

设置用户ui操作行为。

史晓晓 已提交
902
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
903

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

@
@shi-xiaoxiao-iris 已提交
906
**参数:**
@
@shi-xiaoxiao-iris 已提交
907

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

@
@shi-xiaoxiao-iris 已提交
913
**示例:**
@
@shi-xiaoxiao-iris 已提交
914 915

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

W
wuqi0105 已提交
932
### requestCredentialRegisterInfo<sup>10+</sup>
W
wuqi0105 已提交
933

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

获取凭据的注册信息。

史晓晓 已提交
938
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
939

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

**参数:**

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

**示例:**

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

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

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

导入凭据信息。

史晓晓 已提交
975
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
976

W
wuqi0105 已提交
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 1008 1009
**系统能力**: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 已提交
1010
    dmInstance.importCredential(credentialInfo, (data) => {
W
wuqi0105 已提交
1011 1012 1013
      if (data) {
          console.info("importCredential result:" + JSON.stringify(data));
      } else {
W
wangxuanxuan 已提交
1014
          console.info("importCredential result: data is null");
W
wuqi0105 已提交
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
      }
    });
  } catch (err) {
    console.error("importCredential err:" + err.code + "," + err.message);
  }
  ```

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

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

删除凭据信息。

史晓晓 已提交
1028
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1029

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

**参数:**

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

**示例:**

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

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

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

ui状态变更回调。

史晓晓 已提交
1066
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1067

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

@
@shi-xiaoxiao-iris 已提交
1070
**参数:**
@
@shi-xiaoxiao-iris 已提交
1071

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

@
@shi-xiaoxiao-iris 已提交
1077
**示例:**
@
@shi-xiaoxiao-iris 已提交
1078 1079 1080

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

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

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

1096 1097
取消ui状态变更回调。

史晓晓 已提交
1098
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1099

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

@
@shi-xiaoxiao-iris 已提交
1102
**参数:**
@
@shi-xiaoxiao-iris 已提交
1103

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

@
@shi-xiaoxiao-iris 已提交
1109
**示例:**
@
@shi-xiaoxiao-iris 已提交
1110 1111 1112

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

Z
zengyawen 已提交
1119
### on('deviceStateChange')
Z
zengyawen 已提交
1120

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

Z
zengyawen 已提交
1123 1124
注册设备状态回调。

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

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

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

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

@
@shi-xiaoxiao-iris 已提交
1136
**示例:**
@
@shi-xiaoxiao-iris 已提交
1137

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

Z
zengyawen 已提交
1148
### off('deviceStateChange')
Z
zengyawen 已提交
1149

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

取消注册设备状态回调。

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

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

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

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

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

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

1177 1178
### on('deviceFound')

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

注册发现设备回调监听。

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

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

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

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

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

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

### off('deviceFound')

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

取消注册设备发现回调。

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

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

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

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

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

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

### on('discoverFail')

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

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

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

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

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

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

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

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

### off('discoverFail')

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

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

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

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

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

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

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

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

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

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

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

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

S
summer8999 已提交
1301 1302
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

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

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

@
@shi-xiaoxiao-iris 已提交
1310

@
@shi-xiaoxiao-iris 已提交
1311
**示例:**
@
@shi-xiaoxiao-iris 已提交
1312

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

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

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

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

史晓晓 已提交
1329
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1330

S
summer8999 已提交
1331 1332
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1333
**参数:**
@
@shi-xiaoxiao-iris 已提交
1334

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Z
zengyawen 已提交
1410 1411 1412
### on('serviceDie')

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

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

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

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

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

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

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

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

Z
zengyawen 已提交
1439 1440 1441 1442 1443
### off('serviceDie')

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

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

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

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

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

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

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

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