Manual 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. 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 or Content Cards)
    • 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.

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.tbd
    • CoreImage.framework
    • CoreText.framework
    • WebKit.framework
  6. Add the following frameworks and mark them as optional:
    • CoreTelephony.framework
    • Social.framework
    • Accounts.framework
    • AdSupport.framework
    • StoreKit.framework
  7. While still under the target for your project, select the “Build Settings” tab. In the “Linking” section, locate the “Other Linker Flags” setting and add the -ObjC flag.
  8. The SDWebImage framework is required for the Braze News Feed, Content Cards 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, Content Cards or In-App Messages, please follow the steps below.

SDWebImage Integration

  1. Inside of your project folder, clone SDWebImage repository recursively:
    1
    
    git clone --recursive https://github.com/rs/SDWebImage.git
    
  2. Drag-n-drop SDWebImage/SDWebImage.xcodeproj into your application Xcode project.
  3. In your project application’s target settings, open the “General” tab, click the “+” button under the “Link Frameworks and Libraries” block and add ImageIO.framework.
  4. In your project application’s target settings, open the “General” tab, click the “+” button under the “Embedded Binaries” block and add SDWebImage.framework.
  5. In the SDWebImage project settings, open the “Build Settings” tab. In the “Linking” section, locate the “Other Linker Flags” setting and add the -ObjC flag if it isn’t already present.
  6. In your project application’s target settings, open the “Build Settings” tab. In the “Search Paths” section, locate “Header Search Paths” and add $(SRCROOT)/SDWebImage with “recursive” turned on.

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:

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

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?
New Stuff!