Skip to content

Commit 9f5d2a8

Browse files
Update README (#272)
* Update README
1 parent 82c10d0 commit 9f5d2a8

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@ Before registering any task, the WorkManager plugin must be initialized.
2121

2222
```dart
2323
void callbackDispatcher() {
24-
Workmanager.executeTask((task, inputData) {
24+
Workmanager().executeTask((task, inputData) {
2525
print("Native called background task: $backgroundTask"); //simpleTask will be emitted here.
2626
return Future.value(true);
2727
});
2828
}
2929
3030
void main() {
31-
Workmanager.initialize(
31+
Workmanager().initialize(
3232
callbackDispatcher, // The top level function, aka callbackDispatcher
3333
isInDebugMode: true // If enabled it will post a notification whenever the task is running. Handy for debugging tasks
3434
);
35-
Workmanager.registerOneOffTask("1", "simpleTask"); //Android only (see below)
35+
Workmanager().registerOneOffTask("1", "simpleTask"); //Android only (see below)
3636
runApp(MyApp());
3737
}
3838
```
@@ -50,15 +50,15 @@ Two kinds of background tasks can be registered :
5050

5151
```dart
5252
// One off task registration
53-
Workmanager.registerOneOffTask(
53+
Workmanager().registerOneOffTask(
5454
"1",
5555
"simpleTask"
5656
);
5757
5858
// Periodic task registration
59-
Workmanager.registerPeriodicTask(
59+
Workmanager().registerPeriodicTask(
6060
"2",
61-
"simplePeriodicTask", \
61+
"simplePeriodicTask",
6262
// When no frequency is provided the default 15 minutes is set.
6363
// Minimum frequency is 15 min. Android will automatically change your frequency to 15 min if you have configured a lower frequency.
6464
frequency: Duration(hours: 1),
@@ -76,7 +76,7 @@ Handy for cancellation by `tag`.
7676
This is different from the unique name in that you can group multiple tasks under one tag.
7777

7878
```dart
79-
Workmanager.registerOneOffTask("1", "simpleTask", tag: "tag");
79+
Workmanager().registerOneOffTask("1", "simpleTask", tag: "tag");
8080
```
8181

8282
## Existing Work Policy
@@ -85,23 +85,23 @@ Indicates the desired behaviour when the same task is scheduled more than once.
8585
The default is `KEEP`
8686

8787
```dart
88-
Workmanager.registerOneOffTask("1", "simpleTask", existingWorkPolicy: ExistingWorkPolicy.append);
88+
Workmanager().registerOneOffTask("1", "simpleTask", existingWorkPolicy: ExistingWorkPolicy.append);
8989
```
9090

9191
## Initial Delay
9292

9393
Indicates how along a task should waitbefore its first run.
9494

9595
```dart
96-
Workmanager.registerOneOffTask("1", "simpleTask", initialDelay: Duration(seconds: 10));
96+
Workmanager().registerOneOffTask("1", "simpleTask", initialDelay: Duration(seconds: 10));
9797
```
9898

9999
## Constraints
100100

101101
> Not all constraints are mapped.
102102
103103
```dart
104-
Workmanager.registerOneOffTask(
104+
Workmanager().registerOneOffTask(
105105
"1",
106106
"simpleTask",
107107
constraints: Constraints(
@@ -119,7 +119,7 @@ Workmanager.registerOneOffTask(
119119
Add some input data for your task. Valid value types are: `int`, `bool`, `double`, `String` and their `list`
120120

121121
```dart
122-
Workmanager.registerOneOffTask(
122+
Workmanager().registerOneOffTask(
123123
"1",
124124
"simpleTask",
125125
inputData: {
@@ -137,7 +137,7 @@ The default is `BackoffPolicy.exponential`.
137137
You can also specify the delay.
138138

139139
```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));
141141
```
142142

143143
## Cancellation
@@ -149,17 +149,17 @@ A task can be cancelled in different ways :
149149
Cancels the task that was previously registered using this **Tag**, if any.
150150

151151
```dart
152-
Workmanager.cancelByTag("tag");
152+
Workmanager().cancelByTag("tag");
153153
```
154154

155155
### By Unique Name
156156

157157
```dart
158-
Workmanager.cancelByUniqueName("<MyTask>");
158+
Workmanager().cancelByUniqueName("<MyTask>");
159159
```
160160

161161
### All
162162

163163
```dart
164-
Workmanager.cancelAll();
164+
Workmanager().cancelAll();
165165
```

0 commit comments

Comments
 (0)