Notifications now have a blop sound, also handling application badges

1 files changed, 455 insertions, 0 deletions

diff --git a/plugins/de.appplant.cordova.plugin.local-notification/src/android/notification/Manager.java b/plugins/de.appplant.cordova.plugin.local-notification/src/android/notification/Manager.java
new file mode 100644
index 00000000..03ea384f
--- /dev/null
+++ b/plugins/de.appplant.cordova.plugin.local-notification/src/android/notification/Manager.java
@@ -0,0 +1,455 @@
+/*
+ * Copyright (c) 2013-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.notification;
+
+import android.app.NotificationManager;
+import android.content.Context;
+import android.content.SharedPreferences;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static de.appplant.cordova.plugin.notification.Notification.PREF_KEY;
+
+/**
+ * Central way to access all or single local notifications set by specific
+ * state like triggered or scheduled. Offers shortcut ways to schedule,
+ * cancel or clear local notifications.
+ */
+public class Manager {
+
+    // Context passed through constructor and used for notification builder.
+    private Context context;
+
+    /**
+     * Constructor
+     *
+     * @param context
+     *      Application context
+     */
+    private Manager(Context context){
+        this.context = context;
+    }
+
+    /**
+     * Static method to retrieve class instance.
+     *
+     * @param context
+     *      Application context
+     */
+    public static Manager getInstance(Context context) {
+        return new Manager(context);
+    }
+
+    /**
+     * Schedule local notification specified by JSON object.
+     *
+     * @param options
+     *      JSON object with set of options
+     * @param receiver
+     *      Receiver to handle the trigger event
+     */
+    public Notification schedule (JSONObject options, Class<?> receiver) {
+        return schedule(new Options(context).parse(options), receiver);
+    }
+
+    /**
+     * Schedule local notification specified by options object.
+     *
+     * @param options
+     *      Set of notification options
+     * @param receiver
+     *      Receiver to handle the trigger event
+     */
+    public Notification schedule (Options options, Class<?> receiver) {
+        Notification notification = new Builder(options)
+                .setTriggerReceiver(receiver)
+                .build();
+
+        notification.schedule();
+
+        return notification;
+    }
+
+    /**
+     * Clear local notification specified by ID.
+     *
+     * @param id
+     *      The notification ID
+     * @param updates
+     *      JSON object with notification options
+     * @param receiver
+     *      Receiver to handle the trigger event
+     */
+    public Notification update (int id, JSONObject updates, Class<?> receiver) {
+        Notification notification = get(id);
+
+        if (notification == null)
+            return null;
+
+        notification.cancel();
+
+        JSONObject options = mergeJSONObjects(
+                notification.getOptions().getDict(), updates);
+
+        try {
+            options.putOpt("updatedAt", new Date().getTime());
+        } catch (JSONException ignore) {}
+
+        return schedule(options, receiver);
+    }
+
+    /**
+     * Clear local notification specified by ID.
+     *
+     * @param id
+     *      The notification ID
+     */
+    public Notification clear (int id) {
+        Notification notification = get(id);
+
+        if (notification != null) {
+            notification.clear();
+        }
+
+        return notification;
+    }
+
+    /**
+     * Clear local notification specified by ID.
+     *
+     * @param id
+     *      The notification ID
+     */
+    public Notification cancel (int id) {
+        Notification notification = get(id);
+
+        if (notification != null) {
+            notification.cancel();
+        }
+
+        return notification;
+    }
+
+    /**
+     * Clear all local notifications.
+     */
+    public void clearAll () {
+        List<Notification> notifications = getAll();
+
+        for (Notification notification : notifications) {
+            notification.clear();
+        }
+
+        getNotMgr().cancelAll();
+    }
+
+    /**
+     * Cancel all local notifications.
+     */
+    public void cancelAll () {
+        List<Notification> notifications = getAll();
+
+        for (Notification notification : notifications) {
+            notification.cancel();
+        }
+
+        getNotMgr().cancelAll();
+    }
+
+    /**
+     * All local notifications IDs.
+     */
+    public List<Integer> getIds() {
+        Set<String> keys = getPrefs().getAll().keySet();
+        ArrayList<Integer> ids = new ArrayList<Integer>();
+
+        for (String key : keys) {
+            ids.add(Integer.parseInt(key));
+        }
+
+        return ids;
+    }
+
+    /**
+     * All local notification IDs for given type.
+     *
+     * @param type
+     *      The notification life cycle type
+     */
+    public List<Integer> getIdsByType(Notification.Type type) {
+        List<Notification> notifications = getAll();
+        ArrayList<Integer> ids = new ArrayList<Integer>();
+
+        for (Notification notification : notifications) {
+            if (notification.getType() == type) {
+                ids.add(notification.getId());
+            }
+        }
+
+        return ids;
+    }
+
+    /**
+     * List of local notifications with matching ID.
+     *
+     * @param ids
+     *      Set of notification IDs
+     */
+    public List<Notification> getByIds(List<Integer> ids) {
+        ArrayList<Notification> notifications = new ArrayList<Notification>();
+
+        for (int id : ids) {
+            Notification notification = get(id);
+
+            if (notification != null) {
+                notifications.add(notification);
+            }
+        }
+
+        return notifications;
+    }
+
+    /**
+     * List of all local notification.
+     */
+    public List<Notification> getAll() {
+        return getByIds(getIds());
+    }
+
+    /**
+     * List of local notifications from given type.
+     *
+     * @param type
+     *      The notification life cycle type
+     */
+    public List<Notification> getByType(Notification.Type type) {
+        List<Notification> notifications = getAll();
+        ArrayList<Notification> list = new ArrayList<Notification>();
+
+        if (type == Notification.Type.ALL)
+            return notifications;
+
+        for (Notification notification : notifications) {
+            if (notification.getType() == type) {
+                list.add(notification);
+            }
+        }
+
+        return list;
+    }
+
+    /**
+     * List of local notifications with matching ID from given type.
+     *
+     * @param type
+     *      The notification life cycle type
+     * @param ids
+     *      Set of notification IDs
+     */
+    @SuppressWarnings("UnusedDeclaration")
+    public List<Notification> getBy(Notification.Type type, List<Integer> ids) {
+        ArrayList<Notification> notifications = new ArrayList<Notification>();
+
+        for (int id : ids) {
+            Notification notification = get(id);
+
+            if (notification != null && notification.isScheduled()) {
+                notifications.add(notification);
+            }
+        }
+
+        return notifications;
+    }
+
+    /**
+     * If a notification with an ID exists.
+     *
+     * @param id
+     *      Notification ID
+     */
+    public boolean exist (int id) {
+        return get(id) != null;
+    }
+
+    /**
+     * If a notification with an ID and type exists.
+     *
+     * @param id
+     *      Notification ID
+     * @param type
+     *      Notification type
+     */
+    public boolean exist (int id, Notification.Type type) {
+        Notification notification = get(id);
+
+        return notification != null && notification.getType() == type;
+    }
+
+    /**
+     * List of properties from all local notifications.
+     */
+    public List<JSONObject> getOptions() {
+        return getOptionsById(getIds());
+    }
+
+    /**
+     * List of properties from local notifications with matching ID.
+     *
+     * @param ids
+     *      Set of notification IDs
+     */
+    public List<JSONObject> getOptionsById(List<Integer> ids) {
+        ArrayList<JSONObject> options = new ArrayList<JSONObject>();
+
+        for (int id : ids) {
+            Notification notification = get(id);
+
+            if (notification != null) {
+                options.add(notification.getOptions().getDict());
+            }
+        }
+
+        return options;
+    }
+
+    /**
+     * List of properties from all local notifications from given type.
+     *
+     * @param type
+     *      The notification life cycle type
+     */
+    public List<JSONObject> getOptionsByType(Notification.Type type) {
+        ArrayList<JSONObject> options = new ArrayList<JSONObject>();
+        List<Notification> notifications = getByType(type);
+
+        for (Notification notification : notifications) {
+            options.add(notification.getOptions().getDict());
+        }
+
+        return options;
+    }
+
+    /**
+     * List of properties from local notifications with matching ID from
+     * given type.
+     *
+     * @param type
+     *      The notification life cycle type
+     * @param ids
+     *      Set of notification IDs
+     */
+    public List<JSONObject> getOptionsBy(Notification.Type type,
+                                         List<Integer> ids) {
+
+        if (type == Notification.Type.ALL)
+            return getOptionsById(ids);
+
+        ArrayList<JSONObject> options = new ArrayList<JSONObject>();
+        List<Notification> notifications = getByIds(ids);
+
+        for (Notification notification : notifications) {
+            if (notification.getType() == type) {
+                options.add(notification.getOptions().getDict());
+            }
+        }
+
+        return options;
+    }
+
+    /**
+     * Get existent local notification.
+     *
+     * @param id
+     *      Notification ID
+     */
+    public Notification get(int id) {
+        Map<String, ?> alarms = getPrefs().getAll();
+        String notId          = Integer.toString(id);
+        JSONObject options;
+
+        if (!alarms.containsKey(notId))
+            return null;
+
+
+        try {
+            String json = alarms.get(notId).toString();
+            options = new JSONObject(json);
+        } catch (JSONException e) {
+            e.printStackTrace();
+            return null;
+        }
+
+        Builder builder = new Builder(context, options);
+
+        return builder.build();
+    }
+
+    /**
+     * Merge two JSON objects.
+     *
+     * @param obj1
+     *      JSON object
+     * @param obj2
+     *      JSON object with new options
+     */
+    private JSONObject mergeJSONObjects (JSONObject obj1, JSONObject obj2) {
+        Iterator it = obj2.keys();
+
+        while (it.hasNext()) {
+            try {
+                String key = (String)it.next();
+
+                obj1.put(key, obj2.opt(key));
+            } catch (JSONException e) {
+                e.printStackTrace();
+            }
+        }
+
+        return obj1;
+    }
+
+    /**
+     * Shared private preferences for the application.
+     */
+    private SharedPreferences getPrefs () {
+        return context.getSharedPreferences(PREF_KEY, Context.MODE_PRIVATE);
+    }
+
+    /**
+     * Notification manager for the application.
+     */
+    private NotificationManager getNotMgr () {
+        return (NotificationManager) context
+                .getSystemService(Context.NOTIFICATION_SERVICE);
+    }
+
+}