@@ -21,18 +21,18 @@ Before registering any task, the WorkManager plugin must be initialized.
21
21
22
22
``` dart
23
23
void callbackDispatcher() {
24
- Workmanager.executeTask((task, inputData) {
24
+ Workmanager() .executeTask((task, inputData) {
25
25
print("Native called background task: $backgroundTask"); //simpleTask will be emitted here.
26
26
return Future.value(true);
27
27
});
28
28
}
29
29
30
30
void main() {
31
- Workmanager.initialize(
31
+ Workmanager() .initialize(
32
32
callbackDispatcher, // The top level function, aka callbackDispatcher
33
33
isInDebugMode: true // If enabled it will post a notification whenever the task is running. Handy for debugging tasks
34
34
);
35
- Workmanager.registerOneOffTask("1", "simpleTask"); //Android only (see below)
35
+ Workmanager() .registerOneOffTask("1", "simpleTask"); //Android only (see below)
36
36
runApp(MyApp());
37
37
}
38
38
```
@@ -50,15 +50,15 @@ Two kinds of background tasks can be registered :
50
50
51
51
``` dart
52
52
// One off task registration
53
- Workmanager.registerOneOffTask(
53
+ Workmanager() .registerOneOffTask(
54
54
"1",
55
55
"simpleTask"
56
56
);
57
57
58
58
// Periodic task registration
59
- Workmanager.registerPeriodicTask(
59
+ Workmanager() .registerPeriodicTask(
60
60
"2",
61
- "simplePeriodicTask", \
61
+ "simplePeriodicTask",
62
62
// When no frequency is provided the default 15 minutes is set.
63
63
// Minimum frequency is 15 min. Android will automatically change your frequency to 15 min if you have configured a lower frequency.
64
64
frequency: Duration(hours: 1),
@@ -76,7 +76,7 @@ Handy for cancellation by `tag`.
76
76
This is different from the unique name in that you can group multiple tasks under one tag.
77
77
78
78
``` dart
79
- Workmanager.registerOneOffTask("1", "simpleTask", tag: "tag");
79
+ Workmanager() .registerOneOffTask("1", "simpleTask", tag: "tag");
80
80
```
81
81
82
82
## Existing Work Policy
@@ -85,23 +85,23 @@ Indicates the desired behaviour when the same task is scheduled more than once.
85
85
The default is ` KEEP `
86
86
87
87
``` dart
88
- Workmanager.registerOneOffTask("1", "simpleTask", existingWorkPolicy: ExistingWorkPolicy.append);
88
+ Workmanager() .registerOneOffTask("1", "simpleTask", existingWorkPolicy: ExistingWorkPolicy.append);
89
89
```
90
90
91
91
## Initial Delay
92
92
93
93
Indicates how along a task should waitbefore its first run.
94
94
95
95
``` dart
96
- Workmanager.registerOneOffTask("1", "simpleTask", initialDelay: Duration(seconds: 10));
96
+ Workmanager() .registerOneOffTask("1", "simpleTask", initialDelay: Duration(seconds: 10));
97
97
```
98
98
99
99
## Constraints
100
100
101
101
> Not all constraints are mapped.
102
102
103
103
``` dart
104
- Workmanager.registerOneOffTask(
104
+ Workmanager() .registerOneOffTask(
105
105
"1",
106
106
"simpleTask",
107
107
constraints: Constraints(
@@ -119,7 +119,7 @@ Workmanager.registerOneOffTask(
119
119
Add some input data for your task. Valid value types are: ` int ` , ` bool ` , ` double ` , ` String ` and their ` list `
120
120
121
121
``` dart
122
- Workmanager.registerOneOffTask(
122
+ Workmanager() .registerOneOffTask(
123
123
"1",
124
124
"simpleTask",
125
125
inputData: {
@@ -137,7 +137,7 @@ The default is `BackoffPolicy.exponential`.
137
137
You can also specify the delay.
138
138
139
139
``` dart
140
- Workmanager.registerOneOffTask("1", "simpleTask", backoffPolicy: BackoffPolicy.exponential, backoffPolicyDelay: Duration(seconds: 10));
140
+ Workmanager() .registerOneOffTask("1", "simpleTask", backoffPolicy: BackoffPolicy.exponential, backoffPolicyDelay: Duration(seconds: 10));
141
141
```
142
142
143
143
## Cancellation
@@ -149,17 +149,17 @@ A task can be cancelled in different ways :
149
149
Cancels the task that was previously registered using this ** Tag** , if any.
150
150
151
151
``` dart
152
- Workmanager.cancelByTag("tag");
152
+ Workmanager() .cancelByTag("tag");
153
153
```
154
154
155
155
### By Unique Name
156
156
157
157
``` dart
158
- Workmanager.cancelByUniqueName("<MyTask>");
158
+ Workmanager() .cancelByUniqueName("<MyTask>");
159
159
```
160
160
161
161
### All
162
162
163
163
``` dart
164
- Workmanager.cancelAll();
164
+ Workmanager() .cancelAll();
165
165
```
0 commit comments