Adobe Experience Platform Assurance extension

1. Add the following libraries to your project using the app's Gradle file.

Kotlin

Copy
implementation(platform("com.adobe.marketing.mobile:sdk-bom:3.+"))
implementation("com.adobe.marketing.mobile:core")
implementation("com.adobe.marketing.mobile:assurance")
Copied to your clipboard
implementation(platform("com.adobe.marketing.mobile:sdk-bom:3.+"))
implementation("com.adobe.marketing.mobile:core")
implementation("com.adobe.marketing.mobile:assurance")

Groovy

Copy
implementation platform('com.adobe.marketing.mobile:sdk-bom:3.+')
implementation 'com.adobe.marketing.mobile:core'
implementation 'com.adobe.marketing.mobile:assurance'
Copied to your clipboard
implementation platform('com.adobe.marketing.mobile:sdk-bom:3.+')
implementation 'com.adobe.marketing.mobile:core'
implementation 'com.adobe.marketing.mobile:assurance'

2. Import the Assurance library along with the other Mobile SDK libraries:

Copy
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;
Copied to your clipboard
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;

2. Import the Assurance library along with the other Mobile SDK libraries:

Copy
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;
Copied to your clipboard
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;

Add the library to your project via your Cocoapods Podfile:

Copy
pod 'AEPCore','~> 5.0'
pod 'AEPAssurance','~> 5.0'
Copied to your clipboard
pod 'AEPCore','~> 5.0'
pod 'AEPAssurance','~> 5.0'

Import the Assurance extension along with the other Adobe Mobile SDK extensions:

Swift

Copy
import AEPCore
import AEPAssurance
Copied to your clipboard
import AEPCore
import AEPAssurance

Objective-C

Copy
@import AEPCore;
@import AEPAssurance;
Copied to your clipboard
@import AEPCore;
@import AEPAssurance;

2. Import the Assurance library along with the other Mobile SDK libraries:

Copy
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;
Copied to your clipboard
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;

Java

Copy
public class MainApp extends Application {
    private final String ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID";


    @Override
    public void onCreate() {
        super.onCreate();

        MobileCore.setApplication(this);
        MobileCore.setLogLevel(LoggingMode.VERBOSE);
        MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);

        List<Class<? extends Extension>> extensions = Arrays.asList(
                Assurance.EXTENSION,...);
        MobileCore.registerExtensions(extensions, o -> {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized");
        });
    }
}
Copied to your clipboard
public class MainApp extends Application {
    private final String ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID";


    @Override
    public void onCreate() {
        super.onCreate();

        MobileCore.setApplication(this);
        MobileCore.setLogLevel(LoggingMode.VERBOSE);
        MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);

        List<Class<? extends Extension>> extensions = Arrays.asList(
                Assurance.EXTENSION,...);
        MobileCore.registerExtensions(extensions, o -> {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized");
        });
    }
}

Kotlin

Copy
class MyApp : Application() {

    override fun onCreate() {
        super.onCreate()
        MobileCore.setApplication(this)
        MobileCore.setLogLevel(LoggingMode.VERBOSE)
        MobileCore.configureWithAppID("YOUR_APP_ENVIRONMENT_ID")

        val extensions = listOf(Assurance.EXTENSION, ...)
        MobileCore.registerExtensions(extensions) {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized")
        }
    }
}
Copied to your clipboard
class MyApp : Application() {

    override fun onCreate() {
        super.onCreate()
        MobileCore.setApplication(this)
        MobileCore.setLogLevel(LoggingMode.VERBOSE)
        MobileCore.configureWithAppID("YOUR_APP_ENVIRONMENT_ID")

        val extensions = listOf(Assurance.EXTENSION, ...)
        MobileCore.registerExtensions(extensions) {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized")
        }
    }
}

2. Import the Assurance library along with the other Mobile SDK libraries:

Copy
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;
Copied to your clipboard
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;

To start using the extension library, you must first register the extension with the Mobile Core extension.

Swift

Copy
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

        let extensions = [Assurance.self, ...]
        MobileCore.registerExtensions(extensions, {
            // set app id from the Data Collection UI    
                MobileCore.configureWith(appId: "yourAppId")  
        })

        return true
    }
