#478 Invites on Android: AppInviteApi has been deprecated

#479 Is anybody using the invites part? I can't get the deeplink or invitation id.

Author: EddyVerbruggen

CHANGELOG.md

@@ -3,6 +3,11 @@
 [Firebase iOS SDK Changelog](https://firebase.google.com/support/release-notes/ios)
 [Firebase Android SDK Changelog](https://firebase.google.com/support/release-notes/android)
 
+## 4.1.0 (2017, September 8)
+
+### New
+
+
 ## 4.0.6 (2017, August 23)
 
 ### New

README.md

@@ -26,7 +26,7 @@ For readability the supported features have been moved to their own README's:
 * [Storage](docs/STORAGE.md)
 * [Crash Reporting](docs/CRASHREPORTING.md)
 * [Analytics](docs/ANALYTICS.md)
-* [Invites](docs/INVITES.md)
+* [Invites and Dynamic Links](docs/INVITES_DYNAMICLINKS.md)
 * [AdMob](docs/ADMOB.md)
 
 ## Prerequisites
@@ -74,9 +74,6 @@ You can also change the configuration by deleting the `firebase.nativescript.jso
 ### iOS
 The Firebase iOS SDK is installed via Cocoapods, so run `pod repo update` to ensure you have the latest spec.
 
-### Android
-Install the latest packages 'Google Play Services' and 'Google Repository' in your [Android SDK Manager](http://stackoverflow.com/a/37310513)
-
 #### Google Play Services Version
 The plugin will default to version 10.0+ of the Android `play-services-base` SDK.
 If you need to change the version (to for instance the latest version), you can add a project ext property `googlePlayServicesVersion` like so:
@@ -226,16 +223,12 @@ Another possible error is "FirebaseApp with name [DEFAULT] doesn't exist." which
 placing `google-services.json` to `platforms/android/google-services.json` (see above), and making
 the changes to `build.gradle` which are mentioned above as well.
 
-#### Could not find any version that matches com.google.android.gms:play-services-auth:11.0.+.
-That means making sure you have the latest `Google Repository` bits installed.
+#### Errors regarding API level 26.0.0
+Update your local Android SDKs:
 
 Just run `$ANDROID_HOME/tools/bin/sdkmanager --update` from a command prompt
 or launch the SDK manager from Android Studio, expand `Extras` and install any pending updates.
 
-Also, an error like "Could not find com.google.firebase:firebase-core:10.0.0" can be caused by having
-more than one version of the Android SDK installed. Make sure ANDROID_HOME is set to the Android SDK directory
-that is being updated otherwise it will seem as though your updates have no effect.
-
 #### Found play-services:10.A.B, but version 11.X.Y is needed..
 Update your Android bits like the issue above and reinstall the android platform in your project.
 
@@ -248,12 +241,12 @@ android {
   // other stuff here
 
   project.ext {
-    googlePlayServicesVersion = "11.0.+"
+    googlePlayServicesVersion = "11.2.+"
   }
 }
 ```
 
-Where `"11.0.+"` is best set to the same value as the version on [this line](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/master/platforms/android/include.gradle#L23).
+Where `"11.2.+"` is best set to the same value as the `firebase-core` dependency version in [this file](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/master/platforms/android/include.gradle).
 
 ## Credits
 The starting point for this plugin was [this great Gist](https://gist.github.com/jbristowe/c89a7bcae7fc9a035ee7) by [John Bristowe](https://github.com/jbristowe).

docs/INVITES.md renamed to docs/INVITES_DYNAMICLINKS.md

@@ -21,6 +21,63 @@ Open `app/App_Resources/iOS/Info.plist` and add this somewhere in the file (if i
   <string>For inviting others to use this app.</string>
 ```
 
+## Receiving Dynamic Links
+
+### Android
+To have a dynamic link open your app you need to add an Intent filter to the `<activity>` in `app/App_Resources/Android/AndroidManifest.xml`:
+
+```xml
+  <intent-filter>
+    <action android:name="android.intent.action.VIEW"/>
+    <category android:name="android.intent.category.DEFAULT"/>
+    <category android:name="android.intent.category.BROWSABLE"/>
+    <data android:host="www.coolapp.com" android:scheme="http"/><!-- Change this -->
+    <data android:host="www.coolapp.com" android:scheme="https"/><!-- .. and this! -->
+  </intent-filter>
+```
+
+### iOS
+> We may automate parts of this later, but for now you'll need to do it by hand.
+
+On iOS you'll need to add a custom URL scheme to `app/App_Resources/iOS/Info.plist` (if you don't have this one already):
+
+```xml
+	<key>CFBundleURLTypes</key>
+	<array>
+		<dict>
+			<key>CFBundleTypeRole</key>
+			<string>Editor</string>
+			<key>CFBundleURLName</key>
+			<string>firebaseplugin.deeplink.urlscheme</string><!-- anything you like, but must be unique -->
+			<key>CFBundleURLSchemes</key>
+			<array>
+				<string>org.nativescript.firebasedemo</string><!-- the same as your bundle id (nativescript.id in package.json) -->
+			</array>
+		</dict>
+	</array>
+```
+
+Now open the project in Xcode (the `platforms/ios/<projectname>.xcworkspace` file!) and in the Capabilities tab
+enable Associated Domains and add the following to the Associated Domains list:
+
+```
+applinks:app_code.app.goo.gl
+```
+
+Where `app_code` can be found in the Firebase console at the Dynamic Links section.
+
+#### Copy the entitlements file
+The previous step created a the file`platforms/ios/YourAppName/(Resources/)YourAppName.entitlements`.
+Copy that file to `app/App_Resources/iOS/` (if it doesn't exist yet, otherwise merge its contents),
+so it's not removed when you remove and re-add the iOS platform. The relevant content looks like this:
+
+```xml
+	<key>com.apple.developer.associated-domains</key>
+	<array>
+		<string>applinks:j4ctx.app.goo.gl</string>
+	</array>
+```
+
 ## Functions
 
 ### invites.sendInvitation
@@ -64,4 +121,27 @@ firebase.invites.getInvitation().then(
       console.log("getInvitation error: " + error);
     }
 );
+```
+
+### addOnDynamicLinkReceivedCallback / init.onDynamicLinkCallback
+When your app is launched from a dynamic link, you may want to capture that link and perform some action.
+
+You can either add an `onDynamicLinkCallback` callback to `init`, or use `addOnDynamicLinkReceivedCallback`:
+
+```js
+  firebase.init({
+    onDynamicLinkCallback: function (url) {
+      console.log("Dynamic Link: " + url); // this is a string, like http://mydomain.com/applink
+    }
+  });
+```
+
+.. or:
+
+```js
+  firebase.addOnDynamicLinkReceivedCallback(
+    function (url) {
+      // ..
+    }
+  );
 ```

firebase-common.js

@@ -73,7 +73,7 @@ firebase.storage = null;
 firebase.firebaseRemoteConfig = null;
 firebase.authStateListeners = [];
 firebase._receivedNotificationCallback = null;
-firebase._DynamicLinkCallback = null;
+firebase._dynamicLinkCallback = null;
 
 firebase.addAuthStateListener = function (listener) {
   if (firebase.authStateListeners.indexOf(listener) === -1) {

firebase.android.js

@@ -5,6 +5,7 @@ var fs = require("file-system");
 var firebase = require("./firebase-common");
 
 firebase._launchNotification = null;
+firebase._launchDynamicLink = null;
 
 // we need to cache and restore the context, otherwise the next invocation is broken
 firebase._rememberedContext = null;
@@ -32,42 +33,63 @@ var messagingEnabled = new lazy(function () {
   return typeof(com.google.firebase.messaging) !== "undefined"
 });
 
+var dynamicLinksEnabled = new lazy(function () {
+  return typeof(com.google.android.gms.appinvite) !== "undefined"
+});
+
 (function () {
   appModule.on("launch", function (args) {
-    if (!messagingEnabled()) {
-      return;
-    }
-
     var intent = args.android;
+    var isLaunchIntent = "android.intent.action.VIEW" === intent.getAction();
 
-    var extras = intent.getExtras();
-    if (extras !== null) {
-      var result = {
-        foreground: false,
-        data: {}
-      };
+    if (!isLaunchIntent && messagingEnabled()) {
+      var extras = intent.getExtras();
+      if (extras !== null) {
+        var result = {
+          foreground: false,
+          data: {}
+        };
 
-      var iterator = extras.keySet().iterator();
-      while (iterator.hasNext()) {
-        var key = iterator.next();
-        if (key !== "from" && key !== "collapse_key") {
-          result[key] = extras.get(key);
-          result.data[key] = extras.get(key);
+        var iterator = extras.keySet().iterator();
+        while (iterator.hasNext()) {
+          var key = iterator.next();
+          if (key !== "from" && key !== "collapse_key") {
+            result[key] = extras.get(key);
+            result.data[key] = extras.get(key);
+          }
         }
-      }
 
-      // in case this was a cold start we don't have the _receivedNotificationCallback yet
-      if (firebase._receivedNotificationCallback === null) {
-        firebase._launchNotification = result;
-      } else {
-        // add a little delay just to make sure clients alerting this message will see it as the UI needs to settle
-        setTimeout(function () {
-          firebase._receivedNotificationCallback(result);
-        });
+        if (firebase._receivedNotificationCallback === null) {
+          firebase._launchNotification = result;
+        } else {
+          // add a little delay just to make sure clients alerting this message will see it as the UI needs to settle
+          setTimeout(function () {
+            firebase._receivedNotificationCallback(result);
+          });
+        }
       }
+
+    } else if (isLaunchIntent && dynamicLinksEnabled()) {
+      var intent = args.android;
+
+      var getDynamicLinksCallback = new com.google.android.gms.tasks.OnCompleteListener({
+        onComplete: function (task) {
+          if (task.isSuccessful() && task.getResult() !== null) {
+            result = task.getResult().getLink().toString();
+            if (firebase._dynamicLinkCallback === null) {
+              firebase._launchDynamicLink = result;
+            } else {
+              setTimeout(function () {
+                firebase._dynamicLinkCallback(firebase.toJsObject(result));
+              });
+            }
+          }
+        }
+      });
+      var firebaseDynamicLinks = com.google.firebase.dynamiclinks.FirebaseDynamicLinks.getInstance();
+      firebaseDynamicLinks.getDynamicLink(intent).addOnCompleteListener(getDynamicLinksCallback);
     }
   });
-
 })();
 
 firebase.toHashMap = function (obj) {
@@ -177,7 +199,6 @@ firebase.authStateListener = null;
 
 firebase.init = function (arg) {
   return new Promise(function (resolve, reject) {
-
     function runInit() {
       if (firebase.instance !== null) {
         reject("You already ran init");
@@ -237,11 +258,11 @@ firebase.init = function (arg) {
           firebase.addOnPushTokenReceivedCallback(arg.onPushTokenReceivedCallback);
         }
       }
-	  
-	  // Firebase DynamicLink
-	  if (arg.onDynamicLinkCallback !== undefined){
-	  	firebase.addOnDynamicLinkReceivedCallback(arg.onDynamicLinkCallback);
-	  }
+
+      // Firebase DynamicLink
+      if (arg.onDynamicLinkCallback !== undefined) {
+        firebase.addOnDynamicLinkReceivedCallback(arg.onDynamicLinkCallback);
+      }
 
       // Firebase storage
       if (arg.storageBucket) {
@@ -362,6 +383,30 @@ firebase.addOnMessageReceivedCallback = function (callback) {
   });
 };
 
+firebase.addOnDynamicLinkReceivedCallback = function (callback) {
+  return new Promise(function (resolve, reject) {
+    try {
+      if (typeof(com.google.android.gms.appinvite) === "undefined") {
+        reject("Uncomment invites in the plugin's include.gradle first");
+        return;
+      }
+
+      firebase._dynamicLinkCallback = callback;
+
+      // if the app was launched from a dynamic link, process it now
+      if (firebase._launchDynamicLink !== null) {
+        callback(firebase._launchDynamicLink);
+        firebase._launchDynamicLink = null;
+      }
+
+      resolve();
+    } catch (ex) {
+      console.log("Error in firebase.addOnDynamicLinkReceivedCallback: " + ex);
+      reject(ex);
+    }
+  });
+};
+
 firebase.addOnPushTokenReceivedCallback = function (callback) {
   return new Promise(function (resolve, reject) {
     try {
@@ -2073,8 +2118,7 @@ firebase.invites.getInvitation = function () {
         }
       });
 
-      var autoLaunchDeepLink = false;
-      var activity = appModule.android.foregroundActivity;
+      // var autoLaunchDeepLink = false;
 
       firebase._mGoogleApiClient = new com.google.android.gms.common.api.GoogleApiClient.Builder(com.tns.NativeScriptApplication.getInstance())
           .addOnConnectionFailedListener(onConnectionFailedListener)
@@ -2111,7 +2155,7 @@ firebase.invites.getInvitation = function () {
         }
       });
 
-      firebaseDynamicLinks.getDynamicLink(activity.getIntent())
+      firebaseDynamicLinks.getDynamicLink(appModule.android.startActivity.getIntent())
           .addOnSuccessListener(onSuccessListener)
           .addOnFailureListener(onFailureListener);
 
@@ -2123,59 +2167,4 @@ firebase.invites.getInvitation = function () {
   });
 };
 
-
-firebase.addOnDynamicLinkReceivedCallback = function (callback) {
-  return new Promise(function (resolve, reject) {
-		try {
-		  if (typeof(com.google.android.gms.appinvite) === "undefined") {
-				reject("Uncomment invites in the plugin's include.gradle first");
-				return;
-		  }
-
-		  firebase._DynamicLinkCallback = callback;
-		  resolve();
-		} catch (ex) {
-		  console.log("Error in firebase.addOnDynamicLinkReceivedCallback: " + ex);
-		  reject(ex);
-		}
-  });
-};
-
-var dynamicLinksEnabled = new lazy(function () {
-    return typeof(com.google.android.gms.appinvite) !== "undefined"
-});
-
-(function() {
-  appModule.on("launch", function(args) {
-  	if (!dynamicLinksEnabled()) {
-				return;
-		}
-	
-		var intent = args.android;
-
- 		var getDynamicLinksCallback = new com.google.android.gms.tasks.OnCompleteListener({
-		  onComplete: function(task) {
-
-			  if (task.isSuccessful() && task.getResult() != null) {
-			  	result = task.getResult().getLink(); 
-			  	result = firebase.toJsObject(result); 
-					if(firebase._DynamicLinkCallback === null){
-						console.log("No callback is provided for a dynamic link");
-					}
-					else{
-						setTimeout(function() {
-							firebase._DynamicLinkCallback(result);
-						});
-					}
-					
-			 	}
-			}
-	 	});
-		
-	 firebaseDynamicLinks = com.google.firebase.dynamiclinks.FirebaseDynamicLinks.getInstance();
-	 DynamicLinks = firebaseDynamicLinks.getDynamicLink(intent).addOnCompleteListener(getDynamicLinksCallback);
-
-	});
-})()
-
 module.exports = firebase;