@adobe/react-native-aepassurance
v6.0.2
Published
Adobe Experience Platform support for React Native apps.
Downloads
40,422
Readme
React Native Adobe Experience Platform Assurance Extension
@adobe/react-native-aepassurance
is a wrapper around the iOS and Android Adobe Experience Platform Assurance to allow for integration with React Native applications. Functionality to start Assurance session is provided through JavaScript documented below.
Prerequisites
The Adobe Experience Platform Assurance extension has the following peer dependency, which must be installed prior to installing the identity extension:
Installation
See Requirements and Installation instructions on the main page
Install the @adobe/react-native-aepassurance
package:
cd MyReactApp
npm install @adobe/react-native-aepassurance
Usage
Assurance
Initializing:
Initializing the SDK should be done in native code, documentation on how to initialize the SDK can be found here.
Example:
iOS
@import AEPAssurance;
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[AEPMobileCore configureWithAppId:@"your-app-ID"];
const UIApplicationState appState = application.applicationState;
[AEPMobileCore registerExtensions: @[AEPMobileLifecycle.class, AEPMobileAssurance.class] completion:^{
if (appState != UIApplicationStateBackground) {
[AEPMobileCore lifecycleStart:nil];
}
}];
return YES;
}
To connect to an Assurance session by scanning the QR code, follow Apple developer documentation to set custom URL scheme for your application. Finally, implement the openURL
delegate method and pass the deeplink URL to startSessionWithURL API.
-(BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
[AEPMobileAssurance startSessionWithUrl:url];
return true;
}
Android
import com.adobe.marketing.mobile.Assurance;
public class MainApplication extends Application implements ReactApplication {
@Override
public void onCreate() {
super.onCreate();
MobileCore.setApplication(this);
MobileCore.configureWithAppID("your-app-ID");
List<Class<? extends Extension>> extensions = Arrays.asList(
Lifecycle.EXTENSION,
Assurance.EXTENSION);
MobileCore.registerExtensions(extensions, o -> {
Log.d(LOG_TAG, "Adobe Experience Platform Mobile SDK is initialized");
MobileCore.lifecycleStart(null);
//enable this for Lifecycle. See Note for collecting Lifecycle metrics.
});
}
}
To connect to an Assurance session by scanning the QR code, follow the Android documentation for more information about how to setup a deeplink.
Start Assurance session:
import { Assurance } from "@adobe/react-native-aepassurance";
Assurance.startSession("{your-assurance-session-url}");