#11 Scheduling repeating notifications (daily, weekly, etc)

Author: EddyVerbruggen

.npmignore

@@ -1,2 +1,3 @@
 # Exclude the native source code. The native libraries are included in the plugin as compiled resources (i.e. jar & framework)
-native-src/
+native-src/
+platforms/android/README.md

README.md

@@ -52,14 +52,16 @@ You can pass several options to this function, everything is optional:
 |`at`     |A JavaScript Date object indicating when the notification should be shown. Default 'now'.|
 |`badge`  |On iOS (and some Android devices) you see a number on top of the app icon. On most Android devices you'll see this number in the notification center. Default not set (0).|
 |`sound`  |Currently this is only used on Android where you can set this to `null` to suppress the sound. Default 'the default notification sound'.|
+|`interval` |Set to one of second|minute|hour|day|week|month|quarter|year if you want a recurring notification.|
 
 ```js
   LocalNotifications.schedule([{
     id: 1,
     title: 'The title',
-    body: 'The body',
+    body: 'Recurs every minute until cancelled',
     ticker: 'The ticker',
     badge: 1,
+    interval: 'minute',
     sound: null, // suppress the default sound
     at: new Date(new Date().getTime() + (10 * 1000)) // 10 seconds from now
   }]).then(
@@ -161,6 +163,5 @@ If the `requestPermission` or `schedule` functions previously ran you may want t
 Let us know what you need by opening a Github issue.
 
 We're thinking about adding support for things like:
-- Scheduling repeating notifications (daily, weekly, etc)
 - [Custom Notification sounds](https://github.com/EddyVerbruggen/nativescript-local-notifications/issues/3)
 - Interactive Notifications on iOS

local-notifications.android.js

@@ -80,7 +80,15 @@ LocalNotifications.schedule = function (arg) {
 
         // configure when we'll show the event
         var alarmManager = utils.ad.getApplicationContext().getSystemService(android.content.Context.ALARM_SERVICE);
-        alarmManager.set(android.app.AlarmManager.RTC_WAKEUP, options.atTime, pendingIntent);
+
+        var repeatInterval = LocalNotifications._getInterval(options.interval);
+        options.repeatInterval = repeatInterval; // used when restoring the notification after a reboot
+
+        if (repeatInterval > 0) {
+          alarmManager.setRepeating(android.app.AlarmManager.RTC_WAKEUP, options.atTime, repeatInterval, pendingIntent);
+        } else {
+          alarmManager.set(android.app.AlarmManager.RTC_WAKEUP, options.atTime, pendingIntent);
+        }
 
         LocalNotifications._persist(options);
       }
@@ -93,11 +101,36 @@ LocalNotifications.schedule = function (arg) {
   });
 };
 
+LocalNotifications._getInterval = function(interval) {
+  if (interval === null || interval === "") {
+    return 0;
+  } else if (interval === "second") {
+    return 1000; // it's in ms
+  } else if (interval === "minute") {
+    return android.app.AlarmManager.INTERVAL_FIFTEEN_MINUTES / 15;
+  } else if (interval === "hour") {
+    return android.app.AlarmManager.INTERVAL_HOUR;
+  } else if (interval === "day") {
+    return android.app.AlarmManager.INTERVAL_DAY;
+  } else if (interval === "week") {
+    return android.app.AlarmManager.INTERVAL_DAY * 7;
+  } else if (interval === "month") {
+    return android.app.AlarmManager.INTERVAL_DAY * 31; // well that's almost accurate
+  } else if (interval === "quarter") {
+    return android.app.AlarmManager.INTERVAL_HOUR * 2190;
+  } else if (interval === "year") {
+    return android.app.AlarmManager.INTERVAL_DAY * 365; // same here
+  } else {
+    return 0;
+  }
+};
+
 /**
  * Persist notification info to the Android Shared Preferences.
  * This way we can later retrieve it to cancel it, or restore upon reboot.
  */
 LocalNotifications._persist = function (options) {
+  console.log("------------------- persisting: " + JSON.stringify(options));
   var sharedPreferences = LocalNotifications._getSharedPreferences();
   var sharedPreferencesEditor = sharedPreferences.edit();
   sharedPreferencesEditor.putString("" + options.id, JSON.stringify(options));
@@ -208,7 +241,7 @@ LocalNotifications.requestPermission = function (arg) {
 
 LocalNotifications._getSharedPreferences = function () {
   var context = application.android.foregroundActivity;
-  var PREF_KEY = "LocalNotificationsPlugin"; // TODO get constant from native, as the restorereceiver needs it as well
+  var PREF_KEY = com.telerik.localnotifications.NotificationRestoreReceiver.SHARED_PREFERENCES_KEY;
   return context.getSharedPreferences(PREF_KEY, android.content.Context.MODE_PRIVATE);
 };
 

local-notifications.d.ts

@@ -45,6 +45,11 @@ declare module "nativescript-local-notifications" {
        * Default 'the default notification sound'.
        */
       sound?: string;
+
+      /**
+       * One of second|minute|hour|day|week|month|quarter|year
+       */
+      interval?: string; // TODO add better TS support
     }
 
     export interface ReceivedNotification {

local-notifications.ios.js

@@ -101,18 +101,20 @@ LocalNotifications._schedulePendingNotifications = function () {
     notification.applicationIconBadgeNumber = options.badge;
 
     // these are sent back to the plugin when a notification is received
-    var userInfoDict = NSMutableDictionary.alloc().initWithCapacity(3);
+    var userInfoDict = NSMutableDictionary.alloc().initWithCapacity(4);
     userInfoDict.setObjectForKey(options.id, "id");
     userInfoDict.setObjectForKey(options.title, "title");
     userInfoDict.setObjectForKey(options.body, "body");
+    userInfoDict.setObjectForKey(options.interval, "interval");
     notification.userInfo = userInfoDict;
 
     if (options.sound === undefined || options.sound === "default") {
       notification.soundName = UILocalNotificationDefaultSoundName;
     }
 
+    notification.repeatInterval = LocalNotifications._getInterval(options.interval);
+
     // TODO add these after v1
-    // notification.repeatInterval = 1;
     // notification.soundName = custom..;
     // notification.resumeApplicationInBackground = true;
 
@@ -193,4 +195,28 @@ LocalNotifications.schedule = function (arg) {
   });
 };
 
+LocalNotifications._getInterval = function(interval) {
+  if (interval === null || interval === "") {
+    return NSCalendarUnitEra;
+  } else if (interval === "second") {
+    return NSCalendarUnitSecond;
+  } else if (interval === "minute") {
+    return NSCalendarUnitMinute;
+  } else if (interval === "hour") {
+    return NSCalendarUnitHour;
+  } else if (interval === "day") {
+    return NSCalendarUnitDay;
+  } else if (interval === "week") {
+    return NSCalendarUnitWeekOfYear;
+  } else if (interval === "month") {
+    return NSCalendarUnitMonth;
+  } else if (interval === "quarter") {
+    return NSCalendarUnitQuarter;
+  } else if (interval === "year") {
+    return NSCalendarUnitYear;
+  } else {
+    return NSCalendarUnitEra;
+  }
+};
+
 module.exports = LocalNotifications;

native-src/android/README.md

@@ -14,11 +14,11 @@ Assuming the plugin is locally cloned next to your app's folder:
 
 #### Install
 
-`tns plugin add ../nativescript-local-notifications`
+`tns plugin add ../../nativescript-local-notifications`
 
 #### Reinstall:
 
-`tns plugin remove nativescript-local-notifications && tns plugin add ../nativescript-local-notifications && tns platform remove android && tns platform add android`
+`tns plugin remove nativescript-local-notifications && tns plugin add ../../nativescript-local-notifications && tns platform remove android && tns platform add android`
 
 
 ### run

native-src/android/src/com/telerik/localnotifications/NotificationRestoreReceiver.java

@@ -28,9 +28,11 @@ public class NotificationRestoreReceiver extends BroadcastReceiver {
 
   static final String TAG = "NotificationRestoreReceiver";
 
+  public static final String SHARED_PREFERENCES_KEY = "LocalNotificationsPlugin";
+
   @Override
   public void onReceive(Context context, Intent intent) {
-    final SharedPreferences sharedPreferences = context.getSharedPreferences("LocalNotificationsPlugin", Context.MODE_PRIVATE);
+    final SharedPreferences sharedPreferences = context.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
     final Set notificationOptions = sharedPreferences.getAll().entrySet();
 
     Iterator<Map.Entry> iterator = notificationOptions.iterator();
@@ -71,21 +73,26 @@ public void onReceive(Context context, Intent intent) {
 
         // configure when we'll show the event
         long triggerTime = options.getLong("atTime");
+        long interval = options.optLong("repeatInterval", 0); // in ms
+        final boolean isRepeating = interval > 0;
         final Date triggerDate = new Date(triggerTime);
         final boolean wasInThePast = new Date().after(triggerDate);
         final AlarmManager alarmManager = (AlarmManager) context.getSystemService(Context.ALARM_SERVICE);
-        if (wasInThePast) {
-          Log.d(TAG, "------------------------ cancel notification: " + options);
+        if (wasInThePast && !isRepeating) {
           alarmManager.cancel(pendingIntent);
           ((NotificationManager)context.getSystemService(Context.NOTIFICATION_SERVICE)).cancel(options.getInt("id"));
           // TODO 'unpersist' would be nice
         } else {
           // schedule
-          Log.d(TAG, "------------------------ schedule notification: " + options);
-          alarmManager.set(AlarmManager.RTC_WAKEUP, triggerTime, pendingIntent);
+          if (isRepeating) {
+            alarmManager.setRepeating(AlarmManager.RTC_WAKEUP, triggerTime, interval, pendingIntent);
+          } else {
+            alarmManager.set(AlarmManager.RTC_WAKEUP, triggerTime, pendingIntent);
+          }
         }
-      } catch (JSONException e) {
-        e.printStackTrace();
+      } catch (Throwable t) {
+        Log.e(TAG, "Notification scheduling error: " + t.getMessage());
+        t.printStackTrace();
       }
     }
   }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nativescript-local-notifications",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "The Local Notifications plugin allows your app to show notifications when the app is not running. Just like remote push notifications, but a few orders of magnitude easier to set up.",
   "main" : "local-notifications.js",
   "nativescript": {