1. Add the following libraries in your project's build.gradle file:

Copy
implementation 'com.adobe.marketing.mobile:core:1+'
implementation 'com.adobe.marketing.mobile:assurance:1+'
Copied to your clipboard
implementation 'com.adobe.marketing.mobile:core:1+'
implementation 'com.adobe.marketing.mobile:assurance:1+'

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 'ACPCore'
pod 'AEPAssurance','~> 1.0'
Copied to your clipboard
pod 'ACPCore'
pod 'AEPAssurance','~> 1.0'

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

Swift

Copy
import ACPCore
import AEPAssurance
Copied to your clipboard
import ACPCore
import AEPAssurance

Objective-C

Copy
#import "ACPCore.h"
#import "AEPAssurance.h"
Copied to your clipboard
#import "ACPCore.h"
#import "AEPAssurance.h"

1. Install the AEP Assurance package.

Copy
npm install @adobe/react-native-aepassurance@2.0.1
Copied to your clipboard
npm install @adobe/react-native-aepassurance@2.0.1

2. Link the module.

React Native 0.60+

CLI autolink feature links the module while building the app.

React Native <= 0.59

Copy
react-native link @adobe/react-native-aepassurance
Copied to your clipboard
react-native link @adobe/react-native-aepassurance

Note For iOS using cocoapods, run:

Copy
cd ios/ && pod install
Copied to your clipboard
cd ios/ && pod install

3. Import the extension.

Copy
import {AEPAssurance} from '@adobe/react-native-aepassurance';
Copied to your clipboard
import {AEPAssurance} from '@adobe/react-native-aepassurance';

4. Get the extension version.

Copy
AEPAssurance.extensionVersion().then(version => console.log("AdobeExperienceSDK: AEPAssurance version: " + version));
Copied to your clipboard
AEPAssurance.extensionVersion().then(version => console.log("AdobeExperienceSDK: AEPAssurance version: " + version));

JavaScript

1. Install the AEP Assurance package.

Installation instructions can be found in the Flutter documentation.

2. Import the extension.

Copy
import 'package:flutter_assurance/flutter_assurance.dart';
Copied to your clipboard
import 'package:flutter_assurance/flutter_assurance.dart';

3. Get the extension version.

Copy
String version = await FlutterAEPAssurance.extensionVersion;
Copied to your clipboard
String version = await FlutterAEPAssurance.extensionVersion;

JavaScript

1. After creating your Cordova app and adding the Android and iOS platforms, the AEPAssurance extension for Cordova can be added with this command:

Copy
cordova plugin add https://github.com/adobe/cordova-aepassurance.git
Copied to your clipboard
cordova plugin add https://github.com/adobe/cordova-aepassurance.git

2. Get the extension version.

Copy
AEPAssurance.extensionVersion(function(version) {  
    console.log("AEPAssurance version: " + version);
}, function(error) {  
    console.log(error);  
});
Copied to your clipboard
AEPAssurance.extensionVersion(function(version) {  
    console.log("AEPAssurance version: " + version);
}, function(error) {  
    console.log(error);  
});

C#

1. After importing the AEPAssurance.unitypackage, the AEP Assurance extension for Unity can be added with the following code in the MainScript:

Copy
using com.adobe.marketing.mobile;
Copied to your clipboard
using com.adobe.marketing.mobile;

2. Get the extension version.

Copy
AEPAssurance.extensionVersion();
Copied to your clipboard
AEPAssurance.extensionVersion();

C#

1. After adding the iOS or Android AEP Assurance NuGet package, the Assurance extension can be added by this import statement:

Copy
using Com.Adobe.Marketing.Mobile;
Copied to your clipboard
using Com.Adobe.Marketing.Mobile;

2. Get the extension version.

Copy
AEPAssurance.ExtensionVersion();
Copied to your clipboard
AEPAssurance.ExtensionVersion();

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

Java

Register the extension when you register other extensions.

To find your app ID, which is mentioned below, please read the Mobile Install Instructions. Within the "Publishing Flow", select the small gray box next to the "Environment" dropdown.

Copy
 public class MobileApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        MobileCore.setApplication(this);

        try {
        // register other necessary extensions
        Assurance.registerExtension();            
        MobileCore.start(new AdobeCallback() {
            @Override
            public void call(final Object o) {
                MobileCore.configureWithAppID("yourAppId");
            }});
        } catch (Exception e) {
        // Log the exception
        }
    }
}
Copied to your clipboard
 public class MobileApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        MobileCore.setApplication(this);

        try {
        // register other necessary extensions
        Assurance.registerExtension();            
        MobileCore.start(new AdobeCallback() {
            @Override
            public void call(final Object o) {
                MobileCore.configureWithAppID("yourAppId");
            }});
        } catch (Exception e) {
        // Log the exception
        }
    }
}

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 {
       // set app id from the Data Collection UI
     ACPCore.configure(withAppId: "yourAppId")
     AEPAssurance.registerExtension()
     ACPCore.start(nil)
     return true;
}
Copied to your clipboard
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
       // set app id from the Data Collection UI
     ACPCore.configure(withAppId: "yourAppId")
     AEPAssurance.registerExtension()
     ACPCore.start(nil)
     return true;
}

