js-apis-WorkSchedulerExtensionAbility.md 2.6 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)
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
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'
```

朱天怡 已提交
19 20 21 22 23 24
## 属性

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

| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
25
| context<sup>10+</sup> | [WorkSchedulerExtensionContext](js-apis-inner-application-WorkSchedulerExtensionContext.md)  | 是 | 否 | WorkSchedulerExtension的上下文环境,继承自ExtensionContext。 |
朱天怡 已提交
26

27 28 29 30 31 32 33 34 35 36
## WorkSchedulerExtensionAbility.onWorkStart

onWorkStart(work: workScheduler.WorkInfo): void

延迟任务调度开始回调。

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

**参数**

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

**示例:** 

H
HelloCrease 已提交
43
  ```ts
44 45 46 47 48 49 50 51 52
    export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
        onWorkStart(workInfo) {
            console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
        }
    }
  ```

## WorkSchedulerExtensionAbility.onWorkStop

N
nobbo 已提交
53
onWorkStop(work: workScheduler.WorkInfo): void
54 55 56 57 58 59 60

延迟任务调度结束回调。

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

**参数**

H
HelloCrease 已提交
61 62
| 参数名  | 类型                                       | 必填   | 说明             |
| ---- | ---------------------------------------- | ---- | -------------- |
Z
修改  
zhutianyi 已提交
63
| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | 是    | 指示要添加到执行队列的工作。 |
64 65 66 67


**示例:** 

H
HelloCrease 已提交
68
  ```ts
69 70 71 72 73
    export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
        onWorkStop(workInfo) {
            console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
        }
    }
陈明 已提交
74
  ```