Rollout.io - Documentation

Installing the Rollout Android SDK

The next step after creating your application is to install the SDK. The following are the steps for installing the SDK:

  1. Add the Rollout SDK to your project by putting the following in the dependencies block of your build.gradle file:
implementation 'io.rollout.rox:rox-android:4.6.0'
  1. Add the Rollout key to the application block in the AndroidManifest.xml file.

The Rollout app key is unique to your application and can be found in the installation instructions or in the app settings on the ROX dashboard.

<meta-data
  android:name="rox.apiKey"
  android:value="the app key goes here" />
  1. Initialize the Rollout SDK by adding the following to the onCreate() method of your application class or main activity:

Note: If your app contains a class that inherits from the application class, that is the right place to initialize the Rollout SDK. If not, you should initialize it in the main activity class of your app.

Rox.setup(this);
Rox.setup(this.getApplication());
  1. Run the app
    Now you can build and run your app in the Android emulator or on a real device.
    If you log in to the Rollout dashboard, the dashboard will recognize that the setup is complete.

That's it! Now your app is ready to use Rollout.

And with that, it's time to create a Rollout feature flag.

Installing the Rollout Android SDK


Suggested Edits are limited on API Reference Pages

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