#54 Support for Push Notifications

Author: EddyVerbruggen

README.md

@@ -89,8 +89,7 @@ For readability the supported features have been moved to their own README's:
 * [Realtime Database](docs/DATABASE.md)
 * [Authentication](docs/AUTHENTICATION.md)
 * [Remote Config](docs/REMOTECONFIG.md)
-* (Push) Notifications (work in progress)
-
+* [Cloud Messaging](docs/MESSAGING.md)
 
 
 ## Known issues on Android

docs/AUTHENTICATION.md

@@ -189,8 +189,14 @@ Don't forget to enable Facebook login in your firebase instance.
   )
 ```
 
-And also, add [this bit to `app.js`](https://github.com/EddyVerbruggen/nativescript-plugin-firebase-demo/blob/master/Firebase/app/app.js#L5-L34) to give control back to your app after Facebook's auth UI finished.
+#### Start-up wiring
+We need to do some wiring when your app starts, so open `app.js` and add this before `application.start();`:
 
+```js
+var firebase = require("nativescript-plugin-firebase");
+```
+
+_Note that if you previously added some other code for this plugin to `app.js` you can now go ahead and remove it._
 
 ### logout
 Shouldn't be more complicated than:

docs/MESSAGING.md

@@ -0,0 +1,57 @@
+<table>
+<tr>
+<td><img src="images/firebase.png" width="154px" height="43px" alt="Firebase"/></td>
+<td>Cloud Messaging</td>
+</tr>
+</table>
+
+## Enabling Firebase Cloud Messaging (FCM)
+Version 3.3.0 of this plugin added FCM support (which is the successor of GCM).
+
+Although using push messages in your Firebase app is really easy setting it up is not. Traditionally, especially for iOS.
+
+### Android
+Work in progress.
+
+### iOS
+
+#### Receiving remote notifications in the background
+Open `app/App_Resources/iOS/Info.plist` and add this to the bottom:
+
+```xml
+<key>UIBackgroundModes</key>
+<array>
+	<string>remote-notification</string>
+</array>
+```
+
+#### Provisioning hell
+Follow [this guide](https://firebase.google.com/docs/cloud-messaging/ios/certs) to the letter. Once you've done it run `tns run ios` and upon starting the app it should prompt you for notification support. That also works on the simulator, but actually receiving notifications is _only_ possible on a real device.
+
+## Functions
+I tried to make this as simple as possible, so everything is handled for you transparently. If you want to act upon the notification that triggered opening your app then configure a callback handler as follows.
+
+### Handling a notification
+To listen to received notifications while in the foreground or when your app moves from the background to the foreground, add a handler `init`.
+
+Any pending notifications (while your app was not in the foreground) will trigger the `onMessageReceivedCallback` handler.
+
+```js
+  firebase.init({
+    onMessageReceivedCallback: function(message) {
+      console.log("Title: " + message.title);
+      console.log("Body: " + message.body);
+      // if your server passed a custom property called 'foo', then do this:
+      console.log("Value of 'foo': " + message.foo);
+  });
+```
+
+You don't _have_ to provide the handler during `init` - you can also do it through a dedicated function.
+
+```js
+  firebase.addOnMessageReceivedCallback(
+    function(message) {
+      // ..
+    });
+  });
+```

docs/NOTIFICATIONS.md

@@ -21,8 +21,6 @@ declare module "nativescript-plugin-firebase" {
       /**
        * This requires you to setup Facebook Auth in the Firebase console,
        * as well as uncommenting the SDK includes in include.gradle (Android) and Podfile (iOS).
-       * 
-       * Note that this works well on iOS, but Android is work in progress.
        */
       FACEBOOK
     }

firebase-common.d.ts

@@ -31,6 +31,10 @@ firebase.firebaseRemoteConfig = null;
 
 firebase.authStateListeners = [];
 
+firebase._receivedNotificationCallback = null;
+
+firebase._pendingNotifications = [];
+
 firebase.addAuthStateListener = function(listener) {
   if (firebase.authStateListeners.indexOf(listener) === -1) {
     firebase.authStateListeners.push(listener);

firebase-common.js

@@ -132,6 +132,17 @@ firebase.init = function (arg) {
         firebaseAuth.addAuthStateListener(firebase.authStateListener);
       }
 
+      // Firebase notifications (FCM)
+      if (typeof(com.google.firebase.messaging) !== "undefined") {
+        console.log("--- has messaging!");
+        // TODO see iOS:
+        // firebase._addObserver(kFIRInstanceIDTokenRefreshNotification, firebase._onTokenRefreshNotification);
+        if (arg.onMessageReceivedCallback !== undefined) {
+          console.log("--- adding messaging callback!");
+          firebase.addOnMessageReceivedCallback(arg.onMessageReceivedCallback);
+        }
+      }
+
       resolve(firebase.instance);
     } catch (ex) {
       console.log("Error in firebase.init: " + ex);
@@ -140,6 +151,24 @@ firebase.init = function (arg) {
   });
 };
 
+firebase.addOnMessageReceivedCallback = function (callback) {
+  return new Promise(function (resolve, reject) {
+    try {
+      if (typeof(com.google.firebase.messaging) === "undefined") {
+        reject("Uncomment firebase-messaging in the plugin's include.gradle first");
+        return;
+      }
+
+      firebase._receivedNotificationCallback = callback;
+      firebase._processPendingNotifications();
+      resolve();
+    } catch (ex) {
+      console.log("Error in firebase.addOnMessageReceivedCallback: " + ex);
+      reject(ex);
+    }
+  });
+};
+
 firebase.getRemoteConfigDefaults = function (properties) {
   var defaults = {};
   for (var p in properties) {
@@ -340,7 +369,7 @@ firebase.login = function (arg) {
 
       } else if (arg.type === firebase.LoginType.FACEBOOK) {
         if (typeof(com.facebook) === "undefined") {
-          reject("Facebook SDK not installed - see Podfile");
+          reject("Facebook SDK not installed - see gradle config");
           return;
         }
 

firebase.android.js

@@ -201,10 +201,31 @@ declare module "nativescript-plugin-firebase" {
       properties: Object;
     }
 
+    /**
+     * The returned object in the callback handler of the addOnMessageReceivedCallback function.
+     * Note that any custom data you send from your server will be available as
+     * key/value properties on the Message object.
+     */
+    export interface Message {
+      /**
+       * The main text shown in the notificiation.
+       */
+      body: string;
+      /**
+       * Optional title, shown above the body in the notification.
+       */
+      title?: string;
+      /**
+       * iOS badge number
+       */
+      badge?: number;
+    }
+
     export function init(options: InitOptions): Promise<any>;
     export function login(options: LoginOptions): Promise<LoginResult>;
     export function logout(): Promise<any>;
     export function getRemoteConfig(options: GetRemoteConfigOptions): Promise<GetRemoteConfigResult>;
+    export function addOnMessageReceivedCallback(onMessageReceived: (data: Message) => void): Promise<any>;
     export function createUser(options: CreateUserOptions): Promise<CreateUserResult>;
     export function deleteUser(): Promise<any>;
     export function resetPassword(options: ResetPasswordOptions): Promise<any>;