延遲任務調度

本模塊提供延遲任務注冊、取消、查詢的能力。

開發者在開發應用時，通過調用延遲任務注冊接口，注冊對實時性要求不高的延遲任務，該任務默認由系統安排，在系統空閑時根據性能、功耗、熱等情況進行調度執行。

說明： 本模塊首批接口從API version 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

審核編輯 黃宇