Assurance API reference

extensionVersion
Returns the current version of the AEP Assurance extension
Android
iOS
React Native
Flutter
Cordova
Unity
Xamarin
Android
Java
Syntax
public static String extensionVersion()
Example
Assurance.extensionVersion()
iOS
Objective-C
Syntax
+ (nonnull NSString*) extensionVersion;
Example
[AEPAssurance extensionVersion];
Swift
Example
AEPAssurance.extensionVersion()
React Native
JavaScript
Example
AEPAssurance.extensionVersion().then(version => console.log("AdobeExperienceSDK: AEP Assurance version: " + version));
Flutter
Dart
Syntax
static Future<String> get extensionVersion async
Example
assuranceVersion = await FlutterAssurance.extensionVersion;
Cordova
Syntax
AEPAssurance.extensionVersion = function(success, fail);
Example
AEPAssurance.extensionVersion(function(version) {  
   console.log("AEPAssurance version: " + version);
}, function(error) {  
   console.log(error);  
});
Unity
Syntax
public static string ExtensionVersion()
Example in C#
string version = AEPAssurance.ExtensionVersion();
print(LOG_TAG + "Assurance version: "+version);
Xamarin
Example in C#
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, 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
iOS
React Native
Flutter
Cordova
Unity
Xamarin
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)
Example
 Assurance.startSession(url);
iOS
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 false;
}
Swift
Example
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)
    }
React Native
JavaScript
Example
AEPAssurance.startSession("your-griffon-session-url");
Flutter
Dart
Syntax
static Future<void> startSession(String url);
Example
FlutterAssurance.startSession(url);
Cordova
Syntax
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);
});
Unity
Syntax
public static void StartSession(string url)
Example in C#
AEPAssurance.StartSession(url);
Xamarin
Example in C#
AEPAssurance.StartSession(url);
Release Notes
Resolving Common Issues
Last updated 5 months ago