Assurance API reference

This document lists information about the previous versions of the Adobe Experience Platform Mobile SDKs. Check out this page for latest versions and solution support of the Mobile SDKs.

extensionVersion

Returns the current version of the AEP Assurance extension.

Android

Java

Syntax

public static String extensionVersion()
Copied to your clipboard
public static String extensionVersion()

Example

Assurance.extensionVersion()
Copied to your clipboard
Assurance.extensionVersion()

iOS

Swift

Example

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

Objective-C

Syntax

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

Example

[AEPAssurance extensionVersion];
Copied to your clipboard
[AEPAssurance extensionVersion];

React Native

JavaScript

Example

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

Flutter

Dart

Syntax

static Future<String> get extensionVersion async
Copied to your clipboard
static Future<String> get extensionVersion async

Example

assuranceVersion = await FlutterAssurance.extensionVersion;
Copied to your clipboard
assuranceVersion = await FlutterAssurance.extensionVersion;

Cordova

Syntax

AEPAssurance.extensionVersion = function(success, fail);
Copied to your clipboard
AEPAssurance.extensionVersion = function(success, fail);

Example

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

Unity

C#

Syntax

public static string ExtensionVersion()
Copied to your clipboard
public static string ExtensionVersion()

Example

string version = AEPAssurance.ExtensionVersion();
print(LOG_TAG + "Assurance version: "+version);
Copied to your clipboard
string version = AEPAssurance.ExtensionVersion();
print(LOG_TAG + "Assurance version: "+version);

Xamarin

C#

Example

string version = AEPAssurance.ExtensionVersion()  
Console.WriteLine("AEPAssurance version installed is: " + version);
Copied to your clipboard
string version = AEPAssurance.ExtensionVersion()  
Console.WriteLine("AEPAssurance version installed is: " + version);

Java

Syntax

public static String extensionVersion()
Copied to your clipboard
public static String extensionVersion()

Example

Assurance.extensionVersion()
Copied to your clipboard
Assurance.extensionVersion()

Swift

Example

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

Objective-C

Syntax

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

Example

[AEPAssurance extensionVersion];
Copied to your clipboard
[AEPAssurance extensionVersion];

JavaScript

Example

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

Dart

Syntax

static Future<String> get extensionVersion async
Copied to your clipboard
static Future<String> get extensionVersion async

Example

assuranceVersion = await FlutterAssurance.extensionVersion;
Copied to your clipboard
assuranceVersion = await FlutterAssurance.extensionVersion;

Syntax

AEPAssurance.extensionVersion = function(success, fail);
Copied to your clipboard
AEPAssurance.extensionVersion = function(success, fail);

Example

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#

Syntax

public static string ExtensionVersion()
Copied to your clipboard
public static string ExtensionVersion()

Example

string version = AEPAssurance.ExtensionVersion();
print(LOG_TAG + "Assurance version: "+version);
Copied to your clipboard
string version = AEPAssurance.ExtensionVersion();
print(LOG_TAG + "Assurance version: "+version);

C#

Example

string version = AEPAssurance.ExtensionVersion()  
Console.WriteLine("AEPAssurance version installed is: " + version);
Copied to your clipboard
string version = AEPAssurance.ExtensionVersion()  
Console.WriteLine("AEPAssurance version installed is: " + version);

startSession

The startSession API needs to be called to begin a AEP Assurance session. When called, the Mobile SDK displays a PIN authentication overlay to begin a session.

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

Android

This API is optional for Android.

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

Java

Syntax

public static void startSession(final String url)
Copied to your clipboard
public static void startSession(final String url)

Example

 Assurance.startSession(url);
Copied to your clipboard
 Assurance.startSession(url);

iOS

Swift

Example

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

For SceneDelegate based applications

    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

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

Example

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

React Native

JavaScript

Example

AEPAssurance.startSession("your-assurance-session-url");
Copied to your clipboard
AEPAssurance.startSession("your-assurance-session-url");

Flutter

Dart

Syntax

static Future<void> startSession(String url);
Copied to your clipboard
static Future<void> startSession(String url);

Example

FlutterAssurance.startSession(url);
Copied to your clipboard
FlutterAssurance.startSession(url);

Cordova

Syntax

AEPAssurance.startSession = function(sessionurl,success, fail);
Copied to your clipboard
AEPAssurance.startSession = function(sessionurl,success, fail);

Example

AEPAssurance.startSession(url,function(result) {  
   console.log("AdobeExperenceSDK: AEPAssurance session started succesfully: " + result);
}, function(error) {  
   console.log("AdobeExperenceSDK: Failed to start AEPAssurance session: " + error);
});
Copied to your clipboard
AEPAssurance.startSession(url,function(result) {  
   console.log("AdobeExperenceSDK: AEPAssurance session started succesfully: " + result);
}, function(error) {  
   console.log("AdobeExperenceSDK: Failed to start AEPAssurance session: " + error);
});

Unity

C#

Syntax

public static void StartSession(string url)
Copied to your clipboard
public static void StartSession(string url)

Example

AEPAssurance.StartSession(url);
Copied to your clipboard
AEPAssurance.StartSession(url);

Xamarin

C#

AEPAssurance.StartSession(url);
Copied to your clipboard
AEPAssurance.StartSession(url);

This API is optional for Android.

Java

Syntax

public static void startSession(final String url)
Copied to your clipboard
public static void startSession(final String url)

Example

 Assurance.startSession(url);
Copied to your clipboard
 Assurance.startSession(url);

Swift

Example

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

For SceneDelegate based applications

    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

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

Example

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

JavaScript

Example

AEPAssurance.startSession("your-assurance-session-url");
Copied to your clipboard
AEPAssurance.startSession("your-assurance-session-url");

Dart

Syntax

static Future<void> startSession(String url);
Copied to your clipboard
static Future<void> startSession(String url);

Example

FlutterAssurance.startSession(url);
Copied to your clipboard
FlutterAssurance.startSession(url);

Syntax

AEPAssurance.startSession = function(sessionurl,success, fail);
Copied to your clipboard
AEPAssurance.startSession = function(sessionurl,success, fail);

Example

AEPAssurance.startSession(url,function(result) {  
   console.log("AdobeExperenceSDK: AEPAssurance session started succesfully: " + result);
}, function(error) {  
   console.log("AdobeExperenceSDK: Failed to start AEPAssurance session: " + error);
});
Copied to your clipboard
AEPAssurance.startSession(url,function(result) {  
   console.log("AdobeExperenceSDK: AEPAssurance session started succesfully: " + result);
}, function(error) {  
   console.log("AdobeExperenceSDK: Failed to start AEPAssurance session: " + error);
});

C#

Syntax

public static void StartSession(string url)
Copied to your clipboard
public static void StartSession(string url)

Example

AEPAssurance.StartSession(url);
Copied to your clipboard
AEPAssurance.StartSession(url);

C#

AEPAssurance.StartSession(url);
Copied to your clipboard
AEPAssurance.StartSession(url);

Migration

Release notes

Was this helpful?

Yes

Assurance API reference

extensionVersion.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Java.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Swift

Objective-C

JavaScript

Dart

C#

C#

Java

Swift

Objective-C

JavaScript

Dart

C#

C#

startSession

Java

Swift

Objective-C

JavaScript

Dart

C#

C#

Java

Swift

Objective-C

JavaScript

Dart

C#

C#

extensionVersion

Java