Merge current pr's (#1)

Author: kyle-is-loading-please-wait

example/lib/main.dart

@@ -224,7 +224,6 @@ class _MyAppState extends State<MyApp> {
                             Workmanager().registerPeriodicTask(
                               simplePeriodic1HourTask,
                               simplePeriodic1HourTask,
-                              flexInterval: Duration(minutes: 15),
                               frequency: Duration(hours: 1),
                             );
                           }
@@ -272,17 +271,6 @@ class _MyAppState extends State<MyApp> {
                       : null,
                 ),
                 SizedBox(height: 16),
-                ElevatedButton(
-                    child: Text("isscheduled (Android)"),
-                    onPressed: Platform.isAndroid
-                        ? () async {
-                            final workInfo =
-                                await Workmanager().isScheduledByUniqueName(
-                              simplePeriodicTask,
-                            );
-                            print('isscheduled = $workInfo');
-                          }
-                        : null),
                 SizedBox(height: 8),
                 Text(
                   "Task cancellation",

workmanager/ios/Classes/BackgroundTaskOperation.swift

@@ -24,6 +24,7 @@ class BackgroundTaskOperation: Operation {
         self.backgroundMode = backgroundMode
     }
 
+
     override func main() {
         let semaphore = DispatchSemaphore(value: 0)
         let worker = BackgroundWorker(mode: self.backgroundMode,
@@ -37,4 +38,4 @@ class BackgroundTaskOperation: Operation {
 
         semaphore.wait()
     }
-}
+}

workmanager/ios/Classes/BackgroundWorker.swift

@@ -113,7 +113,7 @@ class BackgroundWorker {
 
                 backgroundMethodChannel?.invokeMethod(
                     BackgroundChannel.onResultSendCommand,
-                    arguments: arguments,
+                    arguments:arguments,
                     result: { flutterResult in
                         cleanupFlutterResources()
                         let taskSessionCompleter = Date()
@@ -137,4 +137,4 @@ class BackgroundWorker {
 
         return true
     }
-}
+}

workmanager/ios/Classes/CheckBackgroundRefreshPermission.swift

@@ -0,0 +1,66 @@
+//
+//  CheckBackgroundRefreshPermission.swift
+//  workmanager
+//
+//  Created by Lars Huth on 03/11/2022.
+//
+import Foundation
+
+func checkBackgroundRefreshPermission(result: @escaping FlutterResult) -> BackgroundRefreshPermissionState {
+    switch UIApplication.shared.backgroundRefreshStatus {
+    case .available:
+        result(BackgroundRefreshPermissionState.available.rawValue)
+        return BackgroundRefreshPermissionState.available
+    case .denied:
+        result(BackgroundRefreshPermissionState.denied.rawValue)
+        return BackgroundRefreshPermissionState.denied
+    case .restricted:
+        result(BackgroundRefreshPermissionState.restricted.rawValue)
+        return BackgroundRefreshPermissionState.restricted
+    default:
+        result(
+            FlutterError(
+                code: "103",
+                message: "BGAppRefreshTask - Probably you have restricted background refresh permission. " +
+                "\n" +
+                "BackgroundRefreshStatus is unknown\n",
+                details: nil
+            )
+        )
+        return BackgroundRefreshPermissionState.unknown
+    }
+}
+
+func requestBackgroundPermission() {
+    // Request for permission
+    UIApplication.shared.open(URL(string: UIApplication.openSettingsURLString)!)
+}
+
+enum BackgroundRefreshPermissionState: String {
+    /// Background app refresh is enabled in iOS Setting
+    case available
+
+    /// Background app refresh is disabled in iOS Setting. Permission should be requested from user
+    case denied
+
+    /// iOS Setting is under parental control etc. Can't be changed by user
+    case restricted
+
+    /// Unknown state
+    case unknown
+
+    /// Convenience constructor to build a [BackgroundRefreshPermissionState] from a Dart enum.
+    init?(fromDart: String) {
+        self.init(rawValue: fromDart.camelCased(with: "_"))
+    }
+}
+
+private extension String {
+    func camelCased(with separator: Character) -> String {
+        return self.lowercased()
+            .split(separator: separator)
+            .enumerated()
+            .map { $0.offset > 0 ? $0.element.capitalized : $0.element.lowercased() }
+            .joined()
+    }
+}

workmanager/ios/Classes/SwiftWorkmanagerPlugin.swift

@@ -26,6 +26,10 @@ public class SwiftWorkmanagerPlugin: FlutterPluginAppLifeCycleDelegate {
                 }
             }
 
+            struct CheckBackgroundRefreshPermission {
+                static let name = "\(CheckBackgroundRefreshPermission.self)".lowercasingFirst
+            }
+
             struct RegisterOneOffTask {
                 static let name = "\(RegisterOneOffTask.self)".lowercasingFirst
                 enum Arguments: String {
@@ -144,7 +148,7 @@ public class SwiftWorkmanagerPlugin: FlutterPluginAppLifeCycleDelegate {
 
     /// Immediately starts a one off task
     @available(iOS 13.0, *)
-    public static func startOneOffTask(identifier: String, taskIdentifier: UIBackgroundTaskIdentifier, inputData: String, delaySeconds: Int64) {
+    public static func startOneOffTask(identifier: String, taskIdentifier: UIBackgroundTaskIdentifier, inputData:String, delaySeconds: Int64) {
         let operationQueue = OperationQueue()
         // Create an operation that performs the main part of the background task
         let operation = BackgroundTaskOperation(
@@ -267,6 +271,9 @@ extension SwiftWorkmanagerPlugin: FlutterPlugin {
         case (ForegroundMethodChannel.Methods.Initialize.name, let .some(arguments)):
             initialize(arguments: arguments, result: result)
             return
+        case (ForegroundMethodChannel.Methods.CheckBackgroundRefreshPermission.name, .some):
+            _ = checkBackgroundRefreshPermission(result: result)
+            return
         case (ForegroundMethodChannel.Methods.RegisterOneOffTask.name, let .some(arguments)):
             registerOneOffTask(arguments: arguments, result: result)
             return
@@ -325,6 +332,7 @@ extension SwiftWorkmanagerPlugin: FlutterPlugin {
             let inputData =
                     arguments[method.Arguments.inputData.rawValue] as? String
 
+
             taskIdentifier = UIApplication.shared.beginBackgroundTask(withName: uniqueTaskIdentifier, expirationHandler: {
                 // Mark the task as ended if time is expired, otherwise iOS might terminate and will throttle future executions
                 UIApplication.shared.endBackgroundTask(taskIdentifier)
@@ -395,8 +403,8 @@ extension SwiftWorkmanagerPlugin: FlutterPlugin {
             SwiftWorkmanagerPlugin.scheduleBackgroundProcessingTask(
                 withIdentifier: uniqueTaskIdentifier,
                 earliestBeginInSeconds: delaySeconds,
-                requiresNetworkConnectivity: requiresNetwork,
-                requiresExternalPower: requiresCharging)
+                requiresNetworkConnectivity: requiresCharging,
+                requiresExternalPower: requiresNetwork)
 
             result(true)
             return
@@ -492,4 +500,4 @@ extension SwiftWorkmanagerPlugin {
         return worker.performBackgroundRequest(completionHandler)
     }
 
-}
+}

workmanager/ios/Classes/WorkmanagerPlugin.h

@@ -28,4 +28,4 @@
 + (void)registerBGProcessingTaskWithIdentifier:(NSString *) taskIdentifier;
 
 
-@end
+@end

workmanager/lib/src/options.dart

@@ -101,3 +101,23 @@ class Constraints {
     this.requiresStorageNotLow,
   });
 }
+
+/// Background App Refresh permission states. Currently only available in iOS.
+///
+/// On iOS user can disable Background App Refresh permission anytime, hence
+/// background tasks can only run if user has granted the permission.
+/// [Workmanager().checkBackgroundRefreshPermission()] can be used to check the
+/// permission.
+enum BackgroundRefreshPermissionState {
+  /// Background app refresh is enabled in OS Setting
+  available,
+
+  /// Background app refresh is disabled in OS Setting. Permission should be requested from user
+  denied,
+
+  /// OS setting is under parental control etc. Can't be changed by user
+  restricted,
+
+  /// Unknown state
+  unknown
+}