https://github.com/adobe/aepsdk_flutter
https://github.com/adobe/aepsdk_flutter
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/adobe/aepsdk_flutter
- Owner: adobe
- License: apache-2.0
- Created: 2022-02-09T08:42:56.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-10-20T16:45:56.000Z (8 months ago)
- Last Synced: 2026-01-11T10:41:43.156Z (5 months ago)
- Language: Dart
- Size: 908 KB
- Stars: 12
- Watchers: 13
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](./plugins) directory.
| Extension | Package |
| ------------ | ------------------------------------------------------------ |
| [Core](plugins/flutter_aepcore/README.md) (required) | [](https://pub.dartlang.org/packages/flutter_aepcore) |
| [Assurance](plugins/flutter_aepassurance/README.md) | [](https://pub.dartlang.org/packages/flutter_aepassurance) |
| [Edge](plugins/flutter_aepedge/README.md) | [](https://pub.dartlang.org/packages/flutter_aepedge) |
| [Consent](plugins/flutter_aepedgeconsent/README.md) | [](https://pub.dartlang.org/packages/flutter_aepedgeconsent) |
| [EdgeIdentity](plugins/flutter_aepedgeidentity/README.md) | [](https://pub.dartlang.org/packages/flutter_aepedgeidentity) |
| [EdgeBridge](plugins/flutter_aepedgebridge/README.md) | [](https://pub.dartlang.org/packages/flutter_aepedgebridge) |
| [UserProfile](plugins/flutter_aepuserprofile/README.md) | [](https://pub.dartlang.org/packages/flutter_aepuserprofile) |
| [Messaging](plugins/flutter_aepmessaging/README.md) | [](https://pub.dartlang.org/packages/flutter_aepmessaging) |
> [!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](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files). For further details on how Apple's privacy-related announcements affect the Adobe mobile SDK for iOS, please refer to this [document](https://developer.adobe.com/client-sdks/resources/privacy-manifest/).
## Installation
First, make sure that `Flutter` is [installed](https://docs.flutter.dev/get-started/install).
### Installing using Terminal:
Install the package, run:
```bash
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 :
```bash
cd ios && pod install && cd ..
```
To update native dependencies to latest available versions, run the following command:
```bash
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)](https://github.com/adobe/aepsdk_flutter/tree/main/plugins/flutter_aepcore#initializewithappid)
- [MobileCore.initialize(initOptions)](https://github.com/adobe/aepsdk_flutter/tree/main/plugins/flutter_aepcore#initialize)
> [!NOTE]
> Starting from Adobe Experience Platform Flutter **5.x**, there is no longer a need to initialize the SDK on the [native platforms](https://github.com/adobe/aepsdk_flutter/tree/v4.x?tab=readme-ov-file#usage), 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](docs/creating_new_plugins.md)
For all other information on contributing see [Contributing](CONTRIBUTING.md)
## 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](./docs/migration.md)
## License
See [License](LICENSE)