harmony 鸿蒙@ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)

2022-08-09
浏览 (898)

@ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)

本模块提供延迟任务回调能力。开发者可重写模块接口，在延迟任务触发时，系统可通过本模块接口回调应用，在回调里处理任务逻辑。

说明：

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

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

导入模块

import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';

属性

系统能力：SystemCapability.ResourceSchedule.WorkScheduler

名称	类型	可读	可写	说明
context¹⁰⁺	WorkSchedulerExtensionContext	是	否	WorkSchedulerExtension的上下文环境，继承自ExtensionContext。

WorkSchedulerExtensionAbility.onWorkStart

onWorkStart(work: workScheduler.WorkInfo): void

开始延迟任务调度回调。

系统能力： SystemCapability.ResourceSchedule.WorkScheduler

参数：

参数名	类型	必填	说明
work	workScheduler.WorkInfo	是	要添加到执行队列的任务。

示例：

  import workScheduler from '@ohos.resourceschedule.workScheduler';

  export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
    onWorkStart(workInfo: workScheduler.WorkInfo) {
        console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
    }
  }

WorkSchedulerExtensionAbility.onWorkStop

onWorkStop(work: workScheduler.WorkInfo): void

结束延迟任务调度回调。

系统能力： SystemCapability.ResourceSchedule.WorkScheduler

参数：

参数名	类型	必填	说明
work	workScheduler.WorkInfo	是	执行队列中要结束回调的任务。

示例：

  import workScheduler from '@ohos.resourceschedule.workScheduler';

  export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
    onWorkStop(workInfo: workScheduler.WorkInfo) {
        console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
    }
  }