Merge pull request #116 from AppsFlyerSDK/dev/strictMode&waitForAttStatus

Strict mode+wait for att status API

Author: GM-appsflyer

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 6.2.4-nullsafety.5
+- Added support for strict mode (kids app)
+- Added support for wait for att status API
+
 ## 6.2.4+4-nullsafety
 - Fix small bug with validateAndLogInAppIosPurchase API
 

README.md

@@ -23,8 +23,12 @@ When submitting an issue please specify your AppsFlyer sign-up (account) email ,
 - [Getting started](#getting-started)
 - [Setting AppsFlyer options](#appsFlyer-options)
 - [Initializing the SDK](#init-sdk)
-- [Guides](#guides)
-- [API](#api)
+- [Set plugin for IOS 14](#ios14)
+- [Setting strict mode (app for kids)](#strictMode)
+- [Additional Guides](#guides)
+- [APIs](#api)
+
+---
 
 ### Supported Platforms
 
@@ -42,6 +46,7 @@ When submitting an issue please specify your AppsFlyer sign-up (account) email ,
 ### The version `6.2.4-flutterv1` will use iOS SDK V6.2.4 with Flutter V1
 
 ---
+
 ## <a id="v6-breaking-changes"> **❗Migration Guide to v6**
 - [Integration guide](https://support.appsflyer.com//hc/en-us/articles/207032066#introduction)
 - [Migration guide](https://support.appsflyer.com/hc/en-us/articles/360011571778)
@@ -61,10 +66,14 @@ In v6 of AppsFlyer SDK there are some api breaking changes:
 ### Important notice
 - Switch `ConversionData` and `OnAppOpenAttribution` to be based on callbacks instead of streams since plugin version `6.0.5+2`
 
+---
+
 ## <a id="getting-started"> **📲 Getting started**
 
 In order to install the plugin, visit [this](https://pub.dartlang.org/packages/appsflyer_sdk#-installing-tab-) page.
 
+---
+
 ### <a id="appsFlyer-options"> ⚙️  AppsFlyerOptions
 
 To start using AppsFlyer you first need to create an instance of `AppsflyerSdk` before using any other of our sdk functionalities.  
@@ -83,6 +92,8 @@ Map appsFlyerOptions = { "afDevKey": afDevKey,
 AppsflyerSdk appsflyerSdk = AppsflyerSdk(appsFlyerOptions);
 ```
 
+---
+
 ### <a id="init-sdk"> 🚀  Initializing the SDK
 
 The next step is to call `initSdk` which have the optional boolean parameters 
@@ -102,10 +113,77 @@ appsflyerSdk.initSdk(
 );
 ```
 
-## <a id="guides"> **📖 Guides**
+---
+
+## <a id="ios14"> Set plugin for IOS 14
+
+1. Add `#import <AppTrackingTransparency/AppTrackingTransparency.h>` in your `AppDelegate.m` 
+
+2. Add the ATT pop-up for IDFA collection so your `AppDelegate.m` will look like this:
+```
+-(BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions
+{
+    self.viewController = [[MainViewController alloc] init];
+    if (@available(iOS 14, *)) {
+        [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
+            //If you want to do something with the pop-up
+        }];
+    }
+    return [super application:application didFinishLaunchingWithOptions:launchOptions];
+}
+```
+
+3. Add Privacy - Tracking Usage Description inside your `.plist` file in Xcode.
+
+4. Optional: Set the `timeToWaitForATTUserAuthorization` property in the `AppsFlyerOptions` to delay the sdk initazliation for a number of `x seconds` until the user accept the consent dialog:
+```dart
+AppsFlyerOptions options = AppsFlyerOptions(
+    afDevKey: DotEnv().env["DEV_KEY"],
+    appId: DotEnv().env["APP_ID"],
+    showDebug: true,
+    timeToWaitForATTUserAuthorization: 30
+    ); 
+```
+
+For more info visit our Full Support guide for iOS 14:
+
+https://support.appsflyer.com/hc/en-us/articles/207032066#integration-33-configuring-app-tracking-transparency-att-support
+
+---
+
+## <a id="strictMode">👨‍👩‍👧‍👦  Strict mode for App-kids
+
+Starting from version **6.2.4-nullsafety.5** iOS SDK comes in two variants: **Strict** mode and **Regular** mode. 
+
+Please read more: https://support.appsflyer.com/hc/en-us/articles/207032066#integration-strict-mode-sdk
+
+***Change to Strict mode***
+
+After you [installed](#installation) the AppsFlyer plugin:
+
+1. Go to the `ios` folder
+2. Open `appsflyer_sdk.podspec` and add `/Strict` to the `s.ios.dependency` as follow:
+
+`s.ios.dependency 'AppsFlyerFramework', '6.x.x'` To >> `s.ios.dependency 'AppsFlyerFramework/Strict', '6.x.x'`
+
+3. Go to `example/ios` and Run `pod install`
+
+***Change to Regular mode***
+
+1. Go to the `ios` folder:
+2. Open `appsflyer_sdk.podspec` and remove `/strict`:
+
+`s.ios.dependency 'AppsFlyerFramework/Strict', '6.x.x'` To >> `s.ios.dependency 'AppsFlyerFramework', '6.x.x'`
+
+3. Go to `example/ios` and Run `pod install`
+
+---
+
+## <a id="guides"> **📖 Additional Guides (Deeplinking & more) **
 
 Great installation and setup guides can be viewed [here](https://github.com/AppsFlyerSDK/appsflyer-flutter-plugin/blob/master/doc/Guides.md)
 
+---
 ## <a id="api"> **📑 API**
 
 see the full [API](https://github.com/AppsFlyerSDK/appsflyer-flutter-plugin/blob/master/doc/API.md) available for this plugin.

doc/Guides.md

@@ -26,7 +26,7 @@ To start using AppsFlyer you first need to create an instance of `AppsflyerSdk`
 import 'package:appsflyer_sdk/appsflyer_sdk.dart';
 //..
 
-Map appsFlyerOptions = { "afDevKey": afDevKey,
+AppsFlyerOptions appsFlyerOptions = { "afDevKey": afDevKey,
                 "afAppId": appId,
                 "isDebug": true};
 
@@ -46,6 +46,7 @@ appsflyerSdk.initSdk(
     registerOnDeepLinkingCallback: true
 );
 ```
+
 ---
 
 ## <a id="out-of-store"> Android Out of store

ios/Classes/AppsflyerSdkPlugin.m

@@ -1,7 +1,12 @@
 #import "AppsflyerSdkPlugin.h"
 #import "AppsFlyerStreamHandler.h"
 #import <objc/message.h>
+
+
 typedef void (*bypassDidFinishLaunchingWithOption)(id, SEL, NSInteger);
+typedef void (*bypassDisableAdvertisingIdentifier)(id, SEL, BOOL);
+typedef void (*bypassWaitForATTUserAuthorization)(id, SEL, NSTimeInterval);
+
 
 @implementation AppsflyerSdkPlugin {
     FlutterEventChannel *_eventChannel;
@@ -466,18 +471,32 @@ - (void)initSdkWithCall:(FlutterMethodCall*)call result:(FlutterResult)result{
 
 
     [AppsFlyerLib shared].disableCollectASA = disableCollectASA;
-    [AppsFlyerLib shared].disableAdvertisingIdentifier = disableAdvertisingIdentifier;
+
+    SEL DisableAdvertisingSel = NSSelectorFromString(@"setDisableAdvertisingIdentifier:");
+    id AppsFlyer = [AppsFlyerLib shared];
+    if ([AppsFlyer respondsToSelector:DisableAdvertisingSel] && disableAdvertisingIdentifier) {
+        bypassDisableAdvertisingIdentifier msgSend = (bypassDisableAdvertisingIdentifier)objc_msgSend;
+        msgSend(AppsFlyer, DisableAdvertisingSel, disableAdvertisingIdentifier);
+    }
+
     [AppsFlyerLib shared].appleAppID = appId;
     [AppsFlyerLib shared].appsFlyerDevKey = devKey;
     [AppsFlyerLib shared].isDebug = isDebug;
-
+    
     // Load SKAD rules
     SEL SKSel = NSSelectorFromString(@"__willResolveSKRules:");
-    id AppsFlyer = [AppsFlyerLib shared];
+    
     if ([AppsFlyer respondsToSelector:SKSel]) {
         bypassDidFinishLaunchingWithOption msgSend = (bypassDidFinishLaunchingWithOption)objc_msgSend;
         msgSend(AppsFlyer, SKSel, 2);
     }
+    
+    SEL WaitForATTSel = NSSelectorFromString(@"waitForATTUserAuthorizationWithTimeoutInterval:");
+
+    if ([AppsFlyer respondsToSelector:WaitForATTSel] && timeToWaitForATTUserAuthorization != 0) {
+        bypassWaitForATTUserAuthorization msgSend = (bypassWaitForATTUserAuthorization)objc_msgSend;
+        msgSend(AppsFlyer, WaitForATTSel, timeToWaitForATTUserAuthorization);
+    }
 
     [[AppsFlyerLib shared] start];
 

lib/src/appsflyer_sdk.dart

@@ -71,6 +71,12 @@ class AppsflyerSdk {
     }
 
     if (Platform.isIOS) {
+      if (options.timeToWaitForATTUserAuthorization != null) {
+        dynamic timeToWaitForATTUserAuthorization = options.timeToWaitForATTUserAuthorization;
+        assert(timeToWaitForATTUserAuthorization is double);
+
+        validatedOptions[AppsflyerConstants.AF_TIME_TO_WAIT_FOR_ATT_USER_AUTHORIZATION] = timeToWaitForATTUserAuthorization;
+      }
       dynamic appID = options.appId;
       assert(appID != null, "appleAppId is required for iOS apps");
       assert(appID is String);
@@ -125,16 +131,11 @@ class AppsflyerSdk {
     }
 
     if (Platform.isIOS) {
-      if (options[
-              AppsflyerConstants.AF_TIME_TO_WAIT_FOR_ATT_USER_AUTHORIZATION] !=
-          null) {
-        dynamic timeToWaitForATTUserAuthorization = options[
-            AppsflyerConstants.AF_TIME_TO_WAIT_FOR_ATT_USER_AUTHORIZATION];
+      if (options[AppsflyerConstants.AF_TIME_TO_WAIT_FOR_ATT_USER_AUTHORIZATION] != null) {
+        dynamic timeToWaitForATTUserAuthorization = options[AppsflyerConstants.AF_TIME_TO_WAIT_FOR_ATT_USER_AUTHORIZATION];
         assert(timeToWaitForATTUserAuthorization is double);
 
-        afOptions[
-                AppsflyerConstants.AF_TIME_TO_WAIT_FOR_ATT_USER_AUTHORIZATION] =
-            timeToWaitForATTUserAuthorization;
+        afOptions[AppsflyerConstants.AF_TIME_TO_WAIT_FOR_ATT_USER_AUTHORIZATION] = timeToWaitForATTUserAuthorization;
       }
 
       dynamic appID = options[AppsflyerConstants.AF_APP_Id];

pubspec.yaml

@@ -1,6 +1,6 @@
 name: appsflyer_sdk
 description: A Flutter plugin for AppsFlyer SDK. Supports iOS and Android.
-version: 6.2.4+4-nullsafety
+version: 6.2.4-nullsafety.5
 
 homepage: https://github.com/AppsFlyerSDK/flutter_appsflyer_sdk