aepsdk_flutter

aepsdk-flutter

About this project

This repository is a monorepo. It contains a collection of Adobe Experience Platform Mobile SDK Flutter plugins listed below. These plugins can be found in the plugins directory.

Extension	Package
Core (required)
Assurance
Edge
Consent
EdgeIdentity
EdgeBridge
UserProfile
Messaging
Optimize

[!NOTE]
The Flutter plugins within this repository are specifically designed to support the Android and iOS platforms only.

iOS Privacy Manifest

[!IMPORTANT]
Adobe Experience Platform Flutter 4.x plugins now depend on Experience Platform iOS 5.x SDKs, which have been updated to align with Apple's latest guidelines on privacy manifest. For further details on how Apple's privacy-related announcements affect the Adobe mobile SDK for iOS, please refer to this document.

Installation

First, make sure that Flutter is installed.

Installing using Terminal:

Install the package, run:

cd MyFlutterApp
flutter pub add flutter_{plugin_name}

This will automatically update your package's pubspec.yaml with the dependency, and run an implicit flutter pub get.

Installing Manually:

Alternatively, Editing pubspec.yaml manually with dependencies.

dependencies:
  flutter_{plugin_name}: ^{latest_version}

Run:

flutter pub get

iOS development

For iOS development, after installing the plugin packages, download the pod dependencies by running the following command to link the libraries to your Xcode project :

cd ios && pod install && cd ..

To update native dependencies to latest available versions, run the following command:

cd ios && pod update && cd ..

Importing the Plugin

For both installation methods, you need to import the package in your Dart code as follows:

import 'package:flutter_{extension}/flutter_{plugin_name}.dart'

Initializing

Then, initialize the SDK using the following methods:

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

[!NOTE]
Starting from Adobe Experience Platform Flutter 5.x, there is no longer a need to initialize the SDK on the native platforms, as was required in earlier versions.

Tests

Run:

$ cd plugins/flutter_{plugin_name}/
$ flutter test

Contributing

If you are creating a plugin for an AEP-prefix (Swift) library, please follow the steps outlined here

For all other information on contributing see Contributing

Documentation

Additional documentation about migrating from older Flutter libraries (ACP-prefixed Flutter libraries) to the latest Flutter libraries (AEP-prefixed libraries) can be found here

License

See License