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

Q
q30043944 已提交
24
```ts
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

Q
q30043944 已提交
46 47 48 49 50
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

  let dmInstance: deviceManager.Devicemanager | null = null;
51
  try {
Q
q30043944 已提交
52
    deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err: BusinessError, data: deviceManager.Devicemanager) => {
Z
zengyawen 已提交
53
      if (err) { 
54
        console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message);
55
        return;
Z
zengyawen 已提交
56 57
      }
      console.info("createDeviceManager success");
Q
q30043944 已提交
58
      dmInstance = data;
59 60
    });
  } catch(err) {
Q
q30043944 已提交
61 62
    let e: BusinessError = err as BusinessError;
    console.error("createDeviceManager errCode:" + e.code + ",errMessage:" + e.message);
63
  }
Z
zengyawen 已提交
64 65
  ```

66
## DeviceInfo
Z
zengyawen 已提交
67

68
设备信息。
Z
zengyawen 已提交
69

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

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

## DeviceType
Z
zengyawen 已提交
82 83 84

表示设备类型的枚举类。

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

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

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

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

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

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

110
## DeviceStateChangeAction
Z
zengyawen 已提交
111

112 113 114 115
表示设备状态变化的枚举。

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

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

## SubscribeInfo

发现信息。
Z
zengyawen 已提交
126

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

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


## DiscoverMode 

表示发现模式的枚举。

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

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


## ExchangeMedium 

表示发现类型的枚举。

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

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

## ExchangeFreq 

表示发现频率的枚举。

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

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


## SubscribeCap 

表示发现能力的枚举。

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

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


## AuthParam

认证参数。

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

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

## AuthInfo

认证信息。

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

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

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

发布设备参数

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

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

## DeviceManager
Z
zengyawen 已提交
228 229 230

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

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

Z
zengyawen 已提交
233
release(): void
Z
zengyawen 已提交
234

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

史晓晓 已提交
237
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
238

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

@
@shi-xiaoxiao-iris 已提交
241
**错误码:**
@
@shi-xiaoxiao-iris 已提交
242

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

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

@
@shi-xiaoxiao-iris 已提交
249
**示例:**
@
@shi-xiaoxiao-iris 已提交
250

Q
q30043944 已提交
251 252 253
  ```ts
  import { BusinessError } from '@ohos.base'

254 255 256
  try {
    dmInstance.release();
  } catch (err) {
Q
q30043944 已提交
257 258
    let e: BusinessError = err as BusinessError;
    console.error("release errCode:" + e.code + ",errMessage:" + e.message);
259
  }
Z
zengyawen 已提交
260
  ```
Z
zengyawen 已提交
261

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

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

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

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

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

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

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

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

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

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

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

Q
q30043944 已提交
288 289 290 291
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

292
  try {
Q
q30043944 已提交
293
    let deviceInfoList: Array<deviceManager.DeviceInfo> = dmInstance.getTrustedDeviceListSync();
294
  } catch (err) {
Q
q30043944 已提交
295 296
    let e: BusinessError = err as BusinessError;
    console.error("getTrustedDeviceListSync errCode:" + e.code + ",errMessage:" + e.message);
297
  }
Z
zengyawen 已提交
298
  ```
Z
zengyawen 已提交
299

W
wuxiaodong02 已提交
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 328 329 330 331
### 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.                                 |

**示例:**

Q
q30043944 已提交
332 333 334 335
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

W
wuxiaodong02 已提交
336
  try {
Q
q30043944 已提交
337
    let deviceInfoList: Array<deviceManager.DeviceInfo> = dmInstance.getTrustedDeviceListSync(true);
W
wuxiaodong02 已提交
338
  } catch (err) {
Q
q30043944 已提交
339 340
    let e: BusinessError = err as BusinessError;
    console.error("getTrustedDeviceListSync errCode:" + e.code + ",errMessage:" + e.message);
W
wuxiaodong02 已提交
341 342 343
  }
  ```

344 345 346 347 348 349
### getTrustedDeviceList<sup>8+</sup>

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

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

史晓晓 已提交
350
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
351

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

@
@shi-xiaoxiao-iris 已提交
354
**参数:**
@
@shi-xiaoxiao-iris 已提交
355

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

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

Q
q30043944 已提交
362 363 364
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'
365
  try {
Q
q30043944 已提交
366
    dmInstance.getTrustedDeviceList((err: BusinessError, data: deviceManager.DeviceInfo) => {
367
      if (err) {
368
        console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
369 370
        return;
      }
371
      console.log('get trusted device info: ' + JSON.stringify(data));
372
    });
373
  } catch (err) {
Q
q30043944 已提交
374 375
    let e: BusinessError = err as BusinessError;
    console.error("getTrustedDeviceList errCode:" + e.code + ",errMessage:" + e.message);
376
  }
377 378 379 380 381 382 383 384
  ```

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

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

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

史晓晓 已提交
385
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
386

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

@
@shi-xiaoxiao-iris 已提交
389
**返回值:**
@
@shi-xiaoxiao-iris 已提交
390

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

@
@shi-xiaoxiao-iris 已提交
395
**示例:**
@
@shi-xiaoxiao-iris 已提交
396

Q
q30043944 已提交
397 398 399 400 401
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

  dmInstance.getTrustedDeviceList().then((data: Array<deviceManager.DeviceInfo>) => {
402
    console.log('get trusted device info: ' + JSON.stringify(data));
Q
q30043944 已提交
403
    }).catch((err: BusinessError) => {
404
      console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
405
  });
406 407 408 409 410 411 412 413
  ```

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

getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)

同步获取本地设备信息。

史晓晓 已提交
414
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
415

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

@
@shi-xiaoxiao-iris 已提交
418
**返回值:**
@
@shi-xiaoxiao-iris 已提交
419

