Skip to content

Latest commit

 

History

History
 
 

adobe-experience-platform-assurance

README.md

Adobe Experience Platform (AEP) Assurance Extension

This extension enables capabilities for Adobe Experience Platform Assurance.

To get started with Assurance in your app, you'll need to:

  1. Install the AEP Assurance extension in Data Collection UI
  2. Add AEP Assurance SDK extension library to your app
    1. Import AEP Assurance into your app
    2. Register and implement extension APIs

Install the AEP Assurance extension in the Data Collection UI

Go to the Experience Platform Data Collection UI and select your mobile property:

  1. In the Data Collection UI, click the Extensions tab.
  2. On the Catalog tab, locate the AEP Assurance extension, and click Install.
  3. Follow the publishing process to update the Mobile SDK configuration.

Add the AEP Assurance extension to your app

Import the library to your app code

{% tabs %} {% tab title="Android" %}

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

    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:

    import com.adobe.marketing.mobile.Assurance;
import com.adobe.marketing.mobile.MobileCore;

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Add the library to your project via your Cocoapods Podfile

pod 'AEPCore','~> 3.0'
pod 'AEPAssurance','~> 3.0'

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

Swift

import AEPCore
import AEPAssurance

Objective-C

@import AEPCore;
@import AEPAssurance;

{% endtab %}

{% tab title="iOS (AEP 1.x)" %} Add the library to your project via your Cocoapods Podfile:

pod 'ACPCore'
pod 'AEPAssurance','~> 1.0'

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

Swift

import ACPCore
import AEPAssurance

Objective-C

#import "ACPCore.h"
#import "AEPAssurance.h"

{% endtab %}

{% tab title="React Native" %}

  1. Install the AEP Assurance package.

    npm install @adobe/react-native-aepassurance

    1.1 Link

    • React Native 0.60+

CLI autolink feature links the module while building the app.

  • React Native <= 0.59
   react-native link @adobe/react-native-aepassurance

Note For iOS using cocoapods, run:

   cd ios/ && pod install

  1. Import the extension.

     import {AEPAssurance} from '@adobe/react-native-aepassurance';

  2. Get the extension version.

     AEPAssurance.extensionVersion().then(version => console.log("AdobeExperienceSDK: AEPAssurance version: " + version));

{% endtab %}

{% tab title="Flutter" %}

JavaScript

  1. Install the AEP Assurance package.

    Installation instructions can be found in the Flutter documentation.

  2. Import the extension.

    import 'package:flutter_assurance/flutter_assurance.dart';

  3. Get the extension version.

    String version = await FlutterAEPAssurance.extensionVersion;

{% endtab %}

{% tab title="Cordova" %}

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:

    cordova plugin add https://github.com/adobe/cordova-aepassurance.git

  2. Get the extension version.

    AEPAssurance.extensionVersion(function(version) {  
   console.log("AEPAssurance version: " + version);
}, function(error) {  
   console.log(error);  
});

{% endtab %}

{% tab title="Unity" %}

C#

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

    using com.adobe.marketing.mobile;

  2. Get the extension version.

    AEPAssurance.extensionVersion();

{% endtab %}

{% tab title="Xamarin" %}

C#

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

    using Com.Adobe.Marketing.Mobile;

  2. Get the extension version.

    AEPAssurance.ExtensionVersion();

{% endtab %} {% endtabs %}

Register AEPAssurance with Mobile Core

{% tabs %} {% tab title="Android" %} To start using the extension library, you must first register the extension with the Mobile Core extension.

Java

  1. Register the extension when you register other extensions. {% hint style="info" %} "yourAppId", mentioned below, is found in Launch "Mobile Install Instructions". When inside of "Publishing Flow", select on the small gray box next to "Environment" dropdown. {% endhint %}

  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
      }
   }
  }

{% endtab %}

{% tab title="iOS (AEP 3.x)" %}

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

Swift

    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

- (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;
}

{% endtab %}

{% tab title="iOS (AEP 1.x)" %}

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

Swift

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

- (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;
 }

{% endtab %}

{% tab title="React Native" %}

JavaScript

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

{% tab title="Flutter" %}

Dart

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

{% tab title="Cordova" %}

JavaScript

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

{% tab title="Unity" %}

C#

Register the extension in the start() function:

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);
    }
}

{% endtab %}

{% tab title="Xamarin" %} iOS

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

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:

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");
  }
}

{% endtab %} {% endtabs %}

Implement AEP Assurance session start APIs (iOS only)

(session start APIs for other platforms listed here )

The startSession API needs to be called to begin an Adobe Experience Platform Assurance session. When called, SDK displays a PIN authentication overlay to begin a session.

{% hint style="info" %}

You may call this API when the app launches with a url (see code snippet below for sample usage)

The AEP Assurance Android extension does not require this API to be called since it registers the app lifecycle handlers which automatically pick up any deep links and use them to start the session.

When using the AEP Assurance iOS extension, you should call this API when the app launches with a url (see code snippet below for sample usage).

{% endhint %}

{% tabs %}

{% tab title="iOS (AEP 3.x)" %}

Swift

Example

    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:

    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

static func startSession(url: URL?)

Example

- (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:

- (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];
}

{% endtab %}

{% tab title="iOS (AEP 1.x)" %}

Swift

Example

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:

func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    AEPAssurance.startSession((URLContexts.first!).url)
}

Objective-C

Syntax

+ (void) startSession: (NSURL* _Nonnull) url;

Example

- (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:

- (void) scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    UIOpenURLContext * urlContext = URLContexts.anyObject;
    if (urlContext != nil) {
        [AEPAssurance startSession:urlContext.URL];
    }
}

{% endtab %} {% endtabs %}