cordova-plugin-local-notifications-continued 1.2.4

package/src/android/OptionsTrigger.java

@@ -0,0 +1,104 @@
+/*
+ * Apache 2.0 License
+ *
+ * Copyright (c) Manuel Beck 2025
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apache License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://opensource.org/licenses/Apache-2.0/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ */
+
+package de.appplant.cordova.plugin.localnotification;
+
+import org.json.JSONObject;
+
+public class OptionsTrigger {
+    
+    private JSONObject triggerJSON;
+
+    public OptionsTrigger(JSONObject triggerJSON) {
+        this.triggerJSON = triggerJSON;
+    }
+
+    public boolean has(String key) {
+        return triggerJSON.has(key);
+    }
+
+    public long getAt() {
+        return triggerJSON.optLong("at", 0);
+    }
+
+    public int getIn() {
+        return triggerJSON.optInt("in", 0);
+    }
+
+    public String getUnit() {
+        return triggerJSON.optString("unit", null);
+    }
+
+    /**
+     * Only for repeating notifications, when the first notification should be triggered.
+     */
+    public long getFirstAt() {
+        return triggerJSON.optLong("firstAt", 0);
+    }
+
+    /**
+     * Only for repeating notifications, when the first notification should be triggered.
+     */
+    public long getAfter() {
+        return triggerJSON.optLong("after", 0);
+    }
+
+    /**
+     * If a repeating notification should be stopped after some occurrences. -1 means infinite.
+     * @return
+     */
+    public int getCount() {
+        return triggerJSON.optInt("count", -1);
+    }
+
+    /**
+     * Can be a {@link String} or {@link JSONObject}.
+     */
+    public Object getEvery() {
+        return triggerJSON.opt("every");
+    }
+
+    /**
+     * Gets trigger.every as {@link String}. If trigger.every is a {@link JSONObject}, it returns null
+     */
+    public String getEveryAsString() {
+        return getEvery() instanceof String ? (String) getEvery() : null;
+    }
+
+    /**
+     * Gets trigger.every as {@link JSONObject}. If trigger.every is a {@link String}, it returns null
+     */
+    public JSONObject getEveryAsJSONObject() {
+        return getEvery() instanceof JSONObject ? (JSONObject) getEvery() : null;
+    }
+
+    public long getBefore() {
+        return triggerJSON.optLong("before", 0);
+    }
+
+    public JSONObject getJSON() {
+        return triggerJSON;
+    }
+
+    public String toString() {
+        return triggerJSON.toString();
+    }
+}

package/src/android/action/Action.java

