提交 ecdb4b7e 编写于 作者: 陈明

更新文档

Signed-off-by: N陈明 <chenming48@huawei.com>
上级 89eeafe4
...@@ -10,13 +10,14 @@ ...@@ -10,13 +10,14 @@
import workScheduler from '@ohos.workScheduler' import workScheduler from '@ohos.workScheduler'
``` ```
## 系统能力
SystemCapability.ResourceSchedule.WorkScheduler
## workScheduler.startWork ## workScheduler.startWork
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
workScheduler.startWork(work: WorkInfo): boolean workScheduler.startWork(work: WorkInfo): boolean
- **说明**
通知WorkSchedulerService将工作添加到执行队列。 通知WorkSchedulerService将工作添加到执行队列。
- **参数** - **参数**
...@@ -48,12 +49,15 @@ workScheduler.startWork(work: WorkInfo): boolean ...@@ -48,12 +49,15 @@ workScheduler.startWork(work: WorkInfo): boolean
``` ```
## workScheduler.stopWork ## workScheduler.stopWork
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
stopWork(work: WorkInfo, needCancel?: boolean): boolean stopWork(work: WorkInfo, needCancel?: boolean): boolean
- **说明**
通知WorkSchedulerService停止指定工作。 通知WorkSchedulerService停止指定工作。
- **参数** - **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -84,11 +88,14 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean ...@@ -84,11 +88,14 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
``` ```
## workScheduler.getWorkStatus ## workScheduler.getWorkStatus
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
getWorkStatus(workId: number, callback : AsyncCallback<WorkInfo>): void getWorkStatus(workId: number, callback : AsyncCallback<WorkInfo>): void
获取工作的最新状态,使用callback形式返回。 - **说明**
获取工作的最新状态,使用Callback形式返回。
- **参数** - **参数**
...@@ -113,9 +120,13 @@ getWorkStatus(workId: number, callback : AsyncCallback<WorkInfo>): void ...@@ -113,9 +120,13 @@ getWorkStatus(workId: number, callback : AsyncCallback<WorkInfo>): void
``` ```
## workScheduler.getWorkStatus ## workScheduler.getWorkStatus
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
getWorkStatus(workID: number): Promise<WorkInfo> getWorkStatus(workID: number): Promise<WorkInfo>
- **说明**
获取工作的最新状态,使用Promise形式返回。 获取工作的最新状态,使用Promise形式返回。
- **参数** - **参数**
...@@ -143,10 +154,14 @@ getWorkStatus(workID: number): Promise<WorkInfo> ...@@ -143,10 +154,14 @@ getWorkStatus(workID: number): Promise<WorkInfo>
``` ```
## workScheduler.obtainAllWorks ## workScheduler.obtainAllWorks
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
obtainAllWorks(callback : AsyncCallback<void>): Array<WorkInfo> obtainAllWorks(callback : AsyncCallback<void>): Array<WorkInfo>
获取与当前应用程序关联的所有工作,使用callback形式返回。 - **说明**
获取与当前应用程序关联的所有工作,使用Callback形式返回。
- **参数** - **参数**
...@@ -174,9 +189,13 @@ obtainAllWorks(callback : AsyncCallback<void>): Array<WorkInfo> ...@@ -174,9 +189,13 @@ obtainAllWorks(callback : AsyncCallback<void>): Array<WorkInfo>
``` ```
## workScheduler.obtainAllWorks ## workScheduler.obtainAllWorks
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
obtainAllWorks(): Promise<Array<WorkInfo>> obtainAllWorks(): Promise<Array<WorkInfo>>
- **说明**
获取与当前应用程序关联的所有工作,使用Promise形式返回。 获取与当前应用程序关联的所有工作,使用Promise形式返回。
- **返回值** - **返回值**
...@@ -196,9 +215,13 @@ obtainAllWorks(): Promise<Array<WorkInfo>> ...@@ -196,9 +215,13 @@ obtainAllWorks(): Promise<Array<WorkInfo>>
``` ```
## workScheduler.stopAndClearWorks ## workScheduler.stopAndClearWorks
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
stopAndClearWorks(): boolean stopAndClearWorks(): boolean
- **说明**
停止和取消与当前应用程序关联的所有工作。 停止和取消与当前应用程序关联的所有工作。
- **示例** - **示例**
...@@ -209,10 +232,14 @@ stopAndClearWorks(): boolean ...@@ -209,10 +232,14 @@ stopAndClearWorks(): boolean
``` ```
## workScheduler.isLastWorkTimeOut ## workScheduler.isLastWorkTimeOut
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
isLastWorkTimeOut(workId: number, callback : AsyncCallback<void>): boolean isLastWorkTimeOut(workId: number, callback : AsyncCallback<void>): boolean
检查指定工作的最后一次执行是否为超时操作,使用callback形式返回。 - **说明**
检查指定工作的最后一次执行是否为超时操作,使用Callback形式返回。
- **参数** - **参数**
...@@ -240,9 +267,13 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback<void>): boolean ...@@ -240,9 +267,13 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback<void>): boolean
``` ```
## workScheduler.isLastWorkTimeOut ## workScheduler.isLastWorkTimeOut
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
obtainAllWorks(): Promise<Array<WorkInfo>> - **接口**
isLastWorkTimeOut(workId: number): Promise<boolean>
- **说明**
检查指定工作的最后一次执行是否为超时操作,使用Promise形式返回。 检查指定工作的最后一次执行是否为超时操作,使用Promise形式返回。
- **参数** - **参数**
...@@ -271,6 +302,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>> ...@@ -271,6 +302,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>>
``` ```
## workScheduler.WorkInfo ## workScheduler.WorkInfo
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
提供工作的具体信息。 提供工作的具体信息。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -289,6 +323,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>> ...@@ -289,6 +323,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>>
|repeatCount |number|否|循环次数| |repeatCount |number|否|循环次数|
## workScheduler.NetworkType ## workScheduler.NetworkType
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
触发工作的网络类型。 触发工作的网络类型。
|名称 |默认值 |说明| |名称 |默认值 |说明|
...@@ -301,6 +338,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>> ...@@ -301,6 +338,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>>
|NETWORK_TYPE_ETHERNET |5 |表示这个触发条件是有线网络连接。| |NETWORK_TYPE_ETHERNET |5 |表示这个触发条件是有线网络连接。|
## workScheduler.ChargingType ## workScheduler.ChargingType
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
触发工作的充电类型。 触发工作的充电类型。
|名称 |默认值 |说明| |名称 |默认值 |说明|
...@@ -311,6 +351,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>> ...@@ -311,6 +351,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>>
|CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。| |CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。|
## workScheduler.BatteryStatus ## workScheduler.BatteryStatus
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
触发工作的电池状态。 触发工作的电池状态。
|名称 |默认值 |说明| |名称 |默认值 |说明|
...@@ -320,6 +363,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>> ...@@ -320,6 +363,9 @@ obtainAllWorks(): Promise<Array<WorkInfo>>
|BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。| |BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。|
## workScheduler.StorageRequest ## workScheduler.StorageRequest
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
触发工作的存储状态。 触发工作的存储状态。
|名称 |默认值 |说明| |名称 |默认值 |说明|
......
...@@ -10,13 +10,14 @@ ...@@ -10,13 +10,14 @@
import workSchedulerExtension from '@ohos.WorkSchedulerExtension' import workSchedulerExtension from '@ohos.WorkSchedulerExtension'
``` ```
## 系统能力
SystemCapability.ResourceSchedule.WorkScheduler
## WorkSchedulerExtension.onWorkStart ## WorkSchedulerExtension.onWorkStart
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
onWorkStart(workInfo: WorkInfo); onWorkStart(workInfo: WorkInfo);
- **说明**
延迟任务调度开始回调。 延迟任务调度开始回调。
- **示例** - **示例**
...@@ -30,9 +31,13 @@ onWorkStart(workInfo: WorkInfo); ...@@ -30,9 +31,13 @@ onWorkStart(workInfo: WorkInfo);
``` ```
## WorkSchedulerExtension.onWorkStop ## WorkSchedulerExtension.onWorkStop
- **系统能力**
SystemCapability.ResourceSchedule.WorkScheduler
- **接口**
onWorkStop(workInfo: WorkInfo); onWorkStop(workInfo: WorkInfo);
- **说明**
延迟任务调度结束回调。 延迟任务调度结束回调。
- **示例** - **示例**
......
...@@ -6,17 +6,17 @@ ...@@ -6,17 +6,17 @@
## 接口说明 ## 接口说明
注册等相关接口 注册相关接口包导入
```js ```js
import workScheduler from '@ohos.workScheduler'; import workScheduler from '@ohos.workScheduler';
``` ```
回调接口 回调相关接口包导入
```js ```js
import WorkSchedulerExtension from '@ohos.WorkSchedulerExtension'; import WorkSchedulerExtension from '@ohos.WorkSchedulerExtension';
``` ```
## 延迟任务调度 ### 延迟任务调度
**表1** workScheduler主要接口 **表1** workScheduler主要接口
...@@ -56,7 +56,7 @@ repeatCount |循环次数| number ...@@ -56,7 +56,7 @@ repeatCount |循环次数| number
function onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调 function onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调
function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调 function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调
## 开发步骤 ### 开发步骤
**开发对应的Extension** **开发对应的Extension**
......
# 延迟任务调度概述 # 延迟任务调度概述
延迟任务调度部件给应用提供一个可以执行实时性不高的任务的机制。当满足设定条件时,会被放入可执行队列,系统根据设备情况,延迟触发可执行队列内的任务。 延迟任务调度给应用提供一个机制,允许应用根据系统安排,在系统空闲时执行实时性不高的任务。当满足设定条件的时候,任务会被放入待调度队列,当系统空闲时调度该任务。
## 使用说明 ## 使用说明
应用要执行对实时性要求不高的任务的时候,比如设备空闲时候做一次数据学习等场景,可以使用延迟调度任务,该机制在满足应用设定条件的时候,会根据系统当前状态,如内存、功耗、热等统一决策调度时间 应用要执行对实时性要求不高的任务的时候,比如设备空闲时候做一次数据学习等场景,可以使用延迟调度任务,该机制在满足应用设定条件的时候,会根据系统当前状态,如内存、功耗、温度等统一决策调度时机
## 延迟任务调度约束 ## 延迟任务调度约束
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册