adobe/aepsdk-edgeidentity-ios

Adobe Experience Platform Identity mobile extension for Adobe Edge Network in Swift

About this project

The AEP Edge Identity mobile extension enables handling of user identity data from a mobile application when using the Adobe Experience Platform SDK and the Edge Network extension.

Requirements

Xcode 15 (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 'AEPEdgeIdentity'
 	pod 'AEPCore'
 	pod 'AEPEdge'
end

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

$ pod install

Swift Package Manager

To add the AEPEdgeIdentity 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 AEPEdgeIdentity package repository: https://github.com/adobe/aepsdk-edgeidentity-ios.git.

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

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

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

Binaries

To generate an AEPEdgeIdentity.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

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.

Package Metadata

Repository: adobe/aepsdk-edgeidentity-ios

Stars: 2

Forks: 11

Open issues: 2

Default branch: main

Primary language: swift

License: Apache-2.0

Topics: adobe-edge-network, adobe-experience-platform, aep-mobile-sdk

README: README.md