• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Work Scheduler Callbacks
2
3> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**<br/>
4> The initial APIs of this module are supported since API version 9. API version 9 is a canary version for trial use. The APIs of this version may be unstable.
5
6
7## Modules to Import
8
9```
10import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'
11```
12
13## WorkSchedulerExtensionAbility.onWorkStart
14
15onWorkStart(work: workScheduler.WorkInfo): void
16
17Triggered when the Work Scheduler task starts.
18
19**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
20
21**Parameters**
22
23| Name | Type                   | Mandatory  | Description            |
24| ---- | --------------------- | ---- | -------------- |
25| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | Yes   | Task to be added to the execution queue.|
26
27**Example**
28
29  ```
30    export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
31        onWorkStart(workInfo) {
32            console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
33        }
34    }
35  ```
36
37## WorkSchedulerExtensionAbility.onWorkStop
38
39onWorkStop(work: workScheduler.WorkInfo): void
40
41Triggered when the Work Scheduler task stops.
42
43**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
44
45**Parameters**
46
47| Name | Type                   | Mandatory  | Description            |
48| ---- | --------------------- | ---- | -------------- |
49| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | Yes   | Task to be added to the execution queue.|
50
51
52**Example**
53
54  ```
55    export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
56        onWorkStop(workInfo) {
57            console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
58        }
59    }
60  ```
61