feat(android_alarm_manager_plus): we can now send extra data to alarm…

… manager and receive it in our callback (#1014) Co-authored-by: Mostafa <123456> Co-authored-by: Joachim Nohl <43643339+nohli@users.noreply.github.com>
fluttercommunity · Oct 20, 2022 · 5272c94 · 5272c94
1 parent 1795b72
commit 5272c94
Show file tree

Hide file tree

Showing 7 changed files with 253 additions and 43 deletions.
diff --git a/packages/android_alarm_manager_plus/android/build.gradle b/packages/android_alarm_manager_plus/android/build.gradle
@@ -8,7 +8,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.0.2'
+        classpath 'com.android.tools.build:gradle:7.2.1'
     }
 }
 

diff --git a/packages/android_alarm_manager_plus/android/gradle/wrapper/gradle-wrapper.properties b/packages/android_alarm_manager_plus/android/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 #Tue Oct 05 10:00:26 EEST 2021
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
diff --git a/...lus/android/src/main/java/dev/fluttercommunity/plus/androidalarmmanager/AlarmService.java b/...lus/android/src/main/java/dev/fluttercommunity/plus/androidalarmmanager/AlarmService.java
@@ -72,7 +72,8 @@ public static void startBackgroundIsolate(Context context, long callbackHandle)
    * AlarmService.initialized} message. Processes all alarm events that came in while the isolate
    * was starting.
    */
