未验证 提交 7d0d602e 编写于 作者: O openharmony_ci 提交者: Gitee

!10604 docs修改

Merge pull request !10604 from 熊欢/master
...@@ -35,13 +35,24 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager ...@@ -35,13 +35,24 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ------------------------------------ | | ---------- | ---------------------------------------- | ---- | ------------------------------------ |
| bundleName | string | 是 | 指示应用程序的包名。 | | bundleName | string | 是 | 指示应用程序的包名。 |
| callback | AsyncCallback<[DeviceManager](#devicemanager)> | 是 | DeviceManager实例创建时调用的回调,返回设备管理器对象实例。 | | callback | AsyncCallback<[DeviceManager](#devicemanager)> | 是 | DeviceManager实例创建时调用的回调,返回设备管理器对象实例。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
| 11600102 | Failed to obtain the service. |
**示例:**
```js ```js
try { try {
deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => { deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => {
...@@ -209,7 +220,6 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager ...@@ -209,7 +220,6 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager
设备管理实例,用于获取可信设备和本地设备的相关信息。在调用DeviceManager的方法前,需要先通过createDeviceManager构建一个DeviceManager实例dmInstance。 设备管理实例,用于获取可信设备和本地设备的相关信息。在调用DeviceManager的方法前,需要先通过createDeviceManager构建一个DeviceManager实例dmInstance。
### release ### release
release(): void release(): void
...@@ -218,7 +228,16 @@ release(): void ...@@ -218,7 +228,16 @@ release(): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
```js ```js
try { try {
dmInstance.release(); dmInstance.release();
...@@ -227,7 +246,6 @@ release(): void ...@@ -227,7 +246,6 @@ release(): void
} }
``` ```
### getTrustedDeviceListSync ### getTrustedDeviceListSync
getTrustedDeviceListSync(): Array<DeviceInfo> getTrustedDeviceListSync(): Array<DeviceInfo>
...@@ -236,12 +254,22 @@ getTrustedDeviceListSync(): Array<DeviceInfo> ...@@ -236,12 +254,22 @@ getTrustedDeviceListSync(): Array<DeviceInfo>
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 返回值: **返回值:**
| 名称 | 说明 | | 名称 | 说明 |
| -------------------------------------- | --------- | | -------------------------------------- | --------- |
| Array<[DeviceInfo](#deviceinfo)> | 返回可信设备列表。 | | Array<[DeviceInfo](#deviceinfo)> | 返回可信设备列表。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
```js ```js
try { try {
var deviceInfoList = dmInstance.getTrustedDeviceListSync(); var deviceInfoList = dmInstance.getTrustedDeviceListSync();
...@@ -250,7 +278,6 @@ getTrustedDeviceListSync(): Array<DeviceInfo> ...@@ -250,7 +278,6 @@ getTrustedDeviceListSync(): Array<DeviceInfo>
} }
``` ```
### getTrustedDeviceList<sup>8+</sup> ### getTrustedDeviceList<sup>8+</sup>
getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): void getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): void
...@@ -259,12 +286,22 @@ getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): voi ...@@ -259,12 +286,22 @@ getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): voi
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------- | | -------- | ---------------------------------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | 是 | 获取所有可信设备列表的回调,返回设备信息。 | | callback | AsyncCallback&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | 是 | 获取所有可信设备列表的回调,返回设备信息。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
```js ```js
try { try {
dmInstance.getTrustedDeviceList((err, data) => { dmInstance.getTrustedDeviceList((err, data) => {
...@@ -287,22 +324,28 @@ getTrustedDeviceList(): Promise&lt;Array&lt;DeviceInfo&gt;&gt; ...@@ -287,22 +324,28 @@ getTrustedDeviceList(): Promise&lt;Array&lt;DeviceInfo&gt;&gt;
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | Promise实例,用于获取异步返回结果。 | | Promise&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | Promise实例,用于获取异步返回结果。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
```js ```js
try { dmInstance.getTrustedDeviceList().then((data) => {
dmInstance.getTrustedDeviceList().then((data) => { console.log('get trusted device info: ' + JSON.stringify(data));
console.log('get trusted device info: ' + JSON.stringify(data)); }).catch((err) => {
}).catch((err) => {
console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
});
} catch (err) {
console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message); console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
} });
``` ```
### getLocalDeviceInfoSync<sup>8+</sup> ### getLocalDeviceInfoSync<sup>8+</sup>
...@@ -313,12 +356,22 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo) ...@@ -313,12 +356,22 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 返回值: **返回值:**
| 名称 | 说明 |
| -------------------------------------- | --------- | | 名称 | 说明 |
| Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回本地设备列表。 | | ------------------------- | ---------------- |
| [DeviceInfo](#deviceinfo) | 返回本地设备列表。 |
**错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
- 示例:
```js ```js
try { try {
var deviceInfo = dmInstance.getLocalDeviceInfoSync(); var deviceInfo = dmInstance.getLocalDeviceInfoSync();
...@@ -327,7 +380,6 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo) ...@@ -327,7 +380,6 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)
} }
``` ```
### getLocalDeviceInfo<sup>8+</sup> ### getLocalDeviceInfo<sup>8+</sup>
getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void
...@@ -336,12 +388,22 @@ getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void ...@@ -336,12 +388,22 @@ getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- | | -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是 | 获取本地设备信息。 | | callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是 | 获取本地设备信息。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
```js ```js
try { try {
dmInstance.getLocalDeviceInfo((err, data) => { dmInstance.getLocalDeviceInfo((err, data) => {
...@@ -364,22 +426,28 @@ getLocalDeviceInfo(): Promise&lt;DeviceInfo&gt; ...@@ -364,22 +426,28 @@ getLocalDeviceInfo(): Promise&lt;DeviceInfo&gt;
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例,用于获取异步返回结果。 | | Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例,用于获取异步返回结果。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------------------------- |
| 11600101| Failed to execute the function. |
**示例:**
```js ```js
try { dmInstance.getLocalDeviceInfo().then((data) => {
dmInstance.getLocalDeviceInfo().then((data) => { console.log('get local device info: ' + JSON.stringify(data));
console.log('get local device info: ' + JSON.stringify(data)); }).catch((err) => {
}).catch((err) => {
console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
});
} catch (err) {
console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message); console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
} });
``` ```
### startDeviceDiscovery8+</sup> ### startDeviceDiscovery8+</sup>
...@@ -390,12 +458,23 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void ...@@ -390,12 +458,23 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 |
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----- | | ------------- | ------------------------------- | ---- | ----- |
| subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 | | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。|
**错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
| 11600104 | Discovery invalid. |
**示例:**
- 示例:
```js ```js
// 生成发现标识,随机数确保每次调用发现接口的标识不一致 // 生成发现标识,随机数确保每次调用发现接口的标识不一致
var subscribeId = Math.floor(Math.random() * 10000 + 1000); var subscribeId = Math.floor(Math.random() * 10000 + 1000);
...@@ -423,13 +502,24 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void ...@@ -423,13 +502,24 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----- | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----- |
| subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 | | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 |
| filterOptions | string | 否 | 发现设备过滤信息。| | filterOptions | string | 否 | 发现设备过滤信息。|
**错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
| 11600104 | Discovery invalid. |
**示例:**
- 示例:
```js ```js
// 生成发现标识,随机数确保每次调用发现接口的标识不一致 // 生成发现标识,随机数确保每次调用发现接口的标识不一致
var subscribeId = Math.floor(Math.random() * 10000 + 1000); var subscribeId = Math.floor(Math.random() * 10000 + 1000);
...@@ -457,7 +547,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void ...@@ -457,7 +547,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void
console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message); console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
### stopDeviceDiscovery ### stopDeviceDiscovery
stopDeviceDiscovery(subscribeId: number): void stopDeviceDiscovery(subscribeId: number): void
...@@ -466,12 +556,22 @@ stopDeviceDiscovery(subscribeId: number): void ...@@ -466,12 +556,22 @@ stopDeviceDiscovery(subscribeId: number): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----- | | ----------- | ------ | ---- | ----- |
| subscribeId | number | 是 | 发现标识。 | | subscribeId | number | 是 | 发现标识。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
```js ```js
// 入参需要和startDeviceDiscovery接口传入的subscribeId配对使用 // 入参需要和startDeviceDiscovery接口传入的subscribeId配对使用
try { try {
...@@ -489,12 +589,23 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void ...@@ -489,12 +589,23 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----- | | ------------- | ------------------------------- | ---- | ----- |
| publishInfo | [PublishInfo](#publishinfo) | 是 | 发布设备发现信息。 | | publishInfo | [PublishInfo](#publishinfo) | 是 | 发布设备发现信息。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
| 11600105 | Publish invalid. |
**示例:**
```js ```js
// 生成发布标识,随机数确保每次调用发布接口的标识不一致 // 生成发布标识,随机数确保每次调用发布接口的标识不一致
var publishId = Math.floor(Math.random() * 10000 + 1000); var publishId = Math.floor(Math.random() * 10000 + 1000);
...@@ -519,12 +630,22 @@ unPublishDeviceDiscovery(publishId: number): void ...@@ -519,12 +630,22 @@ unPublishDeviceDiscovery(publishId: number): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ----------- | -------- | ---- | ----- | | ----------- | -------- | ---- | ----- |
| publishId | number | 是 | 发布标识。 | | publishId | number | 是 | 发布标识。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
```js ```js
// 入参需要和publishDeviceDiscovery接口传入的publishId配对使用 // 入参需要和publishDeviceDiscovery接口传入的publishId配对使用
try { try {
...@@ -542,14 +663,25 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async ...@@ -542,14 +663,25 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ------- | | ---------- | ---------------------------------------- | ---- | ------- |
| deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 |
| authParam | [AuthParam](#authparam) | 是 | 认证参数。 | | authParam | [AuthParam](#authparam) | 是 | 认证参数。 |
| callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 | | callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
| 11600103 | Authentication invalid. |
**示例:**
```js ```js
// 认证的设备信息,可以从发现的结果中获取 // 认证的设备信息,可以从发现的结果中获取
var deviceInfo ={ var deviceInfo ={
...@@ -567,8 +699,8 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async ...@@ -567,8 +699,8 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async
console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message); console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
return; return;
} }
console.info(TAG + "authenticateDevice result:" + JSON.stringify(data)); console.info("authenticateDevice result:" + JSON.stringify(data));
token = data.pinToken; let token = data.pinToken;
}); });
} catch (err) { } catch (err) {
console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message); console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
...@@ -583,12 +715,22 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void ...@@ -583,12 +715,22 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ----- | | ---------- | ------------------------- | ---- | ----- |
| deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 |
- 示例: **错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
```js ```js
try { try {
dmInstance.unAuthenticateDevice(deviceInfo); dmInstance.unAuthenticateDevice(deviceInfo);
...@@ -597,7 +739,6 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void ...@@ -597,7 +739,6 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void
} }
``` ```
### verifyAuthInfo ### verifyAuthInfo
verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void
...@@ -606,13 +747,23 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le ...@@ -606,13 +747,23 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------- | | -------- | ---------------------------------------- | ---- | ------- |
| authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 | | authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 |
| authInfo | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 | | callback | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 |
**错误码:**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例:**
- 示例:
```js ```js
let authInfo = { let authInfo = {
"authType": 1, "authType": 1,
...@@ -625,13 +776,104 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le ...@@ -625,13 +776,104 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le
console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message); console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
return; return;
} }
console.info(TAG + "verifyAuthInfo result:" + JSON.stringify(data)); console.info("verifyAuthInfo result:" + JSON.stringify(data));
}); });
} catch (err) { } catch (err) {
console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message); console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
### setUserOperation9+</sup>
setUserOperation(operateAction: number, params: string): void;
设置用户ui操作行为。
**系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数:**
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | --------------- | ---- | ------------------- |
| operateAction | number | 是 | 用户操作动作。 |
| params | string | 是 | 表示用户的输入参数。 |
**示例:**
```js
try {
/*
operateAction = 0 - 允许授权
operateAction = 1 - 取消授权
operateAction = 2 - 授权框用户操作超时
operateAction = 3 - 取消pin码框展示
operateAction = 4 - 取消pin码输入框展示
operateAction = 5 - pin码输入框确定操作
*/
let operation = 0;
this.dmInstance.setUserOperation(operation, "extra")
} catch (err) {
console.error("setUserOperation errCode:" + err.code + ",errMessage:" + err.message);
}
```
### on('uiStateChange')9+</sup>
on(type: 'uiStateChange', callback: Callback<{ param: string}>): void;
ui状态变更回调。
**系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数:**
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------------ |
| type | string | 是 | 注册的设备管理器 ui 状态回调,以便在状态改变时通知应用。 |
| callback | Callback&lt;{&nbsp;param: string}&gt; | 是 | 指示要注册的设备管理器 ui 状态回调,返回ui状态。 |
**示例:**
```js
try {
dmInstance.on('uiStateChange', (data) => {
console.log("uiStateChange executed, dialog closed" + JSON.stringify(data))
var tmpStr = JSON.parse(data.param)
this.isShow = tmpStr.verifyFailed
console.log("uiStateChange executed, dialog closed" + this.isShow)
if (!this.isShow) {
this.destruction()
}
});
} catch (err) {
console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
}
```
### off('uiStateChange')9+</sup>
off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void;
取消ui状态变更回调
**系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数:**
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 取消注册的设备管理器 ui 状态回调。 |
| callback | Callback&lt;{&nbsp;param: string}&gt; | 是 | 指示要取消注册的设备管理器 ui 状态,返回UI状态。 |
**示例:**
```js
try {
dmInstance.off('uiStateChange');
} catch (err) {
console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
}
```
### on('deviceStateChange') ### on('deviceStateChange')
...@@ -641,13 +883,15 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange ...@@ -641,13 +883,15 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备状态回调,固定为deviceStateChange。 | | type | string | 是 | 注册设备状态回调,固定为deviceStateChange。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要注册的设备状态回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要注册的设备状态回调,返回设备状态和设备信息。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.on('deviceStateChange', (data) => { dmInstance.on('deviceStateChange', (data) => {
...@@ -658,7 +902,6 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange ...@@ -658,7 +902,6 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange
} }
``` ```
### off('deviceStateChange') ### off('deviceStateChange')
off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChangeAction, device: DeviceInfo }&gt;): void off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChangeAction, device: DeviceInfo }&gt;): void
...@@ -667,13 +910,15 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang ...@@ -667,13 +910,15 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 | | type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;&nbsp;}&gt; | 是 | 指示要取消注册的设备状态回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;&nbsp;}&gt; | 是 | 指示要取消注册的设备状态回调,返回设备状态和设备信息。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.off('deviceStateChange', (data) => { dmInstance.off('deviceStateChange', (data) => {
...@@ -684,7 +929,6 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang ...@@ -684,7 +929,6 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang
} }
``` ```
### on('deviceFound') ### on('deviceFound')
on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: DeviceInfo }&gt;): void on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: DeviceInfo }&gt;): void
...@@ -693,13 +937,15 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev ...@@ -693,13 +937,15 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------- |
| type | string | 是 | 注册设备发现回调,以便在发现周边设备时通知应用程序。 | | type | string | 是 | 注册设备发现回调,以便在发现周边设备时通知应用程序。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是 | 注册设备发现的回调方法。 | | callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是 | 注册设备发现的回调方法。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.on('deviceFound', (data) => { dmInstance.on('deviceFound', (data) => {
...@@ -718,13 +964,15 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D ...@@ -718,13 +964,15 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 取消注册设备发现回调。 | | type | string | 是 | 取消注册设备发现回调。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.off('deviceFound', (data) => { dmInstance.off('deviceFound', (data) => {
...@@ -743,13 +991,15 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu ...@@ -743,13 +991,15 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 | | type | string | 是 | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 注册设备发现失败的回调方法。 | | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 注册设备发现失败的回调方法。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.on('discoverFail', (data) => { dmInstance.on('discoverFail', (data) => {
...@@ -768,13 +1018,15 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason: ...@@ -768,13 +1018,15 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason:
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------------- | | -------- | ---------------------------------------- | ---- | ----------------- |
| type | string | 是 | 取消注册设备发现失败回调。 | | type | string | 是 | 取消注册设备发现失败回调。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 指示要取消注册的设备发现失败回调。 | | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 指示要取消注册的设备发现失败回调。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.off('discoverFail', (data) => { dmInstance.off('discoverFail', (data) => {
...@@ -793,13 +1045,16 @@ on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): voi ...@@ -793,13 +1045,16 @@ on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): voi
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------- |
| type | string | 是 | 注册发布设备成功回调,以便将发布成功时通知应用程序。 | | type | string | 是 | 注册发布设备成功回调,以便将发布成功时通知应用程序。 |
| callback | Callback&lt;{ publishId: number }&gt; | 是 | 注册设备发布成功的回调方法。 | | callback | Callback&lt;{ publishId: number }&gt; | 是 | 注册设备发布成功的回调方法。 |
- 示例:
**示例:**
```js ```js
try { try {
dmInstance.on('publishSuccess', (data) => { dmInstance.on('publishSuccess', (data) => {
...@@ -818,13 +1073,15 @@ off(type: 'publishSuccess', callback?: Callback&lt;{ publishId: number }&gt;): v ...@@ -818,13 +1073,15 @@ off(type: 'publishSuccess', callback?: Callback&lt;{ publishId: number }&gt;): v
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 取消注册设备发布成功回调。 | | type | string | 是 | 取消注册设备发布成功回调。 |
| callback | Callback&lt;{ publishId: number }&gt; | 是 | 指示要取消注册的设备发布成功回调。 | | callback | Callback&lt;{ publishId: number }&gt; | 是 | 指示要取消注册的设备发布成功回调。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.off('publishSuccess', (data) => { dmInstance.off('publishSuccess', (data) => {
...@@ -843,13 +1100,15 @@ on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: numbe ...@@ -843,13 +1100,15 @@ on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: numbe
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------ | | -------- | ----------------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备发布失败回调,以便在发布设备失败时通知应用程序。 | | type | string | 是 | 注册设备发布失败回调,以便在发布设备失败时通知应用程序。 |
| callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是 | 注册设备发布失败的回调方法。 | | callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是 | 注册设备发布失败的回调方法。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.on('publishFail', (data) => { dmInstance.on('publishFail', (data) => {
...@@ -868,13 +1127,15 @@ off(type: 'publishFail', callback?: Callback&lt;{ publishId: number, reason: num ...@@ -868,13 +1127,15 @@ off(type: 'publishFail', callback?: Callback&lt;{ publishId: number, reason: num
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ----------------- | | -------- | ----------------------------------------------------- | ---- | ----------------- |
| type | string | 是 | 取消注册设备发布失败回调。 | | type | string | 是 | 取消注册设备发布失败回调。 |
| callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是 | 指示要取消注册设备发布失败回调。 | | callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是 | 指示要取消注册设备发布失败回调。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.off('publishFail', (data) => { dmInstance.off('publishFail', (data) => {
...@@ -893,13 +1154,15 @@ on(type: 'serviceDie', callback: () =&gt; void): void ...@@ -893,13 +1154,15 @@ on(type: 'serviceDie', callback: () =&gt; void): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- | | -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 | | type | string | 是 | 注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
| callback | ()&nbsp;=&gt;&nbsp;void | 是 | 注册serviceDie的回调方法。 | | callback | ()&nbsp;=&gt;&nbsp;void | 是 | 注册serviceDie的回调方法。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.on("serviceDie", () => { dmInstance.on("serviceDie", () => {
...@@ -910,7 +1173,6 @@ on(type: 'serviceDie', callback: () =&gt; void): void ...@@ -910,7 +1173,6 @@ on(type: 'serviceDie', callback: () =&gt; void): void
} }
``` ```
### off('serviceDie') ### off('serviceDie')
off(type: 'serviceDie', callback?: () =&gt; void): void off(type: 'serviceDie', callback?: () =&gt; void): void
...@@ -919,13 +1181,15 @@ off(type: 'serviceDie', callback?: () =&gt; void): void ...@@ -919,13 +1181,15 @@ off(type: 'serviceDie', callback?: () =&gt; void): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
- 参数: **参数:**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- | | -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 取消注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 | | type | string | 是 | 取消注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
| callback | ()&nbsp;=&gt;&nbsp;void | 否 | 取消注册serviceDie的回调方法。 | | callback | ()&nbsp;=&gt;&nbsp;void | 否 | 取消注册serviceDie的回调方法。 |
- 示例: **示例:**
```js ```js
try { try {
dmInstance.off("serviceDie", () => { dmInstance.off("serviceDie", () => {
......
# 设备管理错误码
## 11600101 服务调用异常
**错误信息**
Failed to execute the function.
**可能原因**
服务内部调用异常。
**处理步骤**
重新调用接口再次触发调用。
## 11600102 获取服务失败
**错误信息**
Failed to obtain the service.
**可能原因**
服务未启动或者服务启动失败。
**处理步骤**
检查服务是否正常启动,重新获取服务。
## 11600103 认证业务不可用
**错误信息**
Authentication invalid.
**可能原因**
上一次认证业务未结束。
**处理步骤**
等待上一次认证业务结束,重新发起认证调用。
## 11600104 发现业务不可用
**错误信息**
Discovery invalid.
**可能原因**
上一次发现业务未结束。
**处理步骤**
等待上一次发现业务结束,重新发起发现调用。
## 11600105 发布业务不可用
**错误信息**
Publish invalid.
**可能原因**
上一次发布业务未结束。
**处理步骤**
等待上一次发布业务结束,重新发起发布调用。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册