Added onSuccess and onError callbacks to startSDK, updated iOS SDK to v6.13.2

Author: al-af

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Versions
 ## 6.13.2
-- Added new APIs such as anonymizeUser , performOnDeepLinking
+- Added new APIs such as `anonymizeUser` , `performOnDeepLinking`
+- Added to the `startSDK` API, `onSuccess` and `onError` callbacks
+- Update to iOS SDK to v6.13.2
 ## 6.13.0+2
 - Update to iOS SDK to v6.13.1
 ## 6.13.0+1

android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Thu Jul 23 11:36:59 IDT 2020
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip

android/src/main/java/com/appsflyer/appsflyersdk/AppsflyerSdkPlugin.java

@@ -8,6 +8,8 @@
 import android.os.Handler;
 import android.os.Looper;
 import android.util.Log;
+import java.util.concurrent.atomic.AtomicBoolean;
+import androidx.annotation.NonNull;
 
 import com.appsflyer.AFLogger;
 import com.appsflyer.AppsFlyerConsent;
@@ -22,6 +24,7 @@
 import com.appsflyer.share.ShareInviteHelper;
 import com.appsflyer.internal.platform_extension.Plugin;
 import com.appsflyer.internal.platform_extension.PluginInfo;
+import com.appsflyer.attribution.AppsFlyerRequestListener;
 
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -80,7 +83,7 @@ public class AppsflyerSdkPlugin implements MethodCallHandler, FlutterPlugin, Act
     private Boolean isFacebookDeferredApplinksEnabled = false;
     private Boolean isSetDisableAdvertisingIdentifiersEnable = false;
     private Map<String, Map<String, Object>> mCallbacks = new HashMap<>();