420 421 422
  | 名称                      | 说明              |
  | ------------------------- | ---------------- |
  | [DeviceInfo](#deviceinfo) | 返回本地设备列表。 |
423

@
@shi-xiaoxiao-iris 已提交
424
**错误码:**
@
@shi-xiaoxiao-iris 已提交
425

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

@
@shi-xiaoxiao-iris 已提交
428
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
429 430
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
431

@
@shi-xiaoxiao-iris 已提交
432
**示例:**
@
@shi-xiaoxiao-iris 已提交
433

Q
q30043944 已提交
434 435 436 437
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

438
  try {
Q
q30043944 已提交
439
    let deviceInfo: deviceManager.DeviceInfo = dmInstance.getLocalDeviceInfoSync();
440
  } catch (err) {
Q
q30043944 已提交
441 442
    let e: BusinessError = err as BusinessError;
    console.error("getLocalDeviceInfoSync errCode:" + e.code + ",errMessage:" + e.message);
443
  }
444 445 446 447 448 449 450 451
  ```

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

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

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

史晓晓 已提交
452
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
453

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

@
@shi-xiaoxiao-iris 已提交
456
**参数:**
@
@shi-xiaoxiao-iris 已提交
457

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

@
@shi-xiaoxiao-iris 已提交
462
**示例:**
@
@shi-xiaoxiao-iris 已提交
463

Q
q30043944 已提交
464 465 466 467 468
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'


469
  try {
Q
q30043944 已提交
470
    dmInstance.getLocalDeviceInfo((err: BusinessError, data: deviceManager.DeviceInfo) => {
471
    if (err) {
472
      console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
473
      return;
474
    }
475 476 477
      console.log('get local device info: ' + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
478 479
    let e: BusinessError = err as BusinessError;
    console.error("getLocalDeviceInfo errCode:" + e.code + ",errMessage:" + e.message);
480
  }
481 482 483 484 485 486 487 488
  ```

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

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

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

史晓晓 已提交
489
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
490

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

@
@shi-xiaoxiao-iris 已提交
493 494
**返回值:**

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

@
@shi-xiaoxiao-iris 已提交
499
**示例:**
@
@shi-xiaoxiao-iris 已提交
500

Q
q30043944 已提交
501 502 503 504 505
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

  dmInstance.getLocalDeviceInfo().then((data: deviceManager.DeviceInfo) => {
506
    console.log('get local device info: ' + JSON.stringify(data));
Q
q30043944 已提交
507
  }).catch((err: BusinessError) => {
508
    console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
509
  });
510 511
  ```

S
summer8999 已提交
512 513
### getDeviceInfo<sup>10+</sup>

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

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

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

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

**参数:**

  | 参数名       | 类型                                     | 必填   | 说明        |
  | -------- | ---------------------------------------- | ---- | --------- |
S
summer8999 已提交
526
  | networkId| string                                   | 是   | 设备的网络标识。 |
S
summer8999 已提交
527 528 529 530
  | callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是    | 获取指定设备信息。 |

**示例:**

Q
q30043944 已提交
531 532 533 534
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

S
summer8999 已提交
535
  try {
W
wangxuanxuan 已提交
536 537
    // 设备网络标识,可以从可信设备列表中获取
    let networkId = "xxxxxxx"
Q
q30043944 已提交
538
    dmInstance.getDeviceInfo(networkId, (err: BusinessError, data: deviceManager.DeviceInfo) => {
S
summer8999 已提交
539 540 541 542 543 544 545
    if (err) {
      console.error("getDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
      return;
    }
      console.log('get device info: ' + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
546 547
    let e: BusinessError = err as BusinessError;
    console.error("getDeviceInfo errCode:" + e.code + ",errMessage:" + e.message);
S
summer8999 已提交
548 549 550 551 552
  }
  ```

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

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

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

史晓晓 已提交
557
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
558

S
summer8999 已提交
559 560
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

S
summer8999 已提交
561 562 563 564 565 566
**参数:**

  | 参数名   | 类型                                     | 必填 | 说明        |
  | -------- | ---------------------------------------- | ---- | --------- |
  | networkId| string                                   | 是   | 设备的网络标识。 |
  
S
summer8999 已提交
567 568 569 570 571 572 573 574
**返回值:**

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

**示例:**

Q
q30043944 已提交
575 576 577 578
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

W
wangxuanxuan 已提交
579 580
  // 设备网络标识,可以从可信设备列表中获取
  let networkId = "xxxxxxx"
Q
q30043944 已提交
581
  dmInstance.getDeviceInfo(networkId).then((data: deviceManager.DeviceInfo) => {
S
summer8999 已提交
582
    console.log('get device info: ' + JSON.stringify(data));
Q
q30043944 已提交
583
  }).catch((err: BusinessError) => {
S
summer8999 已提交
584 585 586 587
    console.error("getDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
  });
  ```

@
@shi-xiaoxiao-iris 已提交
588
### startDeviceDiscovery<sup>8+</sup>
589 590 591

startDeviceDiscovery(subscribeInfo: SubscribeInfo): void

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

史晓晓 已提交
594
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
595

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

@
@shi-xiaoxiao-iris 已提交
598
**参数:**
@
@shi-xiaoxiao-iris 已提交
599

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

@
@shi-xiaoxiao-iris 已提交
604
**错误码:**
@
@shi-xiaoxiao-iris 已提交
605

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

@
@shi-xiaoxiao-iris 已提交
608
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
609 610 611 612
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600104 | Discovery invalid.                                              |

@
@shi-xiaoxiao-iris 已提交
613
**示例:**
@
@shi-xiaoxiao-iris 已提交
614

Q
q30043944 已提交
615 616 617 618 619 620 621 622 623 624 625 626 627
  ```ts
  import { BusinessError } from '@ohos.base'

  interface SubscribeInfo {
    subscribeId: number,
    mode: number, // 主动模式
    medium: number,  // 自动发现类型,同时支持多种发现类型
    freq: number,    // 高频率
    isSameAccount: boolean,
    isWakeRemote: boolean,
    capability: number
  };

628
  // 生成发现标识,随机数确保每次调用发现接口的标识不一致
Q
q30043944 已提交
629 630 631 632 633 634 635 636 637
  let subscribeId = Math.floor(Math.random() * 10000 + 1000);
  let subscribeInfo: SubscribeInfo = {
    subscribeId: subscribeId,
    mode: 0xAA, // 主动模式
    medium: 0,  // 自动发现类型,同时支持多种发现类型
    freq: 2,    // 高频率
    isSameAccount: false,
    isWakeRemote: false,
    capability: 1
638
  };
639 640 641
  try {
    dmInstance.startDeviceDiscovery(subscribeInfo); // 当有设备发现时,通过deviceFound回调通知给应用程序
  } catch (err) {
Q
q30043944 已提交
642 643
    let e: BusinessError = err as BusinessError;
    console.error("startDeviceDiscovery errCode:" + e.code + ",errMessage:" + e.message);
644
  }
645 646
  ```

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

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

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

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

S
summer8999 已提交
655 656
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

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

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

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

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

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

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

Q
q30043944 已提交
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
  ```ts
  import { BusinessError } from '@ohos.base'

  interface Filters {
    type: string,
    value: number
  }

  interface FilterOptions {
    filter_op: string, // 可选, 默认"OR"
    filters: Filters[]
    }

  interface SubscribeInfo {
    subscribeId: number,
    mode: number, // 主动模式
    medium: number,  // 自动发现类型,同时支持多种发现类型
    freq: number,    // 高频率
    isSameAccount: boolean,
    isWakeRemote: boolean,
    capability: number
  }

698
  // 生成发现标识,随机数确保每次调用发现接口的标识不一致
Q
q30043944 已提交
699 700 701 702 703 704 705 706 707
  let subscribeId = Math.floor(Math.random() * 10000 + 1000);
  let subscribeInfo: SubscribeInfo = {
    subscribeId: subscribeId,
    mode: 0xAA, // 主动模式
    medium: 0,  // 自动发现类型,同时支持多种发现类型
    freq: 2,    // 高频率
    isSameAccount: false,
    isWakeRemote: false,
    capability: 1
S
summer8999 已提交
708
  };
Q
q30043944 已提交
709 710 711 712 713 714 715 716 717 718 719

  let filters: Filters[] = [
    {
        type: "range",
        value: 50 // 需过滤发现设备的距离,单位(cm)
    }
  ]

  let filterOptions: FilterOptions = {
    filter_op: "OR", // 可选, 默认"OR"
    filters: filters
S
summer8999 已提交
720
  };
721 722 723
  try {
    dmInstance.startDeviceDiscovery(subscribeInfo, JSON.stringify(filterOptions)); // 当有设备发现时,通过deviceFound回调通知给应用程序
  } catch (err) {
Q
q30043944 已提交
724 725
    let e: BusinessError = err as BusinessError;
    console.error("startDeviceDiscovery errCode:" + e.code + ",errMessage:" + e.message);
726
  }
S
summer8999 已提交
727
  ```
@
@shi-xiaoxiao-iris 已提交
728

729 730 731 732 733 734
### stopDeviceDiscovery

stopDeviceDiscovery(subscribeId: number): void

停止发现周边设备。

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

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

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

@
@shi-xiaoxiao-iris 已提交
741
  | 参数名          | 类型   | 必填   | 说明    |
H
HelloCrease 已提交
742 743
  | ----------- | ------ | ---- | ----- |
  | subscribeId | number | 是    | 发现标识。 |
744

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

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

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

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

Q
q30043944 已提交
755 756 757
  ```ts
  import { BusinessError } from '@ohos.base'

758
  try {
759
    // stopDeviceDiscovery和startDeviceDiscovery需配对使用,入参需要和startDeviceDiscovery接口传入的subscribeId值相等
Q
q30043944 已提交
760
    let subscribeId = 12345;
761 762
    dmInstance.stopDeviceDiscovery(subscribeId);
  } catch (err) {
Q
q30043944 已提交
763 764
    let e: BusinessError = err as BusinessError;
    console.error("stopDeviceDiscovery errCode:" + e.code + ",errMessage:" + e.message);
765
  }
766 767
  ```

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

S
summer8999 已提交
770
publishDeviceDiscovery(publishInfo: PublishInfo): void
S
summer8999 已提交
771

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

史晓晓 已提交
774
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
775

S
summer8999 已提交
776 777
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
778
**参数:**
@
@shi-xiaoxiao-iris 已提交
779

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

@
@shi-xiaoxiao-iris 已提交
784
**错误码:**
@
@shi-xiaoxiao-iris 已提交
785

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

@
@shi-xiaoxiao-iris 已提交
788
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
789 790 791
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
| 11600105 | Publish invalid.                                                |
@
@shi-xiaoxiao-iris 已提交
792

@
@shi-xiaoxiao-iris 已提交
793
**示例:**
@
@shi-xiaoxiao-iris 已提交
794

Q
q30043944 已提交
795 796 797 798 799 800 801 802 803 804
  ```ts
  import { BusinessError } from '@ohos.base'

  interface PublishInfo {
    publishId: number,
    mode: number, // 主动模式
    freq: number,    // 高频率
    ranging: boolean  // 支持发现时测距
  };

805
  // 生成发布标识,随机数确保每次调用发布接口的标识不一致
Q
q30043944 已提交
806 807 808 809 810 811
  let publishId = Math.floor(Math.random() * 10000 + 1000);
  let publishInfo: PublishInfo = {
    publishId: publishId,
    mode: 0xAA, // 主动模式
    freq: 2,    // 高频率
    ranging: true  // 支持发现时测距
S
summer8999 已提交
812
  };
Q
q30043944 已提交
813

814 815 816
  try {
    dmInstance.publishDeviceDiscovery(publishInfo); // 当有发布结果时,通过回调通知给应用程序
  } catch (err) {
Q
q30043944 已提交
817 818
    let e: BusinessError = err as BusinessError;
    console.error("publishDeviceDiscovery errCode:" + e.code + ",errMessage:" + e.message);
819
  }
S
summer8999 已提交
820
  ```
821

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

S
summer8999 已提交
824
unPublishDeviceDiscovery(publishId: number): void
S
summer8999 已提交
825 826 827

停止发布设备发现。

史晓晓 已提交
828
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
829

S
summer8999 已提交
830 831
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
832
**参数:**
@
@shi-xiaoxiao-iris 已提交
833

@
@shi-xiaoxiao-iris 已提交
834
  | 参数名        | 类型 | 必填 | 说明  |
S
summer8999 已提交
835 836
  | ----------- | -------- | ---- | ----- |
  | publishId   | number   | 是   | 发布标识。 |
S
summer8999 已提交
837

@
@shi-xiaoxiao-iris 已提交
838
**错误码:**
@
@shi-xiaoxiao-iris 已提交
839

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

@
@shi-xiaoxiao-iris 已提交
842
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
843 844
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
845

@
@shi-xiaoxiao-iris 已提交
846
**示例:**
@
@shi-xiaoxiao-iris 已提交
847

Q
q30043944 已提交
848 849 850
  ```ts
  import { BusinessError } from '@ohos.base'

851
  try {
852
    // unPublishDeviceDiscovery和publishDeviceDiscovery配对使用,入参需要和publishDeviceDiscovery接口传入的publishId值相等
Q
q30043944 已提交
853
    let publishId = 12345;
854
    dmInstance.unPublishDeviceDiscovery(publishId);
855
  } catch (err) {
Q
q30043944 已提交
856 857
    let e: BusinessError = err as BusinessError;
    console.error("unPublishDeviceDiscovery errCode:" + e.code + ",errMessage:" + e.message);
858
  }
S
summer8999 已提交
859 860
  ```

861 862
### authenticateDevice

863
authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: AsyncCallback&lt;{deviceId: string, pinToken ?: number}&gt;): void
864 865 866

认证设备。

史晓晓 已提交
867
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
868

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

@
@shi-xiaoxiao-iris 已提交
871
**参数:**
@
@shi-xiaoxiao-iris 已提交
872

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

@
@shi-xiaoxiao-iris 已提交
879
**示例:**
@
@shi-xiaoxiao-iris 已提交
880

Q
q30043944 已提交
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    deviceId: string = ""
    pinToken?: number = 0
  }

  interface DeviceInfo {
    deviceId: string,
    deviceName: string
    deviceType: number,
    networkId: string,
    range: number
  };

  interface ExtraInfo {
    targetPkgName: string,
    appName: string,
    appDescription: string,
    business: string
  }

  interface AuthParam {
    authType: number,// 认证类型: 1 - 无帐号PIN码认证
    extraInfo: ExtraInfo
  }

909
  // 认证的设备信息,可以从发现的结果中获取
Q
q30043944 已提交
910 911 912 913 914 915
  let deviceInfo: DeviceInfo = {
    deviceId: "XXXXXXXX",
    deviceName: "",
    deviceType: 0x0E,
    networkId: "xxxxxxx",
    range: 0
916
  };
Q
q30043944 已提交
917 918 919 920 921
  let extraInfo: ExtraInfo = {
    targetPkgName: 'ohos.samples.xxx',
    appName: 'xxx',
    appDescription: 'xxx',
    business: '0'
922
  }
Q
q30043944 已提交
923 924 925
  let authParam: AuthParam = {
    authType: 1,// 认证类型: 1 - 无帐号PIN码认证
    extraInfo: extraInfo
926
  }
Q
q30043944 已提交
927

928
  try {
Q
q30043944 已提交
929
    dmInstance.authenticateDevice(deviceInfo, authParam, (err: BusinessError, data: Data) => {
930
      if (err) {
931
          console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
932 933
          return;
      }
@
@shi-xiaoxiao-iris 已提交
934 935
      console.info("authenticateDevice result:" + JSON.stringify(data));
      let token = data.pinToken;
936 937
    });
  } catch (err) {
Q
q30043944 已提交
938 939
    let e: BusinessError = err as BusinessError;
    console.error("authenticateDevice errCode:" + e.code + ",errMessage:" + e.message);
940
  }
941 942 943 944 945 946 947 948
  ```

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

unAuthenticateDevice(deviceInfo: DeviceInfo): void

解除认证设备。

史晓晓 已提交
949
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
950

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

@
@shi-xiaoxiao-iris 已提交
953
**参数:**
@
@shi-xiaoxiao-iris 已提交
954

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

@
@shi-xiaoxiao-iris 已提交
959
**错误码:**
@
@shi-xiaoxiao-iris 已提交
960

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

@
@shi-xiaoxiao-iris 已提交
963
| 错误码ID | 错误信息                                                        |
@
@shi-xiaoxiao-iris 已提交
964 965
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function.                                 |
@
@shi-xiaoxiao-iris 已提交
966

@
@shi-xiaoxiao-iris 已提交
967
**示例:**
@
@shi-xiaoxiao-iris 已提交
968

Q
q30043944 已提交
969 970 971 972 973 974 975 976 977 978 979
  ```ts
  import { BusinessError } from '@ohos.base'

  interface DeviceInfo {
    deviceId: string,
    deviceName: string,
    deviceType: number,
    networkId: string,
    range: number
  }

980
  try {
Q
q30043944 已提交
981 982 983 984 985 986
    let deviceInfo: DeviceInfo = {
      deviceId: "XXXXXXXX",
      deviceName: "",
      deviceType: 0x0E,
      networkId: "xxxxxxx",
      range: 0
987
    };
988 989
    dmInstance.unAuthenticateDevice(deviceInfo);
  } catch (err) {
Q
q30043944 已提交
990 991
    let e: BusinessError = err as BusinessError;
    console.error("unAuthenticateDevice errCode:" + e.code + ",errMessage:" + e.message);
992
  }
993 994 995 996
  ```

### verifyAuthInfo

997
verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback&lt;{deviceId: string, level: number}&gt;): void
998 999 1000

验证认证信息。

史晓晓 已提交
1001
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1002

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

@
@shi-xiaoxiao-iris 已提交
1005
**参数:**
@
@shi-xiaoxiao-iris 已提交
1006

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

@
@shi-xiaoxiao-iris 已提交
1012
**示例:**
@
@shi-xiaoxiao-iris 已提交
1013

Q
q30043944 已提交
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
  ```ts
  import { BusinessError } from '@ohos.base'

  interface ExtraInfo {
    authType: number,
    token: number
  }

  interface AuthInfo {
    authType: number,
    token: number,
    extraInfo: ExtraInfo
  }

  class Data {
    deviceId: string = ""
    level: number = 0
  }

  let extraInfo: ExtraInfo = {
    authType: 0,
    token: 0
  }

  let authInfo: AuthInfo = {
    authType: 1,
    token: 123456,
    extraInfo: extraInfo
1042
  }
1043
  try {
Q
q30043944 已提交
1044 1045 1046 1047
    dmInstance.verifyAuthInfo(authInfo, (err: BusinessError, data: Data) => {
      if (err) {
          console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
          return;
1048
    }
@
@shi-xiaoxiao-iris 已提交
1049
    console.info("verifyAuthInfo result:" + JSON.stringify(data));
1050 1051
    });
  } catch (err) {
Q
q30043944 已提交
1052 1053
    let e: BusinessError = err as BusinessError;
    console.error("verifyAuthInfo errCode:" + e.code + ",errMessage:" + e.message);
1054
  }
1055 1056
  ```

@
@shi-xiaoxiao-iris 已提交
1057
### setUserOperation<sup>9+</sup>
@
@shi-xiaoxiao-iris 已提交
1058 1059 1060 1061 1062

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

设置用户ui操作行为。

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

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

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

@
@shi-xiaoxiao-iris 已提交
1069
  | 参数名       | 类型            | 必填  | 说明                |
1070 1071 1072
  | ------------- | --------------- | ---- | ------------------- |
  | operateAction | number          | 是    | 用户操作动作。       |
  | params        | string          | 是    | 表示用户的输入参数。 |
@
@shi-xiaoxiao-iris 已提交
1073

@
@shi-xiaoxiao-iris 已提交
1074
**示例:**
@
@shi-xiaoxiao-iris 已提交
1075

Q
q30043944 已提交
1076 1077 1078
  ```ts
  import { BusinessError } from '@ohos.base'

@
@shi-xiaoxiao-iris 已提交
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
 try {
    /*
      operateAction = 0 - 允许授权
      operateAction = 1 - 取消授权
      operateAction = 2 - 授权框用户操作超时
      operateAction = 3 - 取消pin码框展示
      operateAction = 4 - 取消pin码输入框展示
      operateAction = 5 - pin码输入框确定操作
    */
    let operation = 0;
1089
    dmInstance.setUserOperation(operation, "extra")
@
@shi-xiaoxiao-iris 已提交
1090
    } catch (err) {
Q
q30043944 已提交
1091 1092
      let e: BusinessError = err as BusinessError;
      console.error("setUserOperation errCode:" + e.code + ",errMessage:" + e.message);
@
@shi-xiaoxiao-iris 已提交
1093 1094 1095
  }
  ```

W
wuqi0105 已提交
1096
### requestCredentialRegisterInfo<sup>10+</sup>
W
wuqi0105 已提交
1097

W
wuqi0105 已提交
1098
requestCredentialRegisterInfo(requestInfo: string, callback: AsyncCallback<{registerInfo: string}>): void;
W
wuqi0105 已提交
1099 1100 1101

获取凭据的注册信息。

史晓晓 已提交
1102
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1103

W
wuqi0105 已提交
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

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

**示例:**

Q
q30043944 已提交
1115 1116 1117 1118 1119 1120
  ```ts
  import { BusinessError } from '@ohos.base'

  interface CredentialInfo {
    version: string,
    userId: string
W
wuqi0105 已提交
1121
  }
Q
q30043944 已提交
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131

  class Data {
    registerInfo: string = ""
  }

  let credentialInfo: CredentialInfo = {
    version: "1.2.3",
    userId: "123"
  }

W
wuqi0105 已提交
1132
  try {
Q
q30043944 已提交
1133
    dmInstance.requestCredentialRegisterInfo(credentialInfo, (dataData) => {
W
wuqi0105 已提交
1134
      if (data) {
W
wuqi0105 已提交
1135
          console.info("requestCredentialRegisterInfo result:" + JSON.stringify(data));
W
wuqi0105 已提交
1136
      } else {
W
wangxuanxuan 已提交
1137
          console.info("requestCredentialRegisterInfo result: data is null");
W
wuqi0105 已提交
1138 1139 1140
      }
    });
  } catch (err) {
Q
q30043944 已提交
1141 1142
    let e: BusinessError = err as BusinessError;
    console.error("requestCredentialRegisterInfo err:" + e.code + "," + e.message);
W
wuqi0105 已提交
1143 1144 1145 1146 1147 1148 1149 1150 1151
  }
  ```

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

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

导入凭据信息。

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

W
wuqi0105 已提交
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

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

**示例:**

Q
q30043944 已提交
1165 1166 1167 1168 1169
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    resultInfo: string = ""
W
wuqi0105 已提交
1170
  }