@@ -0,0 +1,214 @@
+/*
+ * Apache 2.0 License
+ *
+ * Copyright (c) Sebastian Katzer 2017
+ * Copyright (c) Manuel Beck 2024
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apache License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://opensource.org/licenses/Apache-2.0/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ */
+
+package de.appplant.cordova.plugin.localnotification.action;
+
+import android.content.Context;
+import android.content.Intent;
+import android.os.Bundle;
+import android.os.Looper;
+import android.util.Log;
+import androidx.core.app.RemoteInput;
+
+import org.json.JSONArray;
+import org.json.JSONObject;
+import org.json.JSONException;
+
+import de.appplant.cordova.plugin.localnotification.LocalNotification;
+import de.appplant.cordova.plugin.localnotification.Notification;
+import de.appplant.cordova.plugin.localnotification.util.AssetUtil;
+
+/**
+ * Holds the icon and title components that would be used in a
+ * NotificationCompat.Action object. Does not include the PendingIntent so
+ * that it may be generated each time the notification is built. Necessary to
+ * compensate for missing functionality in the support library.
+ */
+public class Action {
+
+    private static final String TAG = "Action";
+
+    // Key name for bundled extras
+    public static final String EXTRA_ID = "NOTIFICATION_ACTION_ID";
+
+    private Context context;
+
+    private JSONObject actionOptionsJSON;
+
+    /**
+     * Structure to encapsulate a named action that can be shown as part of
+     * this notification.
+     *
+     * @param context The application context.
+     * @param actionOptionsJSON The action options.
+     */
+    public Action(Context context, JSONObject actionOptionsJSON) {
+        this.context = context;
+        this.actionOptionsJSON = actionOptionsJSON;
+    }
+
+    /**
+     * Gets the ID for the action.
+     */
+    public String getId() {
+        return actionOptionsJSON.optString("id", getTitle());
+    }
+
+    public String getType() {
+        return actionOptionsJSON.optString("type", "button");
+    }
+
+    /**
+     * Gets the Title for the action.
+     */
+    public String getTitle() {
+        return actionOptionsJSON.optString("title", "unknown");
+    }
+
+    /**
+     * Gets the icon for the action. Since Android 7 (Nougat) icons for actions
+     * are not shown anymore. They would only be used on Android Wear.
+     * See: https://android-developers.googleblog.com/2016/06/notifications-in-android-n.html
+     */
+    public int getIcon() {
+        String iconPath = actionOptionsJSON.optString("icon");
+
+        // Get icon from the app resources or system resources
+        int resId = new AssetUtil(context).getResourceId(iconPath, AssetUtil.RESOURCE_TYPE_DRAWABLE);
+
+        // Fallback, nothing found
+        if (resId == 0) resId = android.R.drawable.screen_background_dark;
+
+        return resId;
+    }
+
+    /**
+     * If the app shpould be launched when the action is clicked.
+     * Default is <code>false</code>.
+     */
+    public boolean isLaunch() {
+        return actionOptionsJSON.optBoolean("launch", false);
+    }
+
+    /**
+     * Returns true if the action is of type input.
+     */
+    public boolean isInput() {
+        return getType().equals("input");
+    }
+
+    /**
+     * Gets the input config in case of the action is of type input.
+     */
+    public RemoteInput buildRemoteInput() {
+        return new RemoteInput.Builder(getId())
+                .setLabel(actionOptionsJSON.optString("emptyText"))
+                // Specifies whether the user can provide arbitrary text values
+                // The default is true. If you specify false, you must either provide a non-null and
+                // non-empty array to setChoices, or enable a data result in setAllowDataType.
+                // Otherwise an IllegalArgumentException is thrown
+                .setAllowFreeFormInput(actionOptionsJSON.optBoolean("editable", true))
+                .setChoices(getChoices())
+                .build();
+    }
+
+    /**
+     * List of possible choices for input actions.
+     */
+    private String[] getChoices() {
+        JSONArray opts = actionOptionsJSON.optJSONArray("choices");
+
+        if (opts == null)
+            return null;
+
+        String[] choices = new String[opts.length()];
+
+        for (int i = 0; i < choices.length; i++) {
+            choices[i] = opts.optString(i);
+        }
+
+        return choices;
+    }
+
+    public void handleClick(Intent intent, Notification notification) {
+        Log.d(TAG, "Handle action click, options=" + actionOptionsJSON);
+
+        // Fire action click event to JS
+        LocalNotification.fireEvent(
+            getId(),
+            notification,
+            // Get input data for action, if it is an input action
+            getRemoteInputData(intent));
+
+        // Clear notification from statusbar if it should not be ongoing
+        // This will also remove the notification from the SharedPreferences
+        // if it is the last one
+        if (!notification.getOptions().isAndroidOngoing()) {
+            // A clear does not work on notifications with input fields:
+            // https://stackoverflow.com/questions/54219914/cancel-notification-with-remoteinput-not-working
+            // Google recommends after a reply to update the notificiation without the input action:
+            // https://developer.android.com/develop/ui/views/notifications/build-notification#retrieve-user-reply
+            // We update the notification without actions and cancel it after a timeout
+            if (isInput()) {
+                try {
+                    notification.update(new JSONObject("{\"actions\": null}"));
+                    // Clear the notification after a delay, because the update needs a little bit time to complete
+                    // To be compatible with Android 7, this is done with a Handler
+                    // Since Android 8, this could be handled with the property androidTimeoutAfter
+                    new android.os.Handler(Looper.getMainLooper()).postDelayed(
+                        new Runnable() {
+                            public void run() {
+                                notification.clear();
+                            }
+                        }, 
+                    500);
+                } catch (JSONException e) {
+                    Log.e(TAG, "Failed to update notification", e);
+                }
+            } else {
+                notification.clear();
+            }
+        }
+
+        // Launch the app if required
+        if (isLaunch()) LocalNotification.launchApp(context);
+    }
+
+    /**
+     * Gets the input data for an action, if available.
+     * @param intent The received intent.
+     * @param actionId The action where to look for.
+     */
+    private JSONObject getRemoteInputData(Intent intent) {
+        Bundle remoteInput = RemoteInput.getResultsFromIntent(intent);
+        if (remoteInput == null) return null;
+
+        try {
+            JSONObject data = new JSONObject();
+            data.put("text", remoteInput.getCharSequence(getId()).toString());
+            return data;
+        } catch (JSONException jsonException) {
+            Log.e(TAG, "Failed to build remote input JSON", jsonException);
+            return null;
+        }
+    }
+}

package/src/android/action/ActionGroup.java

