提交 5f4715f0 编写于 作者: S shawn_he

update doc

Signed-off-by: Nshawn_he <shawn.he@huawei.com>
上级 1d092815
...@@ -20,7 +20,7 @@ enable(enable: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -20,7 +20,7 @@ enable(enable: boolean, callback: AsyncCallback&lt;void&gt;): void
Specifies whether to enable screen hopping. This API uses an asynchronous callback to return the result. Specifies whether to enable screen hopping. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -54,7 +54,7 @@ enable(enable: boolean): Promise&lt;void&gt; ...@@ -54,7 +54,7 @@ enable(enable: boolean): Promise&lt;void&gt;
Specifies whether to enable screen hopping. This API uses a promise to return the result. Specifies whether to enable screen hopping. This API uses a promise to return the result.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -92,7 +92,7 @@ start(sinkDeviceDescriptor: string, srcInputDeviceId: number, callback: AsyncCal ...@@ -92,7 +92,7 @@ start(sinkDeviceDescriptor: string, srcInputDeviceId: number, callback: AsyncCal
Starts screen hopping. This API uses an asynchronous callback to return the result. Starts screen hopping. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -135,7 +135,7 @@ start(sinkDeviceDescriptor: string, srcInputDeviceId: number): Promise\<void> ...@@ -135,7 +135,7 @@ start(sinkDeviceDescriptor: string, srcInputDeviceId: number): Promise\<void>
Starts screen hopping. This API uses a promise to return the result. Starts screen hopping. This API uses a promise to return the result.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -183,7 +183,7 @@ stop(callback: AsyncCallback\<void>): void ...@@ -183,7 +183,7 @@ stop(callback: AsyncCallback\<void>): void
Stops screen hopping. This API uses an asynchronous callback to return the result. Stops screen hopping. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -215,7 +215,7 @@ stop(): Promise\<void> ...@@ -215,7 +215,7 @@ stop(): Promise\<void>
Stops screen hopping. This API uses a promise to return the result. Stops screen hopping. This API uses a promise to return the result.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Return value** **Return value**
...@@ -243,7 +243,7 @@ getState(deviceDescriptor: string, callback: AsyncCallback<{ state: boolean }>): ...@@ -243,7 +243,7 @@ getState(deviceDescriptor: string, callback: AsyncCallback<{ state: boolean }>):
Checks whether screen hopping is enabled. This API uses an asynchronous callback to return the result. Checks whether screen hopping is enabled. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -275,7 +275,7 @@ getState(deviceDescriptor: string): Promise<{ state: boolean }> ...@@ -275,7 +275,7 @@ getState(deviceDescriptor: string): Promise<{ state: boolean }>
Checks whether screen hopping is enabled. This API uses a promise to return the result. Checks whether screen hopping is enabled. This API uses a promise to return the result.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -313,7 +313,7 @@ on(type: 'cooperation', callback: AsyncCallback<{ deviceDescriptor: string, even ...@@ -313,7 +313,7 @@ on(type: 'cooperation', callback: AsyncCallback<{ deviceDescriptor: string, even
Enables listening for screen hopping events. Enables listening for screen hopping events.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -342,7 +342,7 @@ off(type: 'cooperation', callback?: AsyncCallback\<void>): void ...@@ -342,7 +342,7 @@ off(type: 'cooperation', callback?: AsyncCallback\<void>): void
Disables listening for screen hopping events. Disables listening for screen hopping events.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
**Parameters** **Parameters**
...@@ -386,7 +386,7 @@ try { ...@@ -386,7 +386,7 @@ try {
Enumerates screen hopping event. Enumerates screen hopping event.
**System capability**: SystemCapability.MultimodalInput.Input.Cooperate **System capability**: SystemCapability.MultimodalInput.Input.Cooperator
| Name | Value | Description | | Name | Value | Description |
| -------- | --------- | ----------------- | | -------- | --------- | ----------------- |
......
...@@ -108,7 +108,7 @@ Represents combination key options. ...@@ -108,7 +108,7 @@ Represents combination key options.
| Name | Type | Readable | Writable | Description | | Name | Type | Readable | Writable | Description |
| --------- | ------ | ---- | ---- | ------- | | --------- | ------ | ---- | ---- | ------- |
| preKeys | Array\<number> | Yes | No| Front key set. The number of front keys ranges from 0 to 4. There is no requirement on the sequence of the keys.| | preKeys | Array<number> | Yes | No| Front key set. The number of front keys ranges from 0 to 4. There is no requirement on the sequence of the keys.|
| finalKey | number | Yes | No| Final key. This parameter is mandatory. A callback function is triggered by the final key.| | finalKey | number | Yes | No| Final key. This parameter is mandatory. A callback function is triggered by the final key.|
| isFinalKeyDown | boolean | Yes | No| Whether the final key is pressed.| | isFinalKeyDown | boolean | Yes | No| Whether the final key is pressed.|
| finalKeyDownDuration | number | Yes | No| Duration within which the final key is pressed. If the value is **0**, the callback function is triggered immediately. If the value is greater than **0** and the value of **isFinalKeyDown** is **true**, the callback function is triggered when the key press duration is longer than the value of this parameter. If the value of **isFinalKeyDown** is **false**, the callback function is triggered when the duration from key press to key release is less than the value of this parameter. | | finalKeyDownDuration | number | Yes | No| Duration within which the final key is pressed. If the value is **0**, the callback function is triggered immediately. If the value is greater than **0** and the value of **isFinalKeyDown** is **true**, the callback function is triggered when the key press duration is longer than the value of this parameter. If the value of **isFinalKeyDown** is **false**, the callback function is triggered when the duration from key press to key release is less than the value of this parameter. |
...@@ -476,7 +476,7 @@ Defines the information about an input device. ...@@ -476,7 +476,7 @@ Defines the information about an input device.
| id | number | Yes| No| Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.| | id | number | Yes| No| Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.|
| name | string | Yes| No| Name of the input device. | | name | string | Yes| No| Name of the input device. |
| sources | Array&lt;[SourceType](#sourcetype)&gt; | Yes| No| Source type of the input device. For example, if a keyboard is attached with a touchpad, the device has two input sources: keyboard and touchpad.| | sources | Array&lt;[SourceType](#sourcetype)&gt; | Yes| No| Source type of the input device. For example, if a keyboard is attached with a touchpad, the device has two input sources: keyboard and touchpad.|
| axisRanges | Array&lt;[axisRanges](#axisrange)&gt; | Yes| No| Axis information of the input device. | | axisRanges | Array&lt;[AxisRange](#axisrange)&gt; | Yes| No| Axis information of the input device. |
| bus<sup>9+</sup> | number | Yes| No| Bus type of the input device. | | bus<sup>9+</sup> | number | Yes| No| Bus type of the input device. |
| product<sup>9+</sup> | number | Yes| No| Product information of the input device. | | product<sup>9+</sup> | number | Yes| No| Product information of the input device. |
| vendor<sup>9+</sup> | number | Yes| No| Vendor information of the input device. | | vendor<sup>9+</sup> | number | Yes| No| Vendor information of the input device. |
......
...@@ -15,37 +15,37 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput ...@@ -15,37 +15,37 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
**System capability**: SystemCapability.MultimodalInput.Input.Core **System capability**: SystemCapability.MultimodalInput.Input.Core
| Name| Type| Readable| Writable| Description| | Name | Value | Description |
| -------- | -------- | -------- | -------- | -------- | | ------ | ----- | ----------- |
| CANCEL | number | Yes| No| Cancellation of the touch action.| | CANCEL | 0 | Cancellation of the touch action.|
| DOWN | number | Yes| No| Pressing of touch.| | DOWN | 1 | Pressing of touch. |
| MOVE | number | Yes| No| Moving of touch.| | MOVE | 2 | Moving of touch. |
| UP | number | Yes| No| Lifting of touch.| | UP | 3 | Lifting of touch. |
## ToolType ## ToolType
**System capability**: SystemCapability.MultimodalInput.Input.Core **System capability**: SystemCapability.MultimodalInput.Input.Core
| Name| Type| Readable| Writable| Description| | Name | Value | Description |
| -------- | -------- | -------- | -------- | -------- | | ---- | ----- | ----------- |
| FINGER | number | Yes| No| Finger| | FINGER | 0 | Finger|
| PEN | number | Yes| No| Pen| | PEN | 1 | Pen|
| RUBBER | number | Yes| No| Eraser| | RUBBER | 2 | Eraser|
| BRUSH | number | Yes| No| Brush| | BRUSH | 3 | Brush|
| PENCIL | number | Yes| No| Pencil| | PENCIL | 4 | Pencil|
| AIRBRUSH | number | Yes| No| Air brush| | AIRBRUSH | 5 | Air brush|
| MOUSE | number | Yes| No| Mouse| | MOUSE | 6 | Mouse|
| LENS | number | Yes| No| Lens| | LENS | 7 | Lens|
## SourceType ## SourceType
**System capability**: SystemCapability.MultimodalInput.Input.Core **System capability**: SystemCapability.MultimodalInput.Input.Core
| Name| Type| Readable| Writable| Description| | Name | Value | Description |
| -------- | -------- | -------- | -------- | -------- | | ---- | ----- | ----------- |
| TOUCH_SCREEN | number | Yes| No| Touchscreen| | TOUCH_SCREEN | 0 | Touchscreen|
| PEN | number | Yes| No| Stylus| | PEN | 1 | Stylus |
| TOUCH_PAD | number | Yes| No| Touchpad| | TOUCH_PAD | 2 | Touchpad |
## Touch ## Touch
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册