Q
q30043944 已提交
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213

  interface CredentialData {
    credentialType: number,
    credentialId: string,
    serverPk: string,
    pkInfoSignature : string,
    pkInfo: string,
    authCode: string,
    peerDeviceId: string
  }

  interface CredentialInfo {
    processType: number,
    authType: number,
    userId: string,
    deviceId: string,
    version: string,
    devicePk : string,
    credentialData : CredentialData[]
  }

  let credentialData: CredentialData = [
    {
      credentialType: 2,
      credentialId: "102",
      serverPk: "3059301306072A8648CE3D020106082A8648CE3D03",
      pkInfoSignature : "30440220490BCB4F822004C9A76AB8D97F80041FC0E",
      pkInfo: "",
      authCode: "",
      peerDeviceId: ""
    }
  ]

  let credentialInfo: CredentialInfo = {
    processType: 1,
    authType: 1,
    userId: "123",
    deviceId: "aaa",
    version: "1.2.3",
    devicePk : "0000",
    credentialData : credentialData
  }

W
wuqi0105 已提交
1214
  try {
Q
q30043944 已提交
1215
    dmInstance.importCredential(credentialInfo, (data: Data) => {
W
wuqi0105 已提交
1216 1217 1218
      if (data) {
          console.info("importCredential result:" + JSON.stringify(data));
      } else {
W
wangxuanxuan 已提交
1219
          console.info("importCredential result: data is null");
W
wuqi0105 已提交
1220 1221 1222
      }
    });
  } catch (err) {
Q
q30043944 已提交
1223 1224
    let e: BusinessError = err as BusinessError;
    console.error("importCredential err:" + e.code + "," + e.message);
W
wuqi0105 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233
  }
  ```

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

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

删除凭据信息。

史晓晓 已提交
1234
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1235

W
wuqi0105 已提交
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

**参数:**

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

**示例:**

Q
q30043944 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    resultInfo: string = ""
  }

  interface QueryInfo {
    processType: number,
    authType: number,
    userId: string
  }

  let queryInfo: QueryInfo = {
    processType: 1,
    authType: 1,
    userId: "123"
W
wuqi0105 已提交
1264
  }
Q
q30043944 已提交
1265

W
wuqi0105 已提交
1266
  try {
Q
q30043944 已提交
1267
    dmInstance.deleteCredential(queryInfo, (data: Data) => {
W
wuqi0105 已提交
1268 1269 1270
      if (data) {
          console.info("deleteCredential result:" + JSON.stringify(data));
      } else {
W
wangxuanxuan 已提交
1271
          console.info("deleteCredential result: data is null");
W
wuqi0105 已提交
1272 1273 1274
      }
    });
  } catch (err) {
Q
q30043944 已提交
1275 1276
    let e: BusinessError = err as BusinessError;
    console.error("deleteCredential err:" + e.code + "," + e.message);
W
wuqi0105 已提交
1277 1278 1279
  }
  ```

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

