Assurance API reference

extensionVersion

Returns the current version of the AEP Assurance extension.

Android

Java

Syntax

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

Example

final String extensionVersion = Assurance.extensionVersion();
Copied to your clipboard
final String extensionVersion = Assurance.extensionVersion();

Kotlin

Example

val extensionVersion: String = Assurance.extensionVersion()
Copied to your clipboard
val extensionVersion: String = 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];

Java

Syntax

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

Example

final String extensionVersion = Assurance.extensionVersion();
Copied to your clipboard
final String extensionVersion = Assurance.extensionVersion();

Kotlin

Example

val extensionVersion: String = Assurance.extensionVersion()
Copied to your clipboard
val extensionVersion: String = 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];

registerExtension

This API has been deprecated starting in v2.0.0 and removed in v3.0.0 of the Android mobile extension.

Use MobileCore.registerExtensions() API instead.

Registers the Assurance extension with the Mobile Core.

Android

Java

Syntax

public static void registerExtension()
Copied to your clipboard
public static void registerExtension()

Example

Assurance.registerExtension();
Copied to your clipboard
Assurance.registerExtension();

Java

Syntax

public static void registerExtension()
Copied to your clipboard
public static void registerExtension()

Example

Assurance.registerExtension();
Copied to your clipboard
Assurance.registerExtension();

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. Deep linking is the best way to connect 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.

Java

Syntax

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

Example

final String url = "<assurance_session_url>";
Assurance.startSession(url);
Copied to your clipboard
final String url = "<assurance_session_url>";
Assurance.startSession(url);

Kotlin

Example

val url: String = "<assurance_session_url>"
Assurance.startSession(url)
Copied to your clipboard
val url: String = "<assurance_session_url>"
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;
}

Java

Syntax

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

Example

final String url = "<assurance_session_url>";
Assurance.startSession(url);
Copied to your clipboard
final String url = "<assurance_session_url>";
Assurance.startSession(url);

Kotlin

Example

val url: String = "<assurance_session_url>"
Assurance.startSession(url)
Copied to your clipboard
val url: String = "<assurance_session_url>"
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;
}

Overview

Resolving common issues

Last updated 4/4/2024

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

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

registerExtension

Java

Java

startSession

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

extensionVersion

Java