Merge pull request #32 from icapps/feature/ExtraAndroidOptions

Also support distance filters for android

Author: NicolaVerbeeck

CHANGELOG.md

@@ -1,7 +1,9 @@
-## 1.1.0 - 12-10-2021
+## 1.1.0 - xx-xx-2021
 #Added
 - Added more options to android config to specify update interval
 - Added iOS specific options to control activity type and/or distance filter
+- Added iOS specific options to restart the tracking after killing the app
+- Added option to Android specific options to only get updates every x meters
 
 ## 1.0.2 - 22-06-2021
 #Fixed

android/src/main/kotlin/com/icapps/background_location_tracker/MethodCallHelper.kt

@@ -37,6 +37,7 @@ internal class MethodCallHelper(private val ctx: Context) : MethodChannel.Method
         val enableNotificationLocationUpdatesKey = "android_config_enable_notification_location_updates"
         val enableCancelTrackingActionKey = "android_config_enable_cancel_tracking_action"
         val cancelTrackingActionTextKey = "android_config_cancel_tracking_action_text"
+        val distanceFilterKey = "android_distance_filter"
         val keys = listOf(
                 callbackHandleKey,
                 loggingEnabledKey,
@@ -57,8 +58,10 @@ internal class MethodCallHelper(private val ctx: Context) : MethodChannel.Method
         val cancelTrackingActionText = call.argument<String>(cancelTrackingActionTextKey)!!
         val enableCancelTrackingAction = call.argument<Boolean>(enableCancelTrackingActionKey)!!
         val trackingInterval = call.argument<Long>(trackingIntervalKey)!!
+        val distanceFilter = (call.argument<Double>(distanceFilterKey) ?: 0.0).toFloat()
         SharedPrefsUtil.saveLoggingEnabled(ctx, loggingEnabled)
         SharedPrefsUtil.saveTrackingInterval(ctx, trackingInterval)
+        SharedPrefsUtil.saveDistanceFilter(ctx, distanceFilter)
         Logger.enabled = loggingEnabled
         NotificationUtil.createNotificationChannels(ctx, channelName)
         SharedPrefsUtil.saveCallbackDispatcherHandleKey(ctx, callbackHandle)

android/src/main/kotlin/com/icapps/background_location_tracker/service/LocationUpdatesService.kt

@@ -8,8 +8,6 @@ import android.content.res.Configuration
 import android.location.Location
 import android.os.Binder
 import android.os.Build
-import android.os.Handler
-import android.os.HandlerThread
 import android.os.IBinder
 import android.os.Looper
 import android.os.PowerManager
@@ -221,11 +219,13 @@ internal class LocationUpdatesService : Service() {
      */
     private fun createLocationRequest() {
         val interval = SharedPrefsUtil.trackingInterval(this)
+        val distanceFilter = SharedPrefsUtil.distanceFilter(this)
         locationRequest = LocationRequest()
         locationRequest?.let {
             it.interval = interval
             it.fastestInterval = interval / 2
-            it.setPriority(LocationRequest.PRIORITY_HIGH_ACCURACY)
+            it.priority = LocationRequest.PRIORITY_HIGH_ACCURACY
+            it.setSmallestDisplacement(distanceFilter)
         }
     }
 

android/src/main/kotlin/com/icapps/background_location_tracker/utils/SharedPrefsUtil.kt

@@ -9,6 +9,7 @@ internal object SharedPrefsUtil {
     private const val KEY_IS_TRACKING = "background.location.tracker.manager.IS_TRACKING"
     private const val KEY_LOGGING_ENABED = "background.location.tracker.manager.LOGGIN_ENABLED"
     private const val KEY_TRACKING_INTERVAL = "background.location.tracker.manager.TRACKING_INTERVAL"
+    private const val KEY_DISTANCE_FILTER = "background.location.tracker.manager.DISTANCE_FILTER"
 
     private const val KEY_NOTIFICATION_BODY = "background.location.tracker.manager.NOTIFICATION_BODY"
     private const val KEY_NOTIFICATION_ICON = "background.location.tracker.manager.NOTIFICATION_ICON"
@@ -52,10 +53,19 @@ internal object SharedPrefsUtil {
                 .apply()
     }
 
+    fun saveDistanceFilter(ctx: Context, filter: Float) {
+        ctx.prefs()
+            .edit()
+            .putFloat(KEY_DISTANCE_FILTER, filter)
+            .apply()
+    }
+
     fun isLoggingEnabled(ctx: Context): Boolean = ctx.prefs().getBoolean(KEY_LOGGING_ENABED, false)
 
     fun trackingInterval(ctx: Context): Long = ctx.prefs().getLong(KEY_TRACKING_INTERVAL, 10000)
 
+    fun distanceFilter(ctx: Context) : Float = ctx.prefs().getFloat(KEY_DISTANCE_FILTER, 0.0f)
+
     //NotificationConfig
     fun saveNotificationConfig(ctx: Context, notificationBody: String, notificationIcon: String?, cancelTrackingActionText: String, enableNotificationLocationUpdates: Boolean, enableCancelTrackingAction: Boolean) {
         ctx.prefs()

example/lib/main.dart

@@ -16,13 +16,16 @@ Future<void> main() async {
   await BackgroundLocationTrackerManager.initialize(
     _backgroundCallback,
     config: const BackgroundLocationTrackerConfig(
+      loggingEnabled: true,
       androidConfig: AndroidConfig(
         notificationIcon: 'explore',
         trackingInterval: Duration(seconds: 4),
+        distanceFilterMeters: 5,
       ),
       iOSConfig: IOSConfig(
         activityType: ActivityType.FITNESS,
         distanceFilterMeters: 5,
+        restartAfterKill: true,
       ),
     ),
   );

ios/Classes/ForegroundChannel.swift

@@ -51,6 +51,7 @@ public class ForegroundChannel : NSObject {
         let loggingEnabledKey = "logging_enabled"
         let activityTypeKey = "ios_activity_type"
         let distanceFilterKey = "ios_distance_filter"
+        let restartAfterKillKey = "ios_restart_after_kill"
         let map = call.arguments as? [String: Any]
         guard let callbackDispatcherHandle = map?[callBackHandleKey] else {
             result(false)
@@ -60,6 +61,7 @@ public class ForegroundChannel : NSObject {
 
         let loggingEnabled: Bool = map?[loggingEnabledKey] as? Bool ?? false
         SharedPrefsUtil.saveLoggingEnabled(loggingEnabled)
+        SharedPrefsUtil.saveRestartAfterKillEnabled(map?[restartAfterKillKey] as? Bool ?? false)
 
         let activityType: CLActivityType
         switch (map?[activityTypeKey] as? String ?? "AUTOMOTIVE") {

ios/Classes/SharedPrefsUtil.swift

@@ -12,6 +12,7 @@ struct SharedPrefsUtil {
 
     private static let KEY_CALLBACK_HANDLER = "background.location.tracker.manager.CALLBACK_DISPATCHER_HANDLE_KEY"
     private static let KEY_IS_TRACKING = "background.location.tracker.manager.IS_TRACKING"
+    private static let KEY_IS_RESTART_AFTER_KILL = "background.location.tracker.manager.RESTART_AFTER_KILL"
     private static let KEY_LOGGING_ENABLED = "background.location.tracker.manager.LOGGIN_ENABLED"
     private static let KEY_DISTANCE_FILTER = "background.location.tracker.manager.DISTANCE_FILTER"
     private static let KEY_ACTIVITY_TYPE = "background.location.tracker.manager.KEY_ACTIVITY_TYPE"
@@ -38,6 +39,14 @@ struct SharedPrefsUtil {
         return getValue(for: SharedPrefsUtil.KEY_IS_TRACKING) ?? false
     }
 
+    static func restartAfterKill() -> Bool {
+        return getValue(for: SharedPrefsUtil.KEY_IS_RESTART_AFTER_KILL) ?? false
+    }
+    
+    static func saveRestartAfterKillEnabled(_ isRestartEnabled: Bool) {
+        store(isRestartEnabled, key: SharedPrefsUtil.KEY_IS_RESTART_AFTER_KILL)
+    }
+    
     static func saveLoggingEnabled(_ isLoggingEnabled: Bool) {
         store(isLoggingEnabled, key: SharedPrefsUtil.KEY_LOGGING_ENABLED)
     }

ios/Classes/SwiftBackgroundLocationTrackerPlugin.swift

@@ -36,6 +36,11 @@ extension SwiftBackgroundLocationTrackerPlugin: FlutterPlugin {
         let instance = SwiftBackgroundLocationTrackerPlugin()
         registrar.addMethodCallDelegate(instance, channel: methodChannel)
         registrar.addApplicationDelegate(instance)
+        
+        if (SharedPrefsUtil.isTracking() && SharedPrefsUtil.restartAfterKill()) {
+            instance.locationManager.delegate = instance
+            instance.locationManager.startUpdatingLocation()
+        }
     }
 
     public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {

lib/src/channel/foreground_channel.dart

@@ -38,8 +38,10 @@ class ForegroundChannel {
             config.androidConfig.cancelTrackingActionText,
         'android_config_enable_cancel_tracking_action':
             config.androidConfig.enableCancelTrackingAction,
+        'android_distance_filter': config.androidConfig.distanceFilterMeters,
         'ios_activity_type': _activityTypeString(config.iOSConfig.activityType),
         'ios_distance_filter': config.iOSConfig.distanceFilterMeters,
+        'ios_restart_after_kill': config.iOSConfig.restartAfterKill,
       },
     );
   }

lib/src/model/config/android_config.dart

@@ -35,6 +35,10 @@ class AndroidConfig {
   /// Defaults to an update every 10 seconds
   final Duration trackingInterval;
 
+  /// The distance in meters that should be moved before updates are sent.
+  /// Defaults to no filter (null)
+  final double? distanceFilterMeters;
+
   const AndroidConfig({
     this.channelName = 'Background Tracking',
     this.notificationBody = 'Background tracking active. Tap to open.',
@@ -43,5 +47,6 @@ class AndroidConfig {
     this.cancelTrackingActionText = 'Stop Tracking',
     this.enableCancelTrackingAction = true,
     this.trackingInterval = const Duration(seconds: 10),
+    this.distanceFilterMeters,
   });
 }