From dd3e01fa2c7e940db3066c22a8928071ff76cce6 Mon Sep 17 00:00:00 2001 From: mayunteng_1 Date: Mon, 10 Oct 2022 19:24:41 +0800 Subject: [PATCH] Signed-off-by: mayunteng_1 Change-Id: I6367d676abcc90be1325e739b9672af9f03616ce --- .../reference/apis/Readme-CN.md | 1 + .../reference/apis/js-apis-cooperate.md | 38 +++++++++++++---- .../errorcodes/errorcodes-multimodalinput.md | 42 ++++++++++++++++++- 3 files changed, 71 insertions(+), 10 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 4f6a834203..7f1d172f70 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -223,6 +223,7 @@ - [@ohos.multimodalInput.mouseEvent (鼠标输入事件)](js-apis-mouseevent.md) - [@ohos.multimodalInput.pointer (鼠标指针)](js-apis-pointer.md) - [@ohos.multimodalInput.touchEvent (触摸输入事件)](js-apis-touchevent.md) + - [@ohos.multimodalInput.inputDeviceCooperate (键鼠穿越](js-apis-cooperate.md) - [@ohos.power (系统电源管理)](js-apis-power.md) - [@ohos.runningLock (Runninglock锁)](js-apis-runninglock.md) - [@ohos.sensor (传感器)](js-apis-sensor.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-cooperate.md b/zh-cn/application-dev/reference/apis/js-apis-cooperate.md index 8d8f418dd3..78f5ac3a52 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-cooperate.md +++ b/zh-cn/application-dev/reference/apis/js-apis-cooperate.md @@ -19,16 +19,18 @@ enable(enable: boolean, callback: AsyncCallback\): void 键鼠穿越开关开启或关闭，使用callback异步回调。 -**系统能力**：SystemCapability.MultimodalInput.Input.InputDeviceCooperate +**系统能力**: SystemCapability.MultimodalInput.Input.InputDeviceCooperate **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------- | ---- | ------------------------------------------------------------ | -| enable | boolean | 是 | 键鼠穿越开关开启或关闭状态。true: 键鼠穿越开关开启; false: 键鼠穿越开关关闭。 | -| callback | AsyncCallback | 是 | 异步回调函数。当键鼠穿越开关开启或关闭成功，err为undefined，否则为错误对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------------- | +| enable | boolean | 是 | 键鼠穿越开关开启或关闭状态。true: 键鼠穿越开关开启; false: 键鼠穿越开关关闭。 +| callback | AsyncCallback\ | 是 | 异步回调函数。当键鼠穿越开关开启或关闭成功，err为undefined，否则为错误对象。 | - **示例**： + + +**示例**： ```js try { @@ -50,7 +52,7 @@ enable(enable: boolean): Promise\ 键鼠穿越开关开启或关闭，使用Promise方式作为异步方法。 -**系统能力**：SystemCapability.MultimodalInput.Input.InputDeviceCooperate +**系统能力**： SystemCapability.MultimodalInput.Input.InputDeviceCooperate **参数**： @@ -58,12 +60,16 @@ enable(enable: boolean): Promise\ | --------- | ------- | ---- | ------------------------------------------------------------------- | | enable | boolean | 是 | 键鼠穿越开关开启或关闭状态。true: 键鼠穿越开关开启; false: 键鼠穿越开关关闭。 | + + **返回值**： | 参数 | 说明 | | ------------------- | ------------------------------- | | Promise\ | Promise实例，用于异步获取结果。 | + + **示例**： ```js @@ -94,6 +100,8 @@ start(sinkDeviceDescriptor: string, srcInputDeviceId: number, callback: AsyncCal | srcInputDeviceId | number | 是 | 键鼠穿越待穿越外设标识符。 | | callback | AsyncCallback\ | 是 | 异步回调函数。当键鼠穿越启动成功，err为undefined，否则为错误对象。| + + **示例**： ```js @@ -125,12 +133,16 @@ start(sinkDeviceDescriptor: string, srcInputDeviceId: number): Promise\ | sinkDeviceDescriptor | string | 是 | 键鼠穿越目标设备描述符。 | | srcInputDeviceId | number | 是 | 键鼠穿越待穿越外设标识符。 | + + **返回值**： | 参数名 | 说明 | | ---------------------- | ------------------------------- | | Promise\ | Promise实例，用于异步获取结果。 | + + **示例**： ```js @@ -159,6 +171,8 @@ stop(callback: AsyncCallback\): void | -------- | ---------------------------- | ---- | ---------------------------- | | callback | AsyncCallback\ | 是 | 异步回调函数，返回查询结果。 | + + **示例**： ```js @@ -187,7 +201,7 @@ stop(): Promise\ | 参数名 | 说明 | | -------- | ---------------------------- | -| Promise\ | Promise实例，用于异步获取结果。 | +| Promise\ | Promise实例，用于异步获取结果。 | **示例**： @@ -248,12 +262,16 @@ getState(deviceDescriptor: string): Promise<{ state: boolean }> | -------- | --------- | ---- | ---------------------------- | | deviceDescriptor | string | 是 | 键鼠穿越目标设备描述符。 | + + **返回值**： | 参数 | 说明 | | ------------------- | ------------------------------- | | Promise<{ state: boolean }>| Promise实例，用于异步获取结果。 | + + **示例**： ```js @@ -283,6 +301,8 @@ on(type: 'cooperation', callback: AsyncCallback<{ deviceDescriptor: string, even | type | string | 是 | 注册类型，'cooperation'。 | | callback | AsyncCallback<{ deviceDescriptor: string, eventMsg: [EventMsg](#eventmsg) }> | 是 | 异步回调函数，接收键鼠穿越事件消息。 | + + **示例**： ```js @@ -314,6 +334,8 @@ off(type: 'cooperation', callback?: AsyncCallback\): void | type | string | 是 | 注册类型，'cooperation'。 | | callback | AsyncCallback | 否 | 异步回调函数，用于返回结果。 | + + **示例**： ```js diff --git a/zh-cn/application-dev/reference/errorcodes/errorcodes-multimodalinput.md b/zh-cn/application-dev/reference/errorcodes/errorcodes-multimodalinput.md index b0fa2e82b0..3a5d06f4d8 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcodes-multimodalinput.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcodes-multimodalinput.md @@ -1,5 +1,43 @@ # 多模输入子系统错误码 +## 201 权限校验失败 + +### 错误信息 + +Permission denied. + +### 错误描述 + +当调用监听模块on和off接口时，若没有申请权限，会报此错误码。 + +### 可能原因 + +1. 监听、去监听鼠标和触屏事件时未配置相应的权限。 + + +### 处理步骤 + +查看权限是否已适配，具体配置方式请参考[权限申请声明](../../security/accesstoken-guidelines.md)。 + +## 401 参数检查错误 + +### 错误信息 + +The parameter invalid. + +### 错误描述 + +当调用监听模块或者键鼠穿越等其他模块接口时，若传入参数的类型或者范围不匹配，会报此错误码。 + +### 可能原因 + +1. 入参类型错误不匹配，如监听接口传入type为非string类型等。 +2. 入参范围不匹配，如插上设备信息时传入非法的deviceId。 + +### 处理步骤 + +检查入参类型和范围是否匹配。 + ## 4400001 目标设备描述符错误 ### 错误信息 @@ -21,11 +59,11 @@ Incorrect descriptor for the target device. 1. 确认键鼠穿越目标设备是否已正确与本地设备完整组网。 2. 正确使用穿越目标设备的设备描述符。 -## 4400002 输入设备操作失败 +## 4400002 操作输入设备失败 ### 错误信息 -Input device operation failed. +Failed to operate the input device. ### 错误描述 -- GitLab