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 3b7ed92b83cddfb82a351e6482904a35e61d5f74..a575cfb2cab3d04a9d775bcb3d19716cb318f733 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 @@ -74,7 +74,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | ---------------------- | ------------------------- | ---- | -------- | | deviceId | string | 是 | 设备的唯一标识。 | | deviceName | string | 是 | 设备名称。 | @@ -88,7 +88,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | ------------ | ---- | ---- | | SPEAKER | 0x0A | 智能音箱 | | PHONE | 0x0E | 手机 | @@ -105,7 +105,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | ------- | ---- | --------------- | | ONLINE | 0 | 设备物理上线状态。 | | READY | 1 | 设备可用状态，表示设备间信息已在分布式数据中同步完成, 可以运行分布式业务。 | @@ -118,7 +118,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | ------------- | --------------------------------- | ---- | ----------------- | | subscribeId | number | 是 | 发现标识，用于标识不同的发现周期。 | | mode | [DiscoverMode ](#discovermode) | 否 | 发现模式。 | @@ -135,7 +135,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | --------------------- | ---- | ----- | | DISCOVER_MODE_PASSIVE | 0x55 | 被动模式。 | | DISCOVER_MODE_ACTIVE | 0xAA | 主动模式。 | @@ -147,7 +147,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | ---- | ---- | --------- | | AUTO | 0 | 自动发现类型。 | | BLE | 1 | 蓝牙发现类型。 | @@ -160,7 +160,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | ---------- | ---- | ----- | | LOW | 0 | 低频率。 | | MID | 1 | 中频率。 | @@ -174,7 +174,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | ------------------------- | ---- | -------------- | | SUBSCRIBE_CAPABILITY_DDMP | 0 | DDMP能力，后续会被废弃。 | | SUBSCRIBE_CAPABILITY_OSD | 1 | OSD能力。 | @@ -186,10 +186,10 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | -------------------- | ---- | ---------- | | authType | number | 是 | 认证类型。 | -| extraInfo | {[key:string] : any} | 否 | 认证参数可扩展字段。 | +| extraInfo | {[key:string] : any} | 否 | 认证参数可扩展字段。 | ## AuthInfo @@ -197,19 +197,19 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | -------------------- | ---- | ---------- | | authType | number | 是 | 认证类型。 | | token | number | 是 | 认证Token。 | -| extraInfo | {[key:string] : any} | 否 | 认证信息可扩展字段。 | +| extraInfo | {[key:string] : any} | 否 | 认证信息可扩展字段。 | -## PublishInfo9+ +## PublishInfo9+ 发布设备参数 **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | ------------- | --------------------------------- | ---- | ----------------- | | publishId | number | 是 | 发布设备标识，用于标识不同的发布周期。 | | mode | [DiscoverMode ](#discovermode) | 是 | 发现模式。 | @@ -288,7 +288,7 @@ getTrustedDeviceList(callback:AsyncCallback<Array<DeviceInfo>>): voi **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------- | | callback | AsyncCallback<Array<[DeviceInfo](#deviceinfo)>> | 是 | 获取所有可信设备列表的回调，返回设备信息。 | @@ -390,7 +390,7 @@ getLocalDeviceInfo(callback:AsyncCallback<DeviceInfo>): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | | callback | AsyncCallback<[DeviceInfo](#deviceinfo)> | 是 | 获取本地设备信息。 | @@ -450,7 +450,7 @@ getLocalDeviceInfo(): Promise<DeviceInfo> }); ``` -### startDeviceDiscovery8+ +### startDeviceDiscovery8+ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void @@ -460,7 +460,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ----- | | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。| @@ -494,7 +494,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void } ``` -### startDeviceDiscovery9+ +### startDeviceDiscovery9+ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void @@ -504,7 +504,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ----- | | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 | | filterOptions | string | 否 | 发现设备过滤信息。| @@ -558,7 +558,7 @@ stopDeviceDiscovery(subscribeId: number): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | ----- | | subscribeId | number | 是 | 发现标识。 | @@ -581,7 +581,7 @@ stopDeviceDiscovery(subscribeId: number): void } ``` -### publishDeviceDiscovery9+ +### publishDeviceDiscovery9+ publishDeviceDiscovery(publishInfo: PublishInfo): void @@ -591,7 +591,7 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ----- | | publishInfo | [PublishInfo](#publishinfo) | 是 | 发布设备发现信息。 | @@ -622,7 +622,7 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void } ``` -### unPublishDeviceDiscovery9+ +### unPublishDeviceDiscovery9+ unPublishDeviceDiscovery(publishId: number): void @@ -632,7 +632,7 @@ unPublishDeviceDiscovery(publishId: number): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | ----------- | -------- | ---- | ----- | | publishId | number | 是 | 发布标识。 | @@ -657,7 +657,7 @@ unPublishDeviceDiscovery(publishId: number): void ### authenticateDevice -authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: AsyncCallback<{deviceId: string, pinToken ?: number}>): void +authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: AsyncCallback<{deviceId: string, pinToken ?: number}>): void 认证设备。 @@ -665,11 +665,11 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------------------------- | ---- | ------- | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | | authParam | [AuthParam](#authparam) | 是 | 认证参数。 | - | callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 | + | callback | AsyncCallback<{deviceId: string, pinToken ?: number}> | 是 | 认证结果回调。 | **错误码：** @@ -717,7 +717,7 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ----- | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | @@ -741,7 +741,7 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void ### verifyAuthInfo -verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void +verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void 验证认证信息。 @@ -749,10 +749,10 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------- | | authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 | - | callback | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 | + | callback | AsyncCallback<{deviceId: string, level: number}> | 是 | 验证结果回调。 | **错误码：** @@ -783,7 +783,7 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le } ``` -### setUserOperation9+ +### setUserOperation9+ setUserOperation(operateAction: number, params: string): void; @@ -793,7 +793,7 @@ setUserOperation(operateAction: number, params: string): void; **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | ------------- | --------------- | ---- | ------------------- | | operateAction | number | 是 | 用户操作动作。 | | params | string | 是 | 表示用户的输入参数。 | @@ -817,9 +817,9 @@ setUserOperation(operateAction: number, params: string): void; } ``` -### on('uiStateChange')9+ +### on('uiStateChange')9+ -on(type: 'uiStateChange', callback: Callback<{ param: string}>): void; +on(type: 'uiStateChange', callback: Callback<{ param: string}>): void; ui状态变更回调。 @@ -827,10 +827,10 @@ ui状态变更回调。 **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------ | ---- | ------------------------------ | | type | string | 是 | 注册的设备管理器 ui 状态回调，以便在状态改变时通知应用。 | - | callback | Callback<{ param: string}> | 是 | 指示要注册的设备管理器 ui 状态回调，返回ui状态。 | + | callback | Callback<{ param: string}> | 是 | 指示要注册的设备管理器 ui 状态回调，返回ui状态。 | **示例：** @@ -850,9 +850,9 @@ ui状态变更回调。 } ``` -### off('uiStateChange')9+ +### off('uiStateChange')9+ -off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void; +off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void; 取消ui状态变更回调 @@ -860,10 +860,10 @@ off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void; **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 取消注册的设备管理器 ui 状态回调。 | - | callback | Callback<{ param: string}> | 是 | 指示要取消注册的设备管理器 ui 状态，返回UI状态。 | + | callback | Callback<{ param: string}> | 否 | 指示要取消注册的设备管理器 ui 状态，返回UI状态。 | **示例：** @@ -885,7 +885,7 @@ on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChange **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 注册设备状态回调，固定为deviceStateChange。 | | callback | Callback<{ action: [DeviceStateChangeAction](#devicestatechangeaction), device: [DeviceInfo](#deviceinfo) }> | 是 | 指示要注册的设备状态回调，返回设备状态和设备信息。 | @@ -912,10 +912,10 @@ off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChang **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------- | | type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 | - | callback | Callback<{ action: [DeviceStateChangeAction](#devicestatechangeaction), device: [DeviceInfo](#deviceinfo)  }> | 是 | 指示要取消注册的设备状态回调，返回设备状态和设备信息。 | + | callback | Callback<{ action: [DeviceStateChangeAction](#devicestatechangeaction), device: [DeviceInfo](#deviceinfo) }> | 否 | 指示要取消注册的设备状态回调，返回设备状态和设备信息。 | **示例：** @@ -939,10 +939,10 @@ on(type: 'deviceFound', callback: Callback<{ subscribeId: number, device: Dev **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | -------------------------- | | type | string | 是 | 注册设备发现回调，以便在发现周边设备时通知应用程序。 | - | callback | Callback<{ subscribeId: number, device: DeviceInfo }> | 是 | 注册设备发现的回调方法。 | + | callback | Callback<{ subscribeId: number, device: [DeviceInfo](#deviceinfo) }> | 是 | 注册设备发现的回调方法。 | **示例：** @@ -966,10 +966,10 @@ off(type: 'deviceFound', callback?: Callback<{ subscribeId: number, device: D **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------- | | type | string | 是 | 取消注册设备发现回调。 | - | callback | Callback<{ subscribeId: number, device: [DeviceInfo](#deviceinfo) }> | 是 | 指示要取消注册的设备发现回调，返回设备状态和设备信息。 | + | callback | Callback<{ subscribeId: number, device: [DeviceInfo](#deviceinfo) }> | 否 | 指示要取消注册的设备发现回调，返回设备状态和设备信息。 | **示例：** @@ -993,10 +993,10 @@ on(type: 'discoverFail', callback: Callback<{ subscribeId: number, reason: nu **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 注册设备发现失败回调，以便在发现周边设备失败时通知应用程序。 | - | callback | Callback<{ subscribeId: number, reason: number }> | 是 | 注册设备发现失败的回调方法。 | + | callback | Callback<{ subscribeId: number, reason: number }> | 是 | 注册设备发现失败的回调方法。 | **示例：** @@ -1020,10 +1020,10 @@ off(type: 'discoverFail', callback?: Callback<{ subscribeId: number, reason: **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------------- | | type | string | 是 | 取消注册设备发现失败回调。 | - | callback | Callback<{ subscribeId: number, reason: number }> | 是 | 指示要取消注册的设备发现失败回调。 | + | callback | Callback<{ subscribeId: number, reason: number }> | 否 | 指示要取消注册的设备发现失败回调。 | **示例：** @@ -1037,7 +1037,7 @@ off(type: 'discoverFail', callback?: Callback<{ subscribeId: number, reason: } ``` -### on('publishSuccess')9+ +### on('publishSuccess')9+ on(type: 'publishSuccess', callback: Callback<{ publishId: number }>): void @@ -1047,10 +1047,10 @@ on(type: 'publishSuccess', callback: Callback<{ publishId: number }>): voi **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | -------------------------- | | type | string | 是 | 注册发布设备成功回调，以便将发布成功时通知应用程序。 | - | callback | Callback<{ publishId: number }> | 是 | 注册设备发布成功的回调方法。 | + | callback | Callback<{ publishId: number }> | 是 | 注册设备发布成功的回调方法。 | **示例：** @@ -1065,7 +1065,7 @@ on(type: 'publishSuccess', callback: Callback<{ publishId: number }>): voi } ``` -### off('publishSuccess')9+ +### off('publishSuccess')9+ off(type: 'publishSuccess', callback?: Callback<{ publishId: number }>): void @@ -1075,10 +1075,10 @@ off(type: 'publishSuccess', callback?: Callback<{ publishId: number }>): v **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------- | | type | string | 是 | 取消注册设备发布成功回调。 | - | callback | Callback<{ publishId: number }> | 是 | 指示要取消注册的设备发布成功回调。 | + | callback | Callback<{ publishId: number }> | 否 | 指示要取消注册的设备发布成功回调。 | **示例：** @@ -1092,7 +1092,7 @@ off(type: 'publishSuccess', callback?: Callback<{ publishId: number }>): v } ``` -### on('publishFail')9+ +### on('publishFail')9+ on(type: 'publishFail', callback: Callback<{ publishId: number, reason: number }>): void @@ -1102,10 +1102,10 @@ on(type: 'publishFail', callback: Callback<{ publishId: number, reason: numbe **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 注册设备发布失败回调，以便在发布设备失败时通知应用程序。 | - | callback | Callback<{ publishId: number, reason: number }> | 是 | 注册设备发布失败的回调方法。 | + | callback | Callback<{ publishId: number, reason: number }> | 是 | 注册设备发布失败的回调方法。 | **示例：** @@ -1119,7 +1119,7 @@ on(type: 'publishFail', callback: Callback<{ publishId: number, reason: numbe } ``` -### off('publishFail')9+ +### off('publishFail')9+ off(type: 'publishFail', callback?: Callback<{ publishId: number, reason: number }>): void @@ -1129,10 +1129,10 @@ off(type: 'publishFail', callback?: Callback<{ publishId: number, reason: num **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------- | ---- | ----------------- | | type | string | 是 | 取消注册设备发布失败回调。 | - | callback | Callback<{ publishId: number, reason: number }> | 是 | 指示要取消注册设备发布失败回调。 | + | callback | Callback<{ publishId: number, reason: number }> | 否 | 指示要取消注册设备发布失败回调。 | **示例：** @@ -1156,7 +1156,7 @@ on(type: 'serviceDie', callback: () => void): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ---------------------------------------- | | type | string | 是 | 注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 | | callback | () => void | 是 | 注册serviceDie的回调方法。 | @@ -1183,7 +1183,7 @@ off(type: 'serviceDie', callback?: () => void): void **参数：** - | 名称 | 参数类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ---------------------------------------- | | type | string | 是 | 取消注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 | | callback | () => void | 否 | 取消注册serviceDie的回调方法。 |