@@ -0,0 +1,135 @@
+/*
+ * Apache 2.0 License
+ *
+ * Copyright (c) Sebastian Katzer 2017
+ * Copyright (c) Manuel Beck 2024
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apache License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://opensource.org/licenses/Apache-2.0/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ */
+
+package de.appplant.cordova.plugin.localnotification.action;
+
+import android.content.Context;
+import android.util.Log;
+
+import org.json.JSONArray;
+import org.json.JSONException;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import de.appplant.cordova.plugin.localnotification.Manager;
+
+public class ActionGroup {
+
+    private static final String TAG = "ActionGroup";
+
+    // Action group id
+    private String id;
+
+    // Actions JSON array, needed for storage
+    private JSONArray actionsJSONArray;
+
+    // List of actions
+    private List<Action> actions;
+
+    private Context context;
+    
+    public ActionGroup(Context context, String actionGroupId, JSONArray actionsJSONArray) {
+        this.context = context;
+        this.id = actionGroupId;
+        this.actionsJSONArray = actionsJSONArray;
+        this.actions = new ArrayList<Action>(actionsJSONArray.length());
+
+        for (int i = 0; i < actionsJSONArray.length(); i++) {
+            this.actions.add(new Action(context, actionsJSONArray.optJSONObject(i)));
+        }
+    }
+
+    /**
+     * Gets the action group id.
+     */
+    public String getId() {
+        return id;
+    }
+
+    /**
+     * Gets the action list.
+     */
+    public List<Action> getActions() {
+        return actions;
+    }
+
+    /**
+     * Gets the action by id.
+     * @param actionId The id of the action to get.
+     * @return The action with the specified id or <code>null</code> if not found.
+     */
+    public Action getActionById(String actionId) {
+        for (Action action : actions) {
+            if (action.getId().equals(actionId)) {
+                return action;
+            }
+        }
+        
+        Log.w(TAG, "Action not found, id=" + actionId);
+        return null;
+    }
+
+    /**
+     * Stores this action group in the {@link SharedPreferences}.
+     */
+    public void store() {
+        Manager.getSharedPreferences(context).edit()
+            .putString("ACTION_GROUP_" + id, actionsJSONArray.toString())
+            .apply();
+    }
+
+    /**
+     * Removes the action group from the {@link SharedPreferences}.
+     * @param context
+     * @param actionGroupId
+     */
+    public static void remove(Context context, String actionGroupId) {
+        Manager.getSharedPreferences(context).edit()
+            .remove("ACTION_GROUP_" + actionGroupId)
+            .apply();
+    }
+
+    /**
+     * Gets the action group with the specified actionGroupId from the
+     * {@link SharedPreferences}.
+     *
+     * @param context The application context.
+     * @param actionGroupId The id of the action group to get.
+     *
+     * @return The restored action group from {@link SharedPreferences} or <code>null</code> if not found.
+     */
+    public static ActionGroup get(Context context, String actionGroupId) {
+        String actionsJSON = Manager.getSharedPreferences(context)
+            .getString("ACTION_GROUP_" + actionGroupId, null);
+
+        if (actionsJSON == null) return null;
+
+        try {
+            JSONArray actionsJSONArray = new JSONArray(actionsJSON);
+            return new ActionGroup(context, actionGroupId, actionsJSONArray);
+        } catch (JSONException jsonException) {
+            Log.e(TAG, "Failed to restore action group: " + actionGroupId, jsonException);
+            return null;
+        }
+    }
+}

package/src/android/build/localnotification.gradle

@@ -0,0 +1,29 @@
+/*
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apache License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://opensource.org/licenses/Apache-2.0/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ */
+
+repositories {
+    mavenCentral()
+    maven {
+        url "https://maven.google.com"
+    }
+}
+
+dependencies {
+    // Needed for getUnusedAppRestrictionsStatus:
+    // - Class ListenableFuture
+    implementation("com.google.guava:guava:33.4.0-android")
+}

package/src/android/receiver/ClearReceiver.java

@@ -0,0 +1,61 @@
+/*
+ * Apache 2.0 License
+ *
+ * Copyright (c) Sebastian Katzer 2017
+ * Copyright (c) Manuel Beck 2024
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apache License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://opensource.org/licenses/Apache-2.0/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ */
+
+package de.appplant.cordova.plugin.localnotification.receiver;
+
+import android.content.BroadcastReceiver;
+import android.content.Context;
+import android.content.Intent;
+import android.os.Bundle;
+import android.util.Log;
+
+import de.appplant.cordova.plugin.localnotification.Notification;
+
+/**
+ * The clear intent receiver is triggered when the user clears a
+ * notification manually. It removes the notification from the
+ * SharedPreferences if it was the last onex to trigger.
+ */
+public class ClearReceiver extends BroadcastReceiver {
+
+    public static final String TAG = "ClearReceiver";
+
+    /**
+     * Called when the notification was cleared from the notification center.
+     * @param context Application context
+     * @param intent Received intent with content data
+     */
+    @Override
+    public void onReceive(Context context, Intent intent) {
+        Log.d(TAG, "Notification cleared, extras=" + intent.getExtras());
+        Notification notification = Notification.getFromSharedPreferences(context, intent.getIntExtra(Notification.EXTRA_ID, -1));
+
+        // Notification not found for id in SharedPreferences
+        if (notification == null) {
+            Log.w(TAG, "Notification not found for id, doing nothing, id=" + intent.getIntExtra(Notification.EXTRA_ID, -1));
+            return;
+        }
+
+        // Will remove the notification from SharedPreferences if it is the last one
+        notification.clear();
+    }
+}

