Skip to content

adobe/aepsdk-audience-ios

Adobe Experience Platform Audience SDK

CocoaPods SPM CircleCI Code Coverage

About this project

The AEPAudience extension represents the Audience Manager Adobe Experience Platform SDK that is required for updating audience profiles for users and retrieving user segment information from your mobile app.

Requirements

  • Xcode 15
  • Swift 5.1

Installation

These are currently the supported installation options:

# Podfile
use_frameworks!

# For app development, include all the following pods
target 'YOUR_TARGET_NAME' do
    pod 'AEPAudience'
    pod 'AEPCore'
    pod 'AEPIdentity'
end

# For extension development, include AEPAudience and its dependencies
target 'YOUR_TARGET_NAME' do
    pod 'AEPAudience'
    pod 'AEPCore'
    pod 'AEPServices'
    pod 'AEPIdentity'
end

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

$ pod install

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

File > Add Packages...

Note The menu options may vary depending on the version of Xcode being used.

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

When prompted, input a specific version or a range of versions for Version rule.

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

dependencies: [
    .package(url: "https://github.com/adobe/aepsdk-audience-ios.git", .upToNextMajor(from: "5.0.0"))
]

Project Reference

Include AEPAudience.xcodeproj in the targeted Xcode project and link all necessary libraries to your app target.

Binaries

Run make archive from the root directory to generate .xcframeworks for each module under the build folder. Drag and drop all .xcframeworks to your app target in Xcode.

Documentation

Additional documentation for usage and SDK architecture can be found under the Documentation directory.

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.