1282
on(type: 'uiStateChange', callback: Callback&lt;{ param: string}&gt;): void;
@
@shi-xiaoxiao-iris 已提交
1283 1284 1285

ui状态变更回调。

史晓晓 已提交
1286
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1287

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

@
@shi-xiaoxiao-iris 已提交
1290
**参数:**
@
@shi-xiaoxiao-iris 已提交
1291

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

@
@shi-xiaoxiao-iris 已提交
1297
**示例:**
@
@shi-xiaoxiao-iris 已提交
1298

Q
q30043944 已提交
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    param: string = ""
  }

  interface TmpStr {
    verifyFailed: boolean
  }

@
@shi-xiaoxiao-iris 已提交
1310
  try {
Q
q30043944 已提交
1311
    dmInstance.on('uiStateChange', (data: Data) => {
@
@shi-xiaoxiao-iris 已提交
1312
    console.log("uiStateChange executed, dialog closed" + JSON.stringify(data))
Q
q30043944 已提交
1313 1314
    let tmpStr: TmpStr = JSON.parse(data.param)
    let isShow = tmpStr.verifyFailed
1315
    console.log("uiStateChange executed, dialog closed" + isShow)
@
@shi-xiaoxiao-iris 已提交
1316 1317
  });
  } catch (err) {
Q
q30043944 已提交
1318 1319
    let e: BusinessError = err as BusinessError;
    console.error("uiStateChange errCode:" + e.code + ",errMessage:" + e.message);
@
@shi-xiaoxiao-iris 已提交
1320 1321 1322
  }
  ```

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

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

1327 1328
取消ui状态变更回调。

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

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

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

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

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

Q
q30043944 已提交
1342 1343 1344
  ```ts
  import { BusinessError } from '@ohos.base'

@
@shi-xiaoxiao-iris 已提交
1345
  try {
@
@shi-xiaoxiao-iris 已提交
1346
    dmInstance.off('uiStateChange');
@
@shi-xiaoxiao-iris 已提交
1347
  } catch (err) {
Q
q30043944 已提交
1348 1349
    let e: BusinessError = err as BusinessError;
    console.error("uiStateChange errCode:" + e.code + ",errMessage:" + e.message);
@
@shi-xiaoxiao-iris 已提交
1350 1351 1352
  }
  ```

Z
zengyawen 已提交
1353
### on('deviceStateChange')
Z
zengyawen 已提交
1354

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

Z
zengyawen 已提交
1357 1358
注册设备状态回调。

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

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

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

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

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

Q
q30043944 已提交
1372 1373 1374 1375 1376 1377 1378 1379 1380
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

  class Data {
    action: deviceManager.DeviceStateChangeAction = 0
    device: deviceManager.DeviceInfo = {}
  }

1381
  try {
Q
q30043944 已提交
1382
    dmInstance.on('deviceStateChange', (data: Data) => {
1383 1384 1385
      console.info("deviceStateChange on:" + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
1386 1387
    let e: BusinessError = err as BusinessError;
    console.error("deviceStateChange errCode:" + e.code + ",errMessage:" + e.message);
1388
  }
Z
zengyawen 已提交
1389
  ```
