Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
0c252a6a
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,发现更多精彩内容 >>
提交
0c252a6a
编写于
7月 29, 2022
作者:
H
HelloCrease
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
HelloCrease
<
lian15@huawei.com
>
上级
82850e67
变更
24
展开全部
隐藏空白更改
内联
并排
Showing
24 changed file
with
1313 addition
and
1387 deletion
+1313
-1387
zh-cn/application-dev/reference/Readme-CN.md
zh-cn/application-dev/reference/Readme-CN.md
+2
-2
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
...v/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
+9
-8
zh-cn/application-dev/reference/apis/js-apis-animator.md
zh-cn/application-dev/reference/apis/js-apis-animator.md
+35
-35
zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md
...ation-dev/reference/apis/js-apis-backgroundTaskManager.md
+33
-33
zh-cn/application-dev/reference/apis/js-apis-config-policy.md
...n/application-dev/reference/apis/js-apis-config-policy.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
...n-dev/reference/apis/js-apis-distributedMissionManager.md
+60
-60
zh-cn/application-dev/reference/apis/js-apis-enterprise-device-manager.md
...n-dev/reference/apis/js-apis-enterprise-device-manager.md
+112
-144
zh-cn/application-dev/reference/apis/js-apis-i18n.md
zh-cn/application-dev/reference/apis/js-apis-i18n.md
+134
-134
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
...n/application-dev/reference/apis/js-apis-inputconsumer.md
+20
-26
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
+8
-8
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
+9
-9
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
...pplication-dev/reference/apis/js-apis-inputeventclient.md
+5
-9
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
+21
-34
zh-cn/application-dev/reference/apis/js-apis-intl.md
zh-cn/application-dev/reference/apis/js-apis-intl.md
+40
-40
zh-cn/application-dev/reference/apis/js-apis-keycode.md
zh-cn/application-dev/reference/apis/js-apis-keycode.md
+334
-334
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
+30
-29
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
+56
-56
zh-cn/application-dev/reference/apis/js-apis-prompt.md
zh-cn/application-dev/reference/apis/js-apis-prompt.md
+99
-121
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
...pplication-dev/reference/apis/js-apis-resource-manager.md
+166
-167
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
+55
-54
zh-cn/application-dev/reference/apis/js-apis-update.md
zh-cn/application-dev/reference/apis/js-apis-update.md
+41
-41
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
...n/application-dev/reference/apis/js-apis-workScheduler.md
+40
-40
未找到文件。
zh-cn/application-dev/reference/Readme-CN.md
浏览文件 @
0c252a6a
# 开发参考
-
[
基于JS扩展的类Web开发范式
](
arkui-js/Readme-CN.md
)
-
[
基于TS扩展的声明式开发范式
](
arkui-ts/Readme-CN.md
)
-
[
组件参考(基于JS扩展的类Web开发范式)
](
arkui-js/Readme-CN.md
)
-
[
组件参考(基于TS扩展的声明式开发范式)
](
arkui-ts/Readme-CN.md
)
-
[
接口参考(JS及TS API)
](
apis/Readme-CN.md
)
-
接口参考(Native API)
-
[
OpenHarmony Native API
](
./native-apis/Readme-CN.md
)
...
...
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
0c252a6a
...
...
@@ -121,7 +121,7 @@
-
资源调度
-
[
@ohos.backgroundTaskManager (后台任务管理)
](
js-apis-backgroundTaskManager.md
)
-
[
@ohos.distributedMissionManager (
distributedMissionManager
)
](
js-apis-distributedMissionManager.md
)
-
[
@ohos.distributedMissionManager (
分布式任务管理
)
](
js-apis-distributedMissionManager.md
)
-
[
@ohos.workScheduler (延迟任务调度)
](
js-apis-workScheduler.md
)
-
[
@ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)
](
js-apis-WorkSchedulerExtensionAbility.md
)
-
定制管理
...
...
zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
浏览文件 @
0c252a6a
...
...
@@ -4,13 +4,14 @@
开发者在开发应用时,通过复写该模块的接口,在延迟任务触发的时候,系统会通过接口回调应用,开发者在回调接口里面可以处理自己的任务逻辑。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
```
ts
import
WorkSchedulerExtensionAbility
from
'
@ohos.WorkSchedulerExtensionAbility
'
```
...
...
@@ -24,13 +25,13 @@ onWorkStart(work: workScheduler.WorkInfo): void
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------- |
| 参数名 | 类型
| 必填 | 说明 |
| ---- | ---------------------
-------------------
| ---- | -------------- |
| work |
[
workScheduler.WorkInfo
](
js-apis-workScheduler.md#workinfo
)
| 是 | 指示要添加到执行队列的工作。 |
**示例:**
```
```
ts
export
default
class
MyWorkSchedulerExtensionAbility
extends
WorkSchedulerExtensionAbility
{
onWorkStart
(
workInfo
)
{
console
.
log
(
'
MyWorkSchedulerExtensionAbility onWorkStart
'
+
JSON
.
stringify
(
workInfo
));
...
...
@@ -48,14 +49,14 @@ onWorkStop(work: workScheduler.WorkInfo): void
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------- |
| 参数名 | 类型
| 必填 | 说明 |
| ---- | ---------------------
-------------------
| ---- | -------------- |
| work |
[
workScheduler.WorkInfo
](
js-apis-workScheduler.md#workinfo
)
| 是 | 指示要添加到执行队列的工作。 |
**示例:**
```
```
ts
export
default
class
MyWorkSchedulerExtensionAbility
extends
WorkSchedulerExtensionAbility
{
onWorkStop
(
workInfo
)
{
console
.
log
(
'
MyWorkSchedulerExtensionAbility onWorkStop
'
+
JSON
.
stringify
(
workInfo
));
...
...
zh-cn/application-dev/reference/apis/js-apis-animator.md
浏览文件 @
0c252a6a
...
...
@@ -3,13 +3,13 @@
本模块提供组件动画效果,包括定义动画、启动动画和以相反的顺序播放动画等。
> **说明:**
>
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
```
js
import
animator
from
'
@ohos.animator
'
;
```
...
...
@@ -23,18 +23,18 @@ createAnimator(options: AnimatorOptions): AnimatorResult
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- | -
------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是
| 定义动画选项。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ----------------------------------- | ---- |
------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是
| 定义动画选项。
|
**返回值:**
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
------------------------- | -----
-------- |
|
[
AnimatorResult
](
#animatorresult
)
| Animator结果接口。 |
**示例:**
```
```
html
<!-- hml -->
<div
class=
"container"
>
<div
class=
"Animation"
style=
"height: {{divHeight}}px; width: {{divWidth}}px; background-color: red;"
onclick=
"Show"
>
...
...
@@ -42,7 +42,7 @@ createAnimator(options: AnimatorOptions): AnimatorResult
</div>
```
```
```
js
// js
export
default
{
data
:
{
...
...
@@ -94,12 +94,12 @@ update(options: AnimatorOptions): void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- | -
------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是
| 定义动画选项。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ----------------------------------- | ---- |
------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是
| 定义动画选项。
|
**示例:**
```
```
js
animator
.
update
(
options
);
```
...
...
@@ -112,7 +112,7 @@ play(): void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**示例:**
```
```
js
animator
.
play
();
```
...
...
@@ -125,7 +125,7 @@ finish(): void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**示例:**
```
```
js
animator
.
finish
();
```
...
...
@@ -138,7 +138,7 @@ pause(): void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**示例:**
```
```
js
animator
.
pause
();
```
...
...
@@ -151,7 +151,7 @@ cancel(): void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**示例:**
```
```
js
animator
.
cancel
();
```
...
...
@@ -164,7 +164,7 @@ reverse(): void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**示例:**
```
```
js
animator
.
reverse
();
```
...
...
@@ -177,12 +177,12 @@ onframe: (progress: number) => void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------
-- | ----
---- | -------- |
| progress | number | 是
| 动画的当前进度。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------
|
---- | -------- |
| progress | number | 是
| 动画的当前进度。
|
**示例:**
```
```
js
animator
.
onframe
();
```
...
...
@@ -195,7 +195,7 @@ onfinish: () => void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**示例:**
```
```
js
animator
.
onfinish
();
```
...
...
@@ -208,7 +208,7 @@ oncancel: () => void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**示例:**
```
```
js
animator
.
oncancel
();
```
...
...
@@ -221,7 +221,7 @@ onrepeat: () => void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**示例:**
```
```
js
animator
.
onrepeat
();
```
...
...
@@ -231,13 +231,13 @@ animator.onrepeat();
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
| 名称
| 参数类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| duration
| number | 是 | 动画播放的时长,单位毫秒,默认为0。
|
| easing
| string | 是 | 动画插值曲线,默认为'ease'。
|
| delay
| number | 是 | 动画延时播放时长,单位毫秒,默认为0,即不延时。
|
| fill
| "none"
\|
"forwards"
\|
"backwards"
\|
"both" | 是
| 动画执行后是否恢复到初始状态,默认值为"none"。动画执行后,动画结束时的状态(在最后一个关键帧中定义)将保留。 |
| direction
| "normal"
\|
"reverse"
\|
"alternate"
\|
"alternate-reverse" | 是 | 动画播放模式,默认值"normal"。
|
| iterations | number
| 是 | 动画播放次数,默认值1。设置为0时不播放,设置为-1时无限次播放。
|
| begin
| number | 是 | 动画插值起点,默认为0。
|
| end
| number | 是 | 动画插值终点,默认为1。
|
| 名称
| 参数类型 | 必填 | 说明
|
| --------
-- | ---------------------------------------- | ---- | --------------------------------
-------- |
| duration
| number | 是 | 动画播放的时长,单位毫秒,默认为0。
|
| easing
| string | 是 | 动画插值曲线,默认为'ease'。
|
| delay
| number | 是 | 动画延时播放时长,单位毫秒,默认为0,即不延时。
|
| fill
| "none"
\|
"forwards"
\|
"backwards"
\|
"both" | 是
| 动画执行后是否恢复到初始状态,默认值为"none"。动画执行后,动画结束时的状态(在最后一个关键帧中定义)将保留。 |
| direction
| "normal"
\|
"reverse"
\|
"alternate"
\|
"alternate-reverse" | 是 | 动画播放模式,默认值"normal"。
|
| iterations | number
| 是 | 动画播放次数,默认值1。设置为0时不播放,设置为-1时无限次播放。
|
| begin
| number | 是 | 动画插值起点,默认为0。
|
| end
| number | 是 | 动画插值终点,默认为1。
|
zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md
浏览文件 @
0c252a6a
...
...
@@ -8,13 +8,13 @@
应用中存在用户能够直观感受到的且需要一直在后台运行的业务时(如,后台播放音乐),可以使用长时任务机制。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
```
js
import
backgroundTaskManager
from
'
@ohos.backgroundTaskManager
'
;
```
...
...
@@ -143,12 +143,12 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ------------------------ |
| context | Context
| 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。
|
| bgMode |
[
BackgroundMode
](
#backgroundmode8
)
| 是 | 向系统申请的后台模式。 |
| wantAgent |
[
WantAgent
](
js-apis-wantAgent.md
)
| 是 | 通知参数,用于指定长时任务通知点击后跳转的界面。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动长时任务的结果。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | ---------------------------------- | ---- | ------------------------
----------------
|
| context | Context
| 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。
|
| bgMode |
[
BackgroundMode
](
#backgroundmode8
)
| 是 | 向系统申请的后台模式。
|
| wantAgent |
[
WantAgent
](
js-apis-wantAgent.md
)
| 是 | 通知参数,用于指定长时任务通知点击后跳转的界面。
|
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动长时任务的结果。
|
**示例**
:
```
js
...
...
@@ -195,11 +195,11 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ----------------------- |
| context | Context
| 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。
|
| bgMode |
[
BackgroundMode
](
#backgroundmode8
)
| 是 | 向系统申请的后台模式。 |
| wantAgent |
[
WantAgent
](
js-apis-wantAgent.md
)
| 是 | 通知参数,用于指定长时任务通知点击跳转的界面。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | ---------------------------------- | ---- | -----------------------
-----------------
|
| context | Context
| 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。
|
| bgMode |
[
BackgroundMode
](
#backgroundmode8
)
| 是 | 向系统申请的后台模式。
|
| wantAgent |
[
WantAgent
](
js-apis-wantAgent.md
)
| 是 | 通知参数,用于指定长时任务通知点击跳转的界面。
|
**返回值**
| 类型 | 说明 |
...
...
@@ -244,10 +244,10 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): vo
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数**
:
| 参数名 | 类型
| 必填 | 说明
|
| -------- | -------------------------
---- | ---- |
---------------------- |
| context | Context
| 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。
|
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动长时任务的结果。
|
| 参数名 | 类型
| 必填 | 说明
|
| -------- | -------------------------
| ---- | ------------------
---------------------- |
| context | Context
| 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。
|
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动长时任务的结果。
|
**示例**
:
```
js
...
...
@@ -275,8 +275,8 @@ stopBackgroundRunning(context: Context): Promise<void>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数**
:
| 参数名 | 类型
| 必填 | 说明
|
| ------- | -------
---------------------- | ---- |
--------- |
| 参数名 | 类型
| 必填 | 说明
|
| ------- | -------
| ---- | -------------------------------
--------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
**返回值**
...
...
@@ -301,7 +301,7 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
延迟挂起信息。
**系统能力:**
以下各项对应的系统能力均为
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------ | ---- | ---------------------------------------- |
...
...
@@ -311,16 +311,16 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
## BackgroundMode<sup>8+</sup>
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
| 参数名 | 参数值 | 描述 |
| ----------------------- | ------ | ------------------------------------------------------------ |
| DATA_TRANSFER | 1 | 数据传输 |
| AUDIO_PLAYBACK | 2 | 音频播放 |
| AUDIO_RECORDING | 3 | 录音 |
| LOCATION | 4 | 定位导航 |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关 |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联 |
| WIFI_INTERACTION | 7 | WLAN相关
<br
/>
**系统API**
:此接口为系统接口,三方应用不支持调用。 |
| VOIP | 8 | 音视频通话
<br
/>
**系统API**
:此接口为系统接口,三方应用不支持调用。 |
| TASK_KEEPING | 9 | 计算任务(仅在特定设备生效) |
\ No newline at end of file
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
| 参数名 | 参数值 | 描述 |
| ----------------------- | ---- | --------------------- |
| DATA_TRANSFER | 1 | 数据传输 |
| AUDIO_PLAYBACK | 2 | 音频播放 |
| AUDIO_RECORDING | 3 | 录音 |
| LOCATION | 4 | 定位导航 |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关 |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联 |
| WIFI_INTERACTION | 7 | WLAN相关
<br
/>
此接口为系统接口。 |
| VOIP | 8 | 音视频通话
<br
/>
此接口为系统接口。 |
| TASK_KEEPING | 9 | 计算任务(仅在特定设备生效) |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-config-policy.md
浏览文件 @
0c252a6a
...
...
@@ -6,7 +6,7 @@
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口均为系统接口
,三方应用不支持调用
。
> 本模块接口均为系统接口。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
浏览文件 @
0c252a6a
...
...
@@ -3,14 +3,14 @@
分布式任务管理模块提供跨设备系统任务管理能力,包括注册系统任务状态监听、取消系统任务状态监听、开始同步远端任务列表、停止同步远端任务列表操作。
> **说明:**
>
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口为系统接口。
## 导入模块
```
```
js
import
distributedMissionManager
from
'
@ohos.distributedMissionManager
'
```
...
...
@@ -27,11 +27,11 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback,
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是
| 注册监听设备信息。 |
| options |
[
MissionCallback
](
#missioncallback
)
| 是 | 注册的回调方法。
|
| callback | AsyncCallback
<
void
>
| 是
| 执行结果回调函数。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | --------------------------------------- | ---- | -
-------- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是
| 注册监听设备信息。 |
| options |
[
MissionCallback
](
#missioncallback
)
| 是 | 注册的回调方法。
|
| callback | AsyncCallback
<
void
>
| 是
| 执行结果回调函数。 |
**示例:**
...
...
@@ -71,16 +71,16 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback):
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | ----
---- | -------- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是 | 设备信息。
|
| options |
<a
href=
"#missioncallback"
>
MissionCallback
</a>
| 是
| 注册的回调方法。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | ---------------------------------------- |
---- | -------- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是 | 设备信息。
|
| options |
<a
href=
"#missioncallback"
>
MissionCallback
</a>
| 是
| 注册的回调方法。 |
**返回值:**
| 类型 | 说明 |
| -------- |
-------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
| 类型 | 说明 |
| ------------------- | --------
-------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
**示例:**
...
...
@@ -125,10 +125,10 @@ unregisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback&
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是 | 设备信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 执行结果回调函数。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | --------------------------------------- | ---- | -
-------- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是 | 设备信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 执行结果回调函数。 |
**示例:**
...
...
@@ -154,15 +154,15 @@ unregisterMissionListener(parameter: MissionDeviceInfo): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是
| 设备信息。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | --------------------------------------- | ---- |
----- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是
| 设备信息。 |
**返回值:**
| 类型 | 说明 |
| -------- |
-------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
| 类型 | 说明 |
| ------------------- | --------
-------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
**示例:**
...
...
@@ -190,10 +190,10 @@ startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback<
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| parameter |
[
MissionParameter
](
#missionparameter
)
| 是 | 同步信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 执行结果回调函数。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | ------------------------------------- | ---- | -
-------- |
| parameter |
[
MissionParameter
](
#missionparameter
)
| 是 | 同步信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 执行结果回调函数。 |
**示例:**
...
...
@@ -220,15 +220,15 @@ startSyncRemoteMissions(parameter: MissionParameter): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| parameter |
[
MissionParameter
](
#missionparameter
)
| 是
| 同步信息。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | ------------------------------------- | ---- |
----- |
| parameter |
[
MissionParameter
](
#missionparameter
)
| 是
| 同步信息。 |
**返回值:**
| 类型 | 说明 |
| -------- |
-------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
| 类型 | 说明 |
| ------------------- | --------
-------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
**示例:**
...
...
@@ -258,10 +258,10 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback<
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是 | 同步信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 执行结果回调函数。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | --------------------------------------- | ---- | -
-------- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是 | 同步信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 执行结果回调函数。 |
**示例:**
...
...
@@ -286,15 +286,15 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是
| 同步信息。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | --------------------------------------- | ---- |
----- |
| parameter |
[
MissionDeviceInfo
](
#missiondeviceinfo
)
| 是
| 同步信息。 |
**返回值:**
| 类型 | 说明 |
| -------- |
-------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
| 类型 | 说明 |
| ------------------- | --------
-------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
**示例:**
...
...
@@ -314,32 +314,32 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise<void>
表示开始同步后,建立的回调函数。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Ability.AbilityRuntime.Mission
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
| 名称
| 类型 | 可读 | 可写 | 说明 |
| --------
| -------- | -------- | -------- |
-------- |
| notifyMissionsChanged | function | 是
| 否 | 通知任务变化,返回设备ID。|
| notifySnapshot
| function | 是 | 否 | 通知快照变化,返回设备ID,任务ID |
| notifyNetDisconnect
| function | 是 | 否 | 通知断开连接,返回设备ID,网络状态 |
| 名称
| 类型 | 可读 | 可写 | 说明 |
| --------
------------- | -------- | ---- | ---- | ----------
-------- |
| notifyMissionsChanged | function | 是
| 否 | 通知任务变化,返回设备ID。 |
| notifySnapshot
| function | 是 | 否 | 通知快照变化,返回设备ID,任务ID |
| notifyNetDisconnect
| function | 是 | 否 | 通知断开连接,返回设备ID,网络状态 |
## MissionParameter
表示同步时所需参数的枚举。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Ability.AbilityRuntime.Mission
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
| 名称
| 参数类型 | 可读 | 可写 | 说明 |
| --------
| -------- | -------- | -------- |
-------- |
| deviceId
| string | 是 | 是 | 表示设备ID。|
| fixConflict | boolean | 是
| 是 | 表示是否存在版本冲突。 |
| tag
| number | 是 | 是 | 表示特定的标签。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明 |
| --------
--- | ------- | ---- | ---- | ---
-------- |
| deviceId
| string | 是 | 是 | 表示设备ID。 |
| fixConflict | boolean | 是
| 是 | 表示是否存在版本冲突。 |
| tag
| number | 是 | 是 | 表示特定的标签。 |
## MissionDeviceInfo
表示注册监听时所需参数的枚举。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Ability.AbilityRuntime.Mission
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 是 | 表示设备ID。|
\ No newline at end of file
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------ | ---- | ---- | ------- |
| deviceId | string | 是 | 是 | 表示设备ID。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-enterprise-device-manager.md
浏览文件 @
0c252a6a
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @
0c252a6a
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @
0c252a6a
...
...
@@ -6,13 +6,13 @@ InputConsumer模块提供对按键事件的监听。
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口
均为系统接口,三方应用不支持调用
。
> - 本模块接口
为系统接口
。
## 导入模块
```
```
js
import
inputConsumer
from
'
@ohos.multimodalInput.inputConsumer
'
;
```
...
...
@@ -23,21 +23,19 @@ on(type: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): v
开始监听组合按键事件, 当满足条件的组合按键输入事件发生时,将keyOptions回调到入参callback表示的回调函数上。
此接口为系统接口。
**系统能力:**
SystemCapability.MultimodalInput.Input.InputConsumer
**参数:**
| 参数
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| type
| string | 是 | 监听输入事件类型,只支持“key”。
|
| keyOptions |
[
keyOptions
](
#keyoptions
)
| 是 | 组合键选项,用来指定组合键输入时应该符合的条件。
|
| callback
| Callback
<
KeyOptions
>
| 是
| 回调函数。当满足条件的按键输入产生时,回调到此函数,以传入的KeyOptions为入参。 |
| 参数
| 类型 | 必填 | 说明
|
| --------
-- | -------------------------- | ---- | --------------------------------
-------- |
| type
| string | 是 | 监听输入事件类型,只支持“key”。
|
| keyOptions |
[
keyOptions
](
#keyoptions
)
| 是 | 组合键选项,用来指定组合键输入时应该符合的条件。
|
| callback
| Callback
<
KeyOptions
>
| 是
| 回调函数。当满足条件的按键输入产生时,回调到此函数,以传入的KeyOptions为入参。 |
**示例:**
```
```
js
let
keyOptions
=
{
preKeys
:
[],
finalKey
:
3
,
isFinalKeyDown
:
true
,
finalKeyDownDuration
:
0
}
let
callback
=
function
(
keyOptions
)
{
console
.
info
(
"
preKeys:
"
+
keyOptions
.
preKeys
,
"
finalKey:
"
+
keyOptions
.
finalKey
,
...
...
@@ -53,21 +51,19 @@ off(type: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>):
停止监听组合按键事件。
此接口为系统接口。
**系统能力:**
SystemCapability.MultimodalInput.Input.InputConsumer
**参数:**
| 参数
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| type
| string | 是 | 监听输入事件类型,只支持“key”。
|
| keyOptions |
[
keyOptions
](
#keyoptions
)
| 是 | 开始监听时传入的keyOptions。
|
| callback
| Callback
<
KeyOptions
>
| 是
| 开始监听时与KeyOption一同传入的回调函数
。 |
| 参数
| 类型 | 必填 | 说明
|
| --------
-- | -------------------------- | ---- | -----------------------
-------- |
| type
| string | 是 | 监听输入事件类型,只支持“key”。
|
| keyOptions |
[
keyOptions
](
#keyoptions
)
| 是 | 开始监听时传入的keyOptions。
|
| callback
| Callback
<
KeyOptions
>
| 是
| 开始监听时与KeyOption一同传入的回调函数
。 |
**示例:**
```
```
js
let
keyOptions
=
{
preKeys
:
[],
finalKey
:
3
,
isFinalKeyDown
:
true
,
finalKeyDownDuration
:
0
}
let
callback
=
function
(
keyOptions
)
{
console
.
info
(
"
preKeys:
"
+
keyOptions
.
preKeys
,
"
finalKey:
"
+
keyOptions
.
finalKey
,
...
...
@@ -81,13 +77,11 @@ inputConsumer.off('key', keyOptions, callback);
组合键输入事件发生时,组合键满足的选项。
此接口为系统接口。
**系统能力:**
SystemCapability.MultimodalInput.Input.InputConsumer
| 参数 | 类型 | 必填 | 说明 |
| --------
| -------- | -------- |
-------- |
| preKeys
| Array | 是 | 组合键前置按键集合,可为空,前置按键无顺序要求。 |
| finalKey
| Number | 是 | 组合键最后按键,不能为空。 |
| isFinalKeyDown
| boolean | 是 | 组合键最后按键是按下还是抬起,默认是按下。 |
| finalKeyDownDuration | Number
| 是 | 组合键最后按键按下持续时长,默认无时长要求。 |
| 参数 | 类型 | 必填 | 说明 |
| --------
------------ | ------- | ---- | ----------------
-------- |
| preKeys
| Array | 是 | 组合键前置按键集合,可为空,前置按键无顺序要求。 |
| finalKey
| Number | 是 | 组合键最后按键,不能为空。 |
| isFinalKeyDown
| boolean | 是 | 组合键最后按键是按下还是抬起,默认是按下。 |
| finalKeyDownDuration | Number
| 是 | 组合键最后按键按下持续时长,默认无时长要求。 |
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @
0c252a6a
...
...
@@ -284,7 +284,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的描述信息。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| -------- | --------------------------- | --------------------------------- |
...
...
@@ -295,7 +295,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的描述信息。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| -------------------- | -------------------------------------- | ---------------------------------------- |
...
...
@@ -314,7 +314,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的轴类型。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| ----------- | ------ | --------------- |
...
...
@@ -332,12 +332,12 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的轴信息。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**
: SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| ----------------------- | ------------------------- | -------- |
| source |
[
SourceType
](
#sourcetype
)
| 轴的输入源类型。 |
| axis |
[
AxisType
](
#axistype9
)
| 轴的类型。 |
| axis |
[
AxisType
](
#axistype9
)
| 轴的类型。 |
| max | number | 轴的最大值。 |
| min | number | 轴的最小值。 |
| fuzz
<sup>
9+
</sup>
| number | 轴的模糊值。 |
...
...
@@ -348,7 +348,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
定义这个轴的输入源类型。比如鼠标设备可上报x轴事件,则x轴的源就是鼠标。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| ----------- | ------ | ----------- |
...
...
@@ -363,7 +363,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
定义监听设备热插拔事件。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| ------ | ------ | --------- |
...
...
@@ -374,7 +374,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
定义键盘输入设备的类型。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**
:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 值 | 说明 |
| ------------------- | ------ | ---- | --------- |
...
...
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
浏览文件 @
0c252a6a
...
...
@@ -2,7 +2,7 @@
InputEvent模块描述了设备上报的基本事件。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
@@ -13,12 +13,12 @@ import InputEvent from '@ohos.multimodalInput.inputEvent';
## InputEvent
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| id | number | 是 | 否 | 由服务端生成全局唯一事件id |
| deviceId | number | 是 | 否 | 上报输入事件的设备id |
| actionTime | number | 是 | 否 | 输入事件的上报时间 |
| screenId | number | 是 | 否 | 目标屏幕id |
| windowId | number | 是 | 否 | 目标窗口id |
\ No newline at end of file
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| ---------- | ------ | ---- | ---- | -------------- |
| id | number | 是 | 否 | 由服务端生成全局唯一事件id |
| deviceId | number | 是 | 否 | 上报输入事件的设备id |
| actionTime | number | 是 | 否 | 输入事件的上报时间 |
| screenId | number | 是 | 否 | 目标屏幕id |
| windowId | number | 是 | 否 | 目标窗口id |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
浏览文件 @
0c252a6a
...
...
@@ -6,7 +6,7 @@ InputEventClient模块提供了注入按键能力。
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口
均为系统接口,三方应用不支持调用
。
> - 本模块接口
为系统接口
。
## 导入模块
...
...
@@ -23,8 +23,6 @@ injectEvent({KeyEvent: KeyEvent}): void
注入按键,KeyEvent为注入按键的描述信息。
此接口为系统接口。
**系统能力:**
SystemCapability.MultimodalInput.Input.InputSimulator
**参数:**
...
...
@@ -48,15 +46,13 @@ let res = inputEventClient.injectEvent({KeyEvent: keyEvent});
## KeyEvent
注入按键的描述信息
此接口为系统接口。
注入按键的描述信息。
**系统能力:**
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.InputSimulator
**系统能力:**
SystemCapability.MultimodalInput.Input.InputSimulator
| 参数 | 类型 | 必填 | 说明 |
| --------------- | ------- | ---- | --------- |
| isPressed | boolean | 是 | 按键是否按下 |
| keyCode | number | 是 | 按键键值 |
| keyDownDuration | number | 是 | 按键按下持续时间 |
| isIntercepted | boolean
| 是 | 按键是否可以被拦截 |
| keyDownDuration | number
| 是 | 按键按下持续时间 |
| isIntercepted | boolean | 是 | 按键是否可以被拦截 |
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @
0c252a6a
...
...
@@ -2,10 +2,10 @@
InputMonitor模块提供了监听全局触摸事件的功能。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口均为系统接口
,三方应用不支持调用
。
> - 本模块接口均为系统接口。
## 导入模块
...
...
@@ -16,28 +16,21 @@ import inputMonitor from '@ohos.multimodalInput.inputMonitor';
```
## 权限
ohos.permission.INPUT_MONITORING
## inputMonitor.on
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
)
| 是
| 触摸输入事件回调函数。
|
**示例:**
...
...
@@ -53,18 +46,16 @@ on(type: "mouse", receiver: Callback<MouseEvent>): void
开始监听全局鼠标事件。
此接口为系统接口。
**需要权限:**
ohos.permission.INPUT_MONITORING
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数
| 类型 | 必填 | 说明
|
| -------- | -------------------------- | ---- | -------------------
------------
|
| type | string | 是 | 监听输入事件类型,取值“mouse”。 |
| receiver | Callback
<
MouseEvent
>
| 是
| 鼠标输入事件回调函数。
|
| 参数
| 类型 | 必填 | 说明
|
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是
| 监听输入事件类型,取值“mouse”。 |
| receiver | Callback
<
MouseEvent
>
| 是
| 鼠标输入事件回调函数。
|
**示例:**
...
...
@@ -82,17 +73,15 @@ 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
)
| 否
| 触摸输入事件回调函数。
|
**示例:**
...
...
@@ -104,18 +93,16 @@ off(type: "mouse", receiver?: Callback<MouseEvent>): void
停止监听全局鼠标事件。
此接口为系统接口。
**需要权限:**
ohos.permission.INPUT_MONITORING
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数
| 类型 | 必填 | 说明
|
| -------- | -------------------------- | ---- | -------------------
------------
|
| type | string | 是 | 监听输入事件类型,取值“mouse”。 |
| receiver | Callback
<
MouseEvent
>
| 否
| 鼠标输入事件回调函数。
|
| 参数
| 类型 | 必填 | 说明
|
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是
| 监听输入事件类型,取值“mouse”。 |
| receiver | Callback
<
MouseEvent
>
| 否
| 鼠标输入事件回调函数。
|
**示例:**
...
...
@@ -129,7 +116,7 @@ inputMonitor.off("mouse");
触摸输入事件的回调函数。如果返回true,则触摸输入被监听器消耗,系统将执行关闭动作。
此接口为系统接口。
**需要权限:**
ohos.permission.INPUT_MONITORING
**系统能力:**
SystemCapability.MultimodalInput.Input.InputMonitor
...
...
@@ -139,8 +126,8 @@ inputMonitor.off("mouse");
| touchEvent |
[
TouchEvent
](
../arkui-js/js-components-common-events.md
)
| 是 | 触摸输入事件回调函数,返回true表示输触事件被监听器消费,false表示输触事件未被监听器消费。 |
**返回值:**
| 类型
| 说明
|
| ------- | -------------------------------------- |
| 类型
| 说明
|
| ------- | --------------------------------------
--
|
| Boolean | 返回true表示触摸输入事件被监听器消费,false表示触摸输入事件未被监听器消费。 |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-intl.md
浏览文件 @
0c252a6a
...
...
@@ -3,7 +3,7 @@
本模块提供提供基础的应用国际化能力,包括时间日期格式化、数字格式化、排序等,相关接口在ECMA 402标准中定义。
[
I18N模块
](
js-apis-i18n.md
)
提供其他非ECMA 402定义的国际化接口,与本模块共同使用可提供完整地国际化支持能力。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - Intl模块包含国际化能力基础接口(在ECMA 402中定义),包括时间日期格式化、数字格式化、排序等,国际化增强能力请参考[I18N模块](js-apis-i18n.md)。
...
...
@@ -11,7 +11,7 @@
## 导入模块
```
```
js
import
Intl
from
'
@ohos.intl
'
;
```
...
...
@@ -46,7 +46,7 @@ constructor()
**系统能力**
:SystemCapability.Global.I18n
**示例:**
```
```
js
var
locale
=
new
Intl
.
Locale
();
```
...
...
@@ -66,7 +66,7 @@ constructor(locale: string, options?: LocaleOptions)
| options | LocaleOptions | 否 | 用于创建区域对象的选项。 |
**示例:**
```
```
js
var
locale
=
new
Intl
.
Locale
(
"
zh-CN
"
);
```
...
...
@@ -85,7 +85,7 @@ toString(): string
| string | 字符串形式的区域信息。 |
**示例:**
```
```
js
var
locale
=
new
Intl
.
Locale
(
"
zh-CN
"
);
locale
.
toString
();
```
...
...
@@ -105,7 +105,7 @@ maximize(): Locale
|
[
Locale
](
#locale
)
| 最大化后的区域对象。 |
**示例:**
```
```
js
var
locale
=
new
Intl
.
Locale
(
"
zh-CN
"
);
locale
.
maximize
();
```
...
...
@@ -125,7 +125,7 @@ minimize(): Locale
|
[
Locale
](
#locale
)
| 最小化后的区域对象。 |
**示例:**
```
```
js
var
locale
=
new
Intl
.
Locale
(
"
zh-CN
"
);
locale
.
minimize
();
```
...
...
@@ -135,7 +135,7 @@ minimize(): Locale
表示区域初始化选项。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Global.I18n
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
...
...
@@ -159,7 +159,7 @@ constructor()
**系统能力**
:SystemCapability.Global.I18n
**示例:**
```
```
js
var
datefmt
=
new
Intl
.
DateTimeFormat
();
```
...
...
@@ -179,13 +179,13 @@ constructor(locale: string | Array<string>, options?: DateTimeOptions)
| options |
[
DateTimeOptions
](
#datetimeoptions
)
| 否 | 用于创建时间日期格式化的选项。 |
**示例:**
```
```
js
var
datefmt
=
new
Intl
.
DateTimeFormat
(
"
zh-CN
"
,
{
dateStyle
:
'
full
'
,
timeStyle
:
'
medium
'
});
```
**示例:**
```
```
js
var
datefmt
=
new
Intl
.
DateTimeFormat
([
"
ban
"
,
"
zh
"
],
{
dateStyle
:
'
full
'
,
timeStyle
:
'
medium
'
});
```
...
...
@@ -209,7 +209,7 @@ format(date: Date): string
| string | 格式化后的时间日期字符串 |
**示例:**
```
```
js
var
date
=
new
Date
(
2021
,
11
,
17
,
3
,
24
,
0
);
var
datefmt
=
new
Intl
.
DateTimeFormat
(
"
en-GB
"
);
datefmt
.
format
(
date
);
...
...
@@ -236,7 +236,7 @@ formatRange(startDate: Date, endDate: Date): string
| string | 格式化后的时间日期段字符串。 |
**示例:**
```
```
js
var
startDate
=
new
Date
(
2021
,
11
,
17
,
3
,
24
,
0
);
var
endDate
=
new
Date
(
2021
,
11
,
18
,
3
,
24
,
0
);
var
datefmt
=
new
Intl
.
DateTimeFormat
(
"
en-GB
"
);
...
...
@@ -258,7 +258,7 @@ resolvedOptions(): DateTimeOptions
|
[
DateTimeOptions
](
#datetimeoptions
)
| DateTimeFormat
对象的格式化选项。 |
**示例:**
```
```
js
var
datefmt
=
new
Intl
.
DateTimeFormat
(
"
en-GB
"
);
datefmt
.
resolvedOptions
();
```
...
...
@@ -268,7 +268,7 @@ resolvedOptions(): DateTimeOptions
表示时间日期格式化选项。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Global.I18n
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
...
...
@@ -305,7 +305,7 @@ constructor()
**系统能力**
:SystemCapability.Global.I18n
**示例:**
```
```
js
var
numfmt
=
new
Intl
.
NumberFormat
();
```
...
...
@@ -325,7 +325,7 @@ constructor(locale: string | Array<string>, options?: NumberOptions)
| options |
[
NumberOptions
](
#numberoptions
)
| 否 | 用于创建数字格式化的选项。 |
**示例:**
```
```
js
var
numfmt
=
new
Intl
.
NumberFormat
(
"
en-GB
"
,
{
style
:
'
decimal
'
,
notation
:
"
scientific
"
});
```
...
...
@@ -350,7 +350,7 @@ format(number: number): string;
**示例:**
```
```
js
var
numfmt
=
new
Intl
.
NumberFormat
([
"
en-GB
"
,
"
zh
"
],
{
style
:
'
decimal
'
,
notation
:
"
scientific
"
});
numfmt
.
format
(
1223
);
```
...
...
@@ -371,7 +371,7 @@ resolvedOptions(): NumberOptions
**示例:**
```
```
js
var
numfmt
=
new
Intl
.
NumberFormat
([
"
en-GB
"
,
"
zh
"
],
{
style
:
'
decimal
'
,
notation
:
"
scientific
"
});
numfmt
.
resolvedOptions
();
```
...
...
@@ -391,7 +391,7 @@ resolvedOptions(): NumberOptions
| currencyDisplay | string | 是 | 是 | 货币的显示方式,取值包括:"symbol",
"narrowSymbol",
"code",
"name"。 |
| unit | string | 是 | 是 | 单位名称,如:"meter","inch",“hectare”等。 |
| unitDisplay | string | 是 | 是 | 单位的显示格式,取值包括:"long",
"short",
"narrow"。 |
| unitUsage
<sup>
8+
</sup>
| string | 是 | 是 | 单位的使用场景,取值包括:"default",
"area-land-agricult",
"area-land-commercl",
"area-land-residntl",
"length-person",
"length-person-small",
"length-rainfall",
"length-road",
"length-road-small",
"length-snowfall",
"length-vehicle",
"length-visiblty",
"length-visiblty-small",
"length-person-informal",
"length-person-small-informal",
"length-road-informal",
"speed-road-travel",
"speed-wind",
"temperature-person",
"temperature-weather",
"volume-vehicle-fuel"。 |
| unitUsage
<sup>
8+
</sup>
| string | 是 | 是 | 单位的使用场景,取值包括:"default",
"area-land-agricult",
"area-land-commercl",
"area-land-residntl",
"length-person",
"length-person-small",
"length-rainfall",
"length-road",
"length-road-small",
"length-snowfall",
"length-vehicle",
"length-visiblty",
"length-visiblty-small",
"length-person-informal",
"length-person-small-informal",
"length-road-informal",
"speed-road-travel",
"speed-wind",
"temperature-person",
"temperature-weather",
"volume-vehicle-fuel"。 |
| signDisplay | string | 是 | 是 | 数字符号的显示格式,取值包括:"auto",
"never",
"always",
"expectZero"。 |
| compactDisplay | string | 是 | 是 | 紧凑型的显示格式,取值包括:"long",
"short"。 |
| notation | string | 是 | 是 | 数字的格式化规格,取值包括:"standard",
"scientific",
"engineering",
"compact"。 |
...
...
@@ -418,7 +418,7 @@ constructor()
**系统能力**
:SystemCapability.Global.I18n
**示例:**
```
```
js
var
collator
=
new
Intl
.
Collator
();
```
...
...
@@ -439,7 +439,7 @@ constructor(locale: string | Array<string>, options?: CollatorOptions)
| options |
[
CollatorOptions
](
#collatoroptions
)
| 否 | 用于创建排序对象的选项。 |
**示例:**
```
```
js
var
collator
=
new
Intl
.
Collator
(
"
zh-CN
"
,
{
localeMatcher
:
"
lookup
"
,
usage
:
"
sort
"
});
```
...
...
@@ -464,7 +464,7 @@ compare(first: string, second: string): number
| number | 比较结果。当number为负数,表示first排序在second之前;当number为0,表示first与second排序相同;当number为正数,表示first排序在second之后。 |
**示例:**
```
```
js
var
collator
=
new
Intl
.
Collator
(
"
zh-Hans
"
);
collator
.
compare
(
"
first
"
,
"
second
"
);
```
...
...
@@ -484,17 +484,17 @@ resolvedOptions(): CollatorOptions
|
[
CollatorOptions
](
#collatoroptions
)
| 返回的Collator对象的属性。 |
**示例:**
```
```
js
var
collator
=
new
Intl
.
Collator
(
"
zh-Hans
"
);
var
options
=
collator
.
resolvedOptions
();
```
## CollatorOptions<sup>8+</sup>
<a name=collatoroptions></a>
## CollatorOptions<sup>8+</sup>
表示Collator可设置的属性。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Global.I18n
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------------- | ------- | ---- | ---- | ---------------------------------------- |
...
...
@@ -519,7 +519,7 @@ constructor()
**系统能力**
:SystemCapability.Global.I18n
**示例:**
```
```
js
var
pluralRules
=
new
Intl
.
PluralRules
();
```
...
...
@@ -539,7 +539,7 @@ constructor(locale: string | Array<string>, options?: PluralRulesOptions)
| options |
[
PluralRulesOptions
](
#pluralrulesoptions
)
| 否 | 用于创建单复数对象的选项。 |
**示例:**
```
```
js
var
pluralRules
=
new
Intl
.
PluraRules
(
"
zh-CN
"
,
{
"
localeMatcher
"
:
"
lookup
"
,
"
type
"
:
"
cardinal
"
});
```
...
...
@@ -563,17 +563,17 @@ select(n: number): string
| string | 单复数类别,取值包括:"zero","one","two",
"few",
"many",
"others"。 |
**示例:**
```
```
js
var
pluralRules
=
new
Intl
.
PluralRules
(
"
zh-Hans
"
);
pluralRules
.
select
(
1
);
```
## PluralRulesOptions<sup>8+</sup>
<a name=pluralrulesoptions></a>
## PluralRulesOptions<sup>8+</sup>
表示PluralRules对象可设置的属性。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Global.I18n
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ---------------------------------------- |
...
...
@@ -598,7 +598,7 @@ constructor()
**系统能力**
:SystemCapability.Global.I18n
**示例:**
```
```
js
var
relativetimefmt
=
new
Intl
.
RelativeTimeFormat
();
```
...
...
@@ -618,7 +618,7 @@ constructor(locale: string | Array<string>, options?: RelativeTimeFormatIn
| options |
[
RelativeTimeFormatInputOptions
](
#relativetimeformatinputoptions
)
| 否 | 用于创建相对时间格式化对象的选项。 |
**示例:**
```
```
js
var
relativeTimeFormat
=
new
Intl
.
RelativeTimeFormat
(
"
zh-CN
"
,
{
"
localeMatcher
"
:
"
lookup
"
,
"
numeric
"
:
"
always
"
,
"
style
"
:
"
long
"
});
```
...
...
@@ -643,7 +643,7 @@ format(value: number, unit: string): string
| string | 格式化后的相对时间。 |
**示例:**
```
```
js
var
relativetimefmt
=
new
Intl
.
RelativeTimeFormat
(
"
zh-CN
"
);
relativetimefmt
.
format
(
3
,
"
quarter
"
)
```
...
...
@@ -669,7 +669,7 @@ formatToParts(value: number, unit: string): Array<object>
| Array
<
object
>
| 返回可用于自定义区域设置格式的相对时间格式的对象数组。 |
**示例:**
```
```
js
var
relativetimefmt
=
new
Intl
.
RelativeTimeFormat
(
"
en
"
,
{
"
numeric
"
:
"
auto
"
});
var
parts
=
relativetimefmt
.
format
(
10
,
"
seconds
"
);
```
...
...
@@ -689,17 +689,17 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
|
[
RelativeTimeFormatResolvedOptions
](
#relativetimeformatresolvedoptions
)
| RelativeTimeFormat
对象的格式化选项。 |
**示例:**
```
```
js
var
relativetimefmt
=
new
Intl
.
RelativeTimeFormat
(
"
en-GB
"
);
relativetimefmt
.
resolvedOptions
();
```
## RelativeTimeFormatInputOptions<sup>8+</sup>
<a name=relativetimeformatinputoptions></a>
## RelativeTimeFormatInputOptions<sup>8+</sup>
表示RelativeTimeFormat对象可设置的属性。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Global.I18n
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- |
...
...
@@ -708,11 +708,11 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
| style | string | 是 | 是 | 国际化消息的长度,取值包括:"long",
"short",
"narrow"。 |
## RelativeTimeFormatResolvedOptions<sup>8+</sup>
<a name=relativetimeformatresolvedoptions></a>
## RelativeTimeFormatResolvedOptions<sup>8+</sup>
表示RelativeTimeFormat对象可设置的属性。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Global.I18n
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------ | ---- | ---- | ---------------------------------------- |
...
...
zh-cn/application-dev/reference/apis/js-apis-keycode.md
浏览文件 @
0c252a6a
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
浏览文件 @
0c252a6a
...
...
@@ -2,7 +2,8 @@
KeyEvent模块提供了设备可以上报的按键事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
@@ -13,39 +14,39 @@ import {Action,Key,KeyEvent} from '@ohos.multimodalInput.keyEvent';
## Action
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| ------
-- | -------- | -------- | -------- | ----
---- |
| CANCEL | number | 是
| 否 | 取消
|
| DOWN
| number | 是 | 否
| 按下按钮 |
| UP
| number | 是 | 否
| 抬起按钮 |
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| ------
| ------ | ---- | ---- |
---- |
| CANCEL | number | 是
| 否 | 取消
|
| DOWN
| number | 是 | 否
| 按下按钮 |
| UP
| number | 是 | 否
| 抬起按钮 |
## Key
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
| -------- | -------- | -------- | --
------ |
| code
| KeyCode | 是 | 否 | 按键码
|
| pressedTime | number
| 是 | 否 | 按下时间
|
| deviceId
| number | 是 | 否
| 按键所属设备 |
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
--- | ------- | ---- | ---- |
------ |
| code
| KeyCode | 是 | 否 | 按键码
|
| pressedTime | number
| 是 | 否 | 按下时间
|
| deviceId
| number | 是 | 否
| 按键所属设备 |
## KeyEvent
**系统能力**
:以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| action | Action | 是 | 否 | 按键动作 |
| key | Key | 是 | 否 | 当前发生变化的按键 |
| unicodeChar | number | 是 | 否 | 按键对应的uniCode字符 |
| keys | Key[] | 是 | 否 | 当前处于按下状态的按键列表 |
| ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 |
| altKey | boolean | 是 | 否 | 当前altKey是否处于按下状态 |
| shiftKey | boolean | 是 | 否 | 当前shiftKey是否处于按下状态 |
| logoKey | boolean | 是 | 否 | 当前logoKey是否处于按下状态 |
| fnKey | boolean | 是 | 否 | 当前fnKey是否处于按下状态 |
| capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 |
| numLock | boolean | 是 | 否 | 当前numLock是否处于激活状态 |
| scrollLock | boolean | 是 | 否 | 当前scrollLock是否处于激活状态 |
\ No newline at end of file
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| ----------- | ------- | ---- | ---- | -------------------- |
| action | Action | 是 | 否 | 按键动作 |
| key | Key | 是 | 否 | 当前发生变化的按键 |
| unicodeChar | number | 是 | 否 | 按键对应的uniCode字符 |
| keys | Key[] | 是 | 否 | 当前处于按下状态的按键列表 |
| ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 |
| altKey | boolean | 是 | 否 | 当前altKey是否处于按下状态 |
| shiftKey | boolean | 是 | 否 | 当前shiftKey是否处于按下状态 |
| logoKey | boolean | 是 | 否 | 当前logoKey是否处于按下状态 |
| fnKey | boolean | 是 | 否 | 当前fnKey是否处于按下状态 |
| capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 |
| numLock | boolean | 是 | 否 | 当前numLock是否处于激活状态 |
| scrollLock | boolean | 是 | 否 | 当前scrollLock是否处于激活状态 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
浏览文件 @
0c252a6a
...
...
@@ -3,6 +3,7 @@
提供根据不同媒体类型定义不同的样式。
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -118,7 +119,7 @@ off(type: 'change', callback?: Callback<MediaQueryResult>): void
### 示例
```
j
s
```
t
s
import
mediaquery
from
'
@ohos.mediaquery
'
let
portraitFunc
=
null
...
...
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
浏览文件 @
0c252a6a
...
...
@@ -2,7 +2,7 @@
设备上报的鼠标事件。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
@@ -13,77 +13,77 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
## Action
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
| -------- | -------- | -------- |
-------- |
| CANCEL
| number | 是 | 否 | 取消
|
| MOVE
| number | 是 | 否 | 鼠标移动
|
| BUTTON_DOWN | number | 是
| 否 | 鼠标按钮按下
|
| BUTTON_UP
| number | 是 | 否 | 鼠标按钮抬起
|
| AXIS_BEGIN
| number | 是 | 否
| 鼠标关联的轴事件开始 |
| AXIS_UPDATE | number | 是
| 否
| 鼠标关联的轴事件更新 |
| AXIS_END
| number | 是 | 否
| 鼠标关联的轴事件结束 |
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
--- | ------ | ---- | ---- | --
-------- |
| CANCEL
| number | 是 | 否 | 取消
|
| MOVE
| number | 是 | 否 | 鼠标移动
|
| BUTTON_DOWN | number | 是
| 否 | 鼠标按钮按下
|
| BUTTON_UP
| number | 是 | 否 | 鼠标按钮抬起
|
| AXIS_BEGIN
| number | 是 | 否
| 鼠标关联的轴事件开始 |
| AXIS_UPDATE | number | 是
| 否
| 鼠标关联的轴事件更新 |
| AXIS_END
| number | 是 | 否
| 鼠标关联的轴事件结束 |
## Button
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| -------
- | -------- | -------- | -------- | ---
----- |
| LEFT
| number | 是 | 否 | 鼠标左键
|
| MIDDLE
| number | 是 | 否 | 鼠标中键
|
| RIGHT
| number | 是 | 否 | 鼠标右键
|
| SIDE
| number | 是 | 否
| 鼠标侧边键 |
| EXTRA
| number | 是 | 否
| 鼠标扩展键 |
| FORWARD | number | 是
| 否
| 鼠标前进键 |
| BACK
| number | 是 | 否
| 鼠标后退键 |
| TASK
| number | 是 | 否
| 鼠标任务键 |
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| -------
| ------ | ---- | ---- |
----- |
| LEFT
| number | 是 | 否 | 鼠标左键
|
| MIDDLE
| number | 是 | 否 | 鼠标中键
|
| RIGHT
| number | 是 | 否 | 鼠标右键
|
| SIDE
| number | 是 | 否
| 鼠标侧边键 |
| EXTRA
| number | 是 | 否
| 鼠标扩展键 |
| FORWARD | number | 是
| 否
| 鼠标前进键 |
| BACK
| number | 是 | 否
| 鼠标后退键 |
| TASK
| number | 是 | 否
| 鼠标任务键 |
## Axis
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
| -------- | -------- | -------- | ---
----- |
| SCROLL_VERTICAL
| number | 是 | 否
| 垂直滚动轴 |
| SCROLL_HORIZONTAL | number | 是
| 否
| 水平滚动轴 |
| PINCH
| number | 是 | 否 | 捏合轴
|
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
--------- | ------ | ---- | ---- |
----- |
| SCROLL_VERTICAL
| number | 是 | 否
| 垂直滚动轴 |
| SCROLL_HORIZONTAL | number | 是
| 否
| 水平滚动轴 |
| PINCH
| number | 是 | 否 | 捏合轴
|
## AxisValue
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| -----
--- | -------- | -------- | -------- | ----
---- |
| axis
| Axis | 是 | 否 | 轴类型
|
| value | number | 是
| 否 | 轴的值
|
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| -----
| ------ | ---- | ---- |
---- |
| axis
| Axis | 是 | 否 | 轴类型
|
| value | number | 是
| 否 | 轴的值
|
## MouseEvent
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
| -------- | -------- | -------- |
-------- |
| action
| Action | 是 | 否 | 鼠标事件动作
|
| screenX
| number | 是 | 否 | 鼠标光标在屏幕中的x坐标
|
| screenY
| number | 是 | 否 | 鼠标光标在屏幕中的y坐标
|
| windowX
| number | 是 | 否 | 鼠标归属窗口的x坐标
|
| windowY
| number | 是 | 否 | 鼠标归属窗口的y坐标
|
| rawDeltaX
| number | 是 | 否
| X轴相对上次上报鼠标位置的偏移,在屏幕边缘位置时,该值可能小于两次鼠标上报的坐标差 |
| rawDeltaY
| number | 是 | 否 | Y轴相对上次上报鼠标位置的偏移
|
| button
| Button | 是 | 否 | 当前按下/抬起的按钮
|
| pressedButtons | Button[]
| 是 | 否 | 当前处于按下状态的按钮
|
| axes
| AxisValue[] | 是 | 否 | 事件包含的所有轴数据
|
| pressedKeys
| KeyCode[] | 是 | 否 | 当前处于按下状态的按键列表
|
| ctrlKey
| boolean | 是 | 否 | 当前ctrlKey是否处于按下状态
|
| altKey
| boolean | 是 | 否 | 当前altKey是否处于按下状态
|
| shiftKey
| boolean | 是 | 否 | 当前shiftKey是否处于按下状态
|
| logoKey
| boolean | 是 | 否 | 当前logoKey是否处于按下状态
|
| fnKey
| boolean | 是 | 否 | 当前fnKey是否处于按下状态
|
| capsLock
| boolean | 是 | 否 | 当前capsLock是否处于激活状态
|
| numLock
| boolean | 是 | 否 | 当前numLock是否处于激活状态
|
| scrollLock
| boolean | 是 | 否 | 当前scrollLock是否处于激活状态
|
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
------ | ----------- | ---- | ---- | --------------------------------
-------- |
| action
| Action | 是 | 否 | 鼠标事件动作
|
| screenX
| number | 是 | 否 | 鼠标光标在屏幕中的x坐标
|
| screenY
| number | 是 | 否 | 鼠标光标在屏幕中的y坐标
|
| windowX
| number | 是 | 否 | 鼠标归属窗口的x坐标
|
| windowY
| number | 是 | 否 | 鼠标归属窗口的y坐标
|
| rawDeltaX
| number | 是 | 否
| X轴相对上次上报鼠标位置的偏移,在屏幕边缘位置时,该值可能小于两次鼠标上报的坐标差 |
| rawDeltaY
| number | 是 | 否 | Y轴相对上次上报鼠标位置的偏移
|
| button
| Button | 是 | 否 | 当前按下/抬起的按钮
|
| pressedButtons | Button[]
| 是 | 否 | 当前处于按下状态的按钮
|
| axes
| AxisValue[] | 是 | 否 | 事件包含的所有轴数据
|
| pressedKeys
| KeyCode[] | 是 | 否 | 当前处于按下状态的按键列表
|
| ctrlKey
| boolean | 是 | 否 | 当前ctrlKey是否处于按下状态
|
| altKey
| boolean | 是 | 否 | 当前altKey是否处于按下状态
|
| shiftKey
| boolean | 是 | 否 | 当前shiftKey是否处于按下状态
|
| logoKey
| boolean | 是 | 否 | 当前logoKey是否处于按下状态
|
| fnKey
| boolean | 是 | 否 | 当前fnKey是否处于按下状态
|
| capsLock
| boolean | 是 | 否 | 当前capsLock是否处于激活状态
|
| numLock
| boolean | 是 | 否 | 当前numLock是否处于激活状态
|
| scrollLock
| boolean | 是 | 否 | 当前scrollLock是否处于激活状态
|
zh-cn/application-dev/reference/apis/js-apis-prompt.md
浏览文件 @
0c252a6a
...
...
@@ -8,7 +8,7 @@
## 导入模块
```
```
js
import
prompt
from
'
@ohos.prompt
'
```
...
...
@@ -26,15 +26,11 @@ showToast(options: ShowToastOptions): void
| options |
[
ShowToastOptions
](
#showtoastoptions
)
| 是 | 文本弹窗选项。 |
**示例:**
```
export default {
showToast() {
prompt.showToast({
message: 'Message Info',
duration: 2000,
});
}
}
```
js
prompt
.
showToast
({
message
:
'
Message Info
'
,
duration
:
2000
,
});
```
## ShowToastOptions
...
...
@@ -42,11 +38,11 @@ showToast(options: ShowToastOptions): void
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型
| 必填
| 说明 |
| -------- | --------------
|
---- | ---------------------------------------- |
| message | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
<sup>
9+
</sup>
| 是
| 显示的文本信息。
|
| duration | number
| 否
| 默认值1500ms,建议区间:1500ms-10000ms,若小于1500ms则取默认值。 |
| bottom | string
| number | 否 | 设置弹窗边框距离屏幕底部的位置。
|
| 名称 | 类型
| 必填
| 说明 |
| -------- | --------------
-------------------------- | --
---- | ---------------------------------------- |
| message | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
<sup>
9+
</sup>
| 是
| 显示的文本信息。
|
| duration | number
| 否
| 默认值1500ms,建议区间:1500ms-10000ms,若小于1500ms则取默认值。 |
| bottom | string
| number | 否
|
## prompt.showDialog
...
...
@@ -69,31 +65,27 @@ showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse>
**示例:**
```
export default {
showDialog() {
prompt.showDialog({
title: 'Title Info',
message: 'Message Info',
buttons: [
{
text: 'button1',
color: '#000000',
},
{
text: 'button2',
color: '#000000',
}
],
})
.then(data => {
console.info('showDialog success, click button: ' + data.index);
})
.catch(err => {
console.info('showDialog error: ' + err);
})
```
js
prompt
.
showDialog
({
title
:
'
Title Info
'
,
message
:
'
Message Info
'
,
buttons
:
[
{
text
:
'
button1
'
,
color
:
'
#000000
'
,
},
{
text
:
'
button2
'
,
color
:
'
#000000
'
,
}
}
],
})
.
then
(
data
=>
{
console
.
info
(
'
showDialog success, click button:
'
+
data
.
index
);
})
.
catch
(
err
=>
{
console
.
info
(
'
showDialog error:
'
+
err
);
})
```
## prompt.showDialog
...
...
@@ -112,32 +104,27 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc
| callback | AsyncCallback
<
[ShowDialogSuccessResponse](#showdialogsuccessresponse)
>
| 是 | 对话框响应结果回调。 |
**示例:**
```
export default
{
callback(err, data) {
if(err) {
console.info('showDialog err: ' + err);
return;
}
co
nsole.info('showDialog success callback, click button: ' + data.index);
```
js
prompt
.
showDialog
(
{
title
:
'
showDialog Title Info
'
,
message
:
'
Message Info
'
,
buttons
:
[
{
text
:
'
button1
'
,
co
lor
:
'
#000000
'
,
},
showDialog() {
prompt.showDialog({
title: 'showDialog Title Info',
message: 'Message Info',
buttons: [
{
text: 'button1',
color: '#000000',
},
{
text: 'button2',
color: '#000000',
}
]
}, this.callback);
{
text
:
'
button2
'
,
color
:
'
#000000
'
,
}
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
info
(
'
showDialog err:
'
+
err
);
return
;
}
console
.
info
(
'
showDialog success callback, click button:
'
+
data
.
index
);
});
```
## ShowDialogOptions
...
...
@@ -146,11 +133,11 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------------------------- |
| 名称 | 类型
| 必填 | 说明 |
| ------- | ------
----------------------------------
| ---- | ---------------------------------------- |
| title | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
<sup>
9+
</sup>
| 否 | 标题文本。 |
| message | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
<sup>
9+
</sup>
| 否 | 内容文本。 |
| buttons | Array | 否 | 对话框中按钮的数组,结构为:{text:'button',
color:
'
\#
666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 |
| buttons | Array
| 否 | 对话框中按钮的数组,结构为:{text:'button',
color:
'
\#
666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 |
## ShowDialogSuccessResponse
...
...
@@ -179,31 +166,26 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenu
**示例:**
```
export default {
callback(err, data) {
if(err) {
console.info('showActionMenu err: ' + err);
return;
}
console.info('showActionMenu success callback, click button: ' + data.index);
```
js
prompt
.
showActionMenu
({
title
:
'
Title Info
'
,
buttons
:
[
{
text
:
'
item1
'
,
color
:
'
#666666
'
,
},
showActionMenu() {
prompt.showActionMenu({
title: 'Title Info',
buttons: [
{
text: 'item1',
color: '#666666',
},
{
text: 'item2',
color: '#000000',
},
]
}, this.callback)
}
{
text
:
'
item2
'
,
color
:
'
#000000
'
,
},
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
info
(
'
showActionMenu err:
'
+
err
);
return
;
}
console
.
info
(
'
showActionMenu success callback, click button:
'
+
data
.
index
);
})
```
## prompt.showActionMenu
...
...
@@ -225,47 +207,43 @@ showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse
| Promise
<
[ActionMenuSuccessResponse](#actionmenusuccessresponse)
>
| 菜单响应结果。 |
**示例:**
```
export default {
showActionMenu() {
prompt.showActionMenu({
title: 'showActionMenu Title Info',
buttons: [
{
text: 'item1',
color: '#666666',
},
{
text: 'item2',
color: '#000000',
},
]
})
.then(data => {
console.info('showActionMenu success, click button: ' + data.index);
})
.catch(err => {
console.info('showActionMenu error: ' + err);
})
}
}
```
js
prompt
.
showActionMenu
({
title
:
'
showActionMenu Title Info
'
,
buttons
:
[
{
text
:
'
item1
'
,
color
:
'
#666666
'
,
},
{
text
:
'
item2
'
,
color
:
'
#000000
'
,
},
]
})
.
then
(
data
=>
{
console
.
info
(
'
showActionMenu success, click button:
'
+
data
.
index
);
})
.
catch
(
err
=>
{
console
.
info
(
'
showActionMenu error:
'
+
err
);
})
```
## ActionMenuOptions
操作菜单的选项。
**系统能力:**
以下各项对应的系统能力均为
SystemCapability.ArkUI.ArkUI.Full。
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------------------------- |
| 名称 | 类型
| 必填 | 说明 |
| ------- | ------
----------------------------------
| ---- | ---------------------------------------- |
| title | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
<sup>
9+
</sup>
| 否 | 标题文本。 |
| buttons | Array
<
[Button](#button)
>
| 是 | 菜单中菜单项按钮的数组,结构为:{text:'button',
color:
'
\#
666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 |
| buttons | Array
<
[Button](#button)
>
| 是 | 菜单中菜单项按钮的数组,结构为:{text:'button',
color:
'
\#
666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 |
## ActionMenuSuccessResponse
操作菜单的响应结果。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------------------------ |
...
...
@@ -275,10 +253,10 @@ showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse
菜单中的菜单项按钮。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型
| 必填 | 说明
|
| ----- | ------
| ---- | -----------------
------- |
| text | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
<sup>
9+
</sup>
| 是 | 按钮文本内容。 |
| 名称 | 类型
| 必填 | 说明
|
| ----- | ------
---------------------------------- | ---- |
------- |
| text
| string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
<sup>
9+
</sup>
| 是 | 按钮文本内容。 |
| color | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
<sup>
9+
</sup>
| 是 | 按钮文本颜色。 |
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
浏览文件 @
0c252a6a
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
浏览文件 @
0c252a6a
...
...
@@ -2,7 +2,8 @@
设备上报的触屏事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
@@ -13,72 +14,72 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
## Action
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| ------
-- | -------- | -------- | -------- | ----
---- |
| CANCEL | number | 是
| 否
| 触摸取消 |
| DOWN
| number | 是 | 否
| 触摸按下 |
| MOVE
| number | 是 | 否
| 触摸移动 |
| UP
| number | 是 | 否
| 触摸抬起 |
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| ------
| ------ | ---- | ---- |
---- |
| CANCEL | number | 是
| 否
| 触摸取消 |
| DOWN
| number | 是 | 否
| 触摸按下 |
| MOVE
| number | 是 | 否
| 触摸移动 |
| UP
| number | 是 | 否
| 触摸抬起 |
## ToolType
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| -------- | ------
-- | -------- | -------- | ----
---- |
| FINGER
| number | 是 | 否 | 手指
|
| PEN
| number | 是 | 否 | 笔
|
| RUBBER
| number | 是 | 否 | 橡皮擦
|
| BRUSH
| number | 是 | 否 | 笔刷
|
| PENCIL
| number | 是 | 否 | 铅笔
|
| AIRBRUSH | number | 是
| 否 | 气笔
|
| MOUSE
| number | 是 | 否 | 鼠标
|
| LENS
| number | 是 | 否 | 透镜
|
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| -------- | ------
| ---- | ---- |
---- |
| FINGER
| number | 是 | 否 | 手指
|
| PEN
| number | 是 | 否 | 笔
|
| RUBBER
| number | 是 | 否 | 橡皮擦
|
| BRUSH
| number | 是 | 否 | 笔刷
|
| PENCIL
| number | 是 | 否 | 铅笔
|
| AIRBRUSH | number | 是
| 否 | 气笔
|
| MOUSE
| number | 是 | 否 | 鼠标
|
| LENS
| number | 是 | 否 | 透镜
|
## SourceType
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
| -------- | -------- | -------- | ----
---- |
| TOUCH_SCREEN | number | 是
| 否 | 触摸屏
|
| PEN
| number | 是 | 否 | 手写笔
|
| TOUCH_PAD
| number | 是 | 否 | 触摸板
|
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
---- | ------ | ---- | ---- |
---- |
| TOUCH_SCREEN | number | 是
| 否 | 触摸屏
|
| PEN
| number | 是 | 否 | 手写笔
|
| TOUCH_PAD
| number | 是 | 否 | 触摸板
|
## Touch
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
| -------- | -------- | -------- |
-------- |
| id
| number | 是 | 否 | 指针标识
|
| pressedTime
| number | 是 | 否 | 按下时的时间戳
|
| screenX
| number | 是 | 否 | 触摸位置所属的屏幕x坐标
|
| screenY
| number | 是 | 否 | 触摸位置所属的屏幕y坐标
|
| windowX
| number | 是 | 否 | 触摸位置在窗口中的x坐标
|
| windowY
| number | 是 | 否 | 触摸位置在窗口中的y坐标
|
| pressure
| number | 是 | 否 | 压力值,取值范围是[0.0, 1.0], 0.0表示不支持
|
| width
| number | 是 | 否 | 按下接触区域的宽度
|
| height
| number | 是 | 否 | 按下接触区域的高度
|
| tiltX
| number | 是 | 否
| 相对YZ平面的角度,取值的范围[-90, 90],其中正值是向右倾斜。 |
| tiltY
| number | 是 | 否 | 相对XZ平面的角度,值的范围[-90, 90],其中正值是向下倾斜。
|
| toolX
| number | 是 | 否 | 工具区域的中心点X
|
| toolY
| number | 是 | 否 | 工具区域的中心点Y
|
| toolWidth
| number | 是 | 否 | 工具区域宽度
|
| toolHeight
| number | 是 | 否 | 工具区域高度
|
| rawX
| number | 是 | 否 | 输入设备上的x坐标
|
| rawY
| number | 是 | 否 | 输入设备上的y坐标
|
| toolType
| number | 是 | 否 | 工具类型
|
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
--- | ------ | ---- | ---- | ---------------------------
-------- |
| id
| number | 是 | 否 | 指针标识
|
| pressedTime
| number | 是 | 否 | 按下时的时间戳
|
| screenX
| number | 是 | 否 | 触摸位置所属的屏幕x坐标
|
| screenY
| number | 是 | 否 | 触摸位置所属的屏幕y坐标
|
| windowX
| number | 是 | 否 | 触摸位置在窗口中的x坐标
|
| windowY
| number | 是 | 否 | 触摸位置在窗口中的y坐标
|
| pressure
| number | 是 | 否 | 压力值,取值范围是[0.0, 1.0], 0.0表示不支持
|
| width
| number | 是 | 否 | 按下接触区域的宽度
|
| height
| number | 是 | 否 | 按下接触区域的高度
|
| tiltX
| number | 是 | 否
| 相对YZ平面的角度,取值的范围[-90, 90],其中正值是向右倾斜。 |
| tiltY
| number | 是 | 否 | 相对XZ平面的角度,值的范围[-90, 90],其中正值是向下倾斜。
|
| toolX
| number | 是 | 否 | 工具区域的中心点X
|
| toolY
| number | 是 | 否 | 工具区域的中心点Y
|
| toolWidth
| number | 是 | 否 | 工具区域宽度
|
| toolHeight
| number | 是 | 否 | 工具区域高度
|
| rawX
| number | 是 | 否 | 输入设备上的x坐标
|
| rawY
| number | 是 | 否 | 输入设备上的y坐标
|
| toolType
| number | 是 | 否 | 工具类型
|
## TouchEvent
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.MultimodalInput.Input.Core
**系统能力**
:SystemCapability.MultimodalInput.Input.Core
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
| -------- | -------- | -------- |
-------- |
| action
| Action | 是 | 否 | 触摸动作
|
| touch
| Touch | 是 | 否 | 当前触摸点
|
| touches
| Touch[] | 是 | 否 | 所有触摸点
|
| sourceType | SourceType | 是
| 否
| 触摸来源的设备类型 |
| 名称
| 参数类型 | 可读 | 可写 | 描述
|
| --------
-- | ---------- | ---- | ---- | -
-------- |
| action
| Action | 是 | 否 | 触摸动作
|
| touch
| Touch | 是 | 否 | 当前触摸点
|
| touches
| Touch[] | 是 | 否 | 所有触摸点
|
| sourceType | SourceType | 是
| 否
| 触摸来源的设备类型 |
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @
0c252a6a
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
浏览文件 @
0c252a6a
...
...
@@ -4,13 +4,13 @@
开发者在开发应用时,通过调用延迟任务注册接口,注册对实时性要求不高的延迟任务,该任务默认由系统安排,在系统空闲时根据性能、功耗、热等情况进行调度执行。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> **说明:**
>
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
```
js
import
workScheduler
from
'
@ohos.workScheduler
'
```
...
...
@@ -35,7 +35,7 @@ startWork(work: WorkInfo): boolean
**示例**
:
```
```
js
let
workInfo
=
{
workId
:
1
,
batteryLevel
:
50
,
...
...
@@ -71,7 +71,7 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
**示例**
:
```
```
js
let
workInfo
=
{
workId
:
1
,
batteryLevel
:
50
,
...
...
@@ -101,7 +101,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
**示例**
:
```
```
js
workScheduler
.
getWorkStatus
(
50
,
(
err
,
res
)
=>
{
if
(
err
)
{
console
.
info
(
'
workschedulerLog getWorkStatus failed, because:
'
+
err
.
code
);
...
...
@@ -134,7 +134,7 @@ getWorkStatus(workId: number): Promise\<WorkInfo>
**示例**
:
```
```
js
workScheduler
.
getWorkStatus
(
50
).
then
((
res
)
=>
{
for
(
let
item
in
res
)
{
console
.
info
(
'
workschedulerLog getWorkStatus success,
'
+
item
+
'
is:
'
+
res
[
item
]);
...
...
@@ -165,7 +165,7 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
**示例**
:
```
```
js
workScheduler
.
obtainAllWorks
((
err
,
res
)
=>
{
if
(
err
)
{
console
.
info
(
'
workschedulerLog obtainAllWorks failed, because:
'
+
err
.
code
);
...
...
@@ -190,7 +190,7 @@ obtainAllWorks(): Promise<Array\<WorkInfo>>
**示例**
:
```
```
js
workScheduler
.
obtainAllWorks
().
then
((
res
)
=>
{
console
.
info
(
'
workschedulerLog obtainAllWorks success, data is:
'
+
JSON
.
stringify
(
res
));
}).
catch
((
err
)
=>
{
...
...
@@ -207,7 +207,7 @@ stopAndClearWorks(): boolean
**示例**
:
```
```
js
let
res
=
workScheduler
.
stopAndClearWorks
();
console
.
info
(
"
workschedulerLog res:
"
+
res
);
```
...
...
@@ -234,7 +234,7 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
**示例**
:
```
```
js
workScheduler
.
isLastWorkTimeOut
(
500
,
(
err
,
res
)
=>
{
if
(
err
)
{
console
.
info
(
'
workschedulerLog isLastWorkTimeOut failed, because:
'
+
err
.
code
);
...
...
@@ -265,7 +265,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**示例**
:
```
```
js
workScheduler
.
isLastWorkTimeOut
(
500
)
.
then
(
res
=>
{
console
.
info
(
'
workschedulerLog isLastWorkTimeOut success, data is:
'
+
res
);
...
...
@@ -278,30 +278,30 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## WorkInfo
提供工作的具体信息。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.ResourceSchedule.WorkScheduler
| 参数名
| 类型 | 必填 | 说明
|
| --------------- | --------------------------------- | ---- | ----------------
----------------
|
| workId | number | 是
| 当前工作的ID
|
| bundleName | string | 是
| 延迟任务包名
|
| abilityName | string | 是 | 延迟任务回调通知的组件名(必填) |
| networkType |
[
NetworkType
](
#networktype
)
| 否
| 网络类型
|
| isCharging | boolean | 否
| 是否充电
|
| chargerType |
[
ChargingType
](
#chargingtype
)
| 否
| 充电类型
|
| batteryLevel | number | 否
| 电量
|
| batteryStatus |
[
BatteryStatus
](
#batterystatus
)
| 否
| 电池状态
|
| storageRequest |
[
StorageRequest
](
#storagerequest
)
| 否
| 存储状态
|
| isRepeat | boolean | 否
| 是否循环任务
|
| repeatCycleTime | number | 否
| 循环间隔
|
| repeatCount | number | 否
| 循环次数
|
| isPersisted | boolean | 否
| 是否持久化保存工作
|
| isDeepIdle | boolean | 否
| 是否要求设备进入空闲状态
|
| idleWaitTime | number | 否
| 空闲等待时间
|
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
| 参数名
| 类型 | 必填 | 说明
|
| --------------- | --------------------------------- | ---- | ---------------- |
| workId | number | 是
| 当前工作的ID
|
| bundleName | string | 是
| 延迟任务包名
|
| abilityName | string | 是
| 延迟任务回调通知的组件名(必填) |
| networkType |
[
NetworkType
](
#networktype
)
| 否
| 网络类型
|
| isCharging | boolean | 否
| 是否充电
|
| chargerType |
[
ChargingType
](
#chargingtype
)
| 否
| 充电类型
|
| batteryLevel | number | 否
| 电量
|
| batteryStatus |
[
BatteryStatus
](
#batterystatus
)
| 否
| 电池状态
|
| storageRequest |
[
StorageRequest
](
#storagerequest
)
| 否
| 存储状态
|
| isRepeat | boolean | 否
| 是否循环任务
|
| repeatCycleTime | number | 否
| 循环间隔
|
| repeatCount | number | 否
| 循环次数
|
| isPersisted | boolean | 否
| 是否持久化保存工作
|
| isDeepIdle | boolean | 否
| 是否要求设备进入空闲状态
|
| idleWaitTime | number | 否
| 空闲等待时间
|
## NetworkType
触发工作的网络类型。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 |
| ---------------------- | ---- | ----------------------- |
...
...
@@ -315,7 +315,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## ChargingType
触发工作的充电类型。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 |
| ------------------------- | ---- | -------------------- |
...
...
@@ -327,7 +327,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## BatteryStatus
触发工作的电池状态。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 |
| -------------------------- | ---- | -------------------------- |
...
...
@@ -338,10 +338,10 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## StorageRequest
触发工作的存储状态。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明|
| -------- | -------- | -------- |
|STORAGE_LEVEL_LOW |0 |表示这个触发条件是存储空间不足。
|STORAGE_LEVEL_OKAY |1 |表示这个触发条件是从存储空间不足恢复到正常。
|STORAGE_LEVEL_LOW_OR_OKAY |2 |表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。
\ No newline at end of file
| 名称 | 默认值 | 说明 |
| ------------------------- | ---- | ------------------------------ |
| STORAGE_LEVEL_LOW | 0 | 表示这个触发条件是存储空间不足。 |
| STORAGE_LEVEL_OKAY | 1 | 表示这个触发条件是从存储空间不足恢复到正常。 |
| STORAGE_LEVEL_LOW_OR_OKAY | 2 | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 |
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录