We strongly recommend that you implement the SDK via a package manager such as Swift Package Manager, CocoaPods, or Carthage. It will save you a lot of time and automate much of the process. However, if you are unable to do so, you may complete the integration manually by following the instructions.
Step 1: Downloading the Braze SDK
Option 1: Dynamic XCFramework
Appboy_iOS_SDK.xcframework.zipfrom the release page and extract the file.
- In Xcode, drag and drop this
.xcframeworkinto your project.
- Under the General tab of the project, select Embed & Sign for
Option 2: Static XCFramework for static integration
Appboy_iOS_SDK.zipfrom the release page.
- In Xcode, from the project navigator, select the destination project or group for Braze
- Navigate to File > Add Files > Project_Name.
- Add the
AppboyUIfolders to your project as a group.
- Make sure that the Copy items into destination group’s folder option is selected if you are integrating for the first time. Expand Options in the file picker to select Copy items if needed and Create groups.
- Delete the
- (Optional) If one of the following applies to you:
- 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
Appboy.bundle. This will remove the
SDWebImageframework 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 Content Cards UI with the core version will lead to unpredictable behavior.
Step 2: Adding required iOS libraries
- Click on the target for your project (using the left-side navigation), and select the Build Phases tab.
- Click the button under Link Binary With Libraries.
- In the menu, select
- Mark this library as required using the pull-down menu next to
- Repeat to add each of the following required frameworks to your project, marking each as “required”.
- Add the following frameworks and mark them as optional:
- Select the Build Settings tab. In the Linking section, locate the Other Linker Flags setting and add the
SDWebImageframework is required for Content Cards and in-app messaging to function properly.
SDWebImageis used for image downloading and displaying, including GIFs. If you intend to use Content Cards or in-app messages, follow the SDWebImage integration steps.
SDWebImage, follow their instructions and then drag and drop the resulting
XCFramework into your project.
Optional location tracking
- Add the
CoreLocation.frameworkto enable location tracking.
- You must authorize location for your users using
CLLocationManagerin your app.
Step 3: Objective-C bridging header
If your project only uses Objective-C, skip this step.
If your project uses Swift, you will need a bridging header file.
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.
Follow the instructions for completing the integration.