Copied to your clipboard
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

        let extensions = [Assurance.self, ...]
        MobileCore.registerExtensions(extensions, {
            // set app id from the Data Collection UI    
                MobileCore.configureWith(appId: "yourAppId")  
        })

        return true
    }

Objective-C

Copy
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    NSArray *extensionsToRegister = @[AEPMobileAssurance.class, ...];
    [AEPMobileCore registerExtensions:extensionsToRegister completion:^{
        // set app id from the Data Collection UI
        [AEPMobileCore configureWithAppId: @"yourAppId"];
    }];

    return YES;
}
Copied to your clipboard
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    NSArray *extensionsToRegister = @[AEPMobileAssurance.class, ...];
    [AEPMobileCore registerExtensions:extensionsToRegister completion:^{
        // set app id from the Data Collection UI
        [AEPMobileCore configureWithAppId: @"yourAppId"];
    }];

    return YES;
}

2. Import the Assurance library along with the other Mobile SDK libraries:

Copy
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;
Copied to your clipboard
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;

Deep linking is the best way to connnect to an Assurance session when using the Android SDK. Assurance SDK on Android is already setup to handle incoming intents to your app. You can add an intent filter for incoming links in your app to complete the deep link configuration. The combination of android:host and android:scheme (in the form of <host>://<scheme>) for this intent filter will serve as the Base URL while creating a session in the Adobe Experience Platform Assurance UI

2. Import the Assurance library along with the other Mobile SDK libraries:

Copy
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;
Copied to your clipboard
import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;

The startSession API needs to be called to begin an Adobe Experience Platform Assurance session. You should call this API when the app launches with a URL (see code snippet below for sample usage). When called, SDK displays a PIN authentication overlay to begin a session.

Swift

Example

Copy
    func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
        Assurance.startSession(url: url)
        return true
    }
Copied to your clipboard
    func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
        Assurance.startSession(url: url)
        return true
    }

In iOS 13 and later, for a scene-based application, use the UISceneDelegate's scene(_:openURLContexts:) method as follows:

Copy
    func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
        // Called when the app in background is opened with a deep link.
        if let deepLinkURL = URLContexts.first?.url {
            Assurance.startSession(url: deepLinkURL)
        }
    }

    func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
        // Called when the app launches with the deep link
        if let deepLinkURL = connectionOptions.urlContexts.first?.url {
            Assurance.startSession(url: deepLinkURL)
        }
    }
Copied to your clipboard
    func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
        // Called when the app in background is opened with a deep link.
        if let deepLinkURL = URLContexts.first?.url {
            Assurance.startSession(url: deepLinkURL)
        }
    }

    func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
        // Called when the app launches with the deep link
        if let deepLinkURL = connectionOptions.urlContexts.first?.url {
            Assurance.startSession(url: deepLinkURL)
        }
    }

Objective-C

Syntax

Copy
static func startSession(url: URL?)
Copied to your clipboard
static func startSession(url: URL?)

Example

Copy
- (BOOL)application:(UIApplication *)app openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    [AEPMobileAssurance startSessionWithUrl:url];
    return true;
}
Copied to your clipboard
- (BOOL)application:(UIApplication *)app openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    [AEPMobileAssurance startSessionWithUrl:url];
    return true;
}

In iOS 13 and later, for a scene-based application, use the UISceneDelegate's scene(_:openURLContexts:) method as follows:

Copy
- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {    
    NSURL *deepLinkURL = connectionOptions.URLContexts.allObjects.firstObject.URL;
    [AEPMobileAssurance startSessionWithUrl:deepLinkURL];
}


- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    [AEPMobileAssurance startSessionWithUrl:URLContexts.allObjects.firstObject.URL];
}
Copied to your clipboard

- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {    
    NSURL *deepLinkURL = connectionOptions.URLContexts.allObjects.firstObject.URL;
    [AEPMobileAssurance startSessionWithUrl:deepLinkURL];
}


- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    [AEPMobileAssurance startSessionWithUrl:URLContexts.allObjects.firstObject.URL];
}