Merge pull request #30 from icapps/feature/ConfigOptions

Support additional configuration arguments

Author: NicolaVerbeeck

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.1.0 - 12-10-2021
+#Added
+- Added more options to android config to specify update interval
+- Added iOS specific options to control activity type and/or distance filter
+
 ## 1.0.2 - 22-06-2021
 #Fixed
 - Formatting

analysis_options.yaml

@@ -19,7 +19,6 @@ linter:
     - always_put_required_named_parameters_first
     - always_require_non_null_named_parameters
     - annotate_overrides
-    - avoid_as
     - avoid_bool_literals_in_conditional_expressions
     - avoid_catching_errors
     - avoid_double_and_int_checks

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

@@ -30,6 +30,7 @@ internal class MethodCallHelper(private val ctx: Context) : MethodChannel.Method
     private fun initialize(ctx: Context, call: MethodCall, result: MethodChannel.Result) {
         val callbackHandleKey = "callback_handle"
         val loggingEnabledKey = "logging_enabled"
+        val trackingIntervalKey = "android_update_interval_msec"
         val channelNameKey = "android_config_channel_name"
         val notificationBodyKey = "android_config_notification_body"
         val notificationIconKey = "android_config_notification_icon"
@@ -43,7 +44,8 @@ internal class MethodCallHelper(private val ctx: Context) : MethodChannel.Method
                 notificationBodyKey,
                 enableNotificationLocationUpdatesKey,
                 cancelTrackingActionTextKey,
-                enableCancelTrackingActionKey
+                enableCancelTrackingActionKey,
+                trackingIntervalKey
         )
         if (!call.checkRequiredFields(keys, result)) return
         val callbackHandle = call.argument<Long>(callbackHandleKey)!!
@@ -54,7 +56,9 @@ internal class MethodCallHelper(private val ctx: Context) : MethodChannel.Method
         val enableNotificationLocationUpdates = call.argument<Boolean>(enableNotificationLocationUpdatesKey)!!
         val cancelTrackingActionText = call.argument<String>(cancelTrackingActionTextKey)!!
         val enableCancelTrackingAction = call.argument<Boolean>(enableCancelTrackingActionKey)!!
+        val trackingInterval = call.argument<Long>(trackingIntervalKey)!!
         SharedPrefsUtil.saveLoggingEnabled(ctx, loggingEnabled)
+        SharedPrefsUtil.saveTrackingInterval(ctx, trackingInterval)
         Logger.enabled = loggingEnabled
         NotificationUtil.createNotificationChannels(ctx, channelName)
         SharedPrefsUtil.saveCallbackDispatcherHandleKey(ctx, callbackHandle)
@@ -70,20 +74,19 @@ 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 keys = listOf(
-                notificationBodyKey,
-                enableNotificationLocationUpdatesKey,
-                cancelTrackingActionTextKey,
-                enableCancelTrackingActionKey
-        )
-        if (!call.checkRequiredFields(keys, result)) return
-        val notificationBody = call.argument<String>(notificationBodyKey)!!
+
+        val notificationBody = call.argument<String>(notificationBodyKey)
         val notificationIcon = call.argument<String>(notificationIconKey)
