延迟任务调度

本模块提供延迟任务注册、取消、查询的能力。

开发者在开发应用时，通过调用延迟任务注册接口，注册对实时性要求不高的延迟任务，该任务默认由系统安排，在系统空闲时根据性能、功耗、热等情况进行调度执行。

说明：本模块首批接口从APIversion 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

导入模块

import workScheduler from '@ohos.workScheduler'

workScheduler.startWork

startWork(work: WorkInfo): boolean

通知WorkSchedulerService将工作添加到执行队列。

系统能力：SystemCapability.ResourceSchedule.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);

workScheduler.stopWork

stopWork(work: WorkInfo, needCancel?: boolean): boolean

通知WorkSchedulerService停止指定工作。

系统能力：SystemCapability.ResourceSchedule.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);

workScheduler.getWorkStatus

getWorkStatus(workId: number, callback : AsyncCallback): void

获取工作的最新状态，使用Callback形式返回。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

示例：

workScheduler.getWorkStatus(50, (err, res) = > {
if (err) {
console.info('workschedulerLog getWorkStatus failed, because:' + err.code);
    } else {
for (let item in res) {
console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
      }
    }
  });

workScheduler.getWorkStatus

getWorkStatus(workId: number): Promise

获取工作的最新状态，使用Promise形式返回。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

返回值：

示例：

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);
  })

workScheduler.obtainAllWorks

obtainAllWorks(callback : AsyncCallback): Array

获取与当前应用程序关联的所有工作，使用Callback形式返回。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

返回值：

示例：

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));
    }
  });

workScheduler.obtainAllWorks

obtainAllWorks(): Promise>

获取与当前应用程序关联的所有工作，使用Promise形式返回。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

返回值：

示例：

workScheduler.obtainAllWorks().then((res) = > {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
  }).catch((err) = > {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.code);
  })

workScheduler.stopAndClearWorks

stopAndClearWorks(): boolean

停止和取消与当前应用程序关联的所有工作。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

示例：

let res = workScheduler.stopAndClearWorks();
console.info("workschedulerLog res:" + res);

workScheduler.isLastWorkTimeOut

isLastWorkTimeOut(workId: number, callback : AsyncCallback): boolean

检查指定工作的最后一次执行是否为超时操作，使用Callback形式返回。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

返回值：

示例：

workScheduler.isLastWorkTimeOut(500, (err, res) = >{
if (err) {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code);
    } else {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
    }
  });

workScheduler.isLastWorkTimeOut

isLastWorkTimeOut(workId: number): Promise

检查指定工作的最后一次执行是否为超时操作，使用Promise形式返回。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

返回值：

示例：

workScheduler.isLastWorkTimeOut(500)
.then(res = > {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
    })
.catch(err = >  {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code);
    });

WorkInfo

提供工作的具体信息。

系统能力：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler

NetworkType

触发工作的网络类型。

系统能力：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler

ChargingType

触发工作的充电类型。

系统能力：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler

BatteryStatus

触发工作的电池状态。

系统能力：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler

StorageRequest

触发工作的存储状态。

系统能力：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler

审核编辑 黄宇