-    
+
     PluginRegistry.NewIntentListener onNewIntentListener = new PluginRegistry.NewIntentListener() {
         @Override
         public boolean onNewIntent(Intent intent) {
@@ -200,7 +203,7 @@ private void startListening(Object arguments, Result rawResult) {
 
     @Override
     public void onMethodCall(MethodCall call, Result result) {
-        if(activity == null){
+        if (activity == null) {
             Log.d("AppsFlyer", "Activity isn't attached to the flutter engine");
             return;
         }
@@ -369,11 +372,52 @@ private void anonymizeUser(MethodCall call, Result result) {
         result.success(null); // indicate that the method invocation is complete
     }
 
-    private void startSDK(MethodCall call, Result result) {
-        AppsFlyerLib instance = AppsFlyerLib.getInstance();
-        instance.start(activity);
-    }
+    /**
+     * Initiates the AppsFlyer SDK. The AtomicBoolean isResultSubmitted ensures the result is
+     * only submitted once, preventing the "Reply already submitted" exception in Flutter.
+     */
+    private void startSDK(MethodCall call, final Result result) {
+        final AtomicBoolean isResultSubmitted = new AtomicBoolean(false);
+
+        try {
+            final AppsFlyerLib instance = AppsFlyerLib.getInstance();
+            String afDevKey = call.argument(AppsFlyerConstants.AF_DEV_KEY);
+            instance.start(activity, afDevKey, new AppsFlyerRequestListener() {
+                @Override
+                public void onSuccess() {
+                    new Handler(Looper.getMainLooper()).post(new Runnable() {
+                        @Override
+                        public void run() {
+                            if (!isResultSubmitted.getAndSet(true)) {
+                                mMethodChannel.invokeMethod("onSuccess", null);
+                                result.success(null);
+                            }
+                        }
+                    });
+                }
 
+                @Override
+                public void onError(final int errorCode, final String errorMessage) {
+                    new Handler(Looper.getMainLooper()).post(new Runnable() {
+                        @Override
+                        public void run() {
+                            if (!isResultSubmitted.getAndSet(true)) {
+                                HashMap<String, Object> errorDetails = new HashMap<>();
+                                errorDetails.put("errorCode", errorCode);
+                                errorDetails.put("errorMessage", errorMessage);
+                                mMethodChannel.invokeMethod("onError", errorDetails);
+                                result.error(String.valueOf(errorCode), errorMessage, null);
+                            }
+                        }
+                    });
+                }
+            });
+        } catch (Exception e) {
+            if (!isResultSubmitted.getAndSet(true)) {
+                result.error("UNEXPECTED_ERROR", e.getMessage(), null);
+            }
+        }
+    }
     public void setConsentData(MethodCall call, Result result) {
         Map<String, Object> arguments = (Map<String, Object>) call.arguments;
         Map<String, Object> consentDict = (Map<String, Object>) arguments.get("consentData");
@@ -394,20 +438,21 @@ public void setConsentData(MethodCall call, Result result) {
 
         result.success(null);
     }
+
     private void enableTCFDataCollection(MethodCall call, Result result) {
         boolean shouldCollect = (boolean) call.argument("shouldCollect");
         AppsFlyerLib.getInstance().enableTCFDataCollection(shouldCollect);
         result.success(null);
     }
 
     private void addPushNotificationDeepLinkPath(MethodCall call, Result result) {
-        if(call.arguments != null){
+        if (call.arguments != null) {
             ArrayList<String> depplinkPath = (ArrayList<String>) call.arguments;
             String[] depplinkPathArr = depplinkPath.toArray(new String[depplinkPath.size()]);
             AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath(depplinkPathArr);
         }
         result.success(null);
-    }    
+    }
 
     private void setDisableNetworkData(MethodCall call, Result result) {
         boolean disableNetworkData = (boolean) call.arguments;
@@ -420,10 +465,10 @@ private void getOutOfStore(Result result) {
     }
 
     private void setOutOfStore(MethodCall call, Result result) {
-            String sourceName = (String) call.arguments;
-            if (sourceName != null) {
-                AppsFlyerLib.getInstance().setOutOfStore(sourceName);
-            }
+        String sourceName = (String) call.arguments;
+        if (sourceName != null) {
+            AppsFlyerLib.getInstance().setOutOfStore(sourceName);
+        }
         result.success(null);
     }
 
@@ -438,14 +483,14 @@ private void setResolveDeepLinkURLs(MethodCall call, Result result) {
     private void setPartnerData(MethodCall call, Result result) {
         String partnerId = (String) call.argument("partnerId");
         HashMap<String, Object> partnerData = (HashMap<String, Object>) call.argument("partnersData");
-        if(partnerData != null){
+        if (partnerData != null) {
             AppsFlyerLib.getInstance().setPartnerData(partnerId, partnerData);
         }
         result.success(null);
     }
 
     private void setSharingFilterForPartners(MethodCall call, Result result) {
-        if(call.arguments != null){
+        if (call.arguments != null) {
             ArrayList<String> partnersInput = (ArrayList<String>) call.arguments;
             String[] partners = partnersInput.toArray(new String[partnersInput.size()]);
             AppsFlyerLib.getInstance().setSharingFilterForPartners(partners);
@@ -465,7 +510,7 @@ private void setDisableAdvertisingIdentifiers(MethodCall call, Result result) {
 
     private void enableFacebookDeferredApplinks(MethodCall call, Result result) {
         isFacebookDeferredApplinksEnabled = (boolean) call.argument("isFacebookDeferredApplinksEnabled");
-        
+
         if (isFacebookDeferredApplinksEnabled) {
             AppsFlyerLib.getInstance().enableFacebookDeferredApplinks(true);
         } else {
@@ -484,7 +529,7 @@ private void sendPushNotificationData(MethodCall call, Result result) {
         String errorMsg = null;
         Bundle bundle;
 
-        if(pushPayload == null){
+        if (pushPayload == null) {
             Log.d("AppsFlyer", "Push payload is null");
             return;
         }
@@ -509,13 +554,14 @@ private void sendPushNotificationData(MethodCall call, Result result) {
             errorMsg = "The activity is null. Push payload has not been sent!";
         }
 
-        if(errorMsg != null){
+        if (errorMsg != null) {
             Log.d("AppsFlyer", errorMsg);
             return;
         }
 
         result.success(null);
     }
+
     private static Bundle jsonToBundle(JSONObject jsonObject) throws JSONException {
         Bundle bundle = new Bundle();
         Iterator iter = jsonObject.keys();
@@ -526,6 +572,7 @@ private static Bundle jsonToBundle(JSONObject jsonObject) throws JSONException {
         }
         return bundle;
     }
+
     private void setOneLinkCustomDomain(MethodCall call, Result result) {
         ArrayList<String> brandDomains = (ArrayList<String>) call.arguments;
         String[] brandDomainsArray = brandDomains.toArray(new String[brandDomains.size()]);
@@ -768,11 +815,11 @@ private void setAdditionalData(MethodCall call, Result result) {
     private void setUserEmails(MethodCall call, Result result) {
         List<String> emails = call.argument("emails");
         int cryptTypeInt = call.argument("cryptType");
-        
+
         AppsFlyerProperties.EmailsCryptType cryptType = null;
-        if (cryptTypeInt == 0){
+        if (cryptTypeInt == 0) {
             cryptType = AppsFlyerProperties.EmailsCryptType.NONE;
-        } else if (cryptTypeInt == 1){
+        } else if (cryptTypeInt == 1) {
             cryptType = AppsFlyerProperties.EmailsCryptType.SHA256;
         } else {
             throw new InvalidParameterException("You can use only NONE or SHA256 for EmailsCryptType on android");

doc/API.md

@@ -205,11 +205,11 @@ Future<bool?> logEvent(String eventName, Map? eventValues) async {
 ## Other functionalities:
 **<a id="anonymizeUser"> `anonymizeUser(shouldAnonymize)`**
 
-It is possible to anonymize specific user identifiers within AppsFlyer analytics. This complies with both the latest privacy requirements (GDPR, COPPA) and Facebook's data and privacy policies. To anonymize an app user.
+It is possible to anonymize specific user identifiers within AppsFlyer analytics.</br>
+This complies with both the latest privacy requirements (GDPR, COPPA) and Facebook's data and privacy policies. To anonymize an app user.
 | parameter                   | type     | description                                                |
 | ----------                  |----------|------------------                                          |
 | shouldAnonymize             | boolean  | True if want Anonymize user Data (default value is false). |
-| callback                    | function | success callback                                           |
 
 _Example:_
 ```dart

doc/BasicIntegration.md

@@ -51,8 +51,13 @@ appsflyerSdk.initSdk(
 | registerOnDeepLinkingCallback | Set a listener for the [UDL](https://dev.appsflyer.com/hc/docs/unified-deep-linking-udl) response |
 
 ### startSdk
-`startSDK()`
-In version 6.13.0 of the appslfyer-flutter-plugin SDK we added the option of splitting between the initialization stage and start stage. All you need to do is add the property manualStart: true to the init object, and later call appsFlyer.startSdk() whenever you decide. If this property is set to false or doesn’t exist, the sdk will start after calling appsFlyer.initSdk(...).
+`startSDK({RequestSuccessListener? onSuccess, RequestErrorListener? onError})`
+Version 6.13.0+ of the AppsFlyer Flutter plugin introduces the option to manually start the SDK. </br>
+To utilise this feature, set the property `manualStart: true` within the initialization configuration. </br>
+Once the `manualStart` option is activated, you can call `appsFlyer.startSdk()` at your discretion. If the `manualStart` property is omitted or set to false, the SDK will start immediately after calling `appsFlyer.initSdk(...)`.
+
+`onSuccess`: An optional callback that is triggered after a successful initialization of the SDK.
+`onError`: An optional callback that is fired in case of an error during SDK initialization, providing an error code and an error message.
 
 ```dart
     // SDK Options
@@ -64,12 +69,33 @@ In version 6.13.0 of the appslfyer-flutter-plugin SDK we added the option of spl
         manualStart: true);
     _appsflyerSdk = AppsflyerSdk(options);
     
-    // Init of AppsFlyer SDK
+    // Initialization of the AppsFlyer SDK
     _appsflyerSdk.initSdk(
         registerConversionDataCallback: true,
         registerOnAppOpenAttributionCallback: true,
         registerOnDeepLinkingCallback: true);
     
-    //Here we start the SDK
-    _appsflyerSdk.startSDK();
+    // Starting the SDK with optional success and error callbacks
+    _appsflyerSdk.startSDK(
+        onSuccess: () {
+            showMessage("AppsFlyer SDK initialized successfully.");
+        },
+        onError: (int errorCode, String errorMessage) {
+            showMessage("Error initializing AppsFlyer SDK: Code $errorCode - $errorMessage");
+        },
+    );
 ```
+
+Use the `onSuccess` callback to perform actions after successful SDK initialization, and the `onError` callback to handle initialization errors. </br>
+Here's an example from the demo app.
+
+```dart
+_appsflyerSdk.startSDK(
+  onSuccess: () {
+    showMessage("AppsFlyer SDK initialized successfully.");
+  },
+  onError: (int errorCode, String errorMessage) {
+    showMessage("Error initializing AppsFlyer SDK: Code $errorCode - $errorMessage");
+  },
+);
+```

example/lib/main_page.dart

@@ -30,17 +30,20 @@ class MainPageState extends State<MainPage> {
         afDevKey: dotenv.env["DEV_KEY"]!,
         appId: dotenv.env["APP_ID"]!,
         showDebug: true,
-        timeToWaitForATTUserAuthorization: 15,
+        timeToWaitForATTUserAuthorization: 1,
         manualStart: true);
     _appsflyerSdk = AppsflyerSdk(options);
 
-    //Setting configuration to the SDK
+    /*
+    Setting configuration to the SDK:
     _appsflyerSdk.setCurrencyCode("USD");
     _appsflyerSdk.enableTCFDataCollection(true);
-    // var forGdpr = AppsFlyerConsent.forGDPRUser(hasConsentForDataUsage: true, hasConsentForAdsPersonalization: true);
-    // _appsflyerSdk.setConsentData(forGdpr);
+    var forGdpr = AppsFlyerConsent.forGDPRUser(hasConsentForDataUsage: true, hasConsentForAdsPersonalization: true);
+    _appsflyerSdk.setConsentData(forGdpr);
     var nonGdpr = AppsFlyerConsent.nonGDPRUser();
     _appsflyerSdk.setConsentData(nonGdpr);
+     */
+
     // Init of AppsFlyer SDK
     await _appsflyerSdk.initSdk(
         registerConversionDataCallback: true,
@@ -87,7 +90,7 @@ class MainPageState extends State<MainPage> {
     });
 
     //_appsflyerSdk.anonymizeUser(true);
-    if(Platform.isAndroid){
+    if (Platform.isAndroid) {
       _appsflyerSdk.performOnDeepLinking();
     }
 
@@ -116,7 +119,14 @@ class MainPageState extends State<MainPage> {
                 ),
                 ElevatedButton(
                   onPressed: () {
-                    _appsflyerSdk.startSDK();
+                    _appsflyerSdk.startSDK(
+                      onSuccess: () {
+                        showMessage("AppsFlyer SDK initialized successfully.");
+                      },
+                      onError: (int errorCode, String errorMessage) {
+                        showMessage("Error initializing AppsFlyer SDK: Code $errorCode - $errorMessage");
+                      },
+                    );
                   },
                   child: Text("START SDK"),
                 )
@@ -138,4 +148,14 @@ class MainPageState extends State<MainPage> {
     }
     return logResult;
   }
+
+  void showMessage(String message) {
+    ScaffoldMessenger.of(context)
+        .showSnackBar(SnackBar(
+      content:
+      Text(message),
+    ));
+  }
 }
+
+