flutter_aepedgebridge 5.0.0

Official Adobe Experience Platform support for Flutter apps. The AEP Edge Bridge mobile extension provides seamless routing of data to the Adobe Experience Platform Edge Network for existing SDK imple [...]

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.

Usage

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.

Importing the SDK:

import 'package:flutter_aepedgebridge/flutter_aepedgebridge.dart';

copied to clipboard

Initializing with SDK:

To initialize the SDK, use the following methods:

• MobileCore.initializeWithAppId(appId)
• MobileCore.initialize(initOptions)

Refer to the root Readme for more information about the SDK setup.

Edge Bridge tutorials

For tutorials on implementing Edge Bridge, refer to the Edge Bridge tutorials.

Validation

Validating Edge Bridge events through Edge workflow using the Event Transations view or Analytics Events 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

Tests

Run:

flutter test

copied to clipboard