deprecation notice & changelog (#385)

* deprecation notice & changelog

* docs

Author: ened

CHANGELOG.md

@@ -3,6 +3,7 @@
 * Android: Remove jetifier from example
 * Restore compatibility with Flutter 3.0.0, thank you @Cwiesen and @sunalwaysknows
 * Replaces `pedantic` checks with `flutter_lints`
+* Ability to specify custom tasks (and custom background work) for iOS was added. Thank you @tuyen-vuduc
 
 # 0.5.0-dev.8
 

README.md

@@ -87,7 +87,7 @@ On Android, the `BackoffPolicy` will configure how `WorkManager` is going to ret
 
 Refer to the example app for a successful, retrying and a failed task.
 
-# iOS speicific setup and note
+# iOS specific setup and note
 
 iOS supports **One off tasks** with a few basic constraints:
 

example/ios/Runner/AppDelegate.swift

@@ -27,7 +27,7 @@ import workmanager
 		WorkmanagerPlugin.registerTask(withIdentifier: "be.tramckrijte.workmanagerExample.simpleDelayedTask")
 		WorkmanagerPlugin.registerTask(withIdentifier: "be.tramckrijte.workmanagerExample.simplePeriodicTask")
 		WorkmanagerPlugin.registerTask(withIdentifier: "be.tramckrijte.workmanagerExample.simplePeriodic1HourTask")
-        
+
         return super.application(application, didFinishLaunchingWithOptions: launchOptions)
 
     }

lib/src/workmanager.dart

@@ -12,7 +12,7 @@ import 'options.dart';
 ///
 /// [taskName] Returns the value you provided when registering the task.
 /// iOS will pass [Workmanager.iOSBackgroundTask] (for background-fetch) or
-/// [Workmanager.iOSBackgroundProcessingTask] for BGTaskScheduler based tasks.
+/// custom task IDs for BGTaskScheduler based tasks.
 ///
 /// The behavior for retries is different on each platform:
 /// - Android: return `false` from the this method will reschedule the work
@@ -105,6 +105,7 @@ class Workmanager {
   ///  });
   /// }
   /// ```
+  @Deprecated('Use custom iOS task names. This property will be removed.')
   static const String iOSBackgroundProcessingTask =
       "workmanager.background.task";
 

test/workmanager_test.dart

@@ -7,15 +7,16 @@ import 'package:workmanager/src/workmanager.dart';
 
 import 'workmanager_test.mocks.dart';
 
+const testTaskName = 'ios-background-task-name';
+
 Future<bool> testCallBackDispatcher(task, inputData) {
   return Future.value(true);
 }
 
 void mySetUpWrapper() {
   GetIt.I<Workmanager>().initialize(testCallBackDispatcher);
   GetIt.I<Workmanager>().cancelAll();
-  GetIt.I<Workmanager>()
-      .cancelByUniqueName(Workmanager.iOSBackgroundProcessingTask);
+  GetIt.I<Workmanager>().cancelByUniqueName(testTaskName);
 }
 
 @GenerateMocks([Workmanager])
@@ -46,8 +47,7 @@ void main() {
       mySetUpWrapper();
 
       verify(GetIt.I<Workmanager>().initialize(testCallBackDispatcher));
-      verify(GetIt.I<Workmanager>()
-          .cancelByUniqueName(Workmanager.iOSBackgroundProcessingTask));
+      verify(GetIt.I<Workmanager>().cancelByUniqueName(testTaskName));
     });
   });
 }