Manual SDK Integration

Step 1: Cloning the Braze SDK

  1. Clone the Braze iOS SDK Github project:
1
2
# This command will clone both versions of the Braze SDK
$ git clone git@github.com:Appboy/appboy-ios-sdk.git
  1. In Xcode, from the project navigator, select the destination project or group for Braze
  2. Navigate to File > Add Files to “Project_Name”
  3. Add the AppboyKit and AppboyUI folders to your project as a group.
    • Make sure that the “Copy items into destination group’s folder” option is checked if you are integrating for the first time. In Xcode 7+, expand “Options” in the file picker to select “Copy items if needed” and “Create groups.”
  4. (Optional) If you are one of the following:
    • You only want the core analytics features of the SDK and do not use any UI features (e.g, In-App Messages, News Feed, or Feedback)
    • You have custom UI for Braze’s UI features and handle the image downloading yourself

    You can use the core version of the SDK by removing the file ABKSDWebImageProxy.m and Appboy.bundle. This will remove the SDWebImage framework dependency and all the UI related resources (e.g. Nib files, images, localization files) from the SDK.

If you try to use the core version of the SDK without Braze’s UI features, in-app messages will not display. Trying to display Braze’s News Feed and Feedback UI with core version will lead to unpredictable behavior.

Step 2: Adding Required iOS Libraries

  1. Click on the target for your project (using the left-side navigation), and select the “Build Phases” tab
  2. Click the button under “Link Binary With Libraries”
  3. In the menu, select SystemConfiguration.framework
  4. Mark this library as required using the pull-down menu next to SystemConfiguration.framework
  5. Repeat to add each of the following required frameworks to your project, marking each as “required”
    • QuartzCore.framework
    • libz.dylib, or libz.tbd in Xcode 7+
    • CoreImage.framework
    • CoreText.framework
    • SystemConfiguration.framework
    • WebKit.framework
  6. Add the following frameworks and mark them as optional:
    • CoreTelephony.framework
    • Social.framework
    • Accounts.framework
    • AdSupport.framework
    • StoreKit.framework
  7. The SDWebImage framework is required for the Braze News Feed and In-App Messaging to function properly. SDWebImage is used for image downloading and displaying, including GIFs. If you intend to use the News Feed or In-App Messages, please follow the integration instructions found on the SDWebImage Github Page.

    NOTE: From version 2.26.0, Braze iOS SDK only supports 4.x version of SDWebImage. If you have to use SDWebImage version 3.x, please use Braze SDK version 2.25.0 or below.

  8. The FLAnimatedImage framework is required to display GIF images in Braze News Feed and In-App Messages. Please follow the integration instructions found on the FLAnimatedImage Github Page.

Optional Location Tracking

  1. Add the CoreLocation.framework to enable location tracking
  2. You must authorize location for your users using CLLocationManager in your app

Step 3: Updating your App Delegate

Add the following line of code to your AppDelegate.m file:

1
#import "AppboyKit.h"

Within your AppDelegate.m file, add the following snippet within your application:didFinishLaunchingWithOptions method:

Be sure to update YOUR-API-KEY with the correct value from your App Settings page.

1
2
3
[Appboy startWithApiKey:@"YOUR-API-KEY"
         inApplication:application
     withLaunchOptions:launchOptions];

Be sure to initialize Braze in your application’s main thread.

See the AppDelegate.m file in the Stopwatch sample app.

If you do not have a bridging header file, create one and name it your-product-module-name-Bridging-Header.h by choosing File > New > File > (iOS or OS X) > Source > Header File. Then add the following line of code to the top of your bridging header file:

1
#import "AppboyKit.h"

In your project’s Build Settings, add the relative path of your header file to the Objective-C Bridging Header build setting under Swift Compiler - Code Generation.

For more information about using Objective-C code in Swift projects, please refer to the Apple Developer Docs.

In AppDelegate.swift, add following snippet within function application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool:

1
Appboy.startWithApiKey("YOUR-API-KEY", inApplication:application, withLaunchOptions:launchOptions)

SDK Integration Complete

Braze should now be collecting data from your application and your basic integration should be complete. Please see the following sections in order to enable custom event tracking, push messaging, the news-feed and the complete suite of Braze features.

Full iOS class documentation is available to provide additional guidance on any of the aforementioned methods.

WAS THIS PAGE HELPFUL?