Merge pull request #92 from AppsFlyerSDK/dev/userInviteRefactor

GM-appsflyer · web-flow · commit 75b2cdf78a94 · 2021-03-08T11:08:25.000+02:00
Refactoring of user invite feature
diff --git a/android/src/main/java/com/appsflyer/appsflyersdk/AppsflyerSdkPlugin.java b/android/src/main/java/com/appsflyer/appsflyersdk/AppsflyerSdkPlugin.java
@@ -262,9 +262,9 @@ private void setAppInivteOneLinkID(MethodCall call, Result result) {
             result.success(null);
         }else{
             AppsFlyerLib.getInstance().setAppInviteOneLink(oneLinkId);
-            if(mCallbacks.containsKey("successSetAppInviteOneLinkID")){
+            if(mCallbacks.containsKey("setAppInviteOneLinkIDCallback")){
                 JSONObject obj = buildJsonResponse("success", AF_SUCCESS);
-                runOnUIThread(obj, "successSetAppInviteOneLinkID", AF_SUCCESS);
+                runOnUIThread(obj, "setAppInviteOneLinkIDCallback", AF_SUCCESS);
             }
         }
     }
@@ -303,17 +303,29 @@ private void generateInviteLink(MethodCall call, Result rawResult) {
         }
 
         CreateOneLinkHttpTask.ResponseListener listener = new CreateOneLinkHttpTask.ResponseListener() {
+            JSONObject obj = new JSONObject();
+
             @Override
             public void onResponse(final String oneLinkUrl) {
-                if (mCallbacks.containsKey("successGenerateInviteLink")) {
-//                    runOnUIThread(oneLinkUrl, "successGenerateInviteLink", AF_SUCCESS);
+                if (mCallbacks.containsKey("generateInviteLinkSuccess")) {
+                    try {
+                        obj.put("userInviteUrl", oneLinkUrl);
+                        runOnUIThread(obj, "generateInviteLinkSuccess", AF_SUCCESS);
+                    }catch (JSONException e) {
+                        e.printStackTrace();
+                    }
                 }
             }
 
             @Override
             public void onResponseError(final String error) {
-                if (mCallbacks.containsKey("errorGenerateInviteLink")) {
-//                    runOnUIThread(error, "errorGenerateInviteLink", AF_FAILURE);
+                if (mCallbacks.containsKey("generateInviteLinkFailure")) {
+                    try {
+                        obj.put("error", error);
+                        runOnUIThread(error, "generateInviteLinkFailure", AF_FAILURE);
+                    }catch (JSONException e) {
+                        e.printStackTrace();
+                    }
                 }
             }
         };
diff --git a/doc/API.md b/doc/API.md
@@ -32,6 +32,7 @@
 - [updateServerUninstallToken](#updateServerUninstallToken)
 - [Validate Purchase](#validatePurchase)
 - [setPushNotification](#setPushNotification)
+- [User Invite](#userInvite)
 - [stream](#streams)
 ---
 
@@ -385,6 +386,58 @@ Please check the following guide in order to understand the relevant payload nee
 
 https://support.appsflyer.com/hc/en-us/articles/207364076-Measuring-push-notification-re-engagement-campaigns
 
+---
+**<a id="userInvite"> User Invite**
+
+1. First define the Onelink ID (find it in the AppsFlyer dashboard in the onelink section:
+
+  **`Future<void> setAppInviteOneLinkID(String oneLinkID, Function callback)`**
+
+2. Set the AppsFlyerInviteLinkParams class to set the query params in the user invite link:
+
+```dart
+class AppsFlyerInviteLinkParams {
+  final String channel;
+  final String campaign;
+  final String referrerName;
+  final String referreImageUrl;
+  final String customerID;
+  final String baseDeepLink;
+  final String brandDomain;
+}
+```
+
+3. Call the generateInviteLink API to generate the user invite link. Use the success and error callbacks for handling.
+
+  **`void generateInviteLink(AppsFlyerInviteLinkParams parameters, Function success, Function error)`**
+
+
+_Example:_
+```dart
+appsFlyerSdk.setAppInviteOneLinkID('OnelinkID', 
+(res){ 
+  print("setAppInviteOneLinkID callback: $res"); 
+});
+
+AppsFlyerInviteLinkParams inviteLinkParams = new AppsFlyerInviteLinkParams(
+      channel: "",
+      referrerName: "",
+      baseDeepLink: "",
+      brandDomain: "",
+      customerID: "",
+      referreImageUrl: "",
+      campaign: ""
+);
+
+appsFlyerSdk.generateInviteLink(inviteLinkParams, 
+  (result){ 
+    print(result); 
+  }, 
+  (error){ 
+    print(error);
+  }
+);
+```
 ---
 ### **Conversion Data and on app open attribution for older versions**
 For plugin version `6.0.5+2` and below the user can access `conversionDataStream`, `appOpenAttributionStream` and `onDeepLinkingStream` to listen for events (see example app)
diff --git a/example/lib/main_page.dart b/example/lib/main_page.dart
@@ -57,7 +57,7 @@ class MainPageState extends State<MainPage> {
                   future: _appsflyerSdk.getSDKVersion(),
                   builder: (BuildContext context, AsyncSnapshot snapshot) {
                     return Text(snapshot.hasData ? snapshot.data : "");
-                  })
+                  }), 
             ],
           ),
         ),
diff --git a/ios/Classes/AppsFlyerStreamHandler.h b/ios/Classes/AppsFlyerStreamHandler.h
@@ -16,7 +16,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface AppsFlyerStreamHandler: NSObject<FlutterStreamHandler, AppsFlyerLibDelegate, AppsFlyerDeepLinkDelegate>
 
-- (void) sendValidatePurchaseResponseToFlutter:(NSDictionary*) obj;
+- (void)sendResponseToFlutter:(NSString *)responseID status:(NSString *)status data:(NSDictionary *)data;
 
 @end
 
diff --git a/ios/Classes/AppsFlyerStreamHandler.m b/ios/Classes/AppsFlyerStreamHandler.m
@@ -155,20 +155,25 @@ - (void)didResolveDeepLink:(AppsFlyerDeepLinkResult* _Nonnull) deepLinkResult {
     }
 }
 
-- (void)sendValidatePurchaseResponseToFlutter:(NSDictionary *)message{
+- (void)sendResponseToFlutter:(NSString *)responseID status:(NSString *)status data:(NSDictionary *)data{
     NSError *error;
-    // NSData *JSON = [NSJSONSerialization dataWithJSONObject:message options:0 error:&error];
-    NSString *JSONString = [self mapToJson:message withError:error];
+    NSString *JSONdata;
+
+    if(data != nil){
+        JSONdata = [self mapToJson:data withError:error];
+    }else{
+        JSONdata = @"empty data";
+    }
     if (error) {
         return;
     }
     NSDictionary *fullResponse = @{
-                @"id": afValidatePurchase,
-                @"data": JSONString,
-                @"status": afSuccess
+                @"id": responseID,
+                @"data": JSONdata,
+                @"status": status
             };
-    JSONString = [self mapToJson:fullResponse withError:error];
-    [AppsflyerSdkPlugin.callbackChannel invokeMethod:@"callListener" arguments:JSONString];
+    JSONdata = [self mapToJson:fullResponse withError:error];
+    [AppsflyerSdkPlugin.callbackChannel invokeMethod:@"callListener" arguments:JSONdata];
 }
 
 @end
diff --git a/ios/Classes/AppsflyerSdkPlugin.h b/ios/Classes/AppsflyerSdkPlugin.h
@@ -37,6 +37,9 @@
 #define afGCDCallback                   @"onInstallConversionData"
 #define afOAOACallback                  @"onAppOpenAttribution"
 #define afUDPCallback                   @"onDeepLinking"
+#define afGenerateInviteLinkSuccess     @"generateInviteLinkSuccess"
+#define afGenerateInviteLinkFailure     @"generateInviteLinkFailure"
+#define afAppInviteOneLinkID            @"appInviteOneLinkID"
 
 // Stream Channels
 #define afMethodChannel                 @"af-api"
diff --git a/ios/Classes/AppsflyerSdkPlugin.m b/ios/Classes/AppsflyerSdkPlugin.m
@@ -183,12 +183,20 @@ - (void)generateInviteLink:(FlutterMethodCall*)call result:(FlutterResult)result
         return generator;
     } completionHandler:^(NSURL * _Nullable url) {
         NSString * resultURL = url.absoluteString;
+        NSDictionary* resultURLObject;
                     if(resultURL != nil){
-                        if([_callbackById containsObject:@"successGenerateInviteLink"]){
-                        [_callbackChannel invokeMethod:@"callListener" arguments:@{
-                            @"id": @"successGenerateInviteLink",
-                            @"data":resultURL
-                        }];
+                        resultURLObject = @{
+                            @"userInviteURL": resultURL
+                        };
+                        if([_callbackById containsObject:afGenerateInviteLinkSuccess]){
+                            [_streamHandler sendResponseToFlutter:afGenerateInviteLinkSuccess status:afSuccess data:resultURLObject];
+                        }
+                    }else{
+                        resultURLObject = @{
+                            @"error": @"The URL wasn't generated!"
+                        };
+                        if([_callbackById containsObject:afGenerateInviteLinkFailure]){
+                            [_streamHandler sendResponseToFlutter:afGenerateInviteLinkFailure status:afFailure data:resultURLObject];
                         }
                     }
     }];
@@ -199,10 +207,11 @@ - (void)generateInviteLink:(FlutterMethodCall*)call result:(FlutterResult)result
 - (void)setAppInviteOneLinkID:(FlutterMethodCall*)call result:(FlutterResult)result{
     NSString* oneLinkID = call.arguments[@"oneLinkID"];
     [AppsFlyerLib shared].appInviteOneLinkID = oneLinkID;
-    if([_callbackById containsObject:@"successSetAppInviteOneLinkID"]){
-        [_callbackChannel invokeMethod:@"callListener" arguments:@{
-            @"id": @"successSetAppInviteOneLinkID"
-        }];
+    if([_callbackById containsObject:@"setAppInviteOneLinkIDCallback"]){
+        NSDictionary* message = @{
+          @"status": afSuccess
+        };
+        [_streamHandler sendResponseToFlutter:afAppInviteOneLinkID status:afSuccess data:message];
     }
     result(nil);
 }
@@ -294,21 +303,15 @@ - (void)validateAndLogInAppPurchase:(FlutterMethodCall*)call result:(FlutterResu
 }
 
 - (void)onValidateSuccess: (NSDictionary*) data{
-    NSDictionary* message = @{
-                              @"status": afSuccess,
-                              @"data": data
-                              };
-    
-    [_streamHandler sendValidatePurchaseResponseToFlutter:message];
+    [_streamHandler sendResponseToFlutter:afValidatePurchase status:afSuccess data:data];
 }
 
 -(void)onValidateFail:(NSError*)error{
-    NSDictionary* message = @{
-                              @"status": afFailure,
-                              @"error": @"error connecting"
-                              };
-    [_streamHandler sendValidatePurchaseResponseToFlutter:message];
-    [self performSelectorOnMainThread:@selector(handleCallback:) withObject:@[message,afValidatePurchaseChannel] waitUntilDone:NO];
+    NSDictionary* errorObject = @{
+                @"error": error.description
+                };
+    [_streamHandler sendResponseToFlutter:afValidatePurchase status:afFailure data:errorObject];
+    [self performSelectorOnMainThread:@selector(handleCallback:) withObject:@[errorObject,afValidatePurchaseChannel] waitUntilDone:NO];
 }
 
 - (void)setAdditionalData:(FlutterMethodCall*)call result:(FlutterResult)result{
diff --git a/lib/src/appsflyer_sdk.dart b/lib/src/appsflyer_sdk.dart
@@ -489,8 +489,8 @@ class AppsflyerSdk {
     if (parameters != null) {
       paramsMap = _translateInviteLinkParamsToMap(parameters);
     }
-    startListening(success, "successGenerateInviteLink");
-    startListening(error, "errorGenerateInviteLink");
+    startListening(success, "generateInviteLinkSuccess");
+    startListening(error, "generateInviteLinkFailure");
     _methodChannel.invokeMethod("generateInviteLink", paramsMap);
   }
 
@@ -512,7 +512,7 @@ class AppsflyerSdk {
   ///The link that is generated for the user invite will use this OneLink ID as the base link ID
   Future<void> setAppInviteOneLinkID(
       String oneLinkID, Function callback) async {
-    startListening(callback, "successSetAppInviteOneLinkID");
+    startListening(callback, "setAppInviteOneLinkIDCallback");
     await _methodChannel.invokeMethod("setAppInviteOneLinkID", {
       'oneLinkID': oneLinkID,
     });
diff --git a/lib/src/callbacks.dart b/lib/src/callbacks.dart
@@ -19,6 +19,7 @@ Future<void> _methodCallHandler(MethodCall call) async {
           case "onInstallConversionData":
           case "onDeepLinking":
           case "validatePurchase":
+          case "generateInviteLinkSuccess":
             String data = callMap["data"];
             Map decodedData = jsonDecode(data);
             Map fullResponse = {
@@ -28,7 +29,7 @@ Future<void> _methodCallHandler(MethodCall call) async {
             _callbacksById[callMap["id"]](fullResponse);
             break;
           default:
-            _callbacksById[call.arguments["id"]](call.arguments["data"]);
+            _callbacksById[callMap["id"]](callMap["data"]);
             break;
         }
       } catch (e) {
diff --git a/test/appsflyer_sdk_test.dart b/test/appsflyer_sdk_test.dart
@@ -67,7 +67,7 @@ void main() {
           case 'setSharingFilter':
           case 'getSDKVersion':
           case 'getAppsFlyerUID':
-          case 'validateAndLogInAppPurchase':
+          case 'validateAndLogInAppAndroidPurchase':
           case 'setMinTimeBetweenSessions':
           case 'getHostPrefix':
           case 'getHostName':
@@ -189,7 +189,7 @@ void main() {
     });
 
     test('check validateAndLogInAppPurchase call', () async {
-      instance.validateAndLogInAppPurchase(
+      instance.validateAndLogInAppAndroidPurchase(
           "publicKey", "signature", "purchaseData", "price", "currency", null);
 
       expect(selectedMethod, 'listen');

Original file line number	Diff line number	Diff line change
`@@ -262,9 +262,9 @@ private void setAppInivteOneLinkID(MethodCall call, Result result) {`
`262`	`262`	`result.success(null);`
`263`	`263`	`}else{`
`264`	`264`	`AppsFlyerLib.getInstance().setAppInviteOneLink(oneLinkId);`
`265`		`- if(mCallbacks.containsKey("successSetAppInviteOneLinkID")){`
	`265`	`+ if(mCallbacks.containsKey("setAppInviteOneLinkIDCallback")){`
`266`	`266`	`JSONObject obj = buildJsonResponse("success", AF_SUCCESS);`
`267`		`- runOnUIThread(obj, "successSetAppInviteOneLinkID", AF_SUCCESS);`
	`267`	`+ runOnUIThread(obj, "setAppInviteOneLinkIDCallback", AF_SUCCESS);`
`268`	`268`	`}`
`269`	`269`	`}`
`270`	`270`	`}`
`@@ -303,17 +303,29 @@ private void generateInviteLink(MethodCall call, Result rawResult) {`
`303`	`303`	`}`
`304`	`304`
`305`	`305`	`CreateOneLinkHttpTask.ResponseListener listener = new CreateOneLinkHttpTask.ResponseListener() {`
	`306`	`+ JSONObject obj = new JSONObject();`
	`307`	`+`
`306`	`308`	`@Override`
`307`	`309`	`public void onResponse(final String oneLinkUrl) {`
`308`		`- if (mCallbacks.containsKey("successGenerateInviteLink")) {`
`309`		`-// runOnUIThread(oneLinkUrl, "successGenerateInviteLink", AF_SUCCESS);`
	`310`	`+ if (mCallbacks.containsKey("generateInviteLinkSuccess")) {`
	`311`	`+ try {`
	`312`	`+ obj.put("userInviteUrl", oneLinkUrl);`
	`313`	`+ runOnUIThread(obj, "generateInviteLinkSuccess", AF_SUCCESS);`
	`314`	`+ }catch (JSONException e) {`
	`315`	`+ e.printStackTrace();`
	`316`	`+ }`
`310`	`317`	`}`
`311`	`318`	`}`
`312`	`319`
`313`	`320`	`@Override`
`314`	`321`	`public void onResponseError(final String error) {`
`315`		`- if (mCallbacks.containsKey("errorGenerateInviteLink")) {`
`316`		`-// runOnUIThread(error, "errorGenerateInviteLink", AF_FAILURE);`
	`322`	`+ if (mCallbacks.containsKey("generateInviteLinkFailure")) {`
	`323`	`+ try {`
	`324`	`+ obj.put("error", error);`
	`325`	`+ runOnUIThread(error, "generateInviteLinkFailure", AF_FAILURE);`
	`326`	`+ }catch (JSONException e) {`
	`327`	`+ e.printStackTrace();`
	`328`	`+ }`
`317`	`329`	`}`
`318`	`330`	`}`
`319`	`331`	`};`