Objective-C

Copy
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [ACPCore configureWithAppId:@"yourAppId"]; // set app id from the Data Collection UI
    [AEPAssurance registerExtension];
    [ACPCore start:nil];
    return YES;
 }
Copied to your clipboard
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [ACPCore configureWithAppId:@"yourAppId"]; // set app id from the Data Collection UI
    [AEPAssurance registerExtension];
    [ACPCore start:nil];
    return YES;
 }

JavaScript

When using React Native, register AEP Assurance with Mobile Core in native code as shown on the Android and iOS tabs.

Dart

When using Flutter, register AEP Assurance with Mobile Core in native code as shown on the Android and iOS tabs.

JavaScript

When using Cordova, register AEP Assurance with Mobile Core in native code as shown on the Android and iOS tabs.

C#

Register the extension in the start() function:

Copy
using com.adobe.marketing.mobile;
using using AOT;

public class MainScript : MonoBehaviour
{
    [MonoPInvokeCallback(typeof(AdobeStartCallback))]
    public static void HandleStartAdobeCallback()
    {   
        // set app id from the Data Collection UI
        ACPCore.ConfigureWithAppID("yourAppId");
    }

    // Start is called before the first frame update
    void Start()
    {   
        AEPAssurance.registerExtension();
        ACPCore.Start(HandleStartAdobeCallback);
    }
}
Copied to your clipboard
using com.adobe.marketing.mobile;
using using AOT;

public class MainScript : MonoBehaviour
{
    [MonoPInvokeCallback(typeof(AdobeStartCallback))]
    public static void HandleStartAdobeCallback()
    {   
        // set app id from the Data Collection UI
        ACPCore.ConfigureWithAppID("yourAppId");
    }

    // Start is called before the first frame update
    void Start()
    {   
        AEPAssurance.registerExtension();
        ACPCore.Start(HandleStartAdobeCallback);
    }
}

iOS

Register the AEPAssurance extension in your app's FinishedLaunching() function:

Copy
public override bool FinishedLaunching(UIApplication app, NSDictionary options)
{
  global::Xamarin.Forms.Forms.Init();
  LoadApplication(new App());
  AEPAssurance.RegisterExtension();
  // start Mobile Core
  ACPCore.Start(startCallback);
  return base.FinishedLaunching(app, options);
}

private void startCallback()
{
  // set app id from the Data Collection UI
  ACPCore.ConfigureWithAppID("yourAppId");
}
Copied to your clipboard
public override bool FinishedLaunching(UIApplication app, NSDictionary options)
{
  global::Xamarin.Forms.Forms.Init();
  LoadApplication(new App());
  AEPAssurance.RegisterExtension();
  // start Mobile Core
  ACPCore.Start(startCallback);
  return base.FinishedLaunching(app, options);
}

private void startCallback()
{
  // set app id from the Data Collection UI
  ACPCore.ConfigureWithAppID("yourAppId");
}

Android

Register the AEPAssurance extension in your app's OnCreate() function:

Copy
protected override void OnCreate(Bundle savedInstanceState)
{
  base.OnCreate(savedInstanceState);
  global::Xamarin.Forms.Forms.Init(this, savedInstanceState);
  LoadApplication(new App());
  AEPAssurance.RegisterExtension();

  // start Mobile Core
  ACPCore.Start(new CoreStartCompletionCallback());
}

class CoreStartCompletionCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object callback)
  {
    // set app id from the Data Collection UI
    ACPCore.ConfigureWithAppID("yourAppId");
  }
}
Copied to your clipboard
protected override void OnCreate(Bundle savedInstanceState)
{
  base.OnCreate(savedInstanceState);
  global::Xamarin.Forms.Forms.Init(this, savedInstanceState);
  LoadApplication(new App());
  AEPAssurance.RegisterExtension();

  // start Mobile Core
  ACPCore.Start(new CoreStartCompletionCallback());
}

class CoreStartCompletionCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object callback)
  {
    // set app id from the Data Collection UI
    ACPCore.ConfigureWithAppID("yourAppId");
  }
}

Swift

Example

Copy
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    AEPAssurance.startSession(url)
    return true
}
Copied to your clipboard
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    AEPAssurance.startSession(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>) {
    AEPAssurance.startSession((URLContexts.first!).url)
}
Copied to your clipboard
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    AEPAssurance.startSession((URLContexts.first!).url)
}

Objective-C

Syntax

Copy
+ (void) startSession: (NSURL* _Nonnull) url;
Copied to your clipboard
+ (void) startSession: (NSURL* _Nonnull) url;

Example

Copy
- (BOOL)application:(UIApplication *)app openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    [AEPAssurance startSession:url];
    return true;
}
Copied to your clipboard
- (BOOL)application:(UIApplication *)app openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    [AEPAssurance startSession: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 openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    UIOpenURLContext * urlContext = URLContexts.anyObject;
    if (urlContext != nil) {
        [AEPAssurance startSession:urlContext.URL];
    }
}
Copied to your clipboard
- (void) scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    UIOpenURLContext * urlContext = URLContexts.anyObject;
    if (urlContext != nil) {
        [AEPAssurance startSession:urlContext.URL];
    }
}