package/src/android/receiver/RestoreReceiver.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2014-2015 by appPlant UG. All rights reserved.
+ *
+ * @APPPLANT_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apache License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://opensource.org/licenses/Apache-2.0/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPPLANT_LICENSE_HEADER_END@
+ */
+
+package de.appplant.cordova.plugin.localnotification.receiver;
+
+import android.app.AlarmManager;
+import android.content.BroadcastReceiver;
+import android.content.Context;
+import android.content.Intent;
+import android.util.Log;
+
+import java.util.List;
+
+import de.appplant.cordova.plugin.localnotification.Manager;
+import de.appplant.cordova.plugin.localnotification.Notification;
+
+/**
+ * This class is triggered, when the system has cleared the alarms and notifications,
+ * e.g. because of a device reboot, app update or granting the SCHEDULE_EXACT_ALARM permission.
+ * The alarms and notifications needs to be restored.
+ */
+public class RestoreReceiver extends BroadcastReceiver {
+
+    public static final String TAG = "RestoreReceiver";
+
+    /**
+     * Called when alarms and notifications need to be restored.
+     * @param context Application context
+     * @param intent Received intent with content data
+     */
+    @Override
+    public void onReceive(Context context, Intent intent) {
+        Log.d(TAG, "Received action: " + intent.getAction());
+
+        // The device was booted and is unlocked
+        if (intent.getAction().equals(Intent.ACTION_BOOT_COMPLETED) ||
+            // The app was updated
+            intent.getAction().equals(Intent.ACTION_MY_PACKAGE_REPLACED) ||
+            // The app is granted the SCHEDULE_EXACT_ALARM permission
+            intent.getAction().equals(AlarmManager.ACTION_SCHEDULE_EXACT_ALARM_PERMISSION_STATE_CHANGED)) {
+
+            List<Notification> notifications = new Manager(context).getNotificationsFromSharedPreferences();
+            Log.d(TAG, "Restoring notifications, count: " + notifications.size());
+
+            for (Notification notification : notifications) {
+                notification.schedule();
+            }
+        }
+    }
+}

package/src/android/receiver/TriggerReceiver.java

@@ -0,0 +1,70 @@
+/*
+ * Apache 2.0 License
+ *
+ * Copyright (c) Sebastian Katzer 2017
+ * Copyright (c) Manuel Beck 2024
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apache License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://opensource.org/licenses/Apache-2.0/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ */
+
+package de.appplant.cordova.plugin.localnotification.receiver;
+
+import android.content.BroadcastReceiver;
+import android.content.Context;
+import android.content.Intent;
+import android.util.Log;
+
+import de.appplant.cordova.plugin.localnotification.Notification;
+
+/**
+ * The alarm receiver is triggered when a scheduled alarm is fired. This class
+ * reads the information in the intent and displays this information in the
+ * Android notification bar. The notification uses the default notification
+ * sound and it vibrates the phone.
+ */
+public class TriggerReceiver extends BroadcastReceiver {
+
+    public static final String TAG = "TriggerReceiver";
+
+    /**
+     * Called when an alarm was triggered.
+     * @param context Application context
+     * @param intent Received intent with content data
+     */
+    @Override
+    public void onReceive(Context context, Intent intent) {
+        Log.d(TAG, "Received action: " + intent.getAction() + ", extras=" + intent.getExtras());
+
+        Notification notification = Notification.getFromSharedPreferences(context, intent.getIntExtra(Notification.EXTRA_ID, -1));
+
+        // Notification not found for id in SharedPreferences
+        if (notification == null) {
+            Log.w(TAG, "Notification not found for id, doing nothing, id=" + intent.getIntExtra(Notification.EXTRA_ID, -1));
+            return;
+        }
+
+        // Show the notification
+        notification.show(false);
+
+        // Schedule next notification if available. The notification
+        // will not be removed from the SharedPreferences, if there is no
+        // next trigger. So the ClickActivity
+        // and ClearReceiver can still read the notification data. They
+        // will remove the notification from the SharedPreferences if they are
+        // executed. A notification can ony be cleared or clicked.
+        notification.scheduleNext();
+    }
+}