Z
zengyawen 已提交
1390

Z
zengyawen 已提交
1391
### off('deviceStateChange')
Z
zengyawen 已提交
1392

1393
off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChangeAction, device: DeviceInfo }&gt;): void
Z
zengyawen 已提交
1394 1395 1396

取消注册设备状态回调。

史晓晓 已提交
1397
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1398

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

@
@shi-xiaoxiao-iris 已提交
1401
**参数:**
@
@shi-xiaoxiao-iris 已提交
1402

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

@
@shi-xiaoxiao-iris 已提交
1408
**示例:**
@
@shi-xiaoxiao-iris 已提交
1409

Q
q30043944 已提交
1410 1411 1412 1413 1414 1415 1416 1417 1418
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

  class Data {
    action: deviceManager.DeviceStateChangeAction = 0
    device: deviceManager.DeviceInfo = {}
  }

1419
  try {
Q
q30043944 已提交
1420
    dmInstance.off('deviceStateChange', (data: Data) => {
1421 1422 1423
      console.info('deviceStateChange' + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
1424 1425
    let e: BusinessError = err as BusinessError;
    console.error("deviceStateChange errCode:" + e.code + ",errMessage:" + e.message);
1426
  }
Z
zengyawen 已提交
1427 1428
  ```

1429 1430
### on('deviceFound')

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

注册发现设备回调监听。

史晓晓 已提交
1435
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1436

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

@
@shi-xiaoxiao-iris 已提交
1439
**参数:**
@
@shi-xiaoxiao-iris 已提交
1440

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

@
@shi-xiaoxiao-iris 已提交
1446
**示例:**
@
@shi-xiaoxiao-iris 已提交
1447

Q
q30043944 已提交
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

  class Data {
    subscribeId: number = 0
    device: deviceManager.DeviceInfo = {}
  }

  subscribeId: number, device: DeviceInfo
1458
  try {
Q
q30043944 已提交
1459
    dmInstance.on('deviceFound', (data: Data) => {
1460 1461 1462
      console.info("deviceFound:" + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
1463 1464
    let e: BusinessError = err as BusinessError;
    console.error("deviceFound errCode:" + e.code + ",errMessage:" + e.message);
1465
  }
1466 1467 1468 1469
  ```

### off('deviceFound')

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

取消注册设备发现回调。

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

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

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

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

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

Q
q30043944 已提交
1487 1488 1489 1490 1491 1492 1493 1494 1495
  ```ts
  import deviceManager from '@ohos.distributedHardware.deviceManager';
  import { BusinessError } from '@ohos.base'

  class Data {
    subscribeId: number = 0
    device: deviceManager.DeviceInfo = {}
  }

1496
  try {
Q
q30043944 已提交
1497
    dmInstance.off('deviceFound', (data: Data) => {
1498 1499 1500
      console.info('deviceFound' + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
1501 1502
    let e: BusinessError = err as BusinessError;
    console.error("deviceFound errCode:" + e.code + ",errMessage:" + e.message);
1503
  }
1504 1505 1506 1507
  ```

### on('discoverFail')

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

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

史晓晓 已提交
1512
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1513

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

@
@shi-xiaoxiao-iris 已提交
1516
**参数:**
@
@shi-xiaoxiao-iris 已提交
1517

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

@
@shi-xiaoxiao-iris 已提交
1523
**示例:**
@
@shi-xiaoxiao-iris 已提交
1524

Q
q30043944 已提交
1525 1526 1527 1528 1529 1530 1531 1532
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    subscribeId: number = 0
    reason: number = 0
  }

1533
  try {
Q
q30043944 已提交
1534
    dmInstance.on('discoverFail', (data: Data) => {
1535
        console.info("discoverFail on:" + JSON.stringify(data));
1536
    });
1537
  } catch (err) {
Q
q30043944 已提交
1538 1539
    let e: BusinessError = err as BusinessError;
    console.error("discoverFail errCode:" + e.code + ",errMessage:" + e.message);
1540
  }
1541 1542 1543 1544
  ```

### off('discoverFail')

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

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

史晓晓 已提交
1549
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1550

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

@
@shi-xiaoxiao-iris 已提交
1553
**参数:**
@
@shi-xiaoxiao-iris 已提交
1554

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

@
@shi-xiaoxiao-iris 已提交
1560
**示例:**
@
@shi-xiaoxiao-iris 已提交
1561

Q
q30043944 已提交
1562 1563 1564 1565 1566 1567 1568 1569
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    subscribeId: number = 0
    reason: number = 0
  }

1570
  try {
Q
q30043944 已提交
1571
    dmInstance.off('discoverFail', (data: Data) => {
1572 1573 1574
      console.info('discoverFail' + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
1575 1576
    let e: BusinessError = err as BusinessError;
    console.error("discoverFail errCode:" + e.code + ",errMessage:" + e.message);
1577
  }
1578 1579
  ```

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

1582
on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): void
S
summer8999 已提交
1583 1584 1585

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

史晓晓 已提交
1586
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1587

S
summer8999 已提交
1588 1589
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1590
**参数:**
@
@shi-xiaoxiao-iris 已提交
1591

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

@
@shi-xiaoxiao-iris 已提交
1597

@
@shi-xiaoxiao-iris 已提交
1598
**示例:**
@
@shi-xiaoxiao-iris 已提交
1599

Q
q30043944 已提交
1600 1601 1602 1603 1604 1605 1606
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    publishId: number = 0
  }

