js-apis-WorkSchedulerExtensionAbility.md 2.2 KB
Newer Older
1
# @ohos.workScheduler (延迟任务调度)
2

N
nobbo 已提交
3 4
本模块提供延迟任务回调能力。

N
nobbo 已提交
5
开发者在开发应用时,通过复写该模块的接口,在延迟任务触发的时候,系统会通过接口回调应用,开发者在回调接口里面可以处理自己的任务逻辑。
N
nobbo 已提交
6

H
HelloCrease 已提交
7 8
>  **说明:**
>
9 10
>  - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>  - 本模块接口仅可在Stage模型下使用。
11 12 13 14


## 导入模块

H
HelloCrease 已提交
15
```ts
16 17 18 19 20 21 22 23 24 25 26 27 28
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'
```

## WorkSchedulerExtensionAbility.onWorkStart

onWorkStart(work: workScheduler.WorkInfo): void

延迟任务调度开始回调。

**系统能力:** SystemCapability.ResourceSchedule.WorkScheduler

**参数**

H
HelloCrease 已提交
29 30
| 参数名  | 类型                                       | 必填   | 说明             |
| ---- | ---------------------------------------- | ---- | -------------- |
Z
修改  
zhutianyi 已提交
31
| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | 是    | 指示要添加到执行队列的工作。 |
32 33 34

**示例:** 

H
HelloCrease 已提交
35
  ```ts
36 37 38 39 40 41 42 43 44
    export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
        onWorkStart(workInfo) {
            console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
        }
    }
  ```

## WorkSchedulerExtensionAbility.onWorkStop

N
nobbo 已提交
45
onWorkStop(work: workScheduler.WorkInfo): void
46 47 48 49 50 51 52

延迟任务调度结束回调。

**系统能力:** SystemCapability.ResourceSchedule.WorkScheduler

**参数**

H
HelloCrease 已提交
53 54
| 参数名  | 类型                                       | 必填   | 说明             |
| ---- | ---------------------------------------- | ---- | -------------- |
Z
修改  
zhutianyi 已提交
55
| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | 是    | 指示要添加到执行队列的工作。 |
56 57 58 59


**示例:** 

H
HelloCrease 已提交
60
  ```ts
61 62 63 64 65
    export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
        onWorkStop(workInfo) {
            console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
        }
    }
陈明 已提交
66
  ```