diff --git a/zh-cn/application-dev/reference/apis/js-apis-device-manager.md b/zh-cn/application-dev/reference/apis/js-apis-device-manager.md index 4e0f3581eca544513c0200eb1274d678a24967f3..ffcd6c121f7f46c65391972769d2fdb4c755a226 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-device-manager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-device-manager.md @@ -35,13 +35,25 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------------------------- | ---- | ------------------------------------ | | bundleName | string | 是 | 指示应用程序的包名。 | | callback | AsyncCallback<[DeviceManager](#devicemanager)> | 是 | DeviceManager实例创建时调用的回调，返回设备管理器对象实例。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 11600101 | Failed to execute the function. | +| 11600102 | Failed to obtain the service. | + +**示例** + ```js try { deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => { @@ -209,7 +221,6 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager 设备管理实例，用于获取可信设备和本地设备的相关信息。在调用DeviceManager的方法前，需要先通过createDeviceManager构建一个DeviceManager实例dmInstance。 - ### release release(): void @@ -218,7 +229,16 @@ release(): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 11600101 | Failed to execute the function. | + +**示例** + ```js try { dmInstance.release(); @@ -227,7 +247,6 @@ release(): void } ``` - ### getTrustedDeviceListSync getTrustedDeviceListSync(): Array<DeviceInfo> @@ -236,12 +255,22 @@ getTrustedDeviceListSync(): Array<DeviceInfo> **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 返回值： +**返回值** + | 名称 | 说明 | | -------------------------------------- | --------- | | Array<[DeviceInfo](#deviceinfo)> | 返回可信设备列表。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 11600101 | Failed to execute the function. | + +**示例** + ```js try { var deviceInfoList = dmInstance.getTrustedDeviceListSync(); @@ -250,7 +279,6 @@ getTrustedDeviceListSync(): Array<DeviceInfo> } ``` - ### getTrustedDeviceList8+ getTrustedDeviceList(callback:AsyncCallback<Array<DeviceInfo>>): void @@ -259,12 +287,23 @@ getTrustedDeviceList(callback:AsyncCallback<Array<DeviceInfo>>): voi **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------- | | callback | AsyncCallback<Array<[DeviceInfo](#deviceinfo)>> | 是 | 获取所有可信设备列表的回调，返回设备信息。 | -- 示例： + **错误码**： + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 11600101 | Failed to execute the function. | + +**示例** + ```js try { dmInstance.getTrustedDeviceList((err, data) => { @@ -287,12 +326,22 @@ getTrustedDeviceList(): Promise<Array<DeviceInfo>> **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 返回值： +**返回值** + | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array<[DeviceInfo](#deviceinfo)>> | Promise实例，用于获取异步返回结果。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 11600101 | Failed to execute the function. | + +**示例** + ```js dmInstance.getTrustedDeviceList().then((data) => { console.log('get trusted device info: ' + JSON.stringify(data)); @@ -309,12 +358,22 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo) **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 返回值： - | 名称 | 说明 | - | -------------------------------------- | --------- | - | Array<[DeviceInfo](#deviceinfo)> | 返回本地设备列表。 | +**返回值** + + | 名称 | 说明 | + | ------------------------- | ---------------- | + | [DeviceInfo](#deviceinfo) | 返回本地设备列表。 | + +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 11600101 | Failed to execute the function. | + +**示例** -- 示例： ```js try { var deviceInfo = dmInstance.getLocalDeviceInfoSync(); @@ -323,7 +382,6 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo) } ``` - ### getLocalDeviceInfo8+ getLocalDeviceInfo(callback:AsyncCallback<DeviceInfo>): void @@ -332,12 +390,23 @@ getLocalDeviceInfo(callback:AsyncCallback<DeviceInfo>): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | | callback | AsyncCallback<[DeviceInfo](#deviceinfo)> | 是 | 获取本地设备信息。 | -- 示例： +**错误码**： + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 11600101 | Failed to execute the function. | + +**示例** + ```js try { dmInstance.getLocalDeviceInfo((err, data) => { @@ -360,11 +429,21 @@ getLocalDeviceInfo(): Promise<DeviceInfo> **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 返回值： +**返回值** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<[DeviceInfo](#deviceinfo)> | Promise实例，用于获取异步返回结果。 | +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 11600101| Failed to execute the function. | + +**示例** + - 示例： ```js dmInstance.getLocalDeviceInfo().then((data) => { @@ -382,12 +461,25 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： - | 名称 | 参数类型 | 必填 | 说明 | +**参数** + + | 名称 | 参数类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ----- | - | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 | + | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。| + +**错误码**： + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 201 | Permission verify failed. | +| 11600101 | Failed to execute the function. | +| 11600104 | Discovery invalid. | + +**示例** -- 示例： ```js // 生成发现标识，随机数确保每次调用发现接口的标识不一致 var subscribeId = Math.floor(Math.random() * 10000 + 1000); @@ -415,13 +507,26 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： - | 名称 | 参数类型 | 必填 | 说明 | - | ------------- | ------------------------------- | ---- | ----- | +**参数** + + | 名称 | 参数类型 | 必填 | 说明 | + | ------------- | ------------------------------- | ---- | ----- | | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 | - | filterOptions | string | 否 | 发现设备过滤信息。| + | filterOptions | string | 否 | 发现设备过滤信息。| + +**错误码**： + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 201 | Permission verify failed. | +| 11600101 | Failed to execute the function. | +| 11600104 | Discovery invalid. | + +**示例** -- 示例： ```js // 生成发现标识，随机数确保每次调用发现接口的标识不一致 var subscribeId = Math.floor(Math.random() * 10000 + 1000); @@ -449,7 +554,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message); } ``` - + ### stopDeviceDiscovery stopDeviceDiscovery(subscribeId: number): void @@ -458,12 +563,24 @@ stopDeviceDiscovery(subscribeId: number): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | ----------- | ------ | ---- | ----- | | subscribeId | number | 是 | 发现标识。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 201 | Permission verify failed. | +| 11600101 | Failed to execute the function. | + +**示例** + ```js // 入参需要和startDeviceDiscovery接口传入的subscribeId配对使用 try { @@ -481,12 +598,25 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ----- | | publishInfo | [PublishInfo](#publishinfo) | 是 | 发布设备发现信息。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 201 | Permission verify failed. | +| 11600101 | Failed to execute the function. | +| 11600105 | Publish invalid. | + +**示例** + ```js // 生成发布标识，随机数确保每次调用发布接口的标识不一致 var publishId = Math.floor(Math.random() * 10000 + 1000); @@ -511,12 +641,24 @@ unPublishDeviceDiscovery(publishId: number): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | ----------- | -------- | ---- | ----- | | publishId | number | 是 | 发布标识。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 201 | Permission verify failed. | +| 11600101 | Failed to execute the function. | + +**示例** + ```js // 入参需要和publishDeviceDiscovery接口传入的publishId配对使用 try { @@ -534,14 +676,27 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | ---------- | ---------------------------------------- | ---- | ------- | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | | authParam | [AuthParam](#authparam) | 是 | 认证参数。 | | callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 201 | Permission verify failed. | +| 11600101 | Failed to execute the function. | +| 11600103 | Authentication invalid. | + +**示例** + ```js // 认证的设备信息，可以从发现的结果中获取 var deviceInfo ={ @@ -559,8 +714,8 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message); return; } - console.info(TAG + "authenticateDevice result:" + JSON.stringify(data)); - token = data.pinToken; + console.info("authenticateDevice result:" + JSON.stringify(data)); + let token = data.pinToken; }); } catch (err) { console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message); @@ -575,12 +730,24 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ----- | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 201 | Permission verify failed. | +| 11600101 | Failed to execute the function. | + +**示例** + ```js try { dmInstance.unAuthenticateDevice(deviceInfo); @@ -589,7 +756,6 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void } ``` - ### verifyAuthInfo verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void @@ -598,13 +764,25 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------- | | authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 | - | authInfo | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 | + | callback | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 | + +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| -------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | +| 201 | Permission verify failed. | +| 11600101 | Failed to execute the function. | + +**示例** -- 示例： ```js let authInfo = { "authType": 1, @@ -617,13 +795,128 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message); return; } - console.info(TAG + "verifyAuthInfo result:" + JSON.stringify(data)); + console.info("verifyAuthInfo result:" + JSON.stringify(data)); }); } catch (err) { console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message); } ``` +### setUserOperation9+ + +setUserOperation(operateAction: number, params: string): void; + +设置用户ui操作行为。 + +**系统能力**：SystemCapability.DistributedHardware.DeviceManager + +**参数** + + | 名称 | 参数类型 | 必填 | 说明 | + | ------------- | --------------- | ---- | ------------------- | + | operateAction | number | 是 | 用户操作动作。 | + | params | string | 是 | 表示用户的输入参数。 | + +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + + ```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+ + +on(type: 'uiStateChange', callback: Callback<{ param: string}>): void; + +ui状态变更回调。 + +**系统能力**：SystemCapability.DistributedHardware.DeviceManager + +**参数** + + | 名称 | 参数类型 | 必填 | 说明 | + | -------- | ------------------------------------ | ---- | ------------------------------ | + | type | string | 是 | 注册的设备管理器 ui 状态回调，以便在状态改变时通知应用。 | + | callback | Callback<{ param: string}> | 是 | 指示要注册的设备管理器 ui 状态回调，返回ui状态。 | + +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + + ```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+ + +off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void; + +取消ui状态变更回调 + +**系统能力**：SystemCapability.DistributedHardware.DeviceManager + +**参数** + + | 名称 | 参数类型 | 必填 | 说明 | + | -------- | ------------------------------------- | ---- | ------------------------------ | + | type | string | 是 | 取消注册的设备管理器 ui 状态回调。 | + | callback | Callback<{ param: string}> | 是 | 指示要取消注册的设备管理器 ui 状态，返回UI状态。 | + +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + + ```js + try { + dmInstance.off('uiStateChange'); + } catch (err) { + console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message); + } + ``` ### on('deviceStateChange') @@ -633,13 +926,23 @@ on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChange **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 注册设备状态回调，固定为deviceStateChange。 | | callback | Callback<{ action: [DeviceStateChangeAction](#devicestatechangeaction), device: [DeviceInfo](#deviceinfo) }> | 是 | 指示要注册的设备状态回调，返回设备状态和设备信息。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.on('deviceStateChange', (data) => { @@ -650,7 +953,6 @@ on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChange } ``` - ### off('deviceStateChange') off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void @@ -659,13 +961,23 @@ off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChang **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------- | | type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 | | callback | Callback<{ action: [DeviceStateChangeAction](#devicestatechangeaction), device: [DeviceInfo](#deviceinfo)  }> | 是 | 指示要取消注册的设备状态回调，返回设备状态和设备信息。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.off('deviceStateChange', (data) => { @@ -685,13 +997,23 @@ on(type: 'deviceFound', callback: Callback<{ subscribeId: number, device: Dev **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | -------------------------- | | type | string | 是 | 注册设备发现回调，以便在发现周边设备时通知应用程序。 | | callback | Callback<{ subscribeId: number, device: DeviceInfo }> | 是 | 注册设备发现的回调方法。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.on('deviceFound', (data) => { @@ -710,13 +1032,23 @@ off(type: 'deviceFound', callback?: Callback<{ subscribeId: number, device: D **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------- | | type | string | 是 | 取消注册设备发现回调。 | | callback | Callback<{ subscribeId: number, device: [DeviceInfo](#deviceinfo) }> | 是 | 指示要取消注册的设备发现回调，返回设备状态和设备信息。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.off('deviceFound', (data) => { @@ -735,13 +1067,23 @@ on(type: 'discoverFail', callback: Callback<{ subscribeId: number, reason: nu **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 注册设备发现失败回调，以便在发现周边设备失败时通知应用程序。 | | callback | Callback<{ subscribeId: number, reason: number }> | 是 | 注册设备发现失败的回调方法。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.on('discoverFail', (data) => { @@ -760,13 +1102,23 @@ off(type: 'discoverFail', callback?: Callback<{ subscribeId: number, reason: **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------------- | | type | string | 是 | 取消注册设备发现失败回调。 | | callback | Callback<{ subscribeId: number, reason: number }> | 是 | 指示要取消注册的设备发现失败回调。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.off('discoverFail', (data) => { @@ -785,13 +1137,23 @@ on(type: 'publishSuccess', callback: Callback<{ publishId: number }>): voi **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | -------------------------- | | type | string | 是 | 注册发布设备成功回调，以便将发布成功时通知应用程序。 | | callback | Callback<{ publishId: number }> | 是 | 注册设备发布成功的回调方法。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.on('publishSuccess', (data) => { @@ -810,13 +1172,23 @@ off(type: 'publishSuccess', callback?: Callback<{ publishId: number }>): v **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------- | | type | string | 是 | 取消注册设备发布成功回调。 | | callback | Callback<{ publishId: number }> | 是 | 指示要取消注册的设备发布成功回调。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.off('publishSuccess', (data) => { @@ -835,13 +1207,23 @@ on(type: 'publishFail', callback: Callback<{ publishId: number, reason: numbe **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ----------------------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 注册设备发布失败回调，以便在发布设备失败时通知应用程序。 | | callback | Callback<{ publishId: number, reason: number }> | 是 | 注册设备发布失败的回调方法。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.on('publishFail', (data) => { @@ -860,13 +1242,23 @@ off(type: 'publishFail', callback?: Callback<{ publishId: number, reason: num **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ----------------------------------------------------- | ---- | ----------------- | | type | string | 是 | 取消注册设备发布失败回调。 | | callback | Callback<{ publishId: number, reason: number }> | 是 | 指示要取消注册设备发布失败回调。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.off('publishFail', (data) => { @@ -885,13 +1277,23 @@ on(type: 'serviceDie', callback: () => void): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ---------------------------------------- | | type | string | 是 | 注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 | | callback | () => void | 是 | 注册serviceDie的回调方法。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.on("serviceDie", () => { @@ -911,13 +1313,23 @@ off(type: 'serviceDie', callback?: () => void): void **系统能力**：SystemCapability.DistributedHardware.DeviceManager -- 参数： +**参数** + | 名称 | 参数类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ---------------------------------------- | | type | string | 是 | 取消注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 | | callback | () => void | 否 | 取消注册serviceDie的回调方法。 | -- 示例： +**错误码** + +以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) + +| 类型 | 说明 | +| ------- | --------------------------------------------------------------- | +| 401 | Input parameter error. | + +**示例** + ```js try { dmInstance.off("serviceDie", () => { diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-device-manager.md b/zh-cn/application-dev/reference/errorcodes/errorcode-device-manager.md new file mode 100644 index 0000000000000000000000000000000000000000..0f5fe6d0c03d1b2478e80a7b8e4b17f6732e539d --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-device-manager.md @@ -0,0 +1,71 @@ +# 分布式硬件子系统错误码 + +## 11600101 服务调用异常 + +### 错误信息 + +Failed to execute the function. + +### 可能原因 + +服务内部调用异常。 + +### 处理步骤 + +重新调用接口再次触发调用。 + +## 11600102 获取服务失败 + +### 错误信息 + +Failed to obtain the service. + +### 可能原因 + +服务未启动或者服务启动失败。 + +### 处理步骤 + +检查服务是否正常启动，重新获取服务。 + +## 11600103 认证业务不可用 + +### 错误信息 + +Authentication invalid. + +### 可能原因 + +上一次认证业务未结束。 + +### 处理步骤 + +等待上一次认证业务结束，重新发起认证调用。 + +## 11600104 发现业务不可用 + +### 错误信息 + +Discovery invalid. + +### 可能原因 + +上一次发现业务未结束。 + +### 处理步骤 + +等待上一次发现业务结束，重新发起发现调用。 + +## 11600105 发布业务不可用 + +### 错误信息 + +Publish invalid. + +### 可能原因 + +上一次发布业务未结束。 + +### 处理步骤 + +等待上一次发布业务结束，重新发起发布调用。