balazsczap / ios-emarsys-sdk

Contents

• What is the Emarsys SDK?
• Sample app
• Setup
  • Installation with CocoaPods
  • Requirements
• Documentation
• DeepLink
• Glossary
• Migrate from MobileEngage
• Rich Push Notifications

What is the Emarsys SDK?

The Emarsys SDK enables you to use Mobile Engage and Predict in a very straightforward way. By incorporating the SDK in your app, we, among others, support you in handling credentials, API calls, tracking of opens and events as well as logins and logouts in the app.

The Emarsys SDK is open-sourced to enhance transparency and to remove privacy concerns. This also means that you will always be up-to-date with what we are working on.

Using the SDK is also beneficial from the product aspect: it simply makes it much easier to send push messages through your app. Please always use the latest version of the SDK in your app.

Sample app

We created a sample application to help in the integration and give an example. Find instructions for the build process here.

Setup

1. Installation with CocoaPods

1.1 Install CocoaPods

CocoaPods is a dependency manager for iOS, which automates and simplifies the process of using 3rd-party libraries. You can install it with the following command:

$ gem install cocoapods

1.2 Podfile

To integrate the Emarsys SDK into your Xcode project using CocoaPods, specify it in your Podfile:

platform :ios, '11.0'

source 'https://github.com/CocoaPods/Specs.git'

target "<TargetName>" do
	pod ‘EmarsysSDK’, '~> ‹latest_released_version_of_emarsys-sdk›’
end

Wherever you see or anything similar in <> brackets, you should change those according to your own naming convention or add a value valid for the context.

1.3 Install Pods

After creating the Podfile, you need to execute the command below to download dependencies: pod install

2. Installation with Swift Package Manager

2.1 Add package in XCode

Select project and under Swift Packages add the package repository url: https://github.com/emartech/ios-emarsys-sdk.git

Select the desired version of the EmarsysSDK.

On the next page select the libraries you want to use and add them to the correct target, for example (based on our SampleApp):

EmarsysSDKLibrary and add to target EmarsysSample

EmarsysNotificationExtensionLibrary and add to target EMSNotificationService

3. Requirements

• The iOS target should be iOS 11 or higher.
• In order to be able to send push messages to your app, you need to have certifications from Apple Push Notification service (APNs).

Note

For further information about how to use our SDK please visit our Documentation