Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“6baeb2d1066b58be0f64d3f864b6e3aea0f5974d”上不存在“paddle/phi/git@gitcode.net:BaiXuePrincess/Paddle.git”
提交 c03c6458 编写于 作者: H HelloCrease
浏览文件
操作

update docs 

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 35c372eb
展开全部 隐藏空白更改
内联 并排
Showing with 940 addition and 931 deletion
zh-cn/application-dev/Readme-CN.md
浏览文件 @ c03c6458
...@@ -29,8 +29,7 @@ ...@@ -29,8 +29,7 @@
- [数据管理](database/Readme-CN.md) - [数据管理](database/Readme-CN.md)
- [电话服务](telephony/Readme-CN.md) - [电话服务](telephony/Readme-CN.md)
- [后台代理提醒](background-agent-scheduled-reminder/Readme-CN.md) - [后台代理提醒](background-agent-scheduled-reminder/Readme-CN.md)
- [后台任务管理](background-task-management/Readme-CN.md) - [任务管理](task-management/Readme-CN.md)
- [延迟任务调度](work-scheduler/Readme-CN.md)
- [设备管理](device/Readme-CN.md) - [设备管理](device/Readme-CN.md)
- [设备使用信息统计](device-usage-statistics/Readme-CN.md) - [设备使用信息统计](device-usage-statistics/Readme-CN.md)
- [DFX](dfx/Readme-CN.md) - [DFX](dfx/Readme-CN.md)
......
zh-cn/application-dev/application-dev-guide-for-gitee.md
浏览文件 @ c03c6458
...@@ -31,7 +31,7 @@ ...@@ -31,7 +31,7 @@
- [网络与连接](connectivity/Readme-CN.md) - [网络与连接](connectivity/Readme-CN.md)
- [数据管理](database/Readme-CN.md) - [数据管理](database/Readme-CN.md)
- [后台代理提醒](background-agent-scheduled-reminder/Readme-CN.md) - [后台代理提醒](background-agent-scheduled-reminder/Readme-CN.md)
- [后台任务管理](background-task-management/Readme-CN.md) - [任务管理](task-management/Readme-CN.md)
- [设备管理](device/Readme-CN.md) - [设备管理](device/Readme-CN.md)
- [设备使用信息统计](device-usage-statistics/Readme-CN.md) - [设备使用信息统计](device-usage-statistics/Readme-CN.md)
- [DFX](dfx/Readme-CN.md) - [DFX](dfx/Readme-CN.md)
...@@ -53,9 +53,9 @@ API参考提供了OpenHarmony全量组件和接口的参考文档，可以帮助 ...@@ -53,9 +53,9 @@ API参考提供了OpenHarmony全量组件和接口的参考文档，可以帮助
内容包括： 内容包括：
- [组件参考（基于JS扩展的类Web开发范式）](reference/arkui-js/Readme-CN.md) - [组件参考（基于JS扩展的类Web开发范式）](reference/arkui-js/Readme-CN.md)
- [组件参考（基于TS扩展的声明式开发范式）](reference/arkui-ts/Readme-CN.md) - [组件参考（基于TS扩展的声明式开发范式）](reference/arkui-ts/Readme-CN.md)
- 接口参考 - 接口参考
- [JS及TS API参考](reference/apis/Readme-CN.md) - [JS及TS API参考](reference/apis/Readme-CN.md)
- Native API - Native API
- [Native API参考](reference/native-apis/Readme-CN.md) - [Native API参考](reference/native-apis/Readme-CN.md)
- [标准库](reference/native-lib/third_party_libc/musl.md) - [标准库](reference/native-lib/third_party_libc/musl.md)
- [Node_API](reference/native-lib/third_party_napi/napi.md) - [Node_API](reference/native-lib/third_party_napi/napi.md)
......
zh-cn/application-dev/application-dev-guide.md
浏览文件 @ c03c6458
...@@ -31,7 +31,7 @@ ...@@ -31,7 +31,7 @@
- [网络与连接](connectivity/ipc-rpc-overview.md) - [网络与连接](connectivity/ipc-rpc-overview.md)
- [数据管理](database/database-mdds-overview.md) - [数据管理](database/database-mdds-overview.md)
- [后台代理提醒](background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md) - [后台代理提醒](background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md)
- [后台任务管理](background-task-management/background-task-overview.md) - [任务管理](task-management/background-task-overview.md)
- [设备管理](device/usb-overview.md) - [设备管理](device/usb-overview.md)
- [设备使用信息统计](device-usage-statistics/device-usage-statistics-overview.md) - [设备使用信息统计](device-usage-statistics/device-usage-statistics-overview.md)
- [DFX](dfx/hiappevent-overview.md) - [DFX](dfx/hiappevent-overview.md)
......
zh-cn/application-dev/background-task-management/Readme-CN.md 已删除 100644 → 0
浏览文件 @ 35c372eb
# 后台任务管理
- [后台任务概述](background-task-overview.md)
- [后台任务开发指导](background-task-dev-guide.md)
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
浏览文件 @ c03c6458
...@@ -23,9 +23,9 @@ matchMediaSync(condition: string): MediaQueryListener ...@@ -23,9 +23,9 @@ matchMediaSync(condition: string): MediaQueryListener
设置媒体查询的查询条件，并返回对应的监听句柄。 设置媒体查询的查询条件，并返回对应的监听句柄。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- | | --------- | ------ | ---- | ---------------------------------------- |
| condition | string | 是 | 媒体事件的匹配条件。 | | condition | string | 是 | 媒体事件的匹配条件，具体可参考[媒体查询语法规则](/ui/ui-ts-layout-mediaquery.md#媒体查询条件语法规则)。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
......
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
浏览文件 @ c03c6458
# Search # Search
> ![](public_sys-resources/icon-note.gif) **说明：** 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > ![](public_sys-resources/icon-note.gif) **说明：**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
提供搜索框组件，用于提供用户搜索内容的输入区域。 提供搜索框组件，用于提供用户搜索内容的输入区域。
...@@ -18,51 +20,51 @@ Search(options?: { value?: string; placeholder?: string; icon?: string; controll ...@@ -18,51 +20,51 @@ Search(options?: { value?: string; placeholder?: string; icon?: string; controll
- 参数 - 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | ----------- | ---------------- | ---- | ---- | ---------------------------------------- |
| value | string | 否 | - | 搜索文本值。 | | value | string | 否 | - | 搜索文本值。 |
| placeholder | string | 否 | - | 无输入时的提示文本。| | placeholder | string | 否 | - | 无输入时的提示文本。 |
| icon | string | 否 | - | 搜索图标路径，默认使用系统搜索图标，支持的图标格式: svg, jpg和png。 | | icon | string | 否 | - | 搜索图标路径，默认使用系统搜索图标，支持的图标格式: svg, jpg和png。 |
| controller | SearchController | 否 | - | 控制器。| | controller | SearchController | 否 | - | 控制器。 |
## 属性 ## 属性
| 名称 | 参数类型 | 默认值 | 描述 | | 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | | ---------------- | ------------------------------------- | ---- | --------------------- |
| searchButton | string | 无 | 搜索框末尾搜索按钮文本值，默认无搜索按钮。| | searchButton | string | 无 | 搜索框末尾搜索按钮文本值，默认无搜索按钮。 |
| placeholderColor | [ResourceColor](../../ui/ts-types.md) | - | 设置placeholder颜色。| | placeholderColor | [ResourceColor](../../ui/ts-types.md) | - | 设置placeholder颜色。 |
| placeholderFont | [Font](../../ui/ts-types.md) | - | 设置placeholder文本样式。| | placeholderFont | [Font](../../ui/ts-types.md) | - | 设置placeholder文本样式。 |
| textFont | [Font](../../ui/ts-types.md) | - | 设置搜索框内文本样式。| | textFont | [Font](../../ui/ts-types.md) | - | 设置搜索框内文本样式。 |
## 事件 ## 事件
| 名称 | 功能描述 | | 名称 | 功能描述 |
| -------- | -------- | | ---------------------------------------- | ---------------------------------------- |
| onSubmit(callback: (value: string) => void) | 点击搜索图标、搜索按钮或者按下软键盘搜索按钮时触发。<br> -value: 当前输入文本框的内容。| | onSubmit(callback: (value: string) => void) | 点击搜索图标、搜索按钮或者按下软键盘搜索按钮时触发。<br> -value: 当前输入文本框的内容。 |
| onChange(callback: (value: string) => void) | 输入内容发生变化时，触发回调。<br> -value: 当前输入文本框的内容。| | onChange(callback: (value: string) => void) | 输入内容发生变化时，触发回调。<br> -value: 当前输入文本框的内容。 |
| onCopy(callback: (value: string) => void) | 组件触发系统剪切板复制操作。<br> -value: 复制的文本内容。| | onCopy(callback: (value: string) => void) | 组件触发系统剪切板复制操作。<br> -value: 复制的文本内容。 |
| onCut(callback: (value: string) => void) | 组件触发系统剪切板剪切操作。<br> -value: 剪切的文本内容。| | onCut(callback: (value: string) => void) | 组件触发系统剪切板剪切操作。<br> -value: 剪切的文本内容。 |
| onPaste(callback: (value: string) => void) | 组件触发系统剪切板粘贴操作。<br> -value: 粘贴的文本内容。| | onPaste(callback: (value: string) => void) | 组件触发系统剪切板粘贴操作。<br> -value: 粘贴的文本内容。 |
## SearchController ## SearchController
Search组件的控制器，通过它操作Search组件。 Search组件的控制器，通过它操作Search组件。
#### 导入对象 ### 导入对象
``` ```
controller: SearchController = new SearchController() controller: SearchController = new SearchController()
``` ```
#### caretPosition ### caretPosition
creatPosition(value: number): viod caretPosition(value: number): viod
设置输入光标的位置。 设置输入光标的位置。
- 参数 - 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------ | ---- | ---- | --------------------- | | ----- | ------ | ---- | ---- | ----------------- |
| value | number | 是 | - | 从字符串开始到光标所在位置的长度。 | | value | number | 是 | - | 从字符串开始到光标所在位置的长度。 |
......
zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md
浏览文件 @ c03c6458
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
"abilities":[ "abilities":[
{ {
... ...
"permissions": ["ohos.permission.INTERNET], "permissions": ["ohos.permission.INTERNET"],
... ...
} }
] ]
...@@ -30,47 +30,47 @@ ...@@ -30,47 +30,47 @@
Video(value: VideoOptions) Video(value: VideoOptions)
- VideoOptions类型接口说明 - VideoOptions类型接口说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | ------------------- | ---------------------------------------- | ---- | ---------------------------------------- | ---------------------------------------- |
| src | string \| [Resource](../../ui/ts-types.md) | 否 | - | 视频播放源的路径，支持本地视频路径和网络路径。<br>支持在resources下面的video或rawfile文件夹里放置媒体资源。<br>支持dataability://的路径前缀，用于访问通过Data Ability提供的视频路径，具体路径信息详见[Data Ability说明](../../ability/fa-dataability.md)。 | | src | string \| [Resource](../../ui/ts-types.md) | 否 | - | 视频播放源的路径，支持本地视频路径和网络路径。<br>支持在resources下面的video或rawfile文件夹里放置媒体资源。<br>支持dataability://的路径前缀，用于访问通过Data Ability提供的视频路径，具体路径信息详见[Data Ability说明](../../ability/fa-dataability.md)。 |
| currentProgressRate | number&nbsp;\|&nbsp;PlaybackSpeed<sup>8+</sup> | 否 | 1.0&nbsp;\|&nbsp;PlaybackSpeed.<br>Speed_Forward_1_00_X | 视频播放倍速。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;number取值仅支持：0.75，1.0，1.25，1.75，2.0。<br/> | | currentProgressRate | number&nbsp;\|&nbsp;PlaybackSpeed<sup>8+</sup> | 否 | 1.0&nbsp;\|&nbsp;PlaybackSpeed.<br>Speed_Forward_1_00_X | 视频播放倍速。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;number取值仅支持：0.75，1.0，1.25，1.75，2.0。<br/> |
| previewUri | string&nbsp;\|&nbsp;PixelMap<sup>8+</sup>&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md) | 否 | - | 预览图片的路径。 | | previewUri | string&nbsp;\|&nbsp;PixelMap<sup>8+</sup>&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md) | 否 | - | 预览图片的路径。 |
| controller | [VideoController](#videocontroller) | 否 | - | 控制器。 | | controller | [VideoController](#videocontroller) | 否 | - | 控制器。 |
- PlaybackSpeed<sup>8+</sup>类型接口说明 - PlaybackSpeed<sup>8+</sup>类型接口说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------------------- | --------- |
| Speed_Forward_0_75_X | 0.75倍速播放。 | | Speed_Forward_0_75_X | 0.75倍速播放。 |
| Speed_Forward_1_00_X | 1倍速播放。 | | Speed_Forward_1_00_X | 1倍速播放。 |
| Speed_Forward_1_25_X | 1.25倍速播放。 | | Speed_Forward_1_25_X | 1.25倍速播放。 |
| Speed_Forward_1_75_X | 1.75倍速播放。 | | Speed_Forward_1_75_X | 1.75倍速播放。 |
| Speed_Forward_2_00_X | 2倍速播放。 | | Speed_Forward_2_00_X | 2倍速播放。 |
## 属性 ## 属性
| 名称 | 参数类型 | 默认值 | 描述 | | 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | | --------- | ---------------------------------------- | ----- | --------------- |
| muted | boolean | false | 是否静音。 | | muted | boolean | false | 是否静音。 |
| autoPlay | boolean | false | 是否自动播放。 | | autoPlay | boolean | false | 是否自动播放。 |
| controls | boolean | true | 控制视频播放的控制栏是否显示。 | | controls | boolean | true | 控制视频播放的控制栏是否显示。 |
| objectFit | [ImageFit](ts-basic-components-image.md) | Cover | 设置视频显示模式。 | | objectFit | [ImageFit](ts-basic-components-image.md) | Cover | 设置视频显示模式。 |
| loop | boolean | false | 是否单个视频循环播放。 | | loop | boolean | false | 是否单个视频循环播放。 |
## 事件 ## 事件
| 名称 | 功能描述 | | 名称 | 功能描述 |
| -------- | -------- | | ---------------------------------------- | ---------------------------------------- |
| onStart()&nbsp;=&gt;&nbsp;void | 播放时触发该事件。 | | onStart()&nbsp;=&gt;&nbsp;void | 播放时触发该事件。 |
| onPause()&nbsp;=&gt;&nbsp;void | 暂停时触发该事件。 | | onPause()&nbsp;=&gt;&nbsp;void | 暂停时触发该事件。 |
| onFinish()&nbsp;=&gt;&nbsp;void | 播放结束时触发该事件。 | | onFinish()&nbsp;=&gt;&nbsp;void | 播放结束时触发该事件。 |
| onError()&nbsp;=&gt;&nbsp;void | 播放失败时触发该事件。 | | onError()&nbsp;=&gt;&nbsp;void | 播放失败时触发该事件。 |
| onPrepared(event?:&nbsp;{&nbsp;duration:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 视频准备完成时触发该事件，通过duration可以获取视频时长，单位为秒(s)。 | | onPrepared(event?:&nbsp;{&nbsp;duration:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 视频准备完成时触发该事件，通过duration可以获取视频时长，单位为秒(s)。 |
| onSeeking(event?:&nbsp;{&nbsp;time:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 操作进度条过程时上报时间信息，单位为s。 | | onSeeking(event?:&nbsp;{&nbsp;time:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 操作进度条过程时上报时间信息，单位为s。 |
| onSeeked(event?:&nbsp;{&nbsp;time:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 操作进度条完成后，上报播放时间信息，单位为s。 | | onSeeked(event?:&nbsp;{&nbsp;time:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 操作进度条完成后，上报播放时间信息，单位为s。 |
| onUpdate(event?:&nbsp;{&nbsp;time:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 播放进度变化时触发该事件，单位为s，更新时间间隔为250ms。 | | onUpdate(event?:&nbsp;{&nbsp;time:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 播放进度变化时触发该事件，单位为s，更新时间间隔为250ms。 |
## VideoController ## VideoController
...@@ -110,9 +110,9 @@ setCurrentTime(value: number) ...@@ -110,9 +110,9 @@ setCurrentTime(value: number)
指定视频播放的进度位置。 指定视频播放的进度位置。
- 参数 - 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | --------- |
| value | number | 是 | - | 视频播放进度位置。 | | value | number | 是 | - | 视频播放进度位置。 |
### requestFullscreen ### requestFullscreen
...@@ -121,9 +121,9 @@ requestFullscreen(value: boolean) ...@@ -121,9 +121,9 @@ requestFullscreen(value: boolean)
请求全屏播放。 请求全屏播放。
- 参数 - 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ----- | ------- |
| value | number | 是 | false | 是否全屏播放。 | | value | number | 是 | false | 是否全屏播放。 |
### exitFullscreen ### exitFullscreen
...@@ -138,18 +138,18 @@ setCurrentTime(value: number, seekMode: SeekMode) ...@@ -138,18 +138,18 @@ setCurrentTime(value: number, seekMode: SeekMode)
指定视频播放的进度位置，并指定跳转模式。 指定视频播放的进度位置，并指定跳转模式。
- 参数 - 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | ---- | ---- | --------- |
| value | number | 是 | - | 视频播放进度位置。 | | value | number | 是 | - | 视频播放进度位置。 |
| seekMode | SeekMode | 是 | - | 跳转模式。 | | seekMode | SeekMode | 是 | - | 跳转模式。 |
- SeekMode<sup>8+</sup>类型接口说明 - SeekMode<sup>8+</sup>类型接口说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---------------- | -------------- |
| PreviousKeyframe | 跳转到前一个最近的关键帧。 | | PreviousKeyframe | 跳转到前一个最近的关键帧。 |
| NextKeyframe | 跳转到后一个最近的关键帧。 | | NextKeyframe | 跳转到后一个最近的关键帧。 |
| ClosestKeyframe | 跳转到最近的关键帧。 | | ClosestKeyframe | 跳转到最近的关键帧。 |
| Accurate | 精准跳转，不论是否为关键帧。 | | Accurate | 精准跳转，不论是否为关键帧。 |
......
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
浏览文件 @ c03c6458
# 点击事件 # 点击事件
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表 ## 权限列表
...@@ -11,43 +11,44 @@ ...@@ -11,43 +11,44 @@
## 事件 ## 事件
| 名称 | 支持冒泡 | 功能描述 | | 名称 | 支持冒泡 | 功能描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | --------------------------------- |
| onClick(callback:&nbsp;(event?:&nbsp;ClickEvent)&nbsp;=&gt;&nbsp;void) | 否 | 点击动作触发该方法调用，event参数见ClickEvent介绍。 | | onClick(callback:&nbsp;(event?:&nbsp;ClickEvent)&nbsp;=&gt;&nbsp;void) | 否 | 点击动作触发该方法调用，event参数见ClickEvent介绍。 |
### ClickEvent对象说明 ## ClickEvent对象说明
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| -------- | -------- | -------- | | ------------------- | -------------------------------- | ------------------- |
| screenX | number | 点击点相对于设备屏幕左边沿的X坐标。 | | screenX | number | 点击点相对于设备屏幕左边沿的X坐标。 |
| screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。 | | screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。 |
| x | number | 点击点相对于被点击元素左边沿的X坐标。 | | x | number | 点击点相对于被点击元素左边沿的X坐标。 |
| y | number | 点击点相对于被点击元素上边沿的Y坐标。 | | y | number | 点击点相对于被点击元素上边沿的Y坐标。 |
| target<sup>8+</sup> | EventTarget | 被点击元素对象。 | | target<sup>8+</sup> | [EventTarget](#eventtarget8对象说明) | 被点击元素对象。 |
| timestamp | number | 事件时间戳。 | | timestamp | number | 事件时间戳。 |
- EventTarget<sup>8+</sup>对象说明 ## EventTarget<sup>8+</sup>对象说明
| 名称 | 参数类型 | 描述 | | 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- | | ---- | ----------------- | ---------- |
| area | Area | 目标元素的区域信息。 | | area | [Area](area8对象说明) | 目标元素的区域信息。 |
- Area<sup>8+</sup>对象说明 ## Area<sup>8+</sup>对象说明
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| -------- | -------- | -------- | | -------------- | -------------------------- | ------------------- |
| width | number | 目标元素的宽度，单位为vp。 | | width | number | 目标元素的宽度，单位为vp。 |
| height | number | 目标元素的高度，单位为vp。 | | height | number | 目标元素的高度，单位为vp。 |
| position | Position | 目标元素左上角相对父元素左上角的位置。 | | position | [Position](#position8对象说明) | 目标元素左上角相对父元素左上角的位置。 |
| globalPosition | Position | 目标元素左上角相对页面左上角的位置。 | | globalPosition | [Position](#position8对象说明) | 目标元素左上角相对页面左上角的位置。 |
- Position<sup>8+</sup>对象说明 ## Position<sup>8+</sup>对象说明
| 属性名称 | 参数类型 | 描述 | | 属性名称 | 参数类型 | 描述 |
| -------- | -------- | -------- | | ---- | ------ | ----------- |
| x | number | x轴坐标，单位为vp。 | | x | number | x轴坐标，单位为vp。 |
| y | number | y轴坐标，单位为vp。 | | y | number | y轴坐标，单位为vp。 |
## 示例 ## 示例
``` ```ts
// xxx.ets
@Entry @Entry
@Component @Component
struct ClickExample { struct ClickExample {
......
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
浏览文件 @ c03c6458
# 拖拽事件 # 拖拽事件
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 事件 ## 事件
| 名称 | 支持冒泡 | 功能描述 | | 名称 | 支持冒泡 | 功能描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| onDragStart(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;&nbsp;[CustomBuilder](../../ui/ts-types.md)) | 否 | 第一次拖拽此事件绑定的组件时，触发回调。<br/>event：拖拽事件信息，包括拖拽点坐标。<br/>extraParams：拖拽事件额外信息，详见extraParam类型描述。<br/>返回值：当前跟手效果所拖拽的对象，用于显示拖拽时的提示组件。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;-&nbsp;长按150毫秒(ms)可触发拖拽事件。<br/>>&nbsp;-&nbsp;优先级：长按手势配置时间小于等于150毫秒(ms)时，长按手势优先触发，否则拖拽事件优先触发。 | | onDragStart(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;&nbsp;[CustomBuilder](../../ui/ts-types.md)) | 否 | 第一次拖拽此事件绑定的组件时，触发回调。<br/>- event：拖拽事件信息，包括拖拽点坐标。<br/>- extraParams：拖拽事件额外信息，详见extraParam类型描述。<br/>返回值：当前跟手效果所拖拽的对象，用于显示拖拽时的提示组件。<br/>长按150毫秒(ms)可触发拖拽事件。优先级：长按手势配置时间小于等于150毫秒(ms)时，长按手势优先触发，否则拖拽事件优先触发。 |
| onDragEnter(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽进入组件范围内时，触发回调。<br/>event：拖拽事件信息，包括拖拽点坐标。<br/>extraParams：拖拽事件额外信息，详见extraParam类型描述。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;当监听了onDrop事件时，此事件才有效。 | | onDragEnter(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽进入组件范围内时，触发回调。<br/>- event：拖拽事件信息，包括拖拽点坐标。<br/>- extraParams：拖拽事件额外信息，详见extraParam类型描述。<br/>当监听了onDrop事件时，此事件才有效。 |
| onDragMove(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽在组件范围内移动时，触发回调。<br/>event：拖拽事件信息，包括拖拽点坐标。<br/>extraParams：拖拽事件额外信息，详见extraParam类型描述。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;当监听了onDrop事件时，此事件才有效。 | | onDragMove(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽在组件范围内移动时，触发回调。<br/>- event：拖拽事件信息，包括拖拽点坐标。<br/>- extraParams：拖拽事件额外信息，详见extraParam类型描述。<br/>当监听了onDrop事件时，此事件才有效。 |
| onDragLeave(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽离开组件范围内时，触发回调。<br/>event：拖拽事件信息，包括拖拽点坐标。<br/>extraParams：拖拽事件额外信息，详见extraParam类型描述。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;当监听了onDrop事件时，此事件才有效。 | | onDragLeave(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽离开组件范围内时，触发回调。<br/>- event：拖拽事件信息，包括拖拽点坐标。<br/>- extraParams：拖拽事件额外信息，详见extraParam类型描述。<br/>当监听了onDrop事件时，此事件才有效。 |
| onDrop(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 绑定此事件的组件可作为拖拽释放目标，当在本组件范围内停止拖拽行为时，触发回调。<br/>event：拖拽事件信息，包括拖拽点坐标。<br/>extraParams：拖拽事件额外信息，详见extraParam类型描述。 | | onDrop(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 绑定此事件的组件可作为拖拽释放目标，当在本组件范围内停止拖拽行为时，触发回调。<br/>- event：拖拽事件信息，包括拖拽点坐标。<br/>- extraParams：拖拽事件额外信息，详见extraParam类型描述。 |
- extraParam说明<br> - extraParam说明<br>
用于返回组件在拖拽中需要用到的额外信息。 用于返回组件在拖拽中需要用到的额外信息。
extraParam是Json对象转换的string字符串，可以通过Json.parse转换的Json对象获取如下属性。 extraParam是Json对象转换的string字符串，可以通过Json.parse转换的Json对象获取如下属性。
| 属性名称 | 属性类型 | 描述 | | 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- | | ------------- | ------ | ---------------------------------------- |
| selectedIndex | number | 当拖拽事件设在父容器的子元素时，selectedIndex表示当前被拖拽子元素是父容器第selectedIndex个子元素，selectedIndex从0开始。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;仅在ListItem组件中生效。 | | selectedIndex | number | 当拖拽事件设在父容器的子元素时，selectedIndex表示当前被拖拽子元素是父容器第selectedIndex个子元素，selectedIndex从0开始。<br/>仅在ListItem组件中生效。 |
| insertIndex | number | 当前拖拽元素在List组件中放下时，insertIndex表示被拖拽元素插入该组件的第insertIndex个位置，insertIndex从0开始。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;仅在List组件的拖拽事件中生效。 | | insertIndex | number | 当前拖拽元素在List组件中放下时，insertIndex表示被拖拽元素插入该组件的第insertIndex个位置，insertIndex从0开始。<br/>仅在List组件的拖拽事件中生效。 |
### DragEvent对象说明 ### DragEvent对象说明
- 接口 | 名称 | 返回值类型 | 功能描述 |
| 名称 | 返回值类型 | 功能描述 | | ------ | ------ | ---------------- |
| -------- | -------- | -------- | | getX() | number | 当前拖拽点x轴坐标，单位为vp。 |
| getX() | number | 当前拖拽点x轴坐标，单位为vp。 | | getY() | number | 当前拖拽点y轴坐标，单位为vp。 |
| getY() | number | 当前拖拽点y轴坐标，单位为vp。 |
## 示例 ## 示例
``` ```ts
// xxx.ets
@Entry @Entry
@Component @Component
struct DragExample { struct DragExample {
......
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
浏览文件 @ c03c6458
# 按键事件 # 按键事件
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表 ## 权限列表
...@@ -11,58 +11,59 @@ ...@@ -11,58 +11,59 @@
## 事件 ## 事件
| 名称 | 支持冒泡 | 功能描述 | | 名称 | 支持冒泡 | 功能描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| onKeyEvent(event:&nbsp;(event?:&nbsp;KeyEvent)&nbsp;=&gt;&nbsp;void) | 是 | 按键动作触发该方法调用，event参数见[KeyEvent](#keyevent对象说明)介绍。 | | onKeyEvent(event:&nbsp;(event?:&nbsp;KeyEvent)&nbsp;=&gt;&nbsp;void) | 是 | 按键动作触发该方法调用，event参数见[KeyEvent](#keyevent对象说明)介绍。 |
### KeyEvent对象说明 ## KeyEvent对象说明
- 属性 - 属性
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| -------- | -------- | -------- | | --------- | --------------------------- | -------------------------- |
| type | KeyType | 按键的类型。 | | type | [KeyType](#keytype枚举说明) | 按键的类型。 |
| keyCode | number | 按键的键码。 | | keyCode | number | 按键的键码。 |
| keyText | string | 按键的键值。 | | keyText | string | 按键的键值。 |
| keySource | KeySource | 触发当前按键的输入设备类型。 | | keySource | [KeySource](#keysource枚举说明) | 触发当前按键的输入设备类型。 |
| deviceId | number | 触发当前按键的输入设备ID。 | | deviceId | number | 触发当前按键的输入设备ID。 |
| metaKey | number | 按键发生时元键的状态，1表示按压态，0表示未按压态。 | | metaKey | number | 按键发生时元键的状态，1表示按压态，0表示未按压态。 |
| timestamp | number | 按键发生时的时间戳。 | | timestamp | number | 按键发生时的时间戳。 |
- 接口 - 接口
| 接口名称 | 功能描述 | | 接口名称 | 功能描述 |
| -------- | -------- | | ---------------------------- | --------- |
| stopPropagation():&nbsp;void | 阻塞事件冒泡传递。 | | stopPropagation():&nbsp;void | 阻塞事件冒泡传递。 |
- KeyType枚举说明 ## KeyType枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---- | ----- |
| Down | 按键按下。 | | Down | 按键按下。 |
| Up | 按键松开。 | | Up | 按键松开。 |
- KeySource枚举说明 ## KeySource枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------------------- | ---------- |
| Unknown | 输入设备类型未知。 | | Unknown | 输入设备类型未知。 |
| Keyboard | 输入设备类型为键盘。 | | [KeyCode](#常用keycode说明) | 输入设备类型为键盘。 |
- 常用KeyCode说明 ## 常用KeyCode说明
| 数值 | 行为 | 物理按键 | | 数值 | 行为 | 物理按键 |
| -------- | -------- | -------- | | ---- | ---- | ---------- |
| 19 | 上 | 向上方向键。 | | 19 | 上 | 向上方向键。 |
| 20 | 下 | 向下方向键。 | | 20 | 下 | 向下方向键。 |
| 21 | 左 | 向左方向键。 | | 21 | 左 | 向左方向键。 |
| 22 | 右 | 向右方向键。 | | 22 | 右 | 向右方向键。 |
| 23 | 确定 | 遥控器的确认键。 | | 23 | 确定 | 遥控器的确认键。 |
| 66 | 确定 | 键盘的回车键。 | | 66 | 确定 | 键盘的回车键。 |
| 160 | 确定 | 键盘的小键盘回车键。 | | 160 | 确定 | 键盘的小键盘回车键。 |
## 示例 ## 示例
``` ```ts
// xxx.ets
@Entry @Entry
@Component @Component
struct KeyEventExample { struct KeyEventExample {
......
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
浏览文件 @ c03c6458
# 触摸事件 # 触摸事件
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
...@@ -11,52 +11,53 @@ ...@@ -11,52 +11,53 @@
## 事件 ## 事件
| 名称 | 是否冒泡 | 功能描述 | | 名称 | 是否冒泡 | 功能描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| onTouch(callback:&nbsp;(event?:&nbsp;TouchEvent)&nbsp;=&gt;&nbsp;void) | 是 | 触摸动作触发该方法调用，event参数见[TouchEvent](#touchevent对象说明)介绍。 | onTouch(callback:&nbsp;(event?:&nbsp;TouchEvent)&nbsp;=&gt;&nbsp;void) | 是 | 触摸动作触发该方法调用，event参数见[TouchEvent](#touchevent对象说明)介绍。 |
### TouchEvent对象说明 ## TouchEvent对象说明
- 属性 - 属性
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| -------- | -------- | -------- | | ------------------- | ---------------------------------------- | ------------ |
| type | TouchType | 触摸事件的类型。 | | type | TouchType | 触摸事件的类型。 |
| touches | ArrayTouchObject&gt; | 全部手指信息。 | | touches | Array&lt;[TouchObject](#touchobject对象说明)&gt; | 全部手指信息。 |
| changedTouches | ArrayTouchObject&gt; | 当前发生变化的手指信息。 | | changedTouches | Array&lt;[TouchObject](#touchobject对象说明)&gt; | 当前发生变化的手指信息。 |
| timestamp | number | 事件时间戳。 | | timestamp | number | 事件时间戳。 |
| target<sup>8+</sup> | [EventTarget](ts-universal-events-click.md)| 被触摸元素对象。 | | target<sup>8+</sup> | [EventTarget](ts-universal-events-click.md) | 被触摸元素对象。 |
- 接口 - 接口
| 接口名称 | 功能描述 | | 接口名称 | 功能描述 |
| -------- | -------- | | ---------------------- | ------- |
| stopPropagation()：void | 阻塞事件冒泡。 | | stopPropagation()：void | 阻塞事件冒泡。 |
- TouchObject对象说明 ## TouchObject对象说明
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| -------- | -------- | -------- | | ------- | --------------------------- | ------------------- |
| type | TouchType | 触摸事件的类型。 | | type | [TouchType](#touchtype枚举说明) | 触摸事件的类型。 |
| id | number | 手指唯一标识符。 | | id | number | 手指唯一标识符。 |
| screenX | number | 触摸点相对于设备屏幕左边沿的X坐标。 | | screenX | number | 触摸点相对于设备屏幕左边沿的X坐标。 |
| screenY | number | 触摸点相对于设备屏幕上边沿的Y坐标。 | | screenY | number | 触摸点相对于设备屏幕上边沿的Y坐标。 |
| x | number | 触摸点相对于被触摸元素左边沿的X坐标。 | | x | number | 触摸点相对于被触摸元素左边沿的X坐标。 |
| y | number | 触摸点相对于被触摸元素上边沿的Y坐标。 | | y | number | 触摸点相对于被触摸元素上边沿的Y坐标。 |
- TouchType枚举说明 ## TouchType枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------ | --------------- |
| Down | 手指按下时触发。 | | Down | 手指按下时触发。 |
| Up | 手指抬起时触发。 | | Up | 手指抬起时触发。 |
| Move | 手指按压态在屏幕上移动时触发。 | | Move | 手指按压态在屏幕上移动时触发。 |
| Cancel | 触摸事件取消时触发。 | | Cancel | 触摸事件取消时触发。 |
## 示例 ## 示例
``` ```ts
// xxx.ets
@Entry @Entry
@Component @Component
struct TouchExample { struct TouchExample {
......
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
浏览文件 @ c03c6458
# 鼠标事件 # 鼠标事件
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表 ## 权限列表
...@@ -11,45 +11,46 @@ ...@@ -11,45 +11,46 @@
## 事件 ## 事件
| 名称 | 支持冒泡 | 描述 | | 名称 | 支持冒泡 | 描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| onHover(callback:&nbsp;(isHover:&nbsp;boolean)&nbsp;=&gt;&nbsp;void) | 否 | 鼠标进入或退出组件时触发该回调。<br/>isHover：表示鼠标是否悬浮在组件上，鼠标进入时为true,&nbsp;退出时为false。 | | onHover(callback:&nbsp;(isHover:&nbsp;boolean)&nbsp;=&gt;&nbsp;void) | 否 | 鼠标进入或退出组件时触发该回调。<br/>isHover：表示鼠标是否悬浮在组件上，鼠标进入时为true,&nbsp;退出时为false。 |
| onMouse(callback:&nbsp;(event?:&nbsp;MouseEvent)&nbsp;=&gt;&nbsp;void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时，触发该回调，event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 | | onMouse(callback:&nbsp;(event?:&nbsp;MouseEvent)&nbsp;=&gt;&nbsp;void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时，触发该回调，event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 |
### MouseEvent对象说明 ## MouseEvent对象说明
| 属性名称 | 属性类型 | 描述 | | 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- | | --------- | ------------------------------- | -------------------- |
| timestamp | number | 触发事件时的时间戳。 | | timestamp | number | 触发事件时的时间戳。 |
| screenX | number | 点击触点相对于屏幕左上角的x轴坐标。 | | screenX | number | 点击触点相对于屏幕左上角的x轴坐标。 |
| screenY | number | 点击触点相对于屏幕左上角的y轴坐标。 | | screenY | number | 点击触点相对于屏幕左上角的y轴坐标。 |
| x | number | 点击触点相对于当前组件左上角的x轴坐标。 | | x | number | 点击触点相对于当前组件左上角的x轴坐标。 |
| y | number | 点击触点相对于当前组件左上角的y轴坐标。 | | y | number | 点击触点相对于当前组件左上角的y轴坐标。 |
| button | MouseButton | 鼠标按键。 | | button | [MouseButton](#mousebutton类型说明) | 鼠标按键。 |
| action | MouseAction | 事件动作。 | | action | [MouseAction](#mouseaction类型说明) | 事件动作。 |
- MouseButton类型说明 ## MouseButton类型说明
| 属性名称 | 属性类型 | 描述 | | 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- | | ------- | ------ | -------- |
| Left | number | 鼠标左键。 | | Left | number | 鼠标左键。 |
| Right | number | 鼠标右键。 | | Right | number | 鼠标右键。 |
| Middle | number | 鼠标中键。 | | Middle | number | 鼠标中键。 |
| Back | number | 鼠标左侧后退键。 | | Back | number | 鼠标左侧后退键。 |
| Forward | number | 鼠标左侧前进键。 | | Forward | number | 鼠标左侧前进键。 |
| None | number | 无按键。 | | None | number | 无按键。 |
- MouseAction类型说明 ## MouseAction类型说明
| 属性名称 | 属性类型 | 描述 | | 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- | | ------- | ------ | ------- |
| Press | number | 鼠标按键按下。 | | Press | number | 鼠标按键按下。 |
| Release | number | 鼠标按键松开。 | | Release | number | 鼠标按键松开。 |
| Move | number | 鼠标移动。 | | Move | number | 鼠标移动。 |
## 示例 ## 示例
``` ```ts
// xxx.ets
@Entry @Entry
@Component @Component
struct MouseEventExample { struct MouseEventExample {
......
zh-cn/application-dev/task-management/Readme-CN.md 0 → 100644
浏览文件 @ c03c6458
# 任务管理
- 后台任务
- [后台任务概述](background-task-overview.md)
- [后台任务开发指导](background-task-dev-guide.md)
- 延迟任务调度
- [延迟任务调度概述](work-scheduler-overview.md)
- [延迟任务调度开发指导](work-scheduler-dev-guide.md)
zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md → zh-cn/application-dev/task-management/work-scheduler-dev-guide.md
浏览文件 @ c03c6458
# 延迟任务调度开发指导 # 延迟任务调度开发指导
## 场景介绍 ## 场景介绍
应用要执行对实时性要求不高的任务的时候，比如设备空闲时候做一次数据学习等场景，可以使用延迟调度任务，该机制在满足应用设定条件的时候，会根据系统当前状态，如内存、功耗、热等统一决策调度时间。 应用要执行对实时性要求不高的任务的时候，比如设备空闲时候做一次数据学习等场景，可以使用延迟调度任务，该机制在满足应用设定条件的时候，会根据系统当前状态，如内存、功耗、热等统一决策调度时间。
## 接口说明 ## 接口说明
注册相关接口包导入： 注册相关接口包导入：
```js ```js
import workScheduler from '@ohos.workScheduler'; import workScheduler from '@ohos.workScheduler';
``` ```
回调相关接口包导入： 回调相关接口包导入：
```js ```js
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';
``` ```
### 延迟任务调度 ### 延迟任务调度
**表1** workScheduler主要接口 **表1** workScheduler主要接口
接口名 | 接口描述 接口名 | 接口描述
---------------------------------------------------------|----------------------------------------- ---------------------------------------------------------|-----------------------------------------
startWork(work: WorkInfo): boolean | 延迟调度任务申请 startWork(work: WorkInfo): boolean | 延迟调度任务申请
stopWork(work: WorkInfo, needCancel?: boolean): boolean | 延迟调度任务取消 stopWork(work: WorkInfo, needCancel?: boolean): boolean | 延迟调度任务取消
getWorkStatus(workId: number, callback: AsyncCallback\<WorkInfo>): void| 获取延迟调度任务状态（Callback形式） getWorkStatus(workId: number, callback: AsyncCallback\<WorkInfo>): void| 获取延迟调度任务状态（Callback形式）
getWorkStatus(workId: number): Promise\<WorkInfo> | 获取延迟调度任务状态（Promise形式） getWorkStatus(workId: number): Promise\<WorkInfo> | 获取延迟调度任务状态（Promise形式）
obtainAllWorks(callback: AsyncCallback\<void>): Array\<WorkInfo>| 获取所有延迟调度任务（Callback形式） obtainAllWorks(callback: AsyncCallback\<void>): Array\<WorkInfo>| 获取所有延迟调度任务（Callback形式）
obtainAllWorks(): Promise<Array\<WorkInfo>>| 获取所有延迟调度任务（Promise形式） obtainAllWorks(): Promise<Array\<WorkInfo>>| 获取所有延迟调度任务（Promise形式）
stopAndClearWorks(): boolean| 停止并清除任务 stopAndClearWorks(): boolean| 停止并清除任务
isLastWorkTimeOut(workId: number, callback: AsyncCallback\<void>): boolean| 获取上次任务是否超时（针对RepeatWork，Callback形式） isLastWorkTimeOut(workId: number, callback: AsyncCallback\<void>): boolean| 获取上次任务是否超时（针对RepeatWork，Callback形式）
isLastWorkTimeOut(workId: number): Promise\<boolean>| 获取上次任务是否超时（针对RepeatWork，Promise形式） isLastWorkTimeOut(workId: number): Promise\<boolean>| 获取上次任务是否超时（针对RepeatWork，Promise形式）
**表2** WorkInfo包含参数 **表2** WorkInfo包含参数
接口名|描述|类型 接口名|描述|类型
---------------------------------------------------------|-----------------------------------------|--------------------------------------------------------- ---------------------------------------------------------|-----------------------------------------|---------------------------------------------------------
workId | 延迟任务Id（必填）|number workId | 延迟任务Id（必填）|number
bundleName | 延迟任务包名（必填）|string bundleName | 延迟任务包名（必填）|string
abilityName | 延迟任务回调通知的组件名（必填）|string abilityName | 延迟任务回调通知的组件名（必填）|string
networkType | 网络类型 | NetworkType networkType | 网络类型 | NetworkType
isCharging | 是否充电 | boolean isCharging | 是否充电 | boolean
chargerType | 充电类型 | ChargingType chargerType | 充电类型 | ChargingType
batteryLevel | 电量| number batteryLevel | 电量| number
batteryStatus| 电池状态| BatteryStatus batteryStatus| 电池状态| BatteryStatus
storageRequest|存储状态| StorageRequest storageRequest|存储状态| StorageRequest
isRepeat|是否循环任务| boolean isRepeat|是否循环任务| boolean
repeatCycleTime |循环间隔| number repeatCycleTime |循环间隔| number
repeatCount |循环次数| number repeatCount |循环次数| number
**表3** 延迟任务回调接口 **表3** 延迟任务回调接口
接口名 | 接口描述 接口名 | 接口描述
---------------------------------------------------------|----------------------------------------- ---------------------------------------------------------|-----------------------------------------
onWorkStart(work: WorkInfo): void | 延迟调度任务开始回调 onWorkStart(work: WorkInfo): void | 延迟调度任务开始回调
onWorkStop(work: WorkInfo): void | 延迟调度任务结束回调 onWorkStop(work: WorkInfo): void | 延迟调度任务结束回调
### 开发步骤 ### 开发步骤
**开发对应的Extension** **开发对应的Extension**
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';
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));
} }
onWorkStop(workInfo) { onWorkStop(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo)); console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
} }
} }
**注册延迟任务** **注册延迟任务**
import workScheduler from '@ohos.workScheduler'; import workScheduler from '@ohos.workScheduler';
let workInfo = { let workInfo = {
workId: 1, workId: 1,
batteryLevel:50, batteryLevel:50,
batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
isRepeat: false, isRepeat: false,
isPersisted: true, isPersisted: true,
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "MyExtension" abilityName: "MyExtension"
} }
var res = workScheduler.startWork(workInfo); var res = workScheduler.startWork(workInfo);
console.info("workschedulerLog res:" + res); console.info("workschedulerLog res:" + res);
**取消延迟任务** **取消延迟任务**
import workScheduler from '@ohos.workScheduler'; import workScheduler from '@ohos.workScheduler';
let workInfo = { let workInfo = {
workId: 1, workId: 1,
batteryLevel:50, batteryLevel:50,
batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
isRepeat: false, isRepeat: false,
isPersisted: true, isPersisted: true,
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "MyExtension" abilityName: "MyExtension"
} }
var res = workScheduler.stopWork(workInfo, false); var res = workScheduler.stopWork(workInfo, false);
console.info("workschedulerLog res:" + res); console.info("workschedulerLog res:" + res);
**获取指定延迟任务** **获取指定延迟任务**
1.Callback写法 1.Callback写法
workScheduler.getWorkStatus(50, (err, res) => { workScheduler.getWorkStatus(50, (err, res) => {
if (err) { if (err) {
console.info('workschedulerLog getWorkStatus failed, because:' + err.data); console.info('workschedulerLog getWorkStatus failed, because:' + err.data);
} else { } else {
for (let item in res) { for (let item in res) {
console.info('workschedulerLog getWorkStatuscallback success,' + item + ' is:' + res[item]); console.info('workschedulerLog getWorkStatuscallback success,' + item + ' is:' + res[item]);
} }
} }
}); });
2.Promise写法 2.Promise写法
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]);
} }
}).catch((err) => { }).catch((err) => {
console.info('workschedulerLog getWorkStatus failed, because:' + err.data); console.info('workschedulerLog getWorkStatus failed, because:' + err.data);
}) })
**获取所有延迟任务** **获取所有延迟任务**
1.Callback写法 1.Callback写法
workScheduler.obtainAllWorks((err, res) =>{ workScheduler.obtainAllWorks((err, res) =>{
if (err) { if (err) {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); console.info('workschedulerLog obtainAllWorks failed, because:' + err.data);
} else { } else {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
} }
}); });
2.Promise写法 2.Promise写法
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) => {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); console.info('workschedulerLog obtainAllWorks failed, because:' + err.data);
}) })
**停止并清除任务** **停止并清除任务**
let res = workScheduler.stopAndClearWorks(); let res = workScheduler.stopAndClearWorks();
console.info("workschedulerLog res:" + res); console.info("workschedulerLog res:" + res);
**判断上次执行是否超时** **判断上次执行是否超时**
1.Callback写法 1.Callback写法
workScheduler.isLastWorkTimeOut(500, (err, res) =>{ workScheduler.isLastWorkTimeOut(500, (err, res) =>{
if (err) { if (err) {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data);
} else { } else {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
} }
}); });
2.Promise写法 2.Promise写法
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);
}) })
.catch(err => { .catch(err => {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data);
}); });
}) })
\ No newline at end of file
zh-cn/application-dev/ui/ui-ts-overview.md
浏览文件 @ c03c6458
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
- **语言运行时** - **语言运行时**
选用方舟语言运行时，提供了针对UI范式语法的解析能力，提供了跨语言调用支持，提供了TS语言高性能运行环境。 选用方舟语言运行时，提供了针对UI范式语法的解析能力、跨语言调用支持的能力和TS语言高性能运行环境。
- **声明式UI后端引擎** - **声明式UI后端引擎**
......
zh-cn/application-dev/website.md
浏览文件 @ c03c6458
此差异已折叠。
zh-cn/application-dev/work-scheduler/Readme-CN.md 已删除 100644 → 0
浏览文件 @ 35c372eb
# 延迟任务调度
- [延迟任务调度概述](work-scheduler-overview.md)
- [延迟任务调度开发指导](work-scheduler-dev-guide.md)
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或