Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
131cd357
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
131cd357
编写于
6月 24, 2022
作者:
O
openharmony_ci
提交者:
Gitee
6月 24, 2022
浏览文件
操作
浏览文件
下载
差异文件
!5783 issue+格式整改
Merge pull request !5783 from LiAn/master
上级
584dea76
f6cc8366
变更
23
隐藏空白更改
内联
并排
Showing
23 changed file
with
426 addition
and
421 deletion
+426
-421
zh-cn/application-dev/background-task-management/Readme-CN.md
...n/application-dev/background-task-management/Readme-CN.md
+0
-4
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
+3
-3
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
...tion-dev/reference/arkui-ts/ts-basic-components-search.md
+10
-8
zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md
...ation-dev/reference/arkui-ts/ts-media-components-video.md
+44
-44
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
...ation-dev/reference/arkui-ts/ts-universal-events-click.md
+33
-33
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
...n-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
+16
-18
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
...ication-dev/reference/arkui-ts/ts-universal-events-key.md
+41
-41
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
...ation-dev/reference/arkui-ts/ts-universal-events-touch.md
+21
-21
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
...lication-dev/reference/arkui-ts/ts-universal-mouse-key.md
+35
-35
zh-cn/application-dev/task-management/Readme-CN.md
zh-cn/application-dev/task-management/Readme-CN.md
+11
-0
zh-cn/application-dev/task-management/background-task-dev-guide.md
...lication-dev/task-management/background-task-dev-guide.md
+23
-23
zh-cn/application-dev/task-management/background-task-overview.md
...plication-dev/task-management/background-task-overview.md
+0
-0
zh-cn/application-dev/task-management/public_sys-resources/icon-caution.gif
...dev/task-management/public_sys-resources/icon-caution.gif
+0
-0
zh-cn/application-dev/task-management/public_sys-resources/icon-danger.gif
...-dev/task-management/public_sys-resources/icon-danger.gif
+0
-0
zh-cn/application-dev/task-management/public_sys-resources/icon-note.gif
...on-dev/task-management/public_sys-resources/icon-note.gif
+0
-0
zh-cn/application-dev/task-management/public_sys-resources/icon-notice.gif
...-dev/task-management/public_sys-resources/icon-notice.gif
+0
-0
zh-cn/application-dev/task-management/public_sys-resources/icon-tip.gif
...ion-dev/task-management/public_sys-resources/icon-tip.gif
+0
-0
zh-cn/application-dev/task-management/public_sys-resources/icon-warning.gif
...dev/task-management/public_sys-resources/icon-warning.gif
+0
-0
zh-cn/application-dev/task-management/work-scheduler-dev-guide.md
...plication-dev/task-management/work-scheduler-dev-guide.md
+181
-181
zh-cn/application-dev/task-management/work-scheduler-overview.md
...pplication-dev/task-management/work-scheduler-overview.md
+0
-0
zh-cn/application-dev/ui/ui-ts-overview.md
zh-cn/application-dev/ui/ui-ts-overview.md
+1
-1
zh-cn/application-dev/website.md
zh-cn/application-dev/website.md
+7
-6
zh-cn/application-dev/work-scheduler/Readme-CN.md
zh-cn/application-dev/work-scheduler/Readme-CN.md
+0
-3
未找到文件。
zh-cn/application-dev/background-task-management/Readme-CN.md
已删除
100644 → 0
浏览文件 @
584dea76
# 后台任务管理
-
[
后台任务概述
](
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
浏览文件 @
131cd357
...
...
@@ -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
浏览文件 @
131cd357
# Search
> **说明:** 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> **说明:**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供搜索框组件,用于提供用户搜索内容的输入区域。
...
...
@@ -28,13 +30,13 @@ Search(options?: { value?: string; placeholder?: string; icon?: string; controll
## 属性
| 名称
| 参数类型
| 默认值 | 描述 |
| ----------------
|
------------------------------------- | ---- | --------------------- |
| searchButton
| string
| 无 | 搜索框末尾搜索按钮文本值,默认无搜索按钮。 |
| placeholderColor
|
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置placeholder颜色。 |
| placeholderFont
|
[
Font
](
../../ui/ts-types.md
)
| - | 设置placeholder文本样式。 |
| textFont
|
[
Font
](
../../ui/ts-types.md
)
| - | 设置搜索框内文本样式。 |
| copyOption
<sup>
9+
</sup>
| boolean
\|
[
CopyOption
](
ts-basic-components-text.md
)
| true | 设置文本是否可复制。 |
| 名称
| 参数类型
| 默认值 | 描述 |
| ----------------
------- | ---
------------------------------------- | ---- | --------------------- |
| searchButton
| string
| 无 | 搜索框末尾搜索按钮文本值,默认无搜索按钮。 |
| placeholderColor
|
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置placeholder颜色。 |
| placeholderFont
|
[
Font
](
../../ui/ts-types.md
)
| - | 设置placeholder文本样式。 |
| textFont
|
[
Font
](
../../ui/ts-types.md
)
| - | 设置搜索框内文本样式。 |
| copyOption
<sup>
9+
</sup>
| boolean
\|
[
CopyOption
](
ts-basic-components-text.md
)
| true | 设置文本是否可复制。
|
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md
浏览文件 @
131cd357
# Video
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>
该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
视频播放组件。
...
...
@@ -13,7 +13,7 @@
"abilities":[
{
...
"permissions": ["ohos.permission.INTERNET],
"permissions": ["ohos.permission.INTERNET
"
],
...
}
]
...
...
@@ -30,47 +30,47 @@
Video(value: VideoOptions)
-
VideoOptions类型接口说明
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| --------
| -------- | -------- | -------- |
-------- |
| src
| string
\|
[
Resource
](
../../ui/ts-types.md
)
| 否 | -
| 视频播放源的路径,支持本地视频路径和网络路径。
<br>
支持在resources下面的video或rawfile文件夹里放置媒体资源。
<br>
支持dataability://的路径前缀,用于访问通过Data Ability提供的视频路径,具体路径信息详见
[
Data Ability说明
](
../../ability/fa-dataability.md
)
。 |
| currentProgressRate | number
\|
PlaybackSpeed
<sup>
8+
</sup>
| 否 | 1.0
\|
PlaybackSpeed.
<br>
Speed_Forward_1_00_X | 视频播放倍速。
<br/>
>
**说明:**
<br/>
>
number取值仅支持:0.75,1.0,1.25,1.75,2.0。
<br/>
|
| previewUri
| string
\|
PixelMap
<sup>
8+
</sup>
\|
[
Resource
](
../../ui/ts-types.md
)
| 否 | - | 预览图片的路径。
|
| controller
|
[
VideoController
](
#videocontroller
)
| 否 | - | 控制器。
|
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| --------
----------- | ---------------------------------------- | ---- | ---------------------------------------- | --------------------------------
-------- |
| src
| string
\|
[
Resource
](
../../ui/ts-types.md
)
| 否 | -
| 视频播放源的路径,支持本地视频路径和网络路径。
<br>
支持在resources下面的video或rawfile文件夹里放置媒体资源。
<br>
支持dataability://的路径前缀,用于访问通过Data Ability提供的视频路径,具体路径信息详见
[
Data Ability说明
](
../../ability/fa-dataability.md
)
。 |
| currentProgressRate | number
\|
PlaybackSpeed
<sup>
8+
</sup>
| 否
| 1.0
\|
PlaybackSpeed.
<br>
Speed_Forward_1_00_X | 视频播放倍速。
<br/>
>
**说明:**
<br/>
>
number取值仅支持:0.75,1.0,1.25,1.75,2.0。
<br/>
|
| previewUri
| string
\|
PixelMap
<sup>
8+
</sup>
\|
[
Resource
](
../../ui/ts-types.md
)
| 否 | - | 预览图片的路径。
|
| controller
|
[
VideoController
](
#videocontroller
)
| 否 | - | 控制器。
|
-
PlaybackSpeed
<sup>
8+
</sup>
类型接口说明
| 名称
| 描述
|
| --------
|
-------- |
| 名称
| 描述
|
| --------
------------ | -
-------- |
| 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_75_X | 1.75倍速播放。 |
| Speed_Forward_2_00_X | 2倍速播放。 |
| Speed_Forward_2_00_X | 2倍速播放。
|
## 属性
| 名称
| 参数类型 | 默认值 | 描述
|
| --------
| -------- | -------- |
-------- |
| muted
| boolean | false | 是否静音。
|
| autoPlay
| boolean | false | 是否自动播放。
|
| controls
| boolean | true
| 控制视频播放的控制栏是否显示。 |
| objectFit |
[
ImageFit
](
ts-basic-components-image.md
)
| Cover | 设置视频显示模式。 |
| loop
| boolean | false | 是否单个视频循环播放。
|
| 名称
| 参数类型 | 默认值 | 描述
|
| --------
- | ---------------------------------------- | ----- | -------
-------- |
| muted
| boolean | false | 是否静音。
|
| autoPlay
| boolean | false | 是否自动播放。
|
| controls
| boolean | true
| 控制视频播放的控制栏是否显示。 |
| objectFit |
[
ImageFit
](
ts-basic-components-image.md
)
| Cover | 设置视频显示模式。
|
| loop
| boolean | false | 是否单个视频循环播放。
|
## 事件
| 名称
| 功能描述
|
| --------
|
-------- |
| onStart()
=
>
void
| 播放时触发该事件。
|
| onPause()
=
>
void
| 暂停时触发该事件。
|
| onFinish()
=
>
void
| 播放结束时触发该事件。
|
| onError()
=
>
void
| 播放失败时触发该事件。
|
| 名称
| 功能描述
|
| --------
-------------------------------- | --------------------------------
-------- |
| onStart()
=
>
void
| 播放时触发该事件。
|
| onPause()
=
>
void
| 暂停时触发该事件。
|
| onFinish()
=
>
void
| 播放结束时触发该事件。
|
| onError()
=
>
void
| 播放失败时触发该事件。
|
| onPrepared(event?:
{
duration:
number
})
=
>
void | 视频准备完成时触发该事件,通过duration可以获取视频时长,单位为秒(s)。 |
| onSeeking(event?:
{
time:
number
})
=
>
void | 操作进度条过程时上报时间信息,单位为s。 |
| onSeeked(event?:
{
time:
number
})
=
>
void | 操作进度条完成后,上报播放时间信息,单位为s。 |
| onUpdate(event?:
{
time:
number
})
=
>
void | 播放进度变化时触发该事件,单位为s,更新时间间隔为250ms。 |
| onSeeking(event?:
{
time:
number
})
=
>
void | 操作进度条过程时上报时间信息,单位为s。
|
| onSeeked(event?:
{
time:
number
})
=
>
void | 操作进度条完成后,上报播放时间信息,单位为s。
|
| onUpdate(event?:
{
time:
number
})
=
>
void | 播放进度变化时触发该事件,单位为s,更新时间间隔为250ms。
|
## VideoController
...
...
@@ -110,9 +110,9 @@ setCurrentTime(value: number)
指定视频播放的进度位置。
-
参数
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| -----
--- | -------- | -------- | -------- |
-------- |
| value | number | 是
| -
| 视频播放进度位置。 |
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| -----
| ------ | ---- | ---- | -
-------- |
| value | number | 是
| -
| 视频播放进度位置。 |
### requestFullscreen
...
...
@@ -121,9 +121,9 @@ requestFullscreen(value: boolean)
请求全屏播放。
-
参数
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| -----
--- | -------- | -------- | -------- | -
------- |
| value | number | 是 | false | 是否全屏播放。 |
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| -----
| ------ | ---- | ----- |
------- |
| value | number | 是
| false | 是否全屏播放。 |
### exitFullscreen
...
...
@@ -138,18 +138,18 @@ setCurrentTime(value: number, seekMode: SeekMode)
指定视频播放的进度位置,并指定跳转模式。
-
参数
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| -------- | -------- | ----
---- | -------- |
-------- |
| value
| number | 是 | -
| 视频播放进度位置。 |
| seekMode | SeekMode | 是
| - | 跳转模式。
|
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| -------- | -------- | ----
| ---- | -
-------- |
| value
| number | 是 | -
| 视频播放进度位置。 |
| seekMode | SeekMode | 是
| - | 跳转模式。
|
-
SeekMode
<sup>
8+
</sup>
类型接口说明
| 名称
| 描述
|
| --------
|
-------- |
| PreviousKeyframe | 跳转到前一个最近的关键帧。 |
| NextKeyframe
| 跳转到后一个最近的关键帧。
|
| ClosestKeyframe
| 跳转到最近的关键帧。
|
| Accurate | 精准跳转,不论是否为关键帧。 |
| 名称
| 描述
|
| --------
-------- | ------
-------- |
| PreviousKeyframe | 跳转到前一个最近的关键帧。
|
| NextKeyframe
| 跳转到后一个最近的关键帧。
|
| ClosestKeyframe
| 跳转到最近的关键帧。
|
| Accurate
| 精准跳转,不论是否为关键帧。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
浏览文件 @
131cd357
# 点击事件
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>
从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
...
...
@@ -11,38 +11,38 @@
## 事件
| 名称
| 支持冒泡 | 功能描述 |
| --------
| -------- |
-------- |
| onClick(callback:
(event?:
ClickEvent)
=
>
void) | 否
| 点击动作触发该方法调用,event参数见ClickEvent介绍。 |
##
#
ClickEvent对象说明
| 属性名称 | 类型 | 描述
|
| -------- | -------- |
-------- |
| screenX | number | 点击点相对于设备屏幕左边沿的X坐标。
|
| screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。
|
| x | number
| 点击点相对于被点击元素左边沿的X坐标。 |
| y | number
| 点击点相对于被点击元素上边沿的Y坐标。 |
| target
<sup>
8+
</sup>
| EventTarget | 被点击元素对象。
|
| timestamp | number | 事件时间戳。
|
-
EventTarget
<sup>
8+
</sup>
对象说明
| 名称 | 参数类型 | 描述
|
| -------- | -------- |
-------- |
| area | Area
| 目标元素的区域信息。 |
-
Area
<sup>
8+
</sup>
对象说明
| 属性名称 | 类型 | 描述
|
| -------- | -------- |
-------- |
| width | number | 目标元素的宽度,单位为vp。
|
| height | number | 目标元素的高度,单位为vp。
|
| position | Position
| 目标元素左上角相对父元素左上角的位置。 |
| globalPosition | Position | 目标元素左上角相对页面左上角的位置。
|
-
Position
<sup>
8+
</sup>
对象说明
| 属性名称 | 参数类型 | 描述 |
| -------- | -------- |
-------- |
| x | number | x轴坐标,单位为vp。 |
| y | number | y轴坐标,单位为vp。 |
| 名称
| 支持冒泡 | 功能描述 |
| --------
-------------------------------- | ---- | -------------------------
-------- |
| onClick(callback:
(event?:
ClickEvent)
=
>
void) | 否
| 点击动作触发该方法调用,event参数见ClickEvent介绍。 |
## ClickEvent对象说明
| 属性名称 | 类型 | 描述
|
| ------------------- | -------------------------------- | -----------
-------- |
| screenX | number | 点击点相对于设备屏幕左边沿的X坐标。
|
| screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。
|
| x | number
| 点击点相对于被点击元素左边沿的X坐标。 |
| y | number
| 点击点相对于被点击元素上边沿的Y坐标。 |
| target
<sup>
8+
</sup>
|
[
EventTarget
](
#eventtarget8对象说明
)
| 被点击元素对象。
|
| timestamp | number | 事件时间戳。
|
##
EventTarget<sup>8+</sup>对象说明
| 名称 | 参数类型 | 描述
|
| ---- | ----------------- | --
-------- |
| area |
[
Area
](
Area8对象说明
)
| 目标元素的区域信息。 |
##
Area<sup>8+</sup>对象说明
| 属性名称 | 类型 | 描述
|
| -------------- | -------------------------- | -----------
-------- |
| width | number | 目标元素的宽度,单位为vp。
|
| height | number | 目标元素的高度,单位为vp。
|
| position |
[
Position
](
#position8对象说明
)
| 目标元素左上角相对父元素左上角的位置。 |
| globalPosition |
[
Position
](
#position8对象说明
)
| 目标元素左上角相对页面左上角的位置。
|
##
Position<sup>8+</sup>对象说明
| 属性名称 | 参数类型 | 描述 |
| ---- | ------ | ---
-------- |
| x | number | x轴坐标,单位为vp。 |
| y | number | y轴坐标,单位为vp。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
浏览文件 @
131cd357
# 拖拽事件
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>
从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 事件
| 名称
| 支持冒泡 | 功能描述
|
| --------
| -------- |
-------- |
| onDragStart(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
[
CustomBuilder
](
../../ui/ts-types.md
)
) | 否
| 第一次拖拽此事件绑定的组件时,触发回调。
<br/>
event:拖拽事件信息,包括拖拽点坐标。
<br/>
extraParams:拖拽事件额外信息,详见extraParam类型描述。
<br/>
返回值:当前跟手效果所拖拽的对象,用于显示拖拽时的提示组件。
<br/>
>
**说明:**
<br/>
>
-
长按150毫秒(ms)可触发拖拽事件。
<br/>
>
-
优先级:长按手势配置时间小于等于150毫秒(ms)时,长按手势优先触发,否则拖拽事件优先触发。 |
| onDragEnter(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
void) | 否
| 拖拽进入组件范围内时,触发回调。
<br/>
event:拖拽事件信息,包括拖拽点坐标。
<br/>
extraParams:拖拽事件额外信息,详见extraParam类型描述。
<br/>
>
**说明:**
<br/>
>
当监听了onDrop事件时,此事件才有效。 |
| onDragMove(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
void) | 否
| 拖拽在组件范围内移动时,触发回调。
<br/>
event:拖拽事件信息,包括拖拽点坐标。
<br/>
extraParams:拖拽事件额外信息,详见extraParam类型描述。
<br/>
>
**说明:**
<br/>
>
当监听了onDrop事件时,此事件才有效。 |
| onDragLeave(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
void) | 否
| 拖拽离开组件范围内时,触发回调。
<br/>
event:拖拽事件信息,包括拖拽点坐标。
<br/>
extraParams:拖拽事件额外信息,详见extraParam类型描述。
<br/>
>
**说明:**
<br/>
>
当监听了onDrop事件时,此事件才有效。 |
| onDrop(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
void) | 否
| 绑定此事件的组件可作为拖拽释放目标,当在本组件范围内停止拖拽行为时,触发回调。
<br/>
event:拖拽事件信息,包括拖拽点坐标。
<br/>
extraParams:拖拽事件额外信息,详见extraParam类型描述。 |
| 名称
| 支持冒泡 | 功能描述
|
| --------
-------------------------------- | ---- | --------------------------------
-------- |
| onDragStart(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
[
CustomBuilder
](
../../ui/ts-types.md
)
) | 否
| 第一次拖拽此事件绑定的组件时,触发回调。
<br/>
- event:拖拽事件信息,包括拖拽点坐标。
<br/>
- extraParams:拖拽事件额外信息,详见extraParam类型描述。
<br/>
返回值:当前跟手效果所拖拽的对象,用于显示拖拽时的提示组件。
<br/>
长按150毫秒(ms)可触发拖拽事件。
优先级:长按手势配置时间小于等于150毫秒(ms)时,长按手势优先触发,否则拖拽事件优先触发。 |
| onDragEnter(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
void) | 否
| 拖拽进入组件范围内时,触发回调。
<br/>
- event:拖拽事件信息,包括拖拽点坐标。
<br/>
- extraParams:拖拽事件额外信息,详见extraParam类型描述。
<br/>
当监听了onDrop事件时,此事件才有效。 |
| onDragMove(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
void) | 否
| 拖拽在组件范围内移动时,触发回调。
<br/>
- event:拖拽事件信息,包括拖拽点坐标。
<br/>
- extraParams:拖拽事件额外信息,详见extraParam类型描述。
<br/>
当监听了onDrop事件时,此事件才有效。 |
| onDragLeave(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
void) | 否
| 拖拽离开组件范围内时,触发回调。
<br/>
- event:拖拽事件信息,包括拖拽点坐标。
<br/>
- extraParams:拖拽事件额外信息,详见extraParam类型描述。
<br/>
当监听了onDrop事件时,此事件才有效。 |
| onDrop(callback:
(event:
DragEvent,
extraParams?:
string)
=
>
void) | 否
| 绑定此事件的组件可作为拖拽释放目标,当在本组件范围内停止拖拽行为时,触发回调。
<br/>
- event:拖拽事件信息,包括拖拽点坐标。
<br/>
-
extraParams:拖拽事件额外信息,详见extraParam类型描述。 |
-
extraParam说明
<br>
用于返回组件在拖拽中需要用到的额外信息。
extraParam是Json对象转换的string字符串,可以通过Json.parse转换的Json对象获取如下属性。
| 属性名称
| 属性类型 | 描述 |
| --------
| -------- |
-------- |
| selectedIndex | number | 当拖拽事件设在父容器的子元素时,selectedIndex表示当前被拖拽子元素是父容器第selectedIndex个子元素,selectedIndex从0开始。
<br/>
>
**说明:**
<br/>
>
仅在ListItem组件中生效。 |
| insertIndex
| number | 当前拖拽元素在List组件中放下时,insertIndex表示被拖拽元素插入该组件的第insertIndex个位置,insertIndex从0开始。
<br/>
>
**说明:**
<br/>
>
仅在List组件的拖拽事件中生效。 |
| 属性名称
| 属性类型 | 描述 |
| --------
----- | ------ | --------------------------------
-------- |
| selectedIndex | number | 当拖拽事件设在父容器的子元素时,selectedIndex表示当前被拖拽子元素是父容器第selectedIndex个子元素,selectedIndex从0开始。
<br/>
仅在ListItem组件中生效。 |
| insertIndex
| number | 当前拖拽元素在List组件中放下时,insertIndex表示被拖拽元素插入该组件的第insertIndex个位置,insertIndex从0开始。
<br/>
仅在List组件的拖拽事件中生效。 |
### DragEvent对象说明
-
接口
| 名称 | 返回值类型 | 功能描述 |
| -------- | -------- | -------- |
| getX() | number | 当前拖拽点x轴坐标,单位为vp。 |
| getY() | number | 当前拖拽点y轴坐标,单位为vp。 |
| 名称 | 返回值类型 | 功能描述 |
| ------ | ------ | ---------------- |
| getX() | number | 当前拖拽点x轴坐标,单位为vp。 |
| getY() | number | 当前拖拽点y轴坐标,单位为vp。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
浏览文件 @
131cd357
# 按键事件
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>
从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
...
...
@@ -11,53 +11,53 @@
## 事件
| 名称
| 支持冒泡 | 功能描述 |
| --------
| -------- |
-------- |
| onKeyEvent(event:
(event?:
KeyEvent)
=
>
void) | 是
| 按键动作触发该方法调用,event参数见
[
KeyEvent
](
#keyevent对象说明
)
介绍。 |
| 名称
| 支持冒泡 | 功能描述 |
| --------
-------------------------------- | ---- | --------------------------------
-------- |
| onKeyEvent(event:
(event?:
KeyEvent)
=
>
void) | 是
| 按键动作触发该方法调用,event参数见
[
KeyEvent
](
#keyevent对象说明
)
介绍。 |
##
#
KeyEvent对象说明
## KeyEvent对象说明
-
属性
| 属性名称
| 类型 | 描述
|
| --------
| -------- |
-------- |
| type
| KeyType | 按键的类型。
|
| keyCode
| number | 按键的键码。
|
| keyText
| string | 按键的键值。
|
| keySource |
KeySource | 触发当前按键的输入设备类型。
|
| deviceId
| number | 触发当前按键的输入设备ID。
|
| metaKey
| number
| 按键发生时元键的状态,1表示按压态,0表示未按压态。 |
| timestamp | number
| 按键发生时的时间戳。
|
| 属性名称
| 类型 | 描述
|
| --------
- | --------------------------- | ------------------
-------- |
| type
|
[
KeyType
](
#keytype枚举说明
)
| 按键的类型。
|
| keyCode
| number | 按键的键码。
|
| keyText
| string | 按键的键值。
|
| keySource |
[
KeySource
](
#keysource枚举说明
)
| 触发当前按键的输入设备类型。
|
| deviceId
| number | 触发当前按键的输入设备ID。
|
| metaKey
| number
| 按键发生时元键的状态,1表示按压态,0表示未按压态。 |
| timestamp | number
| 按键发生时的时间戳。
|
-
接口
| 接口名称
| 功能描述 |
| --------
|
-------- |
| stopPropagation():
void | 阻塞事件冒泡传递。 |
-
KeyType枚举说明
| 名称 | 描述 |
| -------- | ---
----- |
| Down | 按键按下。 |
| Up | 按键松开。 |
-
KeySource枚举说明
| 名称 | 描述 |
| -------- |
-------- |
| Unknown | 输入设备类型未知。 |
| Keyboard | 输入设备类型为键盘。 |
-
常用KeyCode说明
| 数值 | 行为 | 物理按键 |
| -------- | -------- |
-------- |
| 19 | 上 | 向上方向键。 |
| 20 | 下 | 向下方向键。 |
| 21 | 左 | 向左方向键。 |
| 22 | 右 | 向右方向键。 |
| 23 | 确定 | 遥控器的确认键。 |
| 66 | 确定 | 键盘的回车键。 |
| 160 | 确定 | 键盘的小键盘回车键。 |
| 接口名称
| 功能描述 |
| --------
-------------------- | -
-------- |
| stopPropagation():
void | 阻塞事件冒泡传递。 |
##
KeyType枚举说明
| 名称 | 描述 |
| ---- |
----- |
| Down | 按键按下。 |
| Up | 按键松开。 |
##
KeySource枚举说明
| 名称 | 描述 |
| ----------------------- | --
-------- |
| Unknown | 输入设备类型未知。 |
|
[
KeyCode
](
#常用keycode说明
)
| 输入设备类型为键盘。 |
##
常用KeyCode说明
| 数值 | 行为 | 物理按键 |
| ---- | ---- | --
-------- |
| 19 | 上 | 向上方向键。 |
| 20 | 下 | 向下方向键。 |
| 21 | 左 | 向左方向键。 |
| 22 | 右 | 向右方向键。 |
| 23 | 确定 | 遥控器的确认键。 |
| 66 | 确定 | 键盘的回车键。 |
| 160 | 确定 | 键盘的小键盘回车键。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
浏览文件 @
131cd357
...
...
@@ -16,14 +16,14 @@
| onTouch(callback:
(event?:
TouchEvent)
=
>
void) | 是 | 触摸动作触发该方法调用,event参数见
[
TouchEvent
](
#touchevent对象说明
)
介绍。 |
##
#
TouchEvent对象说明
## TouchEvent对象说明
-
属性
| 属性名称 | 类型 | 描述 |
| ------------------- | ---------------------------------------- | ------------ |
| type | TouchType | 触摸事件的类型。 |
| touches | Array
TouchObject
>
| 全部手指信息。 |
| changedTouches | Array
TouchObject
>
| 当前发生变化的手指信息。 |
| touches | Array
<
[TouchObject](touchobject对象说明)
>
| 全部手指信息。 |
| changedTouches | Array
<
[TouchObject](touchobject对象说明)
>
| 当前发生变化的手指信息。 |
| timestamp | number | 事件时间戳。 |
| target
<sup>
8+
</sup>
|
[
EventTarget
](
ts-universal-events-click.md
)
| 被触摸元素对象。 |
...
...
@@ -34,24 +34,24 @@
| stopPropagation():void | 阻塞事件冒泡。 |
-
TouchObject对象说明
| 属性名称 | 类型
| 描述 |
| ------- |
--------- | ------------------- |
| type | TouchType
| 触摸事件的类型。 |
| id | number
| 手指唯一标识符。 |
| screenX | number
| 触摸点相对于设备屏幕左边沿的X坐标。 |
| screenY | number
| 触摸点相对于设备屏幕上边沿的Y坐标。 |
| x | number
| 触摸点相对于被触摸元素左边沿的X坐标。 |
| y | number
| 触摸点相对于被触摸元素上边沿的Y坐标。 |
-
TouchType枚举说明
| 名称 | 描述 |
| ------ | --------------- |
| Down | 手指按下时触发。 |
| Up | 手指抬起时触发。 |
| Move | 手指按压态在屏幕上移动时触发。 |
| Cancel | 触摸事件取消时触发。 |
##
TouchObject对象说明
| 属性名称 | 类型
| 描述 |
| ------- | ------------------
--------- | ------------------- |
| type |
[
TouchType
](
#touchtype枚举说明
)
| 触摸事件的类型。 |
| id | number
| 手指唯一标识符。 |
| screenX | number
| 触摸点相对于设备屏幕左边沿的X坐标。 |
| screenY | number
| 触摸点相对于设备屏幕上边沿的Y坐标。 |
| x | number
| 触摸点相对于被触摸元素左边沿的X坐标。 |
| y | number
| 触摸点相对于被触摸元素上边沿的Y坐标。 |
##
TouchType枚举说明
| 名称 | 描述 |
| ------ | --------------- |
| Down | 手指按下时触发。 |
| Up | 手指抬起时触发。 |
| Move | 手指按压态在屏幕上移动时触发。 |
| Cancel | 触摸事件取消时触发。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
浏览文件 @
131cd357
# 鼠标事件
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>
从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
...
...
@@ -11,40 +11,40 @@
## 事件
| 名称
| 支持冒泡 | 描述
|
| --------
| -------- |
-------- |
| onHover(callback:
(isHover:
boolean)
=
>
void) | 否 | 鼠标进入或退出组件时触发该回调。
<br/>
isHover:表示鼠标是否悬浮在组件上,鼠标进入时为true,
退出时为false。 |
| onMouse(callback:
(event?:
MouseEvent)
=
>
void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时,触发该回调,event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 |
##
#
MouseEvent对象说明
| 属性名称 | 属性类型 | 描述
|
| -------- | -------- |
-------- |
| timestamp | number | 触发事件时的时间戳。
|
| screenX | number | 点击触点相对于屏幕左上角的x轴坐标。
|
| screenY | number | 点击触点相对于屏幕左上角的y轴坐标。
|
| x | number
| 点击触点相对于当前组件左上角的x轴坐标。 |
| y | number
| 点击触点相对于当前组件左上角的y轴坐标。 |
| button | MouseButton | 鼠标按键。
|
| action | MouseAction | 事件动作。
|
-
MouseButton类型说明
| 属性名称 | 属性类型 | 描述 |
| -------- | --
------ | -------- |
| Left | number | 鼠标左键。 |
| Right | number | 鼠标右键。 |
| Middle | number | 鼠标中键。 |
| Back | number | 鼠标左侧后退键。 |
| Forward | number | 鼠标左侧前进键。 |
| None | number | 无按键。 |
-
MouseAction类型说明
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -
------- |
| Press | number | 鼠标按键按下。 |
| Release | number | 鼠标按键松开。 |
| Move | number | 鼠标移动。 |
| 名称
| 支持冒泡 | 描述
|
| --------
-------------------------------- | ---- | --------------------------------
-------- |
| onHover(callback:
(isHover:
boolean)
=
>
void) | 否
| 鼠标进入或退出组件时触发该回调。
<br/>
isHover:表示鼠标是否悬浮在组件上,鼠标进入时为true,
退出时为false。 |
| onMouse(callback:
(event?:
MouseEvent)
=
>
void) | 是
| 当前组件被鼠标按键点击时或者鼠标在组件上移动时,触发该回调,event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 |
## MouseEvent对象说明
| 属性名称 | 属性类型 | 描述
|
| --------- | ------------------------------- | ------------
-------- |
| timestamp | number | 触发事件时的时间戳。
|
| screenX | number | 点击触点相对于屏幕左上角的x轴坐标。
|
| screenY | number | 点击触点相对于屏幕左上角的y轴坐标。
|
| x | number
| 点击触点相对于当前组件左上角的x轴坐标。 |
| y | number
| 点击触点相对于当前组件左上角的y轴坐标。 |
| button |
[
MouseButton
](
#mousebutton类型说明
)
| 鼠标按键。
|
| action |
[
MouseAction
](
#mouseaction类型说明
)
| 事件动作。
|
##
MouseButton类型说明
| 属性名称 | 属性类型 | 描述 |
| ------- |
------ | -------- |
| Left | number | 鼠标左键。 |
| Right | number | 鼠标右键。 |
| Middle | number | 鼠标中键。 |
| Back | number | 鼠标左侧后退键。 |
| Forward | number | 鼠标左侧前进键。 |
| None | number | 无按键。 |
##
MouseAction类型说明
| 属性名称 | 属性类型 | 描述 |
| ------- | ------ |
------- |
| Press | number | 鼠标按键按下。 |
| Release | number | 鼠标按键松开。 |
| Move | number | 鼠标移动。 |
## 示例
...
...
zh-cn/application-dev/task-management/Readme-CN.md
0 → 100644
浏览文件 @
131cd357
# 任务管理
后台任务
-
[
后台任务概述
](
background-task-overview.md
)
-
[
后台任务开发指导
](
background-task-dev-guide.md
)
延迟任务调度
-
[
延迟任务调度概述
](
work-scheduler-overview.md
)
-
[
延迟任务调度开发指导
](
work-scheduler-dev-guide.md
)
\ No newline at end of file
zh-cn/application-dev/
background-
task-management/background-task-dev-guide.md
→
zh-cn/application-dev/task-management/background-task-dev-guide.md
浏览文件 @
131cd357
...
...
@@ -10,11 +10,11 @@
**表1**
短时任务主要接口
| 接口名
| 描述
|
| --------
|
-------- |
| 接口名
| 描述
|
| --------
-------------------------------- | --------------------------------
-------- |
| requestSuspendDelay(reason:
string,
callback:
Callback
<
void
>
):
[
DelaySuspendInfo
](
../reference/apis/js-apis-backgroundTaskManager.md#delaysuspendinfo
)
| 后台应用申请延迟挂起。
<br/>
延迟挂起时间一般情况下默认值为180000,低电量时默认值为60000。 |
| getRemainingDelayTime(requestId:
number):
Promise
<
number
>
| 获取应用程序进入挂起状态前的剩余时间。
<br/>
其任务执行结果以Promise形式返回给应用。
|
| cancelSuspendDelay(requestId:
number):
void | 取消延迟挂起。 |
| getRemainingDelayTime(requestId:
number):
Promise
<
number
>
| 获取应用程序进入挂起状态前的剩余时间。
<br/>
使用Promise形式返回。
|
| cancelSuspendDelay(requestId:
number):
void | 取消延迟挂起。
|
### 开发步骤
...
...
@@ -24,12 +24,12 @@
```js
import backgroundTaskManager from '@ohos.backgroundTaskManager';
let myReason = 'test requestSuspendDelay';
let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => {
console.info("Request suspension delay will time out.");
});
var id = delayInfo.requestId;
console.info("requestId is: " + id);
```
...
...
@@ -91,27 +91,27 @@ ohos.permission.KEEP_BACKGROUND_RUNNING
**表2**
长时任务主要接口
| 接口名
| 描述
|
| --------
|
-------- |
| 接口名
| 描述
|
| --------
-------------------------------- | --------------------
-------- |
| startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise
<
void
>
| 服务启动后,向系统申请长时任务,使服务一直保持后台运行。 |
| stopBackgroundRunning(context: Context): Promise
<
void
>
| 停止后台长时任务的运行。 |
| stopBackgroundRunning(context: Context): Promise
<
void
>
| 停止后台长时任务的运行。
|
其中,wantAgent的信息详见(
[
WantAgent
](
../reference/apis/js-apis-wantAgent.md
)
)
**表3**
后台模式类型
| 参数名
| id值 | 描述 | 配置项
|
| --------
| -------- | -------- |
-------- |
| DATA_TRANSFER | 1
| 数据传输 | dataTransfer
|
| AUDIO_PLAYBACK | 2
| 音频播放 | audioPlayback
|
| AUDIO_RECORDING | 3
| 录音 | audioRecording
|
| LOCATION | 4
| 定位导航 | location
|
| BLUETOOTH_INTERACTION | 5
| 蓝牙相关 | bluetoothInteraction
|
| MULTI_DEVICE_CONNECTION | 6
| 多设备互联
| multiDeviceConnection |
| WIFI_INTERACTION | 7
| WLAN相关(系统保留) | wifiInteraction
|
| VOIP | 8
| 音视频通话(系统保留) | voip
|
| TASK_KEEPING | 9
| 计算任务(仅供特定设备使用) | taskKeeping
|
| 参数名
| id值 | 描述 | 配置项
|
| --------
--------------- | ---- | -------------- | -------------
-------- |
| DATA_TRANSFER | 1
| 数据传输 | dataTransfer
|
| AUDIO_PLAYBACK | 2
| 音频播放 | audioPlayback
|
| AUDIO_RECORDING | 3
| 录音 | audioRecording
|
| LOCATION | 4
| 定位导航 | location
|
| BLUETOOTH_INTERACTION | 5
| 蓝牙相关 | bluetoothInteraction
|
| MULTI_DEVICE_CONNECTION | 6
| 多设备互联
| multiDeviceConnection |
| WIFI_INTERACTION | 7
| WLAN相关(系统保留) | wifiInteraction
|
| VOIP | 8
| 音视频通话(系统保留) | voip
|
| TASK_KEEPING | 9
| 计算任务(仅供特定设备使用) | taskKeeping
|
### 开发步骤
...
...
@@ -137,7 +137,7 @@ ohos.permission.KEEP_BACKGROUND_RUNNING
]
}
```
2.
申请长时任务
```js
...
...
@@ -173,13 +173,13 @@ ohos.permission.KEEP_BACKGROUND_RUNNING
```js
import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility';
backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() => {
console.info("Operation stopBackgroundRunning succeeded");
}).catch((err) => {
console.error("Operation stopBackgroundRunning failed Cause: " + err);
});
```
### 开发实例
...
...
zh-cn/application-dev/
background-
task-management/background-task-overview.md
→
zh-cn/application-dev/task-management/background-task-overview.md
浏览文件 @
131cd357
文件已移动
zh-cn/application-dev/
background-
task-management/public_sys-resources/icon-caution.gif
→
zh-cn/application-dev/task-management/public_sys-resources/icon-caution.gif
浏览文件 @
131cd357
文件已移动
zh-cn/application-dev/
background-
task-management/public_sys-resources/icon-danger.gif
→
zh-cn/application-dev/task-management/public_sys-resources/icon-danger.gif
浏览文件 @
131cd357
文件已移动
zh-cn/application-dev/
background-
task-management/public_sys-resources/icon-note.gif
→
zh-cn/application-dev/task-management/public_sys-resources/icon-note.gif
浏览文件 @
131cd357
文件已移动
zh-cn/application-dev/
background-
task-management/public_sys-resources/icon-notice.gif
→
zh-cn/application-dev/task-management/public_sys-resources/icon-notice.gif
浏览文件 @
131cd357
文件已移动
zh-cn/application-dev/
background-
task-management/public_sys-resources/icon-tip.gif
→
zh-cn/application-dev/task-management/public_sys-resources/icon-tip.gif
浏览文件 @
131cd357
文件已移动
zh-cn/application-dev/
background-
task-management/public_sys-resources/icon-warning.gif
→
zh-cn/application-dev/task-management/public_sys-resources/icon-warning.gif
浏览文件 @
131cd357
文件已移动
zh-cn/application-dev/
work-scheduler
/work-scheduler-dev-guide.md
→
zh-cn/application-dev/
task-management
/work-scheduler-dev-guide.md
浏览文件 @
131cd357
# 延迟任务调度开发指导
## 场景介绍
应用要执行对实时性要求不高的任务的时候,比如设备空闲时候做一次数据学习等场景,可以使用延迟调度任务,该机制在满足应用设定条件的时候,会根据系统当前状态,如内存、功耗、温度等统一决策调度时间。
## 接口说明
注册相关接口包导入:
```
js
import
workScheduler
from
'
@ohos.workScheduler
'
;
```
回调相关接口包导入:
```
js
import
WorkSchedulerExtensionAbility
from
'
@ohos.WorkSchedulerExtensionAbility
'
;
```
### 延迟任务调度
**表1**
workScheduler主要接口
接口名 | 接口描述
---------------------------------------------------------|-----------------------------------------
startWork(work: WorkInfo): boolean; | 延迟调度任务申请
stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消
getWorkStatus(workId: number, callback: AsyncCallback
\<
WorkInfo>): void;| 获取延迟调度任务状态(Callback形式)
getWorkStatus(workId: number): Promise
\<
WorkInfo>; | 获取延迟调度任务状态(Promise形式)
obtainAllWorks(callback: AsyncCallback
\<
void>): Array
\<
WorkInfo>;| 获取所有延迟调度任务(Callback形式)
obtainAllWorks(): Promise
<Array
\<
WorkInfo
>
>;| 获取所有延迟调度任务(Promise形式)
stopAndClearWorks(): boolean;| 停止并清除任务
isLastWorkTimeOut(workId: number, callback: AsyncCallback
\<
void>): boolean;| 获取上次任务是否超时(针对RepeatWork,Callback形式)
isLastWorkTimeOut(workId: number): Promise
\<
boolean>;| 获取上次任务是否超时(针对RepeatWork,Promise形式)
**表2**
WorkInfo包含参数
接口名|描述|类型
---------------------------------------------------------|-----------------------------------------|---------------------------------------------------------
workId | 延迟任务Id(必填)|number
bundleName | 延迟任务包名(必填)|string
abilityName | 延迟任务回调通知的组件名(必填)|string
networkType | 网络类型 | NetworkType
isCharging | 是否充电 | boolean
chargerType | 充电类型 | ChargingType
batteryLevel | 电量| number
batteryStatus| 电池状态| BatteryStatus
storageRequest|存储状态| StorageRequest
isRepeat|是否循环任务| boolean
repeatCycleTime |循环间隔| number
repeatCount |循环次数| number
**表3**
延迟任务回调接口
接口名 | 接口描述
---------------------------------------------------------|-----------------------------------------
onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调
onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调
### 开发步骤
**开发对应的Extension**
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';
export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
onWorkStart(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
}
onWorkStop(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
}
}
**注册延迟任务**
import workScheduler from '@ohos.workScheduler';
let workInfo = {
workId: 1,
batteryLevel:50,
batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
isRepeat: false,
isPersisted: true,
bundleName: "com.example.myapplication",
abilityName: "MyExtension"
}
var res = workScheduler.startWork(workInfo);
console.info("workschedulerLog res:" + res);
**取消延迟任务**
import workScheduler from '@ohos.workScheduler';
let workInfo = {
workId: 1,
batteryLevel:50,
batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
isRepeat: false,
isPersisted: true,
bundleName: "com.example.myapplication",
abilityName: "MyExtension"
}
var res = workScheduler.stopWork(workInfo, false);
console.info("workschedulerLog res:" + res);
**获取指定延迟任务**
1.
Callback写法
workScheduler.getWorkStatus(50, (err, res) => {
if (err) {
console.info('workschedulerLog getWorkStatus failed, because:' + err.code);
} else {
for (let item in res) {
console.info('workschedulerLog getWorkStatuscallback success,' + item + ' is:' + res[item]);
}
}
});
2.
Promise写法
workScheduler.getWorkStatus(50).then((res) => {
for (let item in res) {
console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
}
}).catch((err) => {
console.info('workschedulerLog getWorkStatus failed, because:' + err.code);
})
**获取所有延迟任务**
1.
Callback写法
workScheduler.obtainAllWorks((err, res) =>{
if (err) {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.code);
} else {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
}
});
2.
Promise写法
workScheduler.obtainAllWorks().then((res) => {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
}).catch((err) => {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.code);
})
**停止并清除任务**
let res = workScheduler.stopAndClearWorks();
console.info("workschedulerLog res:" + res);
**判断上次执行是否超时**
1.
Callback写法
workScheduler.isLastWorkTimeOut(500, (err, res) =>{
if (err) {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code);
} else {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
}
});
2.
Promise写法
workScheduler.isLastWorkTimeOut(500)
.then(res => {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
})
.catch(err => {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code);
});
# 延迟任务调度开发指导
## 场景介绍
应用要执行对实时性要求不高的任务的时候,比如设备空闲时候做一次数据学习等场景,可以使用延迟调度任务,该机制在满足应用设定条件的时候,会根据系统当前状态,如内存、功耗、温度等统一决策调度时间。
## 接口说明
注册相关接口包导入:
```
js
import
workScheduler
from
'
@ohos.workScheduler
'
;
```
回调相关接口包导入:
```
js
import
WorkSchedulerExtensionAbility
from
'
@ohos.WorkSchedulerExtensionAbility
'
;
```
### 延迟任务调度
**表1**
workScheduler主要接口
接口名 | 接口描述
---------------------------------------------------------|-----------------------------------------
startWork(work: WorkInfo): boolean; | 延迟调度任务申请
stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消
getWorkStatus(workId: number, callback: AsyncCallback
\<
WorkInfo>): void;| 获取延迟调度任务状态(Callback形式)
getWorkStatus(workId: number): Promise
\<
WorkInfo>; | 获取延迟调度任务状态(Promise形式)
obtainAllWorks(callback: AsyncCallback
\<
void>): Array
\<
WorkInfo>;| 获取所有延迟调度任务(Callback形式)
obtainAllWorks(): Promise
<Array
\<
WorkInfo
>
>;| 获取所有延迟调度任务(Promise形式)
stopAndClearWorks(): boolean;| 停止并清除任务
isLastWorkTimeOut(workId: number, callback: AsyncCallback
\<
void>): boolean;| 获取上次任务是否超时(针对RepeatWork,Callback形式)
isLastWorkTimeOut(workId: number): Promise
\<
boolean>;| 获取上次任务是否超时(针对RepeatWork,Promise形式)
**表2**
WorkInfo包含参数
接口名|描述|类型
---------------------------------------------------------|-----------------------------------------|---------------------------------------------------------
workId | 延迟任务Id(必填)|number
bundleName | 延迟任务包名(必填)|string
abilityName | 延迟任务回调通知的组件名(必填)|string
networkType | 网络类型 | NetworkType
isCharging | 是否充电 | boolean
chargerType | 充电类型 | ChargingType
batteryLevel | 电量| number
batteryStatus| 电池状态| BatteryStatus
storageRequest|存储状态| StorageRequest
isRepeat|是否循环任务| boolean
repeatCycleTime |循环间隔| number
repeatCount |循环次数| number
**表3**
延迟任务回调接口
接口名 | 接口描述
---------------------------------------------------------|-----------------------------------------
onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调
onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调
### 开发步骤
**开发对应的Extension**
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';
export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
onWorkStart(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
}
onWorkStop(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
}
}
**注册延迟任务**
import workScheduler from '@ohos.workScheduler';
let workInfo = {
workId: 1,
batteryLevel:50,
batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
isRepeat: false,
isPersisted: true,
bundleName: "com.example.myapplication",
abilityName: "MyExtension"
}
var res = workScheduler.startWork(workInfo);
console.info("workschedulerLog res:" + res);
**取消延迟任务**
import workScheduler from '@ohos.workScheduler';
let workInfo = {
workId: 1,
batteryLevel:50,
batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
isRepeat: false,
isPersisted: true,
bundleName: "com.example.myapplication",
abilityName: "MyExtension"
}
var res = workScheduler.stopWork(workInfo, false);
console.info("workschedulerLog res:" + res);
**获取指定延迟任务**
1.
Callback写法
workScheduler.getWorkStatus(50, (err, res) => {
if (err) {
console.info('workschedulerLog getWorkStatus failed, because:' + err.code);
} else {
for (let item in res) {
console.info('workschedulerLog getWorkStatuscallback success,' + item + ' is:' + res[item]);
}
}
});
2.
Promise写法
workScheduler.getWorkStatus(50).then((res) => {
for (let item in res) {
console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
}
}).catch((err) => {
console.info('workschedulerLog getWorkStatus failed, because:' + err.code);
})
**获取所有延迟任务**
1.
Callback写法
workScheduler.obtainAllWorks((err, res) =>{
if (err) {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.code);
} else {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
}
});
2.
Promise写法
workScheduler.obtainAllWorks().then((res) => {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
}).catch((err) => {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.code);
})
**停止并清除任务**
let res = workScheduler.stopAndClearWorks();
console.info("workschedulerLog res:" + res);
**判断上次执行是否超时**
1.
Callback写法
workScheduler.isLastWorkTimeOut(500, (err, res) =>{
if (err) {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code);
} else {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
}
});
2.
Promise写法
workScheduler.isLastWorkTimeOut(500)
.then(res => {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
})
.catch(err => {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code);
});
})
\ No newline at end of file
zh-cn/application-dev/
work-scheduler
/work-scheduler-overview.md
→
zh-cn/application-dev/
task-management
/work-scheduler-overview.md
浏览文件 @
131cd357
文件已移动
zh-cn/application-dev/ui/ui-ts-overview.md
浏览文件 @
131cd357
...
...
@@ -42,7 +42,7 @@
-
**语言运行时**
选用方舟语言运行时,提供了针对UI范式语法的解析能力
,提供了跨语言调用支持,提供了
TS语言高性能运行环境。
选用方舟语言运行时,提供了针对UI范式语法的解析能力
、跨语言调用支持的能力和
TS语言高性能运行环境。
-
**声明式UI后端引擎**
...
...
zh-cn/application-dev/website.md
浏览文件 @
131cd357
...
...
@@ -254,12 +254,13 @@
-
后台代理提醒
-
[
后台代理概述
](
background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md
)
-
[
后台代理开发指导
](
background-agent-scheduled-reminder/background-agent-scheduled-reminder-guide.md
)
-
后台任务管理
-
[
后台任务概述
](
background-task-management/background-task-overview.md
)
-
[
后台任务开发指导
](
background-task-management/background-task-dev-guide.md
)
-
延迟任务调度
-
[
延迟任务调度概述
](
work-scheduler/work-scheduler-overview.md
)
-
[
延迟任务调度开发指导
](
work-scheduler/work-scheduler-dev-guide.md
)
-
任务管理
-
后台任务
-
[
后台任务概述
](
task-management/background-task-overview.md
)
-
[
后台任务开发指导
](
task-management/background-task-dev-guide.md
)
-
延迟任务调度
-
[
延迟任务调度概述
](
task-management/work-scheduler-overview.md
)
-
[
延迟任务调度开发指导
](
task-management/work-scheduler-dev-guide.md
)
-
设备管理
-
USB服务
-
[
USB服务开发概述
](
device/usb-overview.md
)
...
...
zh-cn/application-dev/work-scheduler/Readme-CN.md
已删除
100644 → 0
浏览文件 @
584dea76
# 延迟任务调度
-
[
延迟任务调度概述
](
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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录