diff --git a/README_ZH.md b/README_ZH.md index cf05e636fc13e8707ef4e8f47acfe3d9c103987d..98e0dd8e355a1a8c2026449ecd77e1e1ef0cd755 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -17,18 +17,36 @@ ``` -├── frameworks # 接口实现 +├── frameworks # 客户端模块 ├── interfaces -│ ├── innerkits # 对内接口目录 -│ └── kits # 对外接口目录 +│ └── kits # 对外接口模块 ├── sa_profile # 组件服务配置 -├── services # 组件服务实现 -└── utils # 组件工具实现 +├── services # 服务端模块 +└── utils # 工具类、可维可测模块 ``` ## 延迟任务调度 ### 接口说明 +1、延迟任务WorkInfo成员接口 + +接口名|接口描述|类型 +---------------------------------------------------------|-----------------------------------------|--------------------------------------------------------- +workId | 延迟任务Id(必填)|number +bundleName | 延迟任务包名(必填)|string +abilityName | 延迟任务回调通知的组件名(必填)|string +networkType | 网络条件 | NetworkType +isCharging | 是否充电 | bool +chargerType | 充电类型 | ChargingType +batteryLevel | 电量| number +batteryStatus| 电池状态| BatteryStatus +storageRequest|存储状态| StorageRequest +isRepeat|是否循环任务| boolean +repeatCycleTime |循环间隔| number +repeatCount |循环次数| number + + +2、延迟任务注册、取消、查询等相关接口 接口名 | 接口描述 ---------------------------------------------------------|----------------------------------------- @@ -39,8 +57,16 @@ function getWorkStatus(workId: number): Promise; | 获取延迟调度 function obtainAllWorks(callback: AsyncCallback): Array;| 获取所有延迟调度任务(Callback形式) function obtainAllWorks(): Promise>;| 获取所有延迟调度任务(Promise形式) function stopAndClearWorks(): boolean;| 停止并清除任务 -function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| 获取上次任务是否超时(Callback形式) -function isLastWorkTimeOut(workId: number): Promise;| 获取上次任务是否超时(Promise形式) +function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| 获取上次任务是否超时(针对RepeatWork,Callback形式) +function isLastWorkTimeOut(workId: number): Promise;| 获取上次任务是否超时(针对RepeatWork,Promise形式) + +3、延迟任务回调接口 + +接口名 | 接口描述 +---------------------------------------------------------|----------------------------------------- +function onWorkStart(work: WorkInfo): void; | 延迟调度任务回调开始 +function onWorkStop(work: WorkInfo): void; | 延迟调度任务回调结束 + ### 使用说明 应用要执行对实时性要求不高的任务的时候,比如设备空闲时候做一次数据学习等场景,可以使用延迟调度任务,该机制在满足应用设定条件的时候,会根据系统当前状态,如内存、功耗、热等统一决策调度时间。 @@ -50,6 +76,13 @@ function isLastWorkTimeOut(workId: number): Promise;| 获取上次任 延迟调度任务的使用需要遵从如下约束和规则: - **超时**:每次最长运行120s。 +- **WorkInfo参数约束** + +(1) workId、bundleName、abilityName为必填项 + +(2)至少要设置一个满足条件 + +(3)repeatCycleTime至少20分钟,当设置repeatCycleTime时,必须选填isRepeat和repeatCount中的一个。 ## 相关仓