@ohos.resourceschedule.workScheduler (延迟任务调度)

本模块提供延迟任务注册、取消、查询的能力。在开发过程中，对于实时性要求不高的任务，可以调用本模块接口注册延迟任务，在系统空闲时根据性能、功耗、热等情况进行调度执行。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

导入模块

import { workScheduler } from '@kit.BackgroundTasksKit';

workScheduler.startWork

startWork(work: WorkInfo): void

申请延迟任务。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  
  let workInfo: workScheduler.WorkInfo = {
      workId: 1,
      batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
      isRepeat: false,
      isPersisted: true,
      bundleName: "com.example.myapplication",
      abilityName: "MyExtension",
      parameters: {
          mykey0: 1,
          mykey1: "string value",
          mykey2: true,
          mykey3: 1.5
      }
  }
  try{
    workScheduler.startWork(workInfo);
    console.info('workschedulerLog startWork success');
  } catch (error) {
    console.error(`workschedulerLog startwork failed. code is ${(error as BusinessError).code} message is ${(error as BusinessError).message}`);
  }

workScheduler.stopWork

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

取消延迟任务。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  let workInfo: workScheduler.WorkInfo = {
      workId: 1,
      batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
      isRepeat: false,
      isPersisted: true,
      bundleName: "com.example.myapplication",
      abilityName: "MyExtension",
      parameters: {
          mykey0: 1,
          mykey1: "string value",
          mykey2: true,
          mykey3: 1.5
      }
     }
  try{
    workScheduler.stopWork(workInfo, false);
    console.info('workschedulerLog stopWork success');
  } catch (error) {
    console.error(`workschedulerLog stopWork failed. code is ${(error as BusinessError).code} message is ${(error as BusinessError).message}`);
  }

workScheduler.getWorkStatus

getWorkStatus(workId: number, callback : AsyncCallback<WorkInfo>): void

通过workId获取延迟任务，使用Callback异步回调。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  workScheduler.getWorkStatus(50, (error: BusinessError, res: workScheduler.WorkInfo) => {
    if (error) {
      console.error(`workschedulerLog getWorkStatus failed. code is ${error.code} message is ${error.message}`);
    } else {
      console.info(`workschedulerLog getWorkStatus success, ${JSON.stringify(res)}`);
    }
  });

workScheduler.getWorkStatus

getWorkStatus(workId: number): Promise<WorkInfo>

通过workId获取延迟任务，使用Promise异步回调。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  workScheduler.getWorkStatus(50).then((res: workScheduler.WorkInfo) => {
    console.info(`workschedulerLog getWorkStatus success, ${JSON.stringify(res)}`);
  }).catch((error: BusinessError) => {
    console.error(`workschedulerLog getWorkStatus failed. code is ${error.code} message is ${error.message}`);
  })

workScheduler.obtainAllWorks^deprecated

obtainAllWorks(callback : AsyncCallback<void>) : Array<WorkInfo> > 从API version 10开始不再维护，建议使用workScheduler.obtainAllWorks¹⁰⁺替代

获取当前应用所有的延迟任务，使用Callback异步回调。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

workScheduler.obtainAllWorks¹⁰⁺

obtainAllWorks(callback : AsyncCallback&lt;Array&lt;WorkInfo&gt;&gt;): void

获取当前应用所有的延迟任务，使用Callback异步回调。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  workScheduler.obtainAllWorks((error: BusinessError, res: Array<workScheduler.WorkInfo>) =>{
    if (error) {
      console.error(`workschedulerLog obtainAllWorks failed. code is ${error.code} message is ${error.message}`);
    } else {
      console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`);
    }
  });

workScheduler.obtainAllWorks

obtainAllWorks(): Promise<Array<WorkInfo>>

获取当前应用所有的延迟任务，使用Promise异步回调。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  workScheduler.obtainAllWorks().then((res: Array<workScheduler.WorkInfo>) => {
    console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`);
  }).catch((error: BusinessError) => {
    console.error(`workschedulerLog obtainAllWorks failed. code is ${error.code} message is ${error.message}`);
  })

workScheduler.stopAndClearWorks

stopAndClearWorks(): void

停止和取消当前应用所有的延迟任务。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  try{
    workScheduler.stopAndClearWorks();
    console.info(`workschedulerLog stopAndClearWorks success`);
  } catch (error) {
    console.error(`workschedulerLog stopAndClearWorks failed. code is ${(error as BusinessError).code} message is ${(error as BusinessError).message}`);
  }

workScheduler.isLastWorkTimeOut^deprecated

isLastWorkTimeOut(workId: number, callback : AsyncCallback<void>): boolean

从API version 10开始不再维护，建议使用workScheduler.isLastWorkTimeOut¹⁰⁺替代

检查延迟任务的最后一次执行是否超时，使用Callback异步回调。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

workScheduler.isLastWorkTimeOut¹⁰⁺

isLastWorkTimeOut(workId: number, callback : AsyncCallback<boolean>): void

检查延迟任务的最后一次执行是否超时，使用Callback异步回调。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  workScheduler.isLastWorkTimeOut(500, (error: BusinessError, res: boolean) =>{
    if (error) {
      console.error(`workschedulerLog isLastWorkTimeOut failed. code is ${error.code} message is ${error.message}`);
    } else {
      console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`);
    }
  });

workScheduler.isLastWorkTimeOut

isLastWorkTimeOut(workId: number): Promise<boolean>

检查延迟任务的最后一次执行是否超时，使用Promise形式返回。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和workScheduler错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  workScheduler.isLastWorkTimeOut(500)
    .then((res: boolean) => {
      console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`);
    })
    .catch((error: BusinessError) =>  {
      console.error(`workschedulerLog isLastWorkTimeOut failed. code is ${error.code} message is ${error.message}`);
    });

WorkInfo

延迟任务的具体信息。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

NetworkType

触发延迟回调的网络类型。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

ChargingType

触发延迟回调的充电类型。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

BatteryStatus

触发延迟回调的电池状态。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

StorageRequest

触发延迟回调的存储状态。

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Background Tasks Kit（后台任务开发服务）

harmony 鸿蒙BackgroundProcessManager

harmony 鸿蒙TransientTask

harmony 鸿蒙TransientTask_DelaySuspendInfo

harmony 鸿蒙TransientTask_TransientTaskInfo

harmony 鸿蒙background_process_manager.h

harmony 鸿蒙DeviceUsageStatistics错误码

harmony 鸿蒙backgroundTaskManager错误码

harmony 鸿蒙reminderAgentManager错误码

harmony 鸿蒙workScheduler错误码