Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
4027266e
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
4027266e
编写于
5月 24, 2022
作者:
O
openharmony_ci
提交者:
Gitee
5月 24, 2022
浏览文件
操作
浏览文件
下载
差异文件
!4084 InputDevice和inputmonitor补充新增接口说明
Merge pull request !4084 from mayunteng/tmp
上级
6590d247
b16ccf0a
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
162 addition
and
143 deletion
+162
-143
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
+94
-74
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
+68
-69
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
100644 → 100755
浏览文件 @
4027266e
...
...
@@ -11,7 +11,7 @@
## 导入模块
```
```
js
import
inputDevice
from
'
@ohos.multimodalInput.inputDevice
'
;
```
...
...
@@ -33,20 +33,11 @@ getDeviceIds(callback: AsyncCallback<Array<number>>): void
**示例:**
```
export default {
data: {
deviceIds: Array,
},
callback: function(ids) {
this.deviceIds = ids;
},
testGetDeviceIds: function () {
console.info("InputDeviceJsTest---start---testGetDeviceIds");
inputDevice.getDeviceIds(this.callback);
console.info("InputDeviceJsTest---end---testGetDeviceIds");
}
}
```
js
// 示例获取设备所有设备id。
inputDevice
.
getDeviceIds
(
function
(
ids
)
{
// 处理结果
});
```
## inputDevice.getDeviceIds
...
...
@@ -59,24 +50,20 @@ function getDeviceIds(): Promise<Array<number>>
**返回值:**
| 参数
| 说明
|
| ---------------------- | ------------------ |
| Promise
<Array
<
number
>
> | Promise实例,用于异步获取结果 |
| 参数
| 说明
|
| ---------------------- | ------------------
-------------
|
| Promise
<Array
<
number
>
> | Promise实例,用于异步获取结果
。
|
**示例:**
```
export default {
testGetDeviceIds: function () {
console.info("InputDeviceJsTest---start---testGetDeviceIds");
let promise = inputDevice.getDeviceIds();
promise.then((data)=> {
console.info('GetDeviceIds successed, Data: ' + JSON.stringify(data))
}).catch((err)=>{
console.error('Failed GetDeviceIds. Cause: ' + JSON.stringify(err));
});
}
}
```
js
// 示例获取设备所有设备id。
let
promise
=
inputDevice
.
getDeviceIds
();
promise
.
then
((
ids
)
=>
{
// 处理结果
}).
catch
((
err
)
=>
{
// 处理异常
});
```
...
...
@@ -100,24 +87,11 @@ getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): voi
**示例:**
```
export default {
InputDeviceData: {
deviceId : 0,
name : "NA",
sources : Array,
axisRanges : Array,
},
callback: function(deviceData) {
this.InputDeviceData = deviceData;
},
testGetDevice: function () {
// 示例获取设备id为1的设备信息。
console.info("InputDeviceJsTest---start---testGetDevice");
inputDevice.getDevice(1, this.callback);
console.info("InputDeviceJsTest---end---testGetDevice");
}
}
```
js
// 示例获取设备id为1的设备信息。
inputDevice
.
getDevice
(
1
,
function
(
deviceData
)
{
// 处理结果
});
```
## inputDevice.getDevice
...
...
@@ -130,34 +104,69 @@ function getDevice(deviceId: number): Promise<InputDeviceData>
**返回值:**
| 参数
| 说明
|
| ------------------------ | ------------------ |
| Promise
<InputDeviceData>
| Promise实例,用于异步获取结果 |
| 参数
| 说明
|
| ------------------------ | ------------------
-------------
|
| Promise
<InputDeviceData>
| Promise实例,用于异步获取结果
。
|
**示例:**
```
js
// 示例获取设备id为1的设备信息。
let
promise
=
inputDevice
.
getDevice
(
1
);
promise
.
then
((
data
)
=>
{
// 处理结果
}).
catch
((
err
)
=>
{
// 处理异常
});
```
export default {
InputDeviceData: {
deviceId : 0,
name : "NA",
sources : Array,
axisRanges : Array,
},
testGetDevice: function () {
// 示例获取设备id为1的设备信息。
console.info("InputDeviceJsTest---start---testGetDevice");
let promise = inputDevice.getDevice(1);
promise.then((data)=> {
console.info('GetDeviceId successed, Data: ' + JSON.stringify(data))
}).catch((err)=>{
console.error('Failed GetDeviceId. Cause: ' + JSON.stringify(err));
});
}
}
## inputDevice.on<sup>9+</sup>
on(type: "change", listener: Callback
<DeviceListener>
): void
开始监听设备插拔事件。
**系统能力:**
SystemCapability.MultimodalInput.Input.InputDevice
**返回值:**
| 参数 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------- |
| type | string | 是 | 监听类型。 |
| listener | Callback
<DeviceListener>
| 是 | 回调函数。 |
**示例:**
```
js
// 示例监听设备插拔事件
inputDevice
.
on
(
"
change
"
,
function
(
deviceChangedData
)
{
// 处理结果
});
```
## inputDevice.off
function off(type: "change", listener?: Callback
<DeviceListener>
): void;
停止监听设备插拔事件。
**系统能力:**
SystemCapability.MultimodalInput.Input.InputDevice
**返回值:**
| 参数 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | -------------------- |
| type | string | 是 | 监听类型。 |
| listener | Callback
<DeviceListener>
| 否 | 停止监听的回调函数。 |
**示例:**
```
js
// 示例取消监听设备插拔事件
inputDevice
.
off
(
"
change
"
);
```
## InputDeviceData
...
...
@@ -181,12 +190,12 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| ------ | ------------------------- | -------- |
| 名称
| 参数类型 | 说明
|
| ------ | ------------------------- | --------
--------
|
| source |
[
SourceType
](
#sourcetype
)
| 轴的输入源类型。 |
| axis |
[
AxisType
](
axistype
)
| 轴的类型 |
| max | number | 轴上报的最大值
|
| min | number | 轴上报的最小值
|
| axis |
[
AxisType
](
axistype
)
| 轴的类型
。
|
| max | number | 轴上报的最大值
。
|
| min | number | 轴上报的最小值
。
|
...
...
@@ -204,3 +213,14 @@ export default {
| trackball | string | 表示输入设备是轨迹球。 |
| touchpad | string | 表示输入设备是触摸板。 |
| joystick | string | 表示输入设备是操纵杆。 |
## DeviceListener
设备插拔事件。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| -------- | -------- | ----------------------------------- |
| type | string | 表示设备插拔类型,取值add和remove。 |
| deviceId | number | 表示设备id。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
100644 → 100755
浏览文件 @
4027266e
...
...
@@ -10,7 +10,7 @@
## 导入模块
```
```
js
import
inputMonitor
from
'
@ohos.multimodalInput.inputMonitor
'
;
```
...
...
@@ -24,84 +24,97 @@ ohos.permission.INPUT_MONITORING
on(type: "touch", receiver: TouchEventReceiver): void
开始监听全局
输入
。
开始监听全局
触屏事件
。
**需要权限:**
ohos.permission.INPUT_MONITORING
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------------------- |
| type | string
| 是 | 监听输入事件类型,只支持
“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 是
| 触摸输入事件回调函数。 |
| 参数
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
- | ---- | -----------
-------------------- |
| type | string
| 是 | 监听输入事件类型,取值
“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 是 | 触摸输入事件回调函数。 |
**示例:**
```
js
inputMonitor
.
off
(
"
touch
"
,
(
event
)
=>
{
// 消费触屏事件
return
false
;
});
```
export default {
callback: function (value) {
if (checkEvent(value)) {
//事件满足业务要求,事件被消费
return true;
} else {
//事件不满足业务要求,事件未被消费
return false;
}
},
testOn: function () {
console.info("InputMonitorJsTest---start---testOn");
inputMonitor.on(
"touch",
this.callback
);
console.info("InputMonitorJsTest---end---testOn");
}
}
on(type: "mouse", receiver: TouchEventReceiver): void
开始监听全局鼠标事件。
**需要权限:**
ohos.permission.INPUT_MONITORING
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------- |
| type | string | 是 | 监听输入事件类型,取值“mouse”。 |
| receiver | Callback
<MouseEvent>
| 是 | 鼠标输入事件回调函数。 |
**示例:**
```
js
inputMonitor
.
off
(
"
mouse
"
,
(
event
)
=>
{
// 消费鼠标事件
});
```
## inputMonitor.off
off(type: "touch", receiver: TouchEventReceiver): void
停止监听全局输入
。
开始监听全局触屏事件
。
**需要权限:**
ohos.permission.INPUT_MONITORING
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------------------- |
| type | string
| 是 | 监听输入事件类型,只支持
“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 否
| 触摸输入事件回调函数。 |
| 参数
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
- | ---- | -----------
-------------------- |
| type | string
| 是 | 监听输入事件类型,取值
“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 否 | 触摸输入事件回调函数。 |
**示例:**
```
js
inputMonitor
.
off
(
"
touch
"
);
```
export default {
callback: function (value) {
if (checkEvent(value)) {
//事件满足业务要求,事件被消费
return true;
} else {
//事件不满足业务要求,事件未被消费
return false;
}
},
testOff: function () {
console.info("InputMonitorJsTest---start---testOff");
inputMonitor.off(
"touch",
this.callback
);
console.info("InputMonitorJsTest---end---testOff");
}
}
off(type: "mouse", receiver?: Callback
<MouseEvent>
): void
停止监听全局鼠标事件。
**需要权限:**
ohos.permission.INPUT_MONITORING
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------- |
| type | string | 是 | 监听输入事件类型,取值“mouse”。 |
| receiver | Callback
<MouseEvent>
| 否 | 鼠标输入事件回调函数。 |
**示例:**
```
js
inputMonitor
.
off
(
"
mouse
"
);
```
## TouchEventReceiver
触摸输入事件的回调函数,如果返回true,则触摸输入将被监听器消耗(系统执行关闭动作)。
...
...
@@ -125,24 +138,10 @@ export default {
**示例:**
```
export default {
callback: function (value) { //此处为(touchEvent:TouchEvent): Boolean 方法的实现
if (checkEvent(value)) {
//事件满足业务要求,事件被消费
return true;
} else {
//事件不满足业务要求,事件未被消费
return false;
}
},
testOff: function () {
console.info("InputMonitorJsTest---start---testOff");
inputMonitor.off(
"touch",
this.callback
);
console.info("InputMonitorJsTest---end---testOff");
}
}
```
js
inputMonitor
.
on
(
"
touch
"
,
(
event
)
=>
{
// 消费触屏事件
return
false
;
});
inputMonitor
.
off
(
"
touch
"
);
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录