Rollout.io - Documentation

Installing the Rollout iOS SDK

The next step after creating your application is to install the SDK. The iOS installation contains two APIs:

  • ROX.framework
    This is a Swift API that provides an interface for creating flags, remote configuration, custom attributes, exporting app state to external analytics, and more. This framework is dependent on ROXCore.framework, the Objective-C API.
  • ROXCore.framework
    This is an Objective-C API that provides an interface for creating flags, remote configuration, custom attributes, exporting app state to external analytics, and more.

For specific instructions on installing the iOS SDK, select your installation method:

  • Manual installation
  • iOS—CocoaPods
  • iOS—Carthage

Manual Installation

Adding the Rollout SDK framework to your project

  1. If you are already in the manual step screen on the dashboard, click download.
    If for some reason you left the installation screen you can go back by clicking on Dashboard > Install Instructions.

  2. Download the zip file and open it. Place the ROX directory under your project.

  1. Add files to your project in Xcode.
  1. Select ROXCore.framework and RoxSdk.xcodeproj.
  1. Remove ROXCore.framework from Linked Frameworks and Libraries.
  1. Click the plus sign (+) under Embedded Binaries and select both ROXCore.framework and ROX.framework.

Your project should look like this:

  1. Add import ROX to your AppDelegate and ROX.setup to func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool.

CocoaPods Installation

Follow the installation instructions as shown on the Dashboard.
If for some reason you left the installation screen you can go back by clicking on Dashboard > Install Instructions

Carthage Installation

Follow the installation instructions as shown on the Dashboard.
If for some reason you left the installation screen you can go back by clicking on Dashboard > Install Instructions

Compile and run your app

After installation is complete, compile and run your app. Doing so will activate your app in the CloudBees Rollout dashboard.

Build failed?

If you're experiencing any issues, just drop us a line. You can use the chat icon in the bottom-right corner to get in touch with us, or you can email us at support@rollout.io.

Congrats!

Now it's time to start adding flags to your app.

Installing the Rollout iOS SDK


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.