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.
Syntax
Copied to your clipboardAEPAssurance.extensionVersion = function(success, fail);
Example
Copied to your clipboardAEPAssurance.extensionVersion(function(version) {console.log("AEPAssurance version: " + version);}, function(error) {console.log(error);});
Java
Syntax
Copied to your clipboardpublic static String extensionVersion()
Example
Copied to your clipboardAssurance.extensionVersion()
Swift
Example
Copied to your clipboardAEPAssurance.extensionVersion()
Objective-C
Syntax
Copied to your clipboard+ (nonnull NSString*) extensionVersion;
Example
Copied to your clipboard[AEPAssurance extensionVersion];
JavaScript
Example
Copied to your clipboardAEPAssurance.extensionVersion().then(version => console.log("AdobeExperienceSDK: AEP Assurance version: " + version));
Dart
Syntax
Copied to your clipboardstatic Future<String> get extensionVersion async
Example
Copied to your clipboardassuranceVersion = await FlutterAssurance.extensionVersion;
Syntax
Copied to your clipboardAEPAssurance.extensionVersion = function(success, fail);
Example
Copied to your clipboardAEPAssurance.extensionVersion(function(version) {console.log("AEPAssurance version: " + version);}, function(error) {console.log(error);});
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)
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
Copied to your clipboardpublic static void startSession(final String url)
Example
Copied to your clipboardAssurance.startSession(url);
Swift
Example
Copied to your clipboardfunc application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {do {AEPAssurance.startSession(url)return false}}
For SceneDelegate based applications
Copied to your clipboardfunc scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {AEPAssurance.startSession(URLContexts.first!.url)}
Objective-C
Syntax
Copied to your clipboard+ (void) startSession: (NSURL* _Nonnull) url;
Example
Copied to your clipboard- (BOOL)application:(UIApplication *)app openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {[AEPAssurance startSession:url];return false;}
Syntax
Copied to your clipboardAEPAssurance.startSession = function(sessionurl,success, fail);
Example
Copied to your clipboardAEPAssurance.startSession(url,function(result) {console.log("AdobeExperenceSDK: AEPAssurance session started succesfully: " + result);}, function(error) {console.log("AdobeExperenceSDK: Failed to start AEPAssurance session: " + error);});
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
Copied to your clipboardpublic static void startSession(final String url)
Example
Copied to your clipboardAssurance.startSession(url);
Swift
Example
Copied to your clipboardfunc application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {do {AEPAssurance.startSession(url)return false}}
For SceneDelegate based applications
Copied to your clipboardfunc scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {AEPAssurance.startSession(URLContexts.first!.url)}
Objective-C
Syntax
Copied to your clipboard+ (void) startSession: (NSURL* _Nonnull) url;
Example
Copied to your clipboard- (BOOL)application:(UIApplication *)app openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {[AEPAssurance startSession:url];return false;}
Dart
Syntax
Copied to your clipboardstatic Future<void> startSession(String url);
Example
Copied to your clipboardFlutterAssurance.startSession(url);
Syntax
Copied to your clipboardAEPAssurance.startSession = function(sessionurl,success, fail);
Example
Copied to your clipboardAEPAssurance.startSession(url,function(result) {console.log("AdobeExperenceSDK: AEPAssurance session started succesfully: " + result);}, function(error) {console.log("AdobeExperenceSDK: Failed to start AEPAssurance session: " + error);});