Adobe Experience Platform Consent Collection Mobile Extension

About this project

The AEP Consent Collection mobile extension enables consent preferences collection from your mobile app when using the Adobe Experience Platform Mobile SDK and the Edge Network extension.

Requirements

Xcode 11.0 (or newer)
Swift 5.1 (or newer)

Installation

These are currently the supported installation options:

CocoaPods

# Podfile
use_frameworks!

# for app development, include all the following pods
target 'YOUR_TARGET_NAME' do
    pod 'AEPEdgeConsent'
    pod 'AEPCore'
    pod 'AEPEdge'
    pod 'AEPEdgeIdentity'
end

# for extension development, include AEPCore, AEPEdgeConsent, and their dependencies
target 'YOUR_TARGET_NAME' do
    pod 'AEPEdgeConsent'
    pod 'AEPCore'
end

Replace YOUR_TARGET_NAME and then, in the Podfile directory, type:

$ pod install

Swift Package Manager

To add the AEPEdgeConsent Package to your application, from the Xcode menu select:

File > Swift Packages > Add Package Dependency...

Enter the URL for the AEPEdgeConsent package repository: https://github.com/adobe/aepsdk-edgeconsent-ios.git.

When prompted, make sure you change the branch to main. (Once the repo is public, we will reference specific tags/versions instead of a branch)

Alternatively, if your project has a Package.swift file, you can add AEPEdgeConsent directly to your dependencies:

dependencies: [
    .package(url: "https://github.com/adobe/aepsdk-edgeconsent-ios.git", .upToNextMajor(from: "1.0.0"))
],
targets: [
    .target(name: "YourTarget",
            dependencies: ["AEPEdgeConsent"],
            path: "your/path")    
]

Binaries

To generate an AEPEdgeConsent.xcframework, run the following command:

$ make archive

This generates the xcframework under the build folder. Drag and drop all the .xcframeworks to your app target in Xcode.

Development

The first time you clone or download the project, you should run the following from the root directory to setup the environment:

make pod-install

Subsequently, you can make sure your environment is updated by running the following:

make pod-update

Open the Xcode workspace

Open the workspace in Xcode by running the following command from the root directory of the repository:

make open

Command line integration

You can run all the test suites from command line:

make test

Related Projects

Project	Description
AEPCore Extensions	The AEPCore and AEPServices represent the foundation of the Adobe Experience Platform SDK.
AEPEdge Extension	The AEPEdge extension allows you to send data to the Adobe Experience Platform (AEP) from a mobile application.
AEPEdgeIdentity Extension	The AEPEdgeIdentity enables handling of user identity data from a mobile app when using the AEPEdge extension.
AEP SDK Sample App for iOS	Contains iOS sample apps for the AEP SDK. Apps are provided for both Objective-C and Swift implementations.
AEP SDK Sample App for Android	Contains Android sample app for the AEP SDK.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

addb/aepsdk-edgeconsent-ios