Optimizely Rollouts

The Rollouts Developer Hub

Welcome to the Rollouts developer hub. You'll find comprehensive guides and documentation to help you start working with Rollouts as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

iOS and tvOS

Quickstart guide for Optimizely Rollouts

Welcome to the quickstart guide for Optimizely's iOS and tvOS SDKs. The instructions below will help you implement Rollouts and launch your first feature flag.

This guide will help you:

  1. Install the SDK
  2. Instantiate Optimizely when your app starts
  3. Create a feature flag
  4. Roll out the feature

1. Install the SDK

Our iOS and tvOS SDKs are available for distribution through CocoaPods. You can use these SDKs with apps written in Objective C and Swift.

Requirements

iOS 8.0+ or tvOS 9.0+

CocoaPods

  1. Add this line to the Podfile:
pod 'OptimizelySDKiOS','~> 3.0.0'

Alternatively, if you are developing on tvOS, use:

pod 'OptimizelySDKTVOS','~> 3.0.0'
  1. Run the command:
pod install

Carthage

To install on Carthage follow the instructions here

Manual Installation

To install manually follow the instructions here

Source Code

The full source code is at https://github.com/optimizely/objective-c-sdk.

2. Configure Optimizely when your application starts

In Optimizely, find your SDK key by navigating to Settings > Datafile.

Click to enlarge

Click to enlarge

Instantiate the client by placing the code below in AppDelegate.m. Replace 'Your_SDK_Key' with the SDK key you found above.

// In AppDelegate.m
#import <OptimizelySDKiOS/OptimizelySDKiOS.h>

// Build a manager
OPTLYManager *manager = [[OPTLYManager alloc] initWithBuilder:[OPTLYManagerBuilder  builderWithBlock:^(OPTLYManagerBuilder * _Nullable builder) {
  builder.sdkKey = @'<Your_SDK_Key>';
}]];


// Instantiate the client asynchronously with a callback
[manager initializeWithCallback:^(NSError * _Nullable error,
                                  OPTLYClient * _Nullable client) {
  // Use isFeatureEnabled method to see if the feature is enabled for a given user
  bool enabled = [client isFeatureEnabled:@"new_feature" userId:@"user123" attributes: nil];
}];

// In AppDelegate.swift
import OptimizelySDKiOS

// Build a manager
let optimizelyManager = OPTLYManager(builder: OPTLYManagerBuilder(block: { (builder) in
  builder?.sdkKey = 'Your_SDK_Key'
}))

// Instantiate the client asynchronously with a callback
optimizelyManager?.initialize(callback: { [weak self] (error, optimizelyClient) in
  // Use isFeatureEnabled method to see if the feature is enabled for a given user
  let enabled = optimizelyClient?.isFeatureEnabled("new_feature", userId: "user123")
})

For a full example, see:

3. Create a feature flag

Choose a feature in your app to turn on and off with a feature flag. For your first flag, consider starting with a link or visual element that's simple to change, show, or hide based on a boolean.

To set up your first feature flag, navigate to Features > Create New Feature.

Here's how to set it up:

Click to enlarge.

Click to enlarge.

After saving, use the boolean Is Feature Enabled function to show, hide, or change some visual part of your application. Note: you should see a value of false from this function because you haven't rolled out the feature yet. You'll turn it on in the next step.

bool enabled = [client isFeatureEnabled:@"new_feature" userId:@"user123" attributes: nil];

let enabled = optimizelyClient?.isFeatureEnabled("new_feature", userId: "user123")

The UserID enables you to create consistent experiences for a user across multiple visits, but you don't need it for this quickstart. Make the userID any non-null string for now.

4. Roll the feature out

In Optimizely, navigate back to Features and select your feature flag.

You'll return to this feature whenever you want to update the feature flag. For example, roll out your feature incrementally by moving the slider up by 10% per day or show it to a certain group of users. Move it to 100% for a big reveal, or 0% if issues arise in production. No code deployment necessary.

A basic way to confirm that your feature flag is working:

Show the feature to yourself

  1. Navigate to your feature.
  2. Toggle it ON and move the slider to 100% traffic. Click Save.
  3. Confirm that you see the feature.

Hide the feature from yourself

  1. Navigate back to the feature.
  2. Toggle it OFF. Click Save.
  3. Confirm that you no longer see the feature.

When you're ready, go ahead and launch your feature in production. Come back and change its configuration any time, without deploying code.


What's Next

Now that you've seen how feature flags work with Optimizely, learn about configuring our SDKs for your development workflow.

Run a beta
Feature flags in production

iOS and tvOS


Quickstart guide for Optimizely Rollouts

Suggested Edits are limited on API Reference Pages

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