-  /* package */ static void onInitialized() {
+  /* package */
+  static void onInitialized() {
     Log.i(TAG, "AlarmService started!");
     synchronized (alarmQueue) {
       // Handle all the alarm events received before the Dart isolate was
@@ -103,7 +104,8 @@ private static void scheduleAlarm(
       long startMillis,
       long intervalMillis,
       boolean rescheduleOnReboot,
-      long callbackHandle) {
+      long callbackHandle,
+      JSONObject params) {
     if (rescheduleOnReboot) {
       addPersistentAlarm(
           context,
@@ -115,13 +117,15 @@ private static void scheduleAlarm(
           wakeup,
           startMillis,
           intervalMillis,
-          callbackHandle);
+          callbackHandle,
+          params);
     }
 
     // Create an Intent for the alarm and set the desired Dart callback handle.
     Intent alarm = new Intent(context, AlarmBroadcastReceiver.class);
     alarm.putExtra("id", requestCode);
     alarm.putExtra("callbackHandle", callbackHandle);
+    alarm.putExtra("params", params == null ? null : params.toString());
     PendingIntent pendingIntent =
         PendingIntent.getBroadcast(
             context,
@@ -190,7 +194,8 @@ public static void setOneShot(Context context, AndroidAlarmManagerPlugin.OneShot
         request.startMillis,
         0,
         request.rescheduleOnReboot,
-        request.callbackHandle);
+        request.callbackHandle,
+        request.params);
   }
 
   /** Schedules a periodic alarm to be executed repeatedly in the future. */
@@ -209,7 +214,8 @@ public static void setPeriodic(
         request.startMillis,
         request.intervalMillis,
         request.rescheduleOnReboot,
-        request.callbackHandle);
+        request.callbackHandle,
+        request.params);
   }
 
   /** Cancels an alarm with ID {@code requestCode}. */
@@ -248,7 +254,8 @@ private static void addPersistentAlarm(
       boolean wakeup,
       long startMillis,
       long intervalMillis,
-      long callbackHandle) {
+      long callbackHandle,
+      JSONObject params) {
     HashMap<String, Object> alarmSettings = new HashMap<>();
     alarmSettings.put("alarmClock", alarmClock);
     alarmSettings.put("allowWhileIdle", allowWhileIdle);
@@ -258,6 +265,7 @@ private static void addPersistentAlarm(
     alarmSettings.put("startMillis", startMillis);
     alarmSettings.put("intervalMillis", intervalMillis);
     alarmSettings.put("callbackHandle", callbackHandle);
+    alarmSettings.put("params", params);
     JSONObject obj = new JSONObject(alarmSettings);
     String key = getPersistentAlarmKey(requestCode);
     SharedPreferences prefs = context.getSharedPreferences(SHARED_PREFERENCES_KEY, 0);
@@ -322,6 +330,7 @@ public static void reschedulePersistentAlarms(Context context) {
           long startMillis = alarm.getLong("startMillis");
           long intervalMillis = alarm.getLong("intervalMillis");
           long callbackHandle = alarm.getLong("callbackHandle");
+          JSONObject params = alarm.getJSONObject("params");
           scheduleAlarm(
               context,
               requestCode,
@@ -333,7 +342,8 @@ public static void reschedulePersistentAlarms(Context context) {
               startMillis,
               intervalMillis,
               false,
-              callbackHandle);
+              callbackHandle,
+              params);
         } catch (JSONException e) {
           Log.e(TAG, "Data for alarm request code " + requestCode + " is invalid: " + json);
         }

diff --git a/...rc/main/java/dev/fluttercommunity/plus/androidalarmmanager/AndroidAlarmManagerPlugin.java b/...rc/main/java/dev/fluttercommunity/plus/androidalarmmanager/AndroidAlarmManagerPlugin.java
@@ -16,6 +16,7 @@
 import io.flutter.view.FlutterNativeView;
 import org.json.JSONArray;
 import org.json.JSONException;
+import org.json.JSONObject;
 
 /**
  * Flutter plugin for running one-shot and periodic tasks sometime in the future on Android.
@@ -149,6 +150,7 @@ static OneShotRequest fromJson(JSONArray json) throws JSONException {
       long startMillis = json.getLong(5);
       boolean rescheduleOnReboot = json.getBoolean(6);
       long callbackHandle = json.getLong(7);
+      JSONObject params = json.getJSONObject(8);
 
       return new OneShotRequest(
           requestCode,
@@ -158,7 +160,8 @@ static OneShotRequest fromJson(JSONArray json) throws JSONException {
           wakeup,
           startMillis,
           rescheduleOnReboot,
-          callbackHandle);
+          callbackHandle,
+          params);
     }
 
     final int requestCode;
@@ -169,6 +172,7 @@ static OneShotRequest fromJson(JSONArray json) throws JSONException {
     final long startMillis;
     final boolean rescheduleOnReboot;
     final long callbackHandle;
+    final JSONObject params;
 
     OneShotRequest(
         int requestCode,
@@ -178,7 +182,8 @@ static OneShotRequest fromJson(JSONArray json) throws JSONException {
         boolean wakeup,
         long startMillis,
         boolean rescheduleOnReboot,
-        long callbackHandle) {
+        long callbackHandle,
+        JSONObject params) {
       this.requestCode = requestCode;
       this.alarmClock = alarmClock;
       this.allowWhileIdle = allowWhileIdle;
@@ -187,6 +192,7 @@ static OneShotRequest fromJson(JSONArray json) throws JSONException {
       this.startMillis = startMillis;
       this.rescheduleOnReboot = rescheduleOnReboot;
       this.callbackHandle = callbackHandle;
+      this.params = params;
     }
   }
 
@@ -201,7 +207,7 @@ static PeriodicRequest fromJson(JSONArray json) throws JSONException {
       long intervalMillis = json.getLong(5);
       boolean rescheduleOnReboot = json.getBoolean(6);
       long callbackHandle = json.getLong(7);
-
+      JSONObject params = json.getJSONObject(8);
       return new PeriodicRequest(
           requestCode,
           allowWhileIdle,
@@ -210,7 +216,8 @@ static PeriodicRequest fromJson(JSONArray json) throws JSONException {
           startMillis,
           intervalMillis,
           rescheduleOnReboot,
-          callbackHandle);
+          callbackHandle,
+          params);
     }
 
     final int requestCode;
@@ -221,6 +228,7 @@ static PeriodicRequest fromJson(JSONArray json) throws JSONException {
     final long intervalMillis;
     final boolean rescheduleOnReboot;
     final long callbackHandle;
+    final JSONObject params;
 
     PeriodicRequest(
         int requestCode,
@@ -230,7 +238,8 @@ static PeriodicRequest fromJson(JSONArray json) throws JSONException {
         long startMillis,
         long intervalMillis,
         boolean rescheduleOnReboot,
-        long callbackHandle) {
+        long callbackHandle,
+        JSONObject params) {
       this.requestCode = requestCode;
       this.allowWhileIdle = allowWhileIdle;
       this.exact = exact;
@@ -239,6 +248,7 @@ static PeriodicRequest fromJson(JSONArray json) throws JSONException {
       this.intervalMillis = intervalMillis;
       this.rescheduleOnReboot = rescheduleOnReboot;
       this.callbackHandle = callbackHandle;
+      this.params = params;
     }
   }
 }
diff --git a/...rc/main/java/dev/fluttercommunity/plus/androidalarmmanager/FlutterBackgroundExecutor.java b/...rc/main/java/dev/fluttercommunity/plus/androidalarmmanager/FlutterBackgroundExecutor.java
@@ -8,6 +8,7 @@
 import android.content.Intent;
 import android.content.SharedPreferences;
 import android.content.res.AssetManager;
+import android.text.TextUtils;
 import android.util.Log;
 import io.flutter.FlutterInjector;
 import io.flutter.embedding.engine.FlutterEngine;
@@ -24,7 +25,8 @@
 import io.flutter.view.FlutterCallbackInformation;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicBoolean;
-
+import org.json.JSONException;
+import org.json.JSONObject;
 /**
  * An background execution abstraction which handles initializing a background isolate running a
  * callback dispatcher, used to invoke Dart callbacks while backgrounded.
@@ -193,7 +195,15 @@ public void executeDartCallbackInBackgroundIsolate(Intent intent, final CountDow
     // attention to the type of the callback handle as storing this value in a
     // variable of the wrong size will cause the callback lookup to fail.
     long callbackHandle = intent.getLongExtra("callbackHandle", 0);
-
+    String paramsJsonString = intent.getStringExtra("params");
+    JSONObject params = null;
+    if (!TextUtils.isEmpty(paramsJsonString)) {
+      try {
+        params = new JSONObject(paramsJsonString);
+      } catch (JSONException e) {
+        throw new IllegalArgumentException("Can not convert 'params' to JsonObject", e);
+      }
+    }
     // If another thread is waiting, then wake that thread when the callback returns a result.
     MethodChannel.Result result = null;
     if (latch != null) {
@@ -221,7 +231,7 @@ public void notImplemented() {
     // provided.
     backgroundChannel.invokeMethod(
         "invokeAlarmManagerCallback",
-        new Object[] {callbackHandle, intent.getIntExtra("id", -1)},
+        new Object[] {callbackHandle, intent.getIntExtra("id", -1), params},
         result);
   }