Integration instructions for iOS Apps using Objective-C or Swift.

iOS minimum version

Import the SDK into your project

• Swift Package Manager (from SDK version 12+)
• CocoaPods
• Carthage
• Manually.

Swift Package Manager Integration

1. If you're using Swift Package Manager, you can integrate the SDK by adding the iOS SDK repo URL as a package repository for your project.

Extension SDK

CocoaPods Integration

1. If you're using CocoaPods, you can integrate the SDK simply by adding the following line to your Podfile:

   pod 'SailthruMobile'
   
   # optional: add the extention SDK (should be added to main app target and any extension targets that require it)
   pod 'SailthruMobile-Extension'

2. Run pod install to install.

Carthage Integration

1. Install Carthage 0.17.0 or later.
2. Add github "carnivalmobile/carnival-ios-sdk" to your Cartfile.
3. Run carthage update
4. Drag SailthruMobile.framework (and optionally the SailthruMobileExtension.framework) from the appropriate platform directory in Carthage/Build/iOS to the "Linked Frameworks and Libraries" section of your Xcode project's "General" settings.
5. On your application targets' "Build Phases" settings tab, click the "+" icon and choose "New Run Script Phase". Create a Run Script with the following contents: /usr/local/bin/carthage copy-frameworks
6. Add the paths to the frameworks you want to use under "Input Files", e.g.: $(SRCROOT)/Carthage/Build/iOS/SailthruMobile.framework. This script works around an App Store submission bug triggered by universal binaries.

Manual Integration

1. Download the latest release of the SDK from Github and extract it.
2. Select SailthruMobile.xcframework in Finder and drag and drop it into your Xcode project. Make sure "Copy items if needed" is selected, and click "Finish"
3. Add SailthruMobile.xcframework to embedded binaries

   

4. To work-around this app store submission bug download the file on our Framework stripping page and place it in the root of your project. Note: this is only required below SDK version 12.0.0, XCFrameworks do not require this workaround.
6. In your target's build settings screen, build phases, add a new run script and enter bash $SRCROOT/strip-frameworks.sh in the text box.

Upgrading the SDK

Integrate the initialization code

#import <SailthruMobile/SailthruMobile.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [[SailthruMobile new] startEngine:SDK_KEY]; // Obtain SDK key from your Sailthru Mobile app settings
  return YES;
}

SwiftUI Integration

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        SailthruMobile().startEngine(SDK_KEY)
        return true
    }
}

@main
struct SwiftUI_TestApp: App {
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Push Authorization Options

#import <SailthruMobile/SailthruMobile.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [[SailthruMobile new] startEngine:SDK_KEY withAuthorizationOption:STMPushAuthorizationOptionProvisional]; // Obtain SDK key from your Sailthru Mobile app settings
  return YES;
}

func application(application: UIApplication, 
didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
  SailthruMobile().startEngine(SDK_KEY, with: .provisional) // Obtain SDK key from your Sailthru Mobile app settings
  return true
}

Test your integration

Next Steps

1. Setup Push Notifications for iOS to ensure your users can receive push notifications when the app is closed.
2. Setup in-app messages to enable Mobile's rich In-App Messages
3. Collect user data to help in segmenting and targeting your users based on their activity.