Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 0c252a6a 编写于 作者: H HelloCrease
浏览文件
操作

update docs 

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