Android SDK reference

Read time: 6 minutes

Last edited: Oct 02, 2024

Recent major versions

Version 5 of the Android SDK introduces optional automatic collection of environment attributes. To learn more about upgrading, read Android SDK 4.x to 5.0 migration guide.

Version 4 of the Android SDK replaces users with contexts. A context is a generalized way of referring to the people, services, machines, or other resources that encounter feature flags in your product. To learn more about upgrading, read Android SDK 3.x to 4.0 migration guide and Best practices for upgrading users to contexts.

Overview

This topic documents how to get started with the Android SDK, and links to reference information on all of the supported features.

SDK quick links

LaunchDarkly's SDKs are open source. In addition to this reference guide, we provide source, API reference documentation, and a sample application:

Resource	Location
SDK API documentation	SDK API docs
GitHub repository	android-client-sdk
Sample application	Android
Published module	Maven

SDK version compatibility

The LaunchDarkly Android SDK is compatible with Android SDK versions 21 and higher (Android 5.0, Lollipop).

Get started

After you complete the Get started process, follow these instructions to start using the LaunchDarkly SDK in your Android application:

Install the SDK
Import the SDK
Initialize the client
Evaluate a flag

Install the SDK

First, declare a dependency on the LaunchDarkly Android SDK:

The SDK uses AndroidX from Jetpack. If your project does not use AndroidX, read Android's migration guide.

Using ProGuard or R8

If you use ProGuard or R8, the aar artifact should automatically include the configuration for the Android SDK. If this is not the case for your build, include the Proguard configuration lines from consumer-proguard-rules.pro into your proguard file.

Import the SDK

Next, import the LaunchDarkly client in your application code:

Initialize the client

After you install the SDK, create a single, shared instance of LDClient. To create a client instance, you need your environment's mobile key. This authorizes your application to connect to a particular environment within LaunchDarkly.

The Android SDK uses a mobile key

The Android SDK uses a mobile key. Keys are specific to each project and environment. They are available from the Environments list for each project. To learn more about key types, read Keys.

Mobile keys are not secret and you can expose them in your client-side code without risk. However, never embed a server-side SDK key into a client-side application.

We recommend calling the client initialization method with a timeout of zero seconds. This allows you to use the client immediately. The app stores flags from the previous launch on the device and retrieves them for immediate use. The client connects in the background and continually updates itself with the latest flags.

Here's how to create the client:

If you need to, you can block for a short period of time until the SDK retrieves the latest feature flags from LaunchDarkly by using a non-zero value for the timeout parameter in the initialization call. However, calling blocking code from the main thread in an Android app is not a best practice, and we do not recommend it. Blocking until the SDK retrieves the latest feature flags from LaunchDarkly will cause your app never to load if there is a connectivity problem. If you must use a non-zero timeout parameter, we recommend setting it for five seconds or fewer.

To learn more about the specific configuration options available in this SDK, read LDConfig.Builder.

LDClient must be a singleton

It's important to make LDClient a singleton for each LaunchDarkly project. The client instance maintains internal state that allows LaunchDarkly to serve feature flags without making any remote requests. Do not instantiate a new client with every request.

If you have multiple LaunchDarkly projects, you should use the multiple environments feature. To learn more, read Multiple environments.

Evaluate a flag

After you create the client, you can use it to check which variation a particular context will receive for a feature flag.

Here's how:

Making feature flags available to this SDK

You must make feature flags available to mobile SDKs before the SDK can evaluate those flags. If an SDK tries to evaluate a feature flag that is not available, the context will receive the fallback value for that flag.

To make a flag available to this SDK, check the SDKs using Mobile key checkbox during flag creation, or on the flag's settings page. To make all of a project's flags available to this SDK by default, check the SDKs using Mobile key checkbox on your project's Flag settings page.

Shut down the client

Shut down the client when your application terminates. To learn more, read Shutting down.

Data collection

The data collected by the Android SDK persists until the number of cached contexts exceeds a limit. When you call identify, the number of cached contexts increments. Eventually, the number of cached contexts exceeds maxCachedContexts. When that happens, the SDK deletes context data in excess of maxCachedContext, starting with the oldest context first.

Supported features

This SDK supports the following features: