diff --git a/zh-cn/application-dev/background-task-management/Readme-CN.md b/zh-cn/application-dev/background-task-management/Readme-CN.md deleted file mode 100644 index 509366d9f7b9d1cdb06e2e6f6ca7dd012ced70e8..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/background-task-management/Readme-CN.md +++ /dev/null @@ -1,4 +0,0 @@ -# 后台任务管理 - - - [后台任务概述](background-task-overview.md) - - [后台任务开发指导](background-task-dev-guide.md) \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md index 8e721b186d8d5136f31977181d95e10335fa45da..dcaac2c5a72b9a67e716d25d2fe224e2c31d0dd4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md @@ -23,9 +23,9 @@ matchMediaSync(condition: string): MediaQueryListener 设置媒体查询的查询条件，并返回对应的监听句柄。 **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------ | ---- | ---------- | -| condition | string | 是 | 媒体事件的匹配条件。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ---------------------------------------- | +| condition | string | 是 | 媒体事件的匹配条件，具体可参考[媒体查询语法规则](/ui/ui-ts-layout-mediaquery.md#媒体查询条件语法规则)。 | **返回值：** | 类型 | 说明 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md index d8916475ad5229f168948a17caffd1e7c0f66210..2b628baa23577ce114710afb70c8c256a31cd94c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md @@ -1,6 +1,8 @@ # 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 - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | string | 否 | - | 搜索文本值。 | - | placeholder | string | 否 | - | 无输入时的提示文本。| - | icon | string | 否 | - | 搜索图标路径，默认使用系统搜索图标，支持的图标格式: svg, jpg和png。 | - | controller | SearchController | 否 | - | 控制器。| + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ----------- | ---------------- | ---- | ---- | ---------------------------------------- | + | value | string | 否 | - | 搜索文本值。 | + | placeholder | string | 否 | - | 无输入时的提示文本。 | + | icon | string | 否 | - | 搜索图标路径，默认使用系统搜索图标，支持的图标格式: svg, jpg和png。 | + | controller | SearchController | 否 | - | 控制器。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| searchButton | string | 无 | 搜索框末尾搜索按钮文本值，默认无搜索按钮。| -| placeholderColor | [ResourceColor](../../ui/ts-types.md) | - | 设置placeholder颜色。| -| placeholderFont | [Font](../../ui/ts-types.md) | - | 设置placeholder文本样式。| -| textFont | [Font](../../ui/ts-types.md) | - | 设置搜索框内文本样式。| +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------------- | ------------------------------------- | ---- | --------------------- | +| searchButton | string | 无 | 搜索框末尾搜索按钮文本值，默认无搜索按钮。 | +| placeholderColor | [ResourceColor](../../ui/ts-types.md) | - | 设置placeholder颜色。 | +| placeholderFont | [Font](../../ui/ts-types.md) | - | 设置placeholder文本样式。 | +| textFont | [Font](../../ui/ts-types.md) | - | 设置搜索框内文本样式。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onSubmit(callback: (value: string) => void) | 点击搜索图标、搜索按钮或者按下软键盘搜索按钮时触发。
-value: 当前输入文本框的内容。| -| onChange(callback: (value: string) => void) | 输入内容发生变化时，触发回调。
-value: 当前输入文本框的内容。| -| onCopy(callback: (value: string) => void) | 组件触发系统剪切板复制操作。
-value: 复制的文本内容。| -| onCut(callback: (value: string) => void) | 组件触发系统剪切板剪切操作。
-value: 剪切的文本内容。| -| onPaste(callback: (value: string) => void) | 组件触发系统剪切板粘贴操作。
-value: 粘贴的文本内容。| +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onSubmit(callback: (value: string) => void) | 点击搜索图标、搜索按钮或者按下软键盘搜索按钮时触发。
-value: 当前输入文本框的内容。 | +| onChange(callback: (value: string) => void) | 输入内容发生变化时，触发回调。
-value: 当前输入文本框的内容。 | +| onCopy(callback: (value: string) => void) | 组件触发系统剪切板复制操作。
-value: 复制的文本内容。 | +| onCut(callback: (value: string) => void) | 组件触发系统剪切板剪切操作。
-value: 剪切的文本内容。 | +| onPaste(callback: (value: string) => void) | 组件触发系统剪切板粘贴操作。
-value: 粘贴的文本内容。 | ## SearchController Search组件的控制器，通过它操作Search组件。 -#### 导入对象 +### 导入对象 ``` controller: SearchController = new SearchController() ``` -#### caretPosition +### caretPosition -creatPosition(value: number): viod +caretPosition(value: number): viod 设置输入光标的位置。 - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---- | ------ | ---- | ---- | --------------------- | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ----- | ------ | ---- | ---- | ----------------- | | value | number | 是 | - | 从字符串开始到光标所在位置的长度。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md index 279471bbf8ae99a48673addb5fd64e17c2f1a760..b756ad0acd2c93f4ef17fd06ca4dc2f554933ea5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md @@ -84,12 +84,12 @@ controller: TextInputController = new TextInputController() caretPosition(value: number): void -设置光标移动到指定位置。 +设置输入光标的位置。 - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ------ | ---- | ---- | ---------------------------------------- | - | value | number | 是 | - | 设置输入光标的位置。
value：从字符串开始到光标所在位置的字符长度。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ----- | ------ | ---- | ---- | ------------------- | + | value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md b/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md index e09b18331636eae7ba6539ce0373e4bb8f46f1bc..54950652de7e734e81f1d22f406ee059d63b35e0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md @@ -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) | 否 | - | 视频播放源的路径，支持本地视频路径和网络路径。
支持在resources下面的video或rawfile文件夹里放置媒体资源。
支持dataability://的路径前缀，用于访问通过Data Ability提供的视频路径，具体路径信息详见[Data Ability说明](../../ability/fa-dataability.md)。 | - | currentProgressRate | number \| PlaybackSpeed8+ | 否 | 1.0 \| PlaybackSpeed.
Speed_Forward_1_00_X | 视频播放倍速。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> number取值仅支持：0.75，1.0，1.25，1.75，2.0。
| - | previewUri | string \| PixelMap8+ \| [Resource](../../ui/ts-types.md) | 否 | - | 预览图片的路径。 | - | controller | [VideoController](#videocontroller) | 否 | - | 控制器。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ------------------- | ---------------------------------------- | ---- | ---------------------------------------- | ---------------------------------------- | + | src | string \| [Resource](../../ui/ts-types.md) | 否 | - | 视频播放源的路径，支持本地视频路径和网络路径。
支持在resources下面的video或rawfile文件夹里放置媒体资源。
支持dataability://的路径前缀，用于访问通过Data Ability提供的视频路径，具体路径信息详见[Data Ability说明](../../ability/fa-dataability.md)。 | + | currentProgressRate | number \| PlaybackSpeed8+ | 否 | 1.0 \| PlaybackSpeed.
Speed_Forward_1_00_X | 视频播放倍速。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> number取值仅支持：0.75，1.0，1.25，1.75，2.0。
| + | previewUri | string \| PixelMap8+ \| [Resource](../../ui/ts-types.md) | 否 | - | 预览图片的路径。 | + | controller | [VideoController](#videocontroller) | 否 | - | 控制器。 | - PlaybackSpeed8+类型接口说明 - | 名称 | 描述 | - | -------- | -------- | + | 名称 | 描述 | + | -------------------- | --------- | | 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 | 是 | - | 跳转模式。 | - SeekMode8+类型接口说明 - | 名称 | 描述 | - | -------- | -------- | - | PreviousKeyframe | 跳转到前一个最近的关键帧。 | - | NextKeyframe | 跳转到后一个最近的关键帧。 | - | ClosestKeyframe | 跳转到最近的关键帧。 | - | Accurate | 精准跳转，不论是否为关键帧。 | + | 名称 | 描述 | + | ---------------- | -------------- | + | PreviousKeyframe | 跳转到前一个最近的关键帧。 | + | NextKeyframe | 跳转到后一个最近的关键帧。 | + | ClosestKeyframe | 跳转到最近的关键帧。 | + | Accurate | 精准跳转，不论是否为关键帧。 | diff --git a/zh-cn/application-dev/task-management/Readme-CN.md b/zh-cn/application-dev/task-management/Readme-CN.md new file mode 100644 index 0000000000000000000000000000000000000000..4fa19ff234a346a8746ea99df6a6684bbce621de --- /dev/null +++ b/zh-cn/application-dev/task-management/Readme-CN.md @@ -0,0 +1,11 @@ +# 任务管理 + +后台任务 + + - [后台任务概述](background-task-overview.md) + - [后台任务开发指导](background-task-dev-guide.md) + +延迟任务调度 + + - [延迟任务调度概述](work-scheduler-overview.md) + - [延迟任务调度开发指导](work-scheduler-dev-guide.md) \ No newline at end of file diff --git a/zh-cn/application-dev/background-task-management/background-task-dev-guide.md b/zh-cn/application-dev/task-management/background-task-dev-guide.md similarity index 86% rename from zh-cn/application-dev/background-task-management/background-task-dev-guide.md rename to zh-cn/application-dev/task-management/background-task-dev-guide.md index 1813639e5dbf43858b25d0d2806a6ecd2164f53a..8652b3012d203b154ea0a669eadaf2a731d24655 100644 --- a/zh-cn/application-dev/background-task-management/background-task-dev-guide.md +++ b/zh-cn/application-dev/task-management/background-task-dev-guide.md @@ -10,11 +10,11 @@ **表1** 短时任务主要接口 -| 接口名 | 描述 | -| -------- | -------- | +| 接口名 | 描述 | +| ---------------------------------------- | ---------------------------------------- | | requestSuspendDelay(reason: string, callback: Callback<void>): [DelaySuspendInfo](../reference/apis/js-apis-backgroundTaskManager.md#delaysuspendinfo) | 后台应用申请延迟挂起。
延迟挂起时间一般情况下默认值为180000，低电量时默认值为60000。 | -| getRemainingDelayTime(requestId: number): Promise<number> | 获取应用程序进入挂起状态前的剩余时间。
其任务执行结果以Promise形式返回给应用。 | -| cancelSuspendDelay(requestId: number): void | 取消延迟挂起。 | +| getRemainingDelayTime(requestId: number): Promise<number> | 获取应用程序进入挂起状态前的剩余时间。
使用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); }); - + ``` ### 开发实例 diff --git a/zh-cn/application-dev/background-task-management/background-task-overview.md b/zh-cn/application-dev/task-management/background-task-overview.md similarity index 100% rename from zh-cn/application-dev/background-task-management/background-task-overview.md rename to zh-cn/application-dev/task-management/background-task-overview.md diff --git a/zh-cn/application-dev/background-task-management/public_sys-resources/icon-caution.gif b/zh-cn/application-dev/task-management/public_sys-resources/icon-caution.gif similarity index 100% rename from zh-cn/application-dev/background-task-management/public_sys-resources/icon-caution.gif rename to zh-cn/application-dev/task-management/public_sys-resources/icon-caution.gif diff --git a/zh-cn/application-dev/background-task-management/public_sys-resources/icon-danger.gif b/zh-cn/application-dev/task-management/public_sys-resources/icon-danger.gif similarity index 100% rename from zh-cn/application-dev/background-task-management/public_sys-resources/icon-danger.gif rename to zh-cn/application-dev/task-management/public_sys-resources/icon-danger.gif diff --git a/zh-cn/application-dev/background-task-management/public_sys-resources/icon-note.gif b/zh-cn/application-dev/task-management/public_sys-resources/icon-note.gif similarity index 100% rename from zh-cn/application-dev/background-task-management/public_sys-resources/icon-note.gif rename to zh-cn/application-dev/task-management/public_sys-resources/icon-note.gif diff --git a/zh-cn/application-dev/background-task-management/public_sys-resources/icon-notice.gif b/zh-cn/application-dev/task-management/public_sys-resources/icon-notice.gif similarity index 100% rename from zh-cn/application-dev/background-task-management/public_sys-resources/icon-notice.gif rename to zh-cn/application-dev/task-management/public_sys-resources/icon-notice.gif diff --git a/zh-cn/application-dev/background-task-management/public_sys-resources/icon-tip.gif b/zh-cn/application-dev/task-management/public_sys-resources/icon-tip.gif similarity index 100% rename from zh-cn/application-dev/background-task-management/public_sys-resources/icon-tip.gif rename to zh-cn/application-dev/task-management/public_sys-resources/icon-tip.gif diff --git a/zh-cn/application-dev/background-task-management/public_sys-resources/icon-warning.gif b/zh-cn/application-dev/task-management/public_sys-resources/icon-warning.gif similarity index 100% rename from zh-cn/application-dev/background-task-management/public_sys-resources/icon-warning.gif rename to zh-cn/application-dev/task-management/public_sys-resources/icon-warning.gif diff --git a/zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md b/zh-cn/application-dev/task-management/work-scheduler-dev-guide.md similarity index 97% rename from zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md rename to zh-cn/application-dev/task-management/work-scheduler-dev-guide.md index e8f504d8be709881243dc8b4ec5bc945e4cd15b4..d64295583767f6de62206e9b40f545fe9c421cae 100644 --- a/zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md +++ b/zh-cn/application-dev/task-management/work-scheduler-dev-guide.md @@ -1,184 +1,184 @@ -# 延迟任务调度开发指导 - -## 场景介绍 - -应用要执行对实时性要求不高的任务的时候，比如设备空闲时候做一次数据学习等场景，可以使用延迟调度任务，该机制在满足应用设定条件的时候，会根据系统当前状态，如内存、功耗、热等统一决策调度时间。 - - -## 接口说明 -注册相关接口包导入： -```js -import workScheduler from '@ohos.workScheduler'; -``` - -回调相关接口包导入： -```js -import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; -``` - -### 延迟任务调度 - -**表1** workScheduler主要接口 - -接口名 | 接口描述 ----------------------------------------------------------|----------------------------------------- -function startWork(work: WorkInfo): boolean; | 延迟调度任务申请 -function stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消 -function getWorkStatus(workId: number, callback: AsyncCallback): void;| 获取延迟调度任务状态（Callback形式） -function getWorkStatus(workId: number): Promise; | 获取延迟调度任务状态（Promise形式） -function obtainAllWorks(callback: AsyncCallback): Array;| 获取所有延迟调度任务（Callback形式） -function obtainAllWorks(): Promise>;| 获取所有延迟调度任务（Promise形式） -function stopAndClearWorks(): boolean;| 停止并清除任务 -function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| 获取上次任务是否超时（针对RepeatWork，Callback形式） -function isLastWorkTimeOut(workId: number): Promise;| 获取上次任务是否超时（针对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** 延迟任务回调接口 - -接口名 | 接口描述 ----------------------------------------------------------|----------------------------------------- -function onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调 -function 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主要接口 + +接口名 | 接口描述 +---------------------------------------------------------|----------------------------------------- +function startWork(work: WorkInfo): boolean; | 延迟调度任务申请 +function stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消 +function getWorkStatus(workId: number, callback: AsyncCallback): void;| 获取延迟调度任务状态（Callback形式） +function getWorkStatus(workId: number): Promise; | 获取延迟调度任务状态（Promise形式） +function obtainAllWorks(callback: AsyncCallback): Array;| 获取所有延迟调度任务（Callback形式） +function obtainAllWorks(): Promise>;| 获取所有延迟调度任务（Promise形式） +function stopAndClearWorks(): boolean;| 停止并清除任务 +function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| 获取上次任务是否超时（针对RepeatWork，Callback形式） +function isLastWorkTimeOut(workId: number): Promise;| 获取上次任务是否超时（针对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** 延迟任务回调接口 + +接口名 | 接口描述 +---------------------------------------------------------|----------------------------------------- +function onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调 +function 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 diff --git a/zh-cn/application-dev/work-scheduler/work-scheduler-overview.md b/zh-cn/application-dev/task-management/work-scheduler-overview.md similarity index 100% rename from zh-cn/application-dev/work-scheduler/work-scheduler-overview.md rename to zh-cn/application-dev/task-management/work-scheduler-overview.md diff --git a/zh-cn/application-dev/ui/ui-ts-overview.md b/zh-cn/application-dev/ui/ui-ts-overview.md index bd01231a5e8f99cfd3ecb47b1f4f0a0b67708e98..c1c2f3bcf2de96e6948d6e62b0e8f70f6d73770d 100644 --- a/zh-cn/application-dev/ui/ui-ts-overview.md +++ b/zh-cn/application-dev/ui/ui-ts-overview.md @@ -42,7 +42,7 @@ - **语言运行时** - 选用方舟语言运行时，提供了针对UI范式语法的解析能力，提供了跨语言调用支持，提供了TS语言高性能运行环境。 + 选用方舟语言运行时，提供了针对UI范式语法的解析能力、跨语言调用支持的能力和TS语言高性能运行环境。 - **声明式UI后端引擎** diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index c5dbe55c84d520fbfaea0a47c01e6b6e07f7d6f3..532ea2af7ba13856a45dcedb67a5420fc587e815 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -28,7 +28,6 @@ - [HarmonyAppProvision配置文件](quick-start/app-provision-structure.md) - - 开发 @@ -74,7 +73,6 @@ - UI开发 - - [方舟开发框架（ArkUI）概述](ui/arkui-overview.md) - 基于JS扩展的类Web开发范式 @@ -404,7 +402,6 @@ * [屏幕截图开发指导](windowmanager/screenshot-guidelines.md) - - WebGL @@ -441,7 +438,6 @@ - [图片开发指导](media/image.md) - - 相机 @@ -536,18 +532,19 @@ - [后台代理提醒开发指导](background-agent-scheduled-reminder/background-agent-scheduled-reminder-guide.md) - - 后台任务管理 + - 任务管理 + - 后台任务 - - [后台任务概述](background-task-management/background-task-overview.md) + - [后台任务概述](task-management/background-task-overview.md) - - [后台任务开发指导](background-task-management/background-task-dev-guide.md) + - [后台任务开发指导](task-management/background-task-dev-guide.md) - - 延迟任务调度 + - 延迟任务调度 - - [延迟任务调度概述](work-scheduler/work-scheduler-overview.md) + - [延迟任务调度概述](task-management/work-scheduler-overview.md) - - [延迟任务调度开发指导](work-scheduler/work-scheduler-dev-guide.md) + - [延迟任务调度开发指导](task-management/work-scheduler-dev-guide.md) - 设备管理 @@ -611,7 +608,6 @@ - [分布式跟踪开发指导](dfx/hitracechain-guidelines.md) - - 国际化 @@ -1563,7 +1559,6 @@ - 已停止维护的接口 - - [@ohos.bytrace (性能打点)](reference/apis/js-apis-bytrace.md) diff --git a/zh-cn/application-dev/work-scheduler/Readme-CN.md b/zh-cn/application-dev/work-scheduler/Readme-CN.md deleted file mode 100644 index 789acd86ce1e7bb35fd329ea5ea689eced36dfb0..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/work-scheduler/Readme-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -# 延迟任务调度 - - [延迟任务调度概述](work-scheduler-overview.md) - - [延迟任务调度开发指导](work-scheduler-dev-guide.md) \ No newline at end of file