1607
  try {
Q
q30043944 已提交
1608
    dmInstance.on('publishSuccess', (data: Data) => {
1609 1610 1611
      console.info("publishSuccess:" + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
1612 1613
    let e: BusinessError = err as BusinessError;
    console.error("publishSuccess errCode:" + e.code + ",errMessage:" + e.message);
1614
  }
S
summer8999 已提交
1615 1616
  ```

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

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

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

史晓晓 已提交
1623
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1624

S
summer8999 已提交
1625 1626
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1627
**参数:**
@
@shi-xiaoxiao-iris 已提交
1628

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

@
@shi-xiaoxiao-iris 已提交
1634
**示例:**
@
@shi-xiaoxiao-iris 已提交
1635

Q
q30043944 已提交
1636 1637 1638 1639 1640 1641 1642
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    publishId: number = 0
  }

1643
  try {
Q
q30043944 已提交
1644
    dmInstance.off('publishSuccess', (data: Data) => {
1645 1646 1647
      console.info('publishSuccess' + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
1648 1649
    let e: BusinessError = err as BusinessError;
    console.error("publishSuccess errCode:" + e.code + ",errMessage:" + e.message);
1650
  }
S
summer8999 已提交
1651 1652
  ```

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

1655
on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: number }&gt;): void
S
summer8999 已提交
1656 1657 1658

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

史晓晓 已提交
1659
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1660

S
summer8999 已提交
1661 1662
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1663
**参数:**
@
@shi-xiaoxiao-iris 已提交
1664

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

@
@shi-xiaoxiao-iris 已提交
1670
**示例:**
@
@shi-xiaoxiao-iris 已提交
1671

Q
q30043944 已提交
1672 1673 1674 1675 1676 1677 1678 1679
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    publishId: number = 0
    reason: number = 0
  }

1680
  try {
Q
q30043944 已提交
1681
    dmInstance.on('publishFail', (data: Data) => {
1682
      console.info("publishFail on:" + JSON.stringify(data));
1683 1684
    });
  } catch (err) {
Q
q30043944 已提交
1685 1686
    let e: BusinessError = err as BusinessError;
    console.error("publishFail errCode:" + e.code + ",errMessage:" + e.message);
1687
  }
S
summer8999 已提交
1688 1689
  ```

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

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

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

史晓晓 已提交
1696
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1697

S
summer8999 已提交
1698 1699
**系统能力**:SystemCapability.DistributedHardware.DeviceManager

@
@shi-xiaoxiao-iris 已提交
1700
**参数:**
@
@shi-xiaoxiao-iris 已提交
1701

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

@
@shi-xiaoxiao-iris 已提交
1707
**示例:**
@
@shi-xiaoxiao-iris 已提交
1708

Q
q30043944 已提交
1709 1710 1711 1712 1713 1714 1715 1716
  ```ts
  import { BusinessError } from '@ohos.base'

  class Data {
    publishId: number = 0
    reason: number = 0
  }

1717
  try {
Q
q30043944 已提交
1718
    dmInstance.off('publishFail', (data: Data) => {
1719 1720 1721
      console.info('publishFail' + JSON.stringify(data));
    });
  } catch (err) {
Q
q30043944 已提交
1722 1723
    let e: BusinessError = err as BusinessError;
    console.error("publishFail errCode:" + e.code + ",errMessage:" + e.message);
1724
  }
S
summer8999 已提交
1725
  ```
1726

Z
zengyawen 已提交
1727 1728 1729
### on('serviceDie')

on(type: 'serviceDie', callback: () =&gt; void): void
Z
zengyawen 已提交
1730 1731 1732

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

史晓晓 已提交
1733
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1734

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

@
@shi-xiaoxiao-iris 已提交
1737
**参数:**
@
@shi-xiaoxiao-iris 已提交
1738

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

@
@shi-xiaoxiao-iris 已提交
1744
**示例:**
@
@shi-xiaoxiao-iris 已提交
1745

Q
q30043944 已提交
1746 1747 1748
  ```ts
  import { BusinessError } from '@ohos.base'

1749 1750 1751 1752 1753
  try {
    dmInstance.on("serviceDie", () => {
      console.info("serviceDie on");
    });
  } catch (err) {
Q
q30043944 已提交
1754 1755
    let e: BusinessError = err as BusinessError;
    console.error("serviceDie errCode:" + e.code + ",errMessage:" + e.message);
1756
  }
Z
zengyawen 已提交
1757
  ```
Z
zengyawen 已提交
1758

Z
zengyawen 已提交
1759 1760 1761 1762 1763
### off('serviceDie')

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

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

史晓晓 已提交
1765
**需要权限**:ohos.permission.ACCESS_SERVICE_DM
1766

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

@
@shi-xiaoxiao-iris 已提交
1769
**参数:**
@
@shi-xiaoxiao-iris 已提交
1770

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

@
@shi-xiaoxiao-iris 已提交
1776
**示例:**
@
@shi-xiaoxiao-iris 已提交
1777

Q
q30043944 已提交
1778 1779 1780
  ```ts
  import { BusinessError } from '@ohos.base'

1781 1782 1783 1784 1785
  try {
    dmInstance.off("serviceDie", () => {
      console.info("serviceDie off");
    });
  } catch (err) {
Q
q30043944 已提交
1786 1787
    let e: BusinessError = err as BusinessError;
    console.error("serviceDie errCode:" + e.code + ",errMessage:" + e.message);
1788
  }
1789
  ```