Assurance API reference

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

Release Notes

Resolving Common Issues

Last modified 5d ago

Export as PDF

Copy link

Edit on GitHub

On this page

extensionVersion

startSession