- [ios] allows to register custom task id

Author: tuyen-vuduc

README.md

@@ -35,7 +35,7 @@ void main() {
     callbackDispatcher, // The top level function, aka callbackDispatcher
     isInDebugMode: true // If enabled it will post a notification whenever the task is running. Handy for debugging tasks
   );
-  Workmanager().registerOneOffTask("1", "simpleTask"); //Android only (see below)
+  Workmanager().registerOneOffTask("task-identifier", "simpleTask");
   runApp(MyApp());
 }
 ```
@@ -90,7 +90,7 @@ iOS supports **One off tasks** with a few basic constraints:
 
 ```dart
 Workmanager().registerOneOffTask(
-  "1", // Ignored on iOS
+  "task-identifier",
   simpleTaskKey, // Ignored on iOS
   initialDelay: Duration(minutes: 30),
   constraints: Constraints(
@@ -103,7 +103,29 @@ Workmanager().registerOneOffTask(
 );
 ```
 
-Tasks registered this way will appear in the callback dispatcher using as `Workmanager.iOSBackgroundProcessingTask`.
+**NOTE**
+
+- We have to register in ApplicationDelegate class as below example
+
+```swift
+WorkmanagerPlugin.registerTask(withIdentifier: "task-identifier")
+```
+
+- We must also define your `task-identifier` in `info.plist` file
+
+```
+<dict>
+  ....
+	<key>BGTaskSchedulerPermittedIdentifiers</key>
+	<array>
+		<string>workmanager.background.task</string>
+		<string>task-identifier</string>
+	</array>
+  ....
+</dict>
+```
+
+- The task identifier should be prefixed with app bundle id
 
 For more information see the [BGTaskScheduler documentation](https://developer.apple.com/documentation/backgroundtasks).
 
@@ -119,14 +141,14 @@ Two kinds of background tasks can be registered :
 ```dart
 // One off task registration
 Workmanager().registerOneOffTask(
-    "1",
+    "oneoff-task-identifier", 
     "simpleTask"
 );
 
 // Periodic task registration
 Workmanager().registerPeriodicTask(
-    "2",
-    "simplePeriodicTask",
+    "periodic-task-identifier", 
+    "simplePeriodicTask", 
     // When no frequency is provided the default 15 minutes is set.
     // Minimum frequency is 15 min. Android will automatically change your frequency to 15 min if you have configured a lower frequency.
     frequency: Duration(hours: 1),

example/ios/Runner.xcodeproj/project.pbxproj

@@ -8,6 +8,8 @@
 
 /* Begin PBXBuildFile section */
 		1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; };
+		235EE877270FAF0800D284BB /* Info-Release.plist in Resources */ = {isa = PBXBuildFile; fileRef = 235EE875270FAF0800D284BB /* Info-Release.plist */; };
+		235EE878270FAF0800D284BB /* Info-Debug.plist in Resources */ = {isa = PBXBuildFile; fileRef = 235EE876270FAF0800D284BB /* Info-Debug.plist */; };
 		3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; };
 		74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74858FAE1ED2DC5600515810 /* AppDelegate.swift */; };
 		97C146FC1CF9000F007C117D /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FA1CF9000F007C117D /* Main.storyboard */; };
