Install the SDK

In order to install the SDK, we will use CMPComapiFoundation, a dependency manager for iOS/MacOS projects:

Swift Package Manager (SPM)

1. Open your project in Xcode.
2. Select File > Add Package Dependencies... from the menu bar.
3. Paste the repository URL: https://github.com/comapi/comapi-sdk-ios-objc-spm into the top-right search bar.
4. Set your preferred Dependency Rule (e.g., Up to Next Major Version).
5. Click Add Package.
6. Select CMPComapiFoundation, assign it to your app target, and click Add Package again.

Cocoapods

To add the iOS SDK to your Xcode project with CMPComapiFoundation, do the following:

1. Add the iOS SDK

# other podfile info

target '*Your-Target*'
use_frameworks!

pod 'CMPComapiFoundation'

end

2. Install the iOS SDK

$ pod install

3. Import the iOS SDK in your Objective-C or Swift file

#import <CMPComapiFoundation/CMPComapiFoundation.h>

import CMPComapiFoundation

APNS Environment setup

It is important to ensure your app builds are setup correctly for APNS, so that our SDK can detect whether to use the sandbox APNS (for development builds) or the production APNS (for production, ad-hoc distribution or test-flight builds).

🚧

Failure to set the APNS environment correctly for a build will result in no pushes being received!

Development builds push setup

During development, a Apple provisioning profile will be used to sign and deploy your app to a handset. To ensure push works with your app, ensure the following:

1. Your app provisioning profile includes the Push Notification entitlement
2. You have uploaded a the correct p8 (private key) to Dotdigital, supplied the correct Bundle identifier for your app, Apple team ID and private key ID.
3. Your iOS XCode projects build settings must have the Preprocessor Macro of DEBUG=1 in it's build settings, as follows:
   1. Swift based projects you add it by doing:
      1. Open your Project Build Settings and search for Swift Compiler – Custom Flags … Other Swift Flags
      2. Add -DDEBUG to the Debug section
      3. Add -DRELEASE to the Release section
   2. For Objective-C based projects:
      1. Open your Project Build Settings and search for Preproccessor Macros
      2. Add DEBUG=1 to the Debug section
      3. Add DEBUG=0 to the Release section
4. You have included an entitlements file in your app with the following entry:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>aps-environment</key>
	<string>development</string>
</dict>
</plist>

App Store / Adhoc distribution / Test-flight builds push setup

For any other build type other than development you will need to ensure the following are all correct:

1. Your app provisioning profile includes the correct Push entitlement
2. You have uploaded a the correct p8 (private key) to Dotdigital, supplied the correct Bundle identifier for your app, Apple team ID and private key ID.
3. Your iOS XCode project must have the compiler Preprocessor Macro of DEBUG=0 in it's build settings or not defined, otherwise the SDK will register to use APNS sandbox instead of APNS production! To do this:
   1. Swift based projects you add it by doing:
      1. Open your Project Build Settings and search for Swift Compiler – Custom Flags … Other Swift Flags
      2. Add -DDEBUG to the Debug section
      3. Add -DRELEASE to the Release section
   2. For Objective-C based projects:
      1. Open your Project Build Settings and search for Preproccessor Macros
      2. Add DEBUG=1 to the Debug section
      3. Add DEBUG=0 to the Release section
4. The entitlements file in your app has the following entry:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>aps-environment</key>
	<string>production</string>
</dict>
</plist>