Getting started with iOS SDK
This section describes how to set up and install the iOS SDK and how to deploy a feature flag.
Step 1 - Setting up the iOS SDK
To setup iOS SDK, follow these steps:
-
Create a CloudBees Feature Management account. See Signup Page to create an account.
-
Get your environment key.
-
Get the key from App Settings > Environment > Key.
-
Step 2 - Installing the iOS SDK
For instructions on initializing the iOS package to your application., select your installation method:
CocoaPods
To install the iOS package, follow these steps:
-
In the podfile, add the following:
pod 'ROX'
-
To install the Cocoapods dependencies, run the following command in the terminal:
pod install
Carthage
To install the iOS package, follow these steps:
-
In the cartfile, add the following:
github "rollout/rox-ios"
-
To install the Carthage dependencies, run the following command in the terminal:
carthage update --platform iOS
Manual installation
To install the iOS package, follow these steps:
-
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.
-
Download the zip file and open it. Place the ROX directory under your application.
-
Add files to your project in Xcode by selecting
ROXCore.framework
andRoxSdk.xcodeproj
. -
Remove
ROXCore.framework
from Linked Frameworks and Libraries. -
Click the plus sign (
+
) under Embedded Binaries and select bothROXCore.framework
andROX.framework
.
Add the following lines of code to your application
Swift | Objective-c |
---|---|
|
|
Container class registration and environment key setup
|