Carthage Integration

You can integrate the Braze SDK using Carthage by including the following in your Cartfile:

1
github "Appboy/Appboy-iOS-SDK" "<BRAZE_IOS_SDK_VERSION>"

Make sure to replace <BRAZE_IOS_SDK_VERSION> with the latest version of the Braze iOS SDK in “x.y.z” format. Release versions are available here.

For further instructions using Carthage, please refer to their user guide on Github.

Once you’ve synced the Braze SDK release artifacts (we support Carthage via a zip of release artifacts attached to our Github releases), integrate the Appboy_iOS_SDK.framework and SDWebImage.framework into your project. Then, in your Application delegate do:

• OBJECTIVE-C
• swift

1
2
3
4
5
6
7
8
#import <Appboy_iOS_SDK/AppboyKit.h>

...

// In `application:didFinishLaunchingWithOptions:`
[Appboy startWithApiKey:@"YOUR-API-KEY"
         inApplication:application
         withLaunchOptions:launchOptions];

1
2
3
4
5
6
7
8
import Appboy_iOS_SDK

...

// In `application:didFinishLaunchingWithOptions:`
Appboy.start(withApiKey: "YOUR-API-KEY",
              in:application,
              withLaunchOptions:launchOptions)

Dependency-Free Integration

If you want to use SDWebImage in your project along with the Braze SDK, you can install a thin version of the Braze Carthage framework. To do so, include the following lines in your Cartfile:

1
2
binary "https://raw.githubusercontent.com/Appboy/appboy-ios-sdk/master/appboy_ios_sdk.json"
github "rs/SDWebImage"

Core Only Integration

If you want to use the Core SDK without any UI components, you can install the core version of the Braze Carthage framework by including the following line in your Cartfile:

1
binary "https://raw.githubusercontent.com/Appboy/appboy-ios-sdk/master/appboy_ios_sdk_core.json"