Rollout.io Support Site

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

Support    

Rollout API Doc

This document describes the API documentation of Rollout class, Rollout class is used to setup Rollout SDK, control if it is disabled or not and connect the SDK with specific functionality of the app Rollout is installed on (for example analytics).

This Document is not about JavaScript API

This document does not describe how JavaScript should be used and its API, for info regarding this please consult JavaScript API Docs

Rollout

Rollout class is responsible for initiating Rollout SDK on your app

Method
Description

setupWithKey:

setup Rollout

setupWithKey:options:

setup Rollout with non default options (see RolloutOptions)

rolloutDisabled

determine if Rollout is disabled or not (see disable rollout)

setRolloutDisabled:

set Rollout disable/enable (see disable rollout)

RolloutOptions

RolloutOptions instance is used to pass parameters on rollout setup method, here are the list of available configurations

Property
Description

tracker

a block that will be activated when the UI analytics action is activated in Rollout's dashboard, see Configure analytics with tracker block

disableSyncLoadingFallback

a boolean property that control if sync fallback loading is activated or not

verbose

verbosity level of the SDK, used for debugging

silentFiles

array of files to silent when the verbose flag

rolloutDisabled

used to start Rollout in disabled state (see disable rollout)

Disable Rollout

To start the SDK in disabled state

RolloutOptions *options = [[RolloutOptions alloc] init];
options.rolloutDisabled = YES;
[Rollout setupWithKey:@"<your app key here>"
              options:options];
let options:RolloutOptions = RolloutOptions()
options.rolloutDisabled = true
Rollout.setupWithKey("<your app key here>", options:options)

To disable or enable the SDK:

[Rollout setRolloutDisabled:YES]; // disable the SDK
[Rollout setRolloutDisabled:NO]; // enable the SDK
Rollout.setRolloutDisabled(true) // disable the SDK
Rollout.setRolloutDisabled(false) // enable the SDK

To check the current status:

[Rollout rolloutDisabled]; // returns YES if disabled
Rollout.rolloutDisabled() // returns true if disabled

Configure analytics with tracker block

You can use RolloutOptions class to configure your own analytics function that will be used when you use the "send analytics" action in Rollout dashboard. (see send analytics use case)

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  RolloutOptions *rolloutOptions = [[RolloutOptions alloc] init];
  rolloutOptions.tracker = ^(NSDictionary *data){// data is configured on dashbaord
    [[MyAnalytics sharedInstance] send:data];//send data to your own Analytics singleton 
  };
[Rollout setupWithKey:@"<your app key here>"
              options:options];

  // other initializations and Misc //
  return YES;
}
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
  let rolloutOptions:RolloutOptions = RolloutOptions()
  rolloutOptions.tracker = { (data: [NSObject : AnyObject]!) in // data is configured on dashbaord
    MyAnalytics.sharedInstance.send(data); //send data to your own Analytics singleton 
  }
  Rollout.setupWithKey("<your app key here>", options:options)

  // other initializations and Misc //
  return true;
}

Turn on verbose logging

You can turn on verbose logging by changing the verbose flag from Silent to Debug

RolloutOptions *options = [[RolloutOptions alloc] init];
options.verbose = RolloutOptionsVerboseLevelDebug;
[Rollout setupWithKey:@"<your app key here>"  options:options];

Rollout API Doc