提交 055af360 编写于 作者: M mayunteng_1

Signed-off-by: mayunteng_1 <mayunteng@huawei.com>

Change-Id: I654f97bbee43df26eb526a1fff21a88e050bd2ff
上级 345a1df4
......@@ -2,22 +2,20 @@
## cl.multimodalinput.1 API错误信息返回方式变更
如下原有接口使用业务逻辑返回值表示错误信息,不符合OpenHarmony接口错误码规范。从API9开始作以下变更,
设备管理:三方接口,@ohos.multimodalInput.inputDevice.d.ts
下列模块内部接口使用业务逻辑返回值表示错误信息,不符合OpenHarmony接口错误码规范。在API9进行变更。
- 输入设备管理模块:三方接口,@ohos.multimodalInput.inputDevice.d.ts
按键订阅:系统接口,@ohos.multimodalInput.inputConsumer.d.ts
- 组合按键订阅模块:系统接口,@ohos.multimodalInput.inputConsumer.d.ts
键鼠穿越:系统接口,@ohos.multimodalInput.inputDeviceCooperate.d.ts
- 键鼠穿越功能模块:系统接口,@ohos.multimodalInput.inputDeviceCooperate.d.ts
按键注入:系统接口,@ohos.multimodalInput.inputEventClient.d.ts
- 按键注入模块:系统接口,@ohos.multimodalInput.inputEventClient.d.ts
事件监听:系统接口,@ohos.multimodalInput.inputMonitor.d.ts
- 输入监听模块:系统接口,@ohos.multimodalInput.inputMonitor.d.ts
指针事件:系统接口和三方接口,@ohos.multimodalInput.pointer.d.t
- 鼠标指针管理模块:系统接口和三方接口,@ohos.multimodalInput.pointer.d.t
异步接口:通过AsyncCallback或Promise的error对象返回错误信息。
同步接口:不涉及。
以上模块中的异步接口变更为参数检查错误同步抛出,业务逻辑错误通过AsyncCallback或Promise的error对象抛出,同步接口不作变更。
**变更影响**
......@@ -25,74 +23,60 @@
**关键接口/组件变更**
以下接口标记废除:
- **function** getDeviceIds(callback: AsyncCallback<Array<**number**>>): **void**;
- supportKeys(deviceId: **number**, keys: Array<KeyCode>, callback: AsyncCallback<Array<boolean>>): **void**;
- supportKeys(deviceId: **number**, keys: Array<KeyCode>): Promise<Array<boolean>>;
- getKeyboardType(deviceId: **number**, callback: AsyncCallback<KeyboardType>): **void**; &gt;
- getKeyboardType(deviceId: **number**): Promise<KeyboardType>;
- setPointerSpeed(speed: **number**, callback: AsyncCallback<**void**>): **void**;
- setPointerSpeed(speed: **number**): Promise<**void**>;
- getPointerSpeed(callback: AsyncCallback<**number**>): **void**;
- getPointerSpeed(): Promise<**number**>;
- setPointerStyle(windowId: **number**, pointerStyle: PointerStyle, callback: AsyncCallback<**void**>): **void**;
- setPointerStyle(windowId: **number**, pointerStyle: PointerStyle): Promise<**void**>;
- getPointerStyle(windowId: **number**, callback: AsyncCallback<PointerStyle>): **void**;
- getPointerStyle(windowId: **number**): Promise<PointerStyle>;
- setPointerVisible(visible: boolean, callback: AsyncCallback<**void**>): **void**;
- setPointerVisible(visible: boolean): Promise<**void**>;
- isPointerVisible(callback: AsyncCallback<boolean>): **void**;
- isPointerVisible(): Promise<boolean>;
- on(**type**:"touch", receiver:TouchEventReceiver):**void**;
- on(**type**:"mouse", receiver:Callback<MouseEvent>):**void**;
- off(**type**:"touch", receiver?:TouchEventReceiver):**void**;
- off(**type**:"mouse", receiver?:Callback<MouseEvent>):**void**;
- injectEvent({KeyEvent: KeyEvent}): **void**;
- enable(enable: boolean, callback: AsyncCallback<**void**>): **void**;
- enable(enable: boolean): Promise<**void**>;
- start(sinkDeviceDescriptor: **string**, srcInputDeviceId: **number**, callback: AsyncCallback<**void**>): **void**;
- start(sinkDeviceDescriptor: **string**, srcInputDeviceId: **number**): Promise<**void**>;
- stop(callback: AsyncCallback<**void**>): **void**;
- stop(): Promise<**void**>;
- getState(deviceDescriptor: **string**, callback: AsyncCallback<{ state: boolean }>): **void**;
- getState(deviceDescriptor: **string**): Promise<{ state: boolean }>;
- on(**type**: 'cooperation', callback: AsyncCallback<{ deviceDescriptor: **string**, eventMsg: EventMsg }>): **void**;
- off(**type**: 'cooperation', callback?: AsyncCallback<**void**>): **void**;
- on(**type**: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): **void**;
- off(**type**: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>): **void**;
- **function** getDeviceIds(): Promise<Array<**number**>>;
- **function** getDevice(deviceId: **number**, callback: AsyncCallback<InputDeviceData>): **void**;
**function** getDevice(deviceId: **number**): Promise<InputDeviceData>;
以下接口标记废除:
- getDeviceIds(callback: AsyncCallback<Array<**number**>>): **void**;
- getDeviceIds(): Promise<Array<**number**>>;
- getDevice(deviceId: **number**, callback: AsyncCallback<InputDeviceData>): **void**;
- getDevice(deviceId: **number**): Promise<InputDeviceData>;
替代接口如下:
- getDeviceList(callback: AsyncCallback<Array<**number**>>): **void**;
- getDeviceList(): Promise<Array<**number**>>;
- getDeviceInfo(deviceId: **number**, callback: AsyncCallback<InputDeviceData>): **void**;
- getDeviceInfo(deviceId: **number**): Promise<InputDeviceData>;
- **function** getDeviceList(callback: AsyncCallback<Array<**number**>>): **void**;
- **function** getDeviceList(): Promise<Array<**number**>>;
- **function** getDeviceInfo(deviceId: **number**, callback: AsyncCallback<InputDeviceData>): **void**;
- **function** getDeviceInfo(deviceId: **number**): Promise<InputDeviceData>;
以下接口增加错误码处理:
- **function** supportKeys(deviceId: **number**, keys: Array<KeyCode>, callback: AsyncCallback<Array<boolean>>): **void**;
- **function** supportKeys(deviceId: **number**, keys: Array<KeyCode>): Promise<Array<boolean>>;
- **function** getKeyboardType(deviceId: **number**, callback: AsyncCallback<KeyboardType>): **void**; &gt;
- **function** getKeyboardType(deviceId: **number**): Promise<KeyboardType>;
- **function** setPointerSpeed(speed: **number**, callback: AsyncCallback<**void**>): **void**;
- **function** setPointerSpeed(speed: **number**): Promise<**void**>;
- **function** getPointerSpeed(callback: AsyncCallback<**number**>): **void**;
- **function** getPointerSpeed(): Promise<**number**>;
- **function** setPointerStyle(windowId: **number**, pointerStyle: PointerStyle, callback: AsyncCallback<**void**>): **void**;
- **function** setPointerStyle(windowId: **number**, pointerStyle: PointerStyle): Promise<**void**>;
- **function** getPointerStyle(windowId: **number**, callback: AsyncCallback<PointerStyle>): **void**;
- **function** getPointerStyle(windowId: **number**): Promise<PointerStyle>;
- **function** setPointerVisible(visible: boolean, callback: AsyncCallback<**void**>): **void**;
- **function** setPointerVisible(visible: boolean): Promise<**void**>;
- **function** isPointerVisible(callback: AsyncCallback<boolean>): **void**;
- **function** isPointerVisible(): Promise<boolean>;
- **function** on(**type**:"touch", receiver:TouchEventReceiver):**void**;
- **function** on(**type**:"mouse", receiver:Callback<MouseEvent>):**void**;
- **function** off(**type**:"touch", receiver?:TouchEventReceiver):**void**;
- **function** off(**type**:"mouse", receiver?:Callback<MouseEvent>):**void**;
- **function** injectEvent({KeyEvent: KeyEvent}): **void**;
- **function** enable(enable: boolean, callback: AsyncCallback<**void**>): **void**;
- **function** enable(enable: boolean): Promise<**void**>;
- **function** start(sinkDeviceDescriptor: **string**, srcInputDeviceId: **number**, callback: AsyncCallback<**void**>): **void**;
- **function** start(sinkDeviceDescriptor: **string**, srcInputDeviceId: **number**): Promise<**void**>;
- **function** stop(callback: AsyncCallback<**void**>): **void**;
- **function** stop(): Promise<**void**>;
- **function** getState(deviceDescriptor: **string**, callback: AsyncCallback<{ state: boolean }>): **void**;
- **function** getState(deviceDescriptor: **string**): Promise<{ state: boolean }>;
- **function** on(**type**: 'cooperation', callback: AsyncCallback<{ deviceDescriptor: **string**, eventMsg: EventMsg }>): **void**;
- **function** off(**type**: 'cooperation', callback?: AsyncCallback<**void**>): **void**;
- **function** on(**type**: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): **void**;
- **function** off(**type**: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>): **void**;
**以下接口发生变更**
以下接口发生变更
变更前:
- **function** supportKeys(deviceId: **number**, keys: Array<KeyCode>, callback: Callback<Array<boolean>>): **void**;
- **function** getKeyboardType(deviceId: **number**, callback: Callback<KeyboardType>): **void**;
- supportKeys(deviceId: **number**, keys: Array<KeyCode>, callback: Callback<Array<boolean>>): **void**;
- getKeyboardType(deviceId: **number**, callback: Callback<KeyboardType>): **void**;
变更后:
- **function** supportKeys(deviceId: **number**, keys: Array<KeyCode>, callback: AsyncCallback<Array<boolean>>): **void**;
- **function** getKeyboardType(deviceId: **number**, callback: AsyncCallback<KeyboardType>): **void**;
- supportKeys(deviceId: **number**, keys: Array<KeyCode>, callback: AsyncCallback<Array<boolean>>): **void**;
- getKeyboardType(deviceId: **number**, callback: AsyncCallback<KeyboardType>): **void**;
**适配指导**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册