Merge pull request #123 from BranchMetrics/new-events

jdee · web-flow · commit ca1f45a3bde0 · 2017-03-14T11:07:52.000-07:00
BUO.userCompletedAction and event constants
diff --git a/README.md b/README.md
@@ -55,7 +55,12 @@ Please see the Branch [SDK Integration Guide](https://dev.branch.io/getting-star
 
 ## Usage
 ```js
-import branch from 'react-native-branch'
+import branch, { AddToWishlistEvent,
+  PurchasedEvent,
+  PurchaseInitiatedEvent,
+  RegisterViewEvent,
+  ShareCompletedEvent,
+  ShareInitiatedEvent } from 'react-native-branch'
 
 // Subscribe to incoming links (both Branch & non-Branch)
 // bundle = object with: {params, error, uri}
@@ -71,14 +76,19 @@ branch.setIdentity('theUserId')
 branch.userCompletedAction('Purchased Item', {item: 123})
 branch.logout()
 
-let branchUniversalObject = branch.createBranchUniversalObject('canonicalIdentifier', {metadata: {prop1: 'test', prop2: 'abc'}, title: 'Cool Content!', contentDescription: 'Cool Content Description'})
+let branchUniversalObject = branch.createBranchUniversalObject('canonicalIdentifier', {
+  automaticallyListOnSpotlight: true,
+  metadata: {prop1: 'test', prop2: 'abc'},
+  title: 'Cool Content!',
+  contentDescription: 'Cool Content Description'})
+let actionResult = await branchUniversalObject.userCompletedAction(RegisterViewEvent)
 
 let shareOptions = { messageHeader: 'Check this out', messageBody: 'No really, check this out!' }
 let linkProperties = { feature: 'share', channel: 'RNApp' }
 let controlParams = { $desktop_url: 'http://example.com/home', $ios_url: 'http://example.com/ios' }
 let {channel, completed, error} = await branchUniversalObject.showShareSheet(shareOptions, linkProperties, controlParams)
 let {url} = await branchUniversalObject.generateShortUrl(linkProperties, controlParams)
-let viewResult = await branchUniversalObject.registerView()
+let viewResult = await branchUniversalObject.registerView() // deprecated. use userCompletedAction(RegisterViewEvent) instead.
 let spotlightResult = await branchUniversalObject.listOnSpotlight()
 
 let rewards = await branch.loadRewards()
diff --git a/android/src/main/java/io/branch/rnbranch/RNBranchModule.java b/android/src/main/java/io/branch/rnbranch/RNBranchModule.java
@@ -167,6 +167,15 @@ public void userCompletedAction(String event, ReadableMap appState) throws JSONE
         branch.userCompletedAction(event, convertMapToJson(appState));
     }
 
+    @ReactMethod
+    public void userCompletedActionOnUniversalObject(String ident, String event, Promise promise) {
+        BranchUniversalObject universalObject = findUniversalObjectOrReject(ident, promise);
+        if (universalObject == null) return;
+
+        universalObject.userCompletedAction(event);
+        promise.resolve(null);
+    }
+
     @ReactMethod
     public void showShareSheet(String ident, ReadableMap shareOptionsMap, ReadableMap linkPropertiesMap, ReadableMap controlParamsMap, Promise promise) {
         Context context = getReactApplicationContext();
diff --git a/ios/RNBranch.m b/ios/RNBranch.m
@@ -196,6 +196,20 @@ - (BranchUniversalObject *)findUniversalObjectWithIdent:(NSString *)ident reject
     [branchInstance userCompletedAction:event withState:appState];
 }
 
+#pragma mark userCompletedActionOnUniversalObject
+RCT_EXPORT_METHOD(
+                  userCompletedActionOnUniversalObject:(NSString *)identifier
+                  event:(NSString *)event
+                  resolver:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject
+) {
+    BranchUniversalObject *branchUniversalObject = [self findUniversalObjectWithIdent:identifier rejecter:reject];
+    if (!branchUniversalObject) return;
+
+    [branchUniversalObject userCompletedAction:event];
+    resolve(NSNull.null);
+}
+
 #pragma mark showShareSheet
 RCT_EXPORT_METHOD(
                   showShareSheet:(NSString *)identifier
diff --git a/src/branchUniversalObject.js b/src/branchUniversalObject.js
@@ -30,6 +30,7 @@ export default async function createBranchUniversalObject(identifier, options =
 
       return this._tryFunction(RNBranch.showShareSheet, shareOptions, linkProperties, controlParams)
     },
+    // deprecated in favor of userCompletedAction(RegisterViewEvent)
     registerView() {
       return this._tryFunction(RNBranch.registerView)
     },
@@ -40,6 +41,9 @@ export default async function createBranchUniversalObject(identifier, options =
       if (Platform.OS !== 'ios') return Promise.resolve()
       return this._tryFunction(RNBranch.listOnSpotlight)
     },
+    userCompletedAction(event) {
+      return this._tryFunction(RNBranch.userCompletedActionOnUniversalObject, event)
+    },
     release() {
       RNBranch.releaseUniversalObject(this.ident)
     },
diff --git a/src/index.js b/src/index.js
@@ -12,6 +12,13 @@ const INIT_SESSION_SUCCESS = 'RNBranch.initSessionSuccess'
 const INIT_SESSION_ERROR = 'RNBranch.initSessionError'
 const INIT_SESSION_TTL = 5000
 
+export const AddToWishlistEvent = "Add to Wishlist"
+export const PurchasedEvent = "Purchased"
+export const PurchaseInitiatedEvent = "Purchase Started"
+export const RegisterViewEvent = "View"
+export const ShareCompletedEvent = "Share Completed"
+export const ShareInitiatedEvent = "Share Started"
+
 class Branch {
   _launchTime = new Date().getTime();
   _initSessionResult = null;
diff --git a/testbed/testbed_carthage/src/BranchMethods.js b/testbed/testbed_carthage/src/BranchMethods.js
@@ -3,7 +3,7 @@ import { ScrollView, StyleSheet, Text, View } from 'react-native'
 
 import Button from './Button'
 
-import branch from 'react-native-branch'
+import branch, { RegisterViewEvent } from 'react-native-branch'
 
 const defaultBUO = {
   title: 'wallo'
@@ -42,18 +42,6 @@ class BranchMethods extends Component {
     }
   }
 
-  registerView = async () => {
-    if (!this.buo) await this.createBranchUniversalObject()
-    try {
-      let result = await this.buo.registerView()
-      console.log('registerView', result)
-      this.addResult('success', 'registerView', result)
-    } catch (err) {
-      console.log('registerView err', err.toString())
-      this.addResult('error', 'registerView', err.toString())
-    }
-  }
-
   listOnSpotlight = async () => {
     if (!this.buo) await this.createBranchUniversalObject()
     try {
@@ -111,6 +99,18 @@ class BranchMethods extends Component {
     }
   }
 
+  userCompletedAction = async() => {
+    if (!this.buo) await this.createBranchUniversalObject()
+    try {
+      let result = await this.buo.userCompletedAction(RegisterViewEvent)
+      console.log('userCompletedAction', result)
+      this.addResult('success', 'userCompletedAction', result)
+    } catch (err) {
+      console.log('userCompletedAction err', err.toString())
+      this.addResult('error', 'userCompletedAction', err.toString())
+    }
+  }
+
   addResult(type, slug, payload) {
     let result = { type, slug, payload }
     this.setState({
@@ -138,8 +138,8 @@ class BranchMethods extends Component {
         <Text style={styles.header}>METHODS</Text>
         <ScrollView style={styles.buttonsContainer}>
           <Button onPress={this.createBranchUniversalObject}>createBranchUniversalObject</Button>
+          <Button onPress={this.userCompletedAction}>userCompletedAction</Button>
           <Button onPress={this.generateShortUrl}>generateShortUrl</Button>
-          <Button onPress={this.registerView}>registerView</Button>
           <Button onPress={this.listOnSpotlight}>listOnSpotlight</Button>
           <Button onPress={this.showShareSheet}>showShareSheet</Button>
           <Button onPress={this.redeemRewards.bind(this, '')}>redeemRewards</Button>
diff --git a/testbed/testbed_cocoapods/android/app/app.iml b/testbed/testbed_cocoapods/android/app/app.iml
@@ -76,13 +76,29 @@
       <sourceFolder url="file://$MODULE_DIR$/src/test/java" isTestSource="true" />
       <sourceFolder url="file://$MODULE_DIR$/src/test/rs" isTestSource="true" />
       <sourceFolder url="file://$MODULE_DIR$/src/test/shaders" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/assets" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/blame" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/builds" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/classes" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental-classes" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental-runtime-classes" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental-safeguard" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental-verifier" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/instant-run-resources" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/instant-run-support" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/jniLibs" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/manifests" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/reload-dex" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/res" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/restart-dex" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/rs" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/shaders" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/split-apk" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/symbols" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/transforms" />
       <excludeFolder url="file://$MODULE_DIR$/build/outputs" />
+      <excludeFolder url="file://$MODULE_DIR$/build/tmp" />
     </content>
     <orderEntry type="jdk" jdkName="Android API 23 Platform" jdkType="Android SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
diff --git a/testbed/testbed_cocoapods/src/BranchMethods.js b/testbed/testbed_cocoapods/src/BranchMethods.js
@@ -3,7 +3,7 @@ import { ScrollView, StyleSheet, Text, View } from 'react-native'
 
 import Button from './Button'
 
-import branch from 'react-native-branch'
+import branch, { RegisterViewEvent } from 'react-native-branch'
 
 const defaultBUO = {
   title: 'wallo'
@@ -42,18 +42,6 @@ class BranchMethods extends Component {
     }
   }
 
-  registerView = async () => {
-    if (!this.buo) await this.createBranchUniversalObject()
-    try {
-      let result = await this.buo.registerView()
-      console.log('registerView', result)
-      this.addResult('success', 'registerView', result)
-    } catch (err) {
-      console.log('registerView err', err.toString())
-      this.addResult('error', 'registerView', err.toString())
-    }
-  }
-
   listOnSpotlight = async () => {
     if (!this.buo) await this.createBranchUniversalObject()
     try {
@@ -111,6 +99,18 @@ class BranchMethods extends Component {
     }
   }
 
+  userCompletedAction = async() => {
+    if (!this.buo) await this.createBranchUniversalObject()
+    try {
+      let result = await this.buo.userCompletedAction(RegisterViewEvent)
+      console.log('userCompletedAction', result)
+      this.addResult('success', 'userCompletedAction', result)
+    } catch (err) {
+      console.log('userCompletedAction err', err.toString())
+      this.addResult('error', 'userCompletedAction', err.toString())
+    }
+  }
+
   addResult(type, slug, payload) {
     let result = { type, slug, payload }
     this.setState({
@@ -138,8 +138,8 @@ class BranchMethods extends Component {
         <Text style={styles.header}>METHODS</Text>
         <ScrollView style={styles.buttonsContainer}>
           <Button onPress={this.createBranchUniversalObject}>createBranchUniversalObject</Button>
+          <Button onPress={this.userCompletedAction}>userCompletedAction</Button>
           <Button onPress={this.generateShortUrl}>generateShortUrl</Button>
-          <Button onPress={this.registerView}>registerView</Button>
           <Button onPress={this.listOnSpotlight}>listOnSpotlight</Button>
           <Button onPress={this.showShareSheet}>showShareSheet</Button>
           <Button onPress={this.redeemRewards.bind(this, '')}>redeemRewards</Button>
