Merge pull request #169 from renesansz/feat/mixpanel-integration

Mixpanel integration
BranchMetrics · Aug 7, 2016 · 836ddaf · 836ddaf
2 parents 56d9e9c + 93d2004
commit 836ddaf
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -167,6 +167,7 @@ Branch.getFirstReferringParams().then(function (res) {
 1. Branch Session
   + [setDebug](#setDebug)
   + [initSession](#initSession)
+  + [setMixpanelToken](#setMixpanelToken)
   + [getLatestReferringParams](#getLatestReferringParams)
   + [getFirstReferringParams](#getFirstReferringParams)
   + [setIdentity](#setIdentity)
@@ -235,6 +236,17 @@ function DeepLinkHandler(data) {
 }
 ```
 
+### <a id="setMixpanelToken"></a>setMixpanelToken()
+
+Allow Branch SDK to pass the user's Mixpanel distinct id to our servers. Branch will then pass that Distinct ID to Mixpanel when logging any event.
+**Note:** This should be initialized first before `initSession()` or else Mixpanel integration won't work.
+
+##### Usage
+
+```js
+Branch.setMixpanelToken('<your-mixpanel-token-here>');
+```
+
 ### <a id="getFirstReferringParams"></a>getFirstReferringParams()
 
 Retrieves the install session parameters.

diff --git a/src/android/io/branch/BranchSDK.java b/src/android/io/branch/BranchSDK.java
@@ -106,6 +106,9 @@ public boolean execute(String action, JSONArray args, CallbackContext callbackCo
         } else if (action.equals("initSession")) {
             cordova.getThreadPool().execute(r);
             return true;
+        }  else if (action.equals("setMixpanelToken")) {
+            cordova.getThreadPool().execute(r);
+            return true;
         } else {
             if (this.instance != null) {
                 if (action.equals("setIdentity")) {
@@ -586,6 +589,21 @@ private void setIdentity(String newIdentity, CallbackContext callbackContext)
 
     }
 
+    /**
+     * <p>Allow Branch SDK to pass the user's Mixpanel distinct id to our servers. Branch will then pass that Distinct ID to Mixpanel when logging any event.</p>
+     *
+     * @param token A {@link String} value containing the unique identifier of the Mixpanel user.
+     * @param callbackContext   A callback to execute at the end of this method
+     */
+    private void setMixpanelToken(String token, CallbackContext callbackContext)
+    {
+
+        Branch.getInstance().setRequestMetadata("$mixpanel_distinct_id", token);
+
+        callbackContext.success("Success");
+
+    }
+
     /**
      * <p>A void call to indicate that the user has performed a specific action and for that to be
      * reported to the Branch API.</p>
@@ -598,6 +616,7 @@ private void userCompletedAction(String action, CallbackContext callbackContext)
     {
 
         this.instance.userCompletedAction(action);
+
         callbackContext.success("Success");
 
     }
@@ -616,6 +635,7 @@ private void userCompletedAction(String action, JSONObject metaData, CallbackCon
     {
 
         this.instance.userCompletedAction(action, metaData);
+
         callbackContext.success("Success");
 
     }
@@ -1141,6 +1161,8 @@ public void run() {
                     setDebug(this.args.getBoolean(0), this.callbackContext);
                 } else if (this.action.equals("initSession")) {
                     initSession(this.callbackContext);
+                }  else if (this.action.equals("setMixpanelToken")) {
+                    setMixpanelToken(this.args.getString(0), this.callbackContext);
                 } else {
                     if (this.action.equals("setIdentity")) {
                         setIdentity(this.args.getString(0), this.callbackContext);

diff --git a/src/ios/BranchSDK.h b/src/ios/BranchSDK.h
@@ -25,6 +25,7 @@
 
 // BranchSDK Basic Methods
 - (void)initSession:(CDVInvokedUrlCommand*)command;
+- (void)setMixpanelToken:(CDVInvokedUrlCommand*)command;
 - (void)setDebug:(CDVInvokedUrlCommand*)command;
 - (void)getAutoInstance:(CDVInvokedUrlCommand*)command;
 - (void)getLatestReferringParams:(CDVInvokedUrlCommand*)command;

diff --git a/src/ios/BranchSDK.m b/src/ios/BranchSDK.m
@@ -143,6 +143,13 @@ - (void)initSession:(CDVInvokedUrlCommand*)command
     }];
 }
 
+- (void)setMixpanelToken:(CDVInvokedUrlCommand*)command
+{
+
+    [[Branch getInstance] setRequestMetadataKey:@"$mixpanel_distinct_id" value:[command.arguments objectAtIndex:0]];
+
+}
+
 - (void)setDebug:(CDVInvokedUrlCommand*)command
 {
     bool enableDebug = [[command.arguments objectAtIndex:0] boolValue] == YES;

diff --git a/testbed/www/js/index.js b/testbed/www/js/index.js
@@ -82,6 +82,7 @@ function InitSession()
 {
     console.log('Trigger InitSession()');
 
+    Branch.setMixpanelToken('<your-mixpanel-token-here>');
     Branch.initSession().then(function (res) {
         console.log(res);
         alert('Response: ' + JSON.stringify(res));

diff --git a/www/branch.js b/www/branch.js
@@ -71,6 +71,20 @@ Branch.prototype.initSession = function () {
 
 };
 
+/**
+ * Get Mixpanel tolen/assisstance.
+ * NOTE: This must be called before initSession
+ *
+ * @param (String) token. Default = false
+ *
+ * @return (Promise)
+ */
+Branch.prototype.setMixpanelToken = function (token) {
+
+    return execute('setMixpanelToken', [token]);
+
+};
+
 /**
  * Set debug mode.
  * NOTE: This must be called before initSession