@@ -45,6 +47,8 @@
 		1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = GeneratedPluginRegistrant.h; sourceTree = "<group>"; };
 		1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GeneratedPluginRegistrant.m; sourceTree = "<group>"; };
 		1D8E96D33387777E764CB962 /* Pods-Runner.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.release.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"; sourceTree = "<group>"; };
+		235EE875270FAF0800D284BB /* Info-Release.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = "Info-Release.plist"; sourceTree = "<group>"; };
+		235EE876270FAF0800D284BB /* Info-Debug.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = "Info-Debug.plist"; sourceTree = "<group>"; };
 		24469BF6D0EF2BB3720EC4B4 /* Pods-RunnerTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-RunnerTests.release.xcconfig"; path = "Target Support Files/Pods-RunnerTests/Pods-RunnerTests.release.xcconfig"; sourceTree = "<group>"; };
 		3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = "<group>"; };
 		57B0832593D65C5496C91850 /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = "<group>"; };
@@ -60,7 +64,6 @@
 		97C146FB1CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = "<group>"; };
 		97C146FD1CF9000F007C117D /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
 		97C147001CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = "<group>"; };
-		97C147021CF9000F007C117D /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		9EA9C43326E8F58700E77F3E /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 		9EA9C43526E8F58700E77F3E /* WorkmanagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WorkmanagerTests.swift; sourceTree = "<group>"; };
 		9EA9C43726E8F58700E77F3E /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
@@ -136,10 +139,11 @@
 		97C146F01CF9000F007C117D /* Runner */ = {
 			isa = PBXGroup;
 			children = (
+				235EE876270FAF0800D284BB /* Info-Debug.plist */,
+				235EE875270FAF0800D284BB /* Info-Release.plist */,
 				97C146FA1CF9000F007C117D /* Main.storyboard */,
 				97C146FD1CF9000F007C117D /* Assets.xcassets */,
 				97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */,
-				97C147021CF9000F007C117D /* Info.plist */,
 				97C146F11CF9000F007C117D /* Supporting Files */,
 				1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */,
 				1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */,
@@ -231,7 +235,7 @@
 				TargetAttributes = {
 					97C146ED1CF9000F007C117D = {
 						CreatedOnToolsVersion = 7.3.1;
-						DevelopmentTeam = GPGRWN6G4J;
+						DevelopmentTeam = 6KRGLYTFWP;
 						LastSwiftMigration = 1110;
 					};
 					9EA9C43226E8F58700E77F3E = {
@@ -267,8 +271,10 @@
 			buildActionMask = 2147483647;
 			files = (
 				97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */,
+				235EE877270FAF0800D284BB /* Info-Release.plist in Resources */,
 				3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */,
 				97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */,
+				235EE878270FAF0800D284BB /* Info-Debug.plist in Resources */,
 				97C146FC1CF9000F007C117D /* Main.storyboard in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -643,7 +649,7 @@
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
 				CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)";
-				DEVELOPMENT_TEAM = GPGRWN6G4J;
+				DEVELOPMENT_TEAM = 6KRGLYTFWP;
 				ENABLE_BITCODE = NO;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(inherited)",

example/ios/Runner/AppDelegate.swift

@@ -19,6 +19,8 @@ import workmanager
             // This will make other plugins available during a background operation.
             GeneratedPluginRegistrant.register(with: registry)
         }
+            
+        WorkmanagerPlugin.registerTask(withIdentifier: "vn.newwave.custom-task-identifier")
 
         return super.application(application, didFinishLaunchingWithOptions: launchOptions)
 

example/ios/Runner/Info-Debug.plist

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>NSLocalNetworkUsageDescription</key>
+	<string>Allows Flutter tools to connect and debug your application</string>
+	<key>NSBonjourServices</key>
+	<array>
+		<string>_dartobservatory._tcp</string>
+	</array>
+	<key>BGTaskSchedulerPermittedIdentifiers</key>
+	<array>
+		<string>workmanager.background.task</string>
+		<string>vn.newwave.custom-task-identifier</string>
+	</array>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>workmanager_example</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>LSRequiresIPhoneOS</key>
+	<true/>
+	<key>UIBackgroundModes</key>
+	<array>
+		<string>fetch</string>
+		<string>processing</string>
+	</array>
+	<key>UILaunchStoryboardName</key>
+	<string>LaunchScreen</string>
+	<key>UIMainStoryboardFile</key>
+	<string>Main</string>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>UISupportedInterfaceOrientations~ipad</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationPortraitUpsideDown</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>UIViewControllerBasedStatusBarAppearance</key>
+	<false/>
+</dict>
+</plist>

example/ios/Runner/Info.plist renamed to example/ios/Runner/Info-Release.plist

@@ -5,6 +5,7 @@
 	<key>BGTaskSchedulerPermittedIdentifiers</key>
 	<array>
 		<string>workmanager.background.task</string>
+		<string>vn.newwave.custom-task-identifier</string>
 	</array>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>$(DEVELOPMENT_LANGUAGE)</string>

example/lib/main.dart

@@ -126,7 +126,7 @@ class _MyAppState extends State<MyApp> {
                   child: Text("Perform a BG Task"),
                   onPressed: () {
                     Workmanager().registerOneOffTask(
-                      "1",
+                      "vn.newwave.custom-task-identifier",
                       simpleTaskKey,
                       inputData: <String, dynamic>{
                         'int': 1,
@@ -150,7 +150,7 @@ class _MyAppState extends State<MyApp> {
                   child: Text("Register OneOff Task"),
                   onPressed: () {
                     Workmanager().registerOneOffTask(
-                      "1",
+                       "vn.newwave.custom-task-identifier",
                       simpleTaskKey,
                       inputData: <String, dynamic>{
                         'int': 1,

ios/Classes/SwiftWorkmanagerPlugin.swift

@@ -10,11 +10,8 @@ extension String {
 }
 
 public class SwiftWorkmanagerPlugin: FlutterPluginAppLifeCycleDelegate {
-
     static let identifier = "be.tramckrijte.workmanager"
 
-    static let defaultBGProcessingTaskIdentifier = "workmanager.background.task"
-
     private static var flutterPluginRegistrantCallback: FlutterPluginRegistrantCallback?
 
     private struct ForegroundMethodChannel {
@@ -31,6 +28,7 @@ public class SwiftWorkmanagerPlugin: FlutterPluginAppLifeCycleDelegate {
             struct RegisterOneOffTask {
                 static let name = "\(RegisterOneOffTask.self)".lowercasingFirst
                 enum Arguments: String {
+                    case uniqueName
                     case initialDelaySeconds
                     case networkType
                     case requiresCharging
@@ -52,7 +50,7 @@ public class SwiftWorkmanagerPlugin: FlutterPluginAppLifeCycleDelegate {
     }
 
     @available(iOS 13.0, *)
-    private func handleBGProcessingTask(_ task: BGProcessingTask) {
+    private static func handleBGProcessingTask(_ task: BGProcessingTask) {
         let operationQueue = OperationQueue()
 
         // Create an operation that performs the main part of the background task
@@ -77,20 +75,18 @@ public class SwiftWorkmanagerPlugin: FlutterPluginAppLifeCycleDelegate {
         operationQueue.addOperation(operation)
     }
 
-    public override func application(_ application: UIApplication,
-                                     didFinishLaunchingWithOptions launchOptions: [AnyHashable: Any] = [:]) -> Bool {
+    @objc
+    public static func registerTask(withIdentifier identifier: String) {
         if #available(iOS 13.0, *) {
             BGTaskScheduler.shared.register(
-                forTaskWithIdentifier: SwiftWorkmanagerPlugin.defaultBGProcessingTaskIdentifier,
+                forTaskWithIdentifier: identifier,
                 using: nil
             ) { task in
                 if let task = task as? BGProcessingTask {
-                    self.handleBGProcessingTask(task)
+                    handleBGProcessingTask(task)
                 }
             }
         }
-
-        return true
     }
 }
 
@@ -156,8 +152,13 @@ extension SwiftWorkmanagerPlugin: FlutterPlugin {
                     result(WMPError.invalidParameters.asFlutterError)
                     return
                 }
+                guard let identifier =
+                        arguments[method.Arguments.uniqueName.rawValue] as? String else {
+                    result(WMPError.invalidParameters.asFlutterError)
+                    return
+                }
                 let request = BGProcessingTaskRequest(
-                    identifier: SwiftWorkmanagerPlugin.defaultBGProcessingTaskIdentifier
+                    identifier: identifier
                 )
                 let requiresCharging = arguments[method.Arguments.requiresCharging.rawValue] as? Bool ?? false
 

ios/Classes/WorkmanagerPlugin.h

@@ -1,4 +1,7 @@
 #import <Flutter/Flutter.h>
 
 @interface WorkmanagerPlugin : NSObject<FlutterPlugin>
+
++ (void)registerTaskWithIdentifier:(NSString *) taskIdentifier;
+
 @end

ios/Classes/WorkmanagerPlugin.m

@@ -16,4 +16,10 @@ + (void)setPluginRegistrantCallback:(FlutterPluginRegistrantCallback)callback {
     [SwiftWorkmanagerPlugin setPluginRegistrantCallback:callback];
 }
 
++ (void)registerTaskWithIdentifier:(NSString *) taskIdentifier {
+    if (@available(iOS 13, *)) {
+        [SwiftWorkmanagerPlugin registerTaskWithIdentifier:taskIdentifier];
+    }
+}
+
 @end