flutter_aepedgebridge

Description:

flutter aepedgebridge

flutter_aepedgebridge #

flutter_aepedgebridge is a flutter plugin for the iOS and Android Adobe Experience Platform Edge Bridge to allow for integration with flutter applications.
The Edge Bridge mobile extension provides seamless routing of data to the Adobe Experience Platform Edge Network for existing SDK implementations. For applications which already make use of the MobileCore.trackAction and/or MobileCore.trackState APIs to send data to Adobe Analytics, this extension will automatically route those API calls to the Edge Network, making the data available for mapping to a user's XDM schema using the Data Prep for Data Collection.

Important
Edge Bridge serves primarily as a migration aid for applications that are already using Adobe Analytics within their implementation.
For new applications being developed with the Adobe Experience Platform Mobile SDKs, it is strongly recommended to use the Edge.sendEvent API of the Edge Network extension.

Prerequisites #
The Edge Bridge extension has the following peer dependencies, which must be installed prior to installing the Edge Bridge extension:

flutter_aepcore
flutter_aepedge
flutter_aepedgeidentity

Installation #
Install instructions for this package can be found here.

Note: After you have installed the SDK, don't forget to run pod install in your ios directory to link the libraries to your Xcode project.

Tests #
Run:
flutter test
copied to clipboard
Usage #
Installing and registering the extension with the AEP Mobile Core #
Install the Adobe Experience Platform Edge Network extension in your mobile property and configure the default Datastream ID by following the steps in the Edge Network extension documentation.

Note
Experience Platform Edge Bridge does not have a corresponding extension card in the Data Collection UI; no changes to a Data Collection mobile property are required to use Edge Bridge.

Registering the extension with AEPCore: #

Note
It is required to initialize the SDK via native code inside your AppDelegate (iOS) and MainApplication class (Android).

As part of the initialization code, make sure that you set the SDK wrapper type to Flutter before you start the SDK.
Refer to the Initialization section of the root README for more information about initializing the SDK.
Initialization Example
iOS
// AppDelegate.h
@import AEPCore;
@import AEPEdge;
@import AEPEdgeIdentity;
@import AEPEdgeBridge;
...
@implementation AppDelegate

// AppDelegate.m
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[AEPMobileCore setWrapperType:AEPWrapperTypeFlutter];

// TODO: Set up the preferred Environment File ID from your mobile property configured in Data Collection UI
NSString* ENVIRONMENT_FILE_ID = @"YOUR-APP-ID";

NSArray *extensionsToRegister = @[AEPMobileEdgeIdentity.class,
AEPMobileEdge.class,
AEPMobileEdgeBridge.class
];

[AEPMobileCore registerExtensions:extensionsToRegister completion:^{
[AEPMobileCore configureWithAppId: ENVIRONMENT_FILE_ID];
}];
return YES;
}
copied to clipboard
Android
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Edge;
import com.adobe.marketing.mobile.edge.identity.Identity;
import com.adobe.marketing.mobile.edge.bridge.EdgeBridge

...
import io.flutter.app.FlutterApplication;
...
public class MainApplication extends FlutterApplication {
...
// TODO: Set up the preferred Environment File ID from your mobile property configured in Data Collection UI
private final String ENVIRONMENT_FILE_ID = "YOUR-APP-ID";

@Override
public void on Create(){
super.onCreate();
...
MobileCore.setApplication(this);
MobileCore.setWrapperType(WrapperType.FLUTTER);
MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);

MobileCore.registerExtensions(
Arrays.asList(Identity.EXTENSION, Edge.EXTENSION, EdgeBridge.EXTENSION),
o -> Log.d("MainApp", "Adobe Experience Platform Mobile SDK was initialized")
);
}
}
copied to clipboard
Importing the SDK: #
import 'package:flutter_aepedgebridge/flutter_aepedgebridge.dart';
copied to clipboard
Edge Bridge tutorials #
For tutorials on implementing Edge Bridge and Data Prep mapping, refer to the Edge Bridge tutorials.
Validation #
Validating Edge Bridge events through Edge workflow using the Event Transations view or Analytics Events 2.0 view in Assurance.
API reference #
extensionVersion #
Returns the version of the client-side Edge Bridge extension.
Syntax
static Future<String> get extensionVersion
copied to clipboard
Example
String version = await EdgeBridge.extensionVersion;
copied to clipboard