-        val enableNotificationLocationUpdates = call.argument<Boolean>(enableNotificationLocationUpdatesKey)!!
-        val cancelTrackingActionText = call.argument<String>(cancelTrackingActionTextKey)!!
-        val enableCancelTrackingAction = call.argument<Boolean>(enableCancelTrackingActionKey)!!
-        if (notificationBody != null && notificationIcon != null && cancelTrackingActionText != null && enableNotificationLocationUpdates != null && enableCancelTrackingAction != null) {
-            SharedPrefsUtil.saveNotificationConfig(ctx, notificationBody, notificationIcon, cancelTrackingActionText, enableNotificationLocationUpdates, enableCancelTrackingAction)
+        val enableNotificationLocationUpdates = call.argument<Boolean>(enableNotificationLocationUpdatesKey)
+        val cancelTrackingActionText = call.argument<String>(cancelTrackingActionTextKey)
+        val enableCancelTrackingAction = call.argument<Boolean>(enableCancelTrackingActionKey)
+        if (notificationBody != null || notificationIcon != null || cancelTrackingActionText != null
+                || enableNotificationLocationUpdates != null || enableCancelTrackingAction != null) {
+            SharedPrefsUtil.saveNotificationConfig(ctx, notificationBody ?: SharedPrefsUtil.getNotificationBody(ctx),
+                                                   notificationIcon ?: SharedPrefsUtil.getNotificationIcon(ctx),
+                                                   cancelTrackingActionText ?: SharedPrefsUtil.getCancelTrackingActionText(ctx),
+                                                   enableNotificationLocationUpdates ?: SharedPrefsUtil.isNotificationLocationUpdatesEnabled(ctx),
+                                                   enableCancelTrackingAction ?: SharedPrefsUtil.isCancelTrackingActionEnabled(ctx))
         }
         serviceConnection.service?.startTracking()
         result.success(true)

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

@@ -204,10 +204,11 @@ internal class LocationUpdatesService : Service() {
      * Sets the location request parameters.
      */
     private fun createLocationRequest() {
+        val interval = SharedPrefsUtil.trackingInterval(this)
         locationRequest = LocationRequest()
         locationRequest?.let {
-            it.interval = UPDATE_INTERVAL_IN_MILLISECONDS
-            it.fastestInterval = FASTEST_UPDATE_INTERVAL_IN_MILLISECONDS
+            it.interval = interval
+            it.fastestInterval = interval / 2
             it.setPriority(LocationRequest.PRIORITY_HIGH_ACCURACY)
         }
     }
@@ -246,16 +247,5 @@ internal class LocationUpdatesService : Service() {
         const val ACTION_BROADCAST = "$PACKAGE_NAME.broadcast"
         const val EXTRA_LOCATION = "$PACKAGE_NAME.location"
         const val EXTRA_STARTED_FROM_NOTIFICATION = "$PACKAGE_NAME.started_from_notification"
-
-        /**
-         * The desired interval for location updates. Inexact. Updates may be more or less frequent.
-         */
-        private const val UPDATE_INTERVAL_IN_MILLISECONDS: Long = 10000
-
-        /**
-         * The fastest rate for active location updates. Updates will never be more frequent
-         * than this value.
-         */
-        private const val FASTEST_UPDATE_INTERVAL_IN_MILLISECONDS = UPDATE_INTERVAL_IN_MILLISECONDS / 2
     }
 }

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

@@ -8,6 +8,7 @@ internal object SharedPrefsUtil {
     private const val KEY_CALBACK_HANDLER = "background.location.tracker.manager.CALLBACK_DISPATCHER_HANDLE_KEY"
     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_NOTIFICATION_BODY = "background.location.tracker.manager.NOTIFICATION_BODY"
     private const val KEY_NOTIFICATION_ICON = "background.location.tracker.manager.NOTIFICATION_ICON"
@@ -44,8 +45,17 @@ internal object SharedPrefsUtil {
                 .apply()
     }
 
+    fun saveTrackingInterval(ctx: Context, interval: Long) {
+        ctx.prefs()
+                .edit()
+                .putLong(KEY_TRACKING_INTERVAL, interval)
+                .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)
+
     //NotificationConfig
     fun saveNotificationConfig(ctx: Context, notificationBody: String, notificationIcon: String?, cancelTrackingActionText: String, enableNotificationLocationUpdates: Boolean, enableCancelTrackingAction: Boolean) {
         ctx.prefs()

coverage/filter_test_coverage.dart

@@ -50,8 +50,9 @@ class LcovSection {
     final file = File(path);
     final content = file.readAsLinesSync();
     final sb = StringBuffer();
-    getFilteredBody(body, content)
-        .forEach((item) => sb..write(item)..write('\n'));
+    getFilteredBody(body, content).forEach((item) => sb
+      ..write(item)
+      ..write('\n'));
     return sb.toString();
   }
 

example/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Fri Jun 23 08:50:38 CEST 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.2-all.zip

example/ios/Flutter/AppFrameworkInfo.plist

@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>8.0</string>
+  <string>9.0</string>
 </dict>
 </plist>

example/ios/Podfile.lock

@@ -4,7 +4,7 @@ PODS:
   - Flutter (1.0.0)
   - flutter_local_notifications (0.0.1):
     - Flutter
-  - "permission_handler (5.0.1+1)":
+  - "permission_handler (5.1.0+2)":
     - Flutter
 
 DEPENDENCIES:
@@ -25,10 +25,10 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   background_location_tracker: 3f0954d5a839b9bfffbdc887e679d183a7bbc1c9
-  Flutter: 0e3d915762c693b495b44d77113d4970485de6ec
+  Flutter: 50d75fe2f02b26cc09d224853bb45737f8b3214a
   flutter_local_notifications: 0c0b1ae97e741e1521e4c1629a459d04b9aec743
-  permission_handler: eac8e15b4a1a3fba55b761d19f3f4e6b005d15b6
+  permission_handler: ccb20a9fad0ee9b1314a52b70b76b473c5f8dab0
 
 PODFILE CHECKSUM: aafe91acc616949ddb318b77800a7f51bffa2a4c
 
-COCOAPODS: 1.10.0
+COCOAPODS: 1.11.2