adobe/aepsdk-messaging-ios

AEP SDKs - Messaging extension for iOS

.package(url: "https://github.com/adobe/aepsdk-messaging-ios.git", from: "1.0.0")

Adobe Experience Platform - Messaging extension for iOS

About this project

Adobe Experience Platform Messaging Extension is an extension for the Adobe Experience Platform Swift SDK.

The AEPMessaging extension allows you to send push notification tokens and push notification click-through feedback to the Adobe Experience Platform.

Requirements

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

Installation

CocoaPods

# Podfile
use_frameworks!

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

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

$ pod install

Swift Package Manager

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

File > Swift Packages > Add Package Dependency...

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

When prompted, make sure you change the branch to main.

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

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

Binaries

To generate AEPMessaging.xcframework, run the following command from the root directory:

make archive

This will generate an XCFramework under the build folder. Drag and drop all the .xcframeworks to your app target.

Documentation

Additional documentation for configuration and sdk usage can be found under the Documentation directory.

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

Setup Demo Application

The AEP Messaging Demo application is a sample app which demonstrates how to send psuh notification token and notification click through feedback

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

Looking to contribute to this project? Please review our Contributing guidelines prior to opening a pull request.

We look forward to working with you!

Licensing

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