Remote Config SDK for Android

Provides remote configuration for Android applications.

Requirements

Supported Android Versions

This SDK supports Android API level 21 (Lollipop) and above.

Getting Started

#1 Add dependency to your app’s build.gradle

repositories {
  jcenter()
}

dependency {
  implementation 'com.rakuten.tech.mobile.remoteconfig:remote-config:1.0.0'
}

#2 Set your App Id, Subscription Key, & Base URL

We don’t currently host a public API, so you will need to provide your own Base URL for API requests.

In your AndroidManifest.xml:

<manifest>
    <application>

      <meta-data
        android:name="com.rakuten.tech.mobile.remoteconfig.BaseUrl"
        android:value="https://www.example.com" />

      <meta-data
        android:name="com.rakuten.tech.mobile.ras.AppId"
        android:value="your_app_id" />

      <meta-data
        android:name="com.rakuten.tech.mobile.ras.ProjectSubscriptionKey"
        android:value="your_subscription_key" />

    </application>
</manifest>

#3 Retrieve Config Values

Config values are fetched from the API at launch time and then periodically fetched again every 60 minutes. However, newly fetched config values will not be applied until the next App launch. This also means that the first time the App is launched, the fallback values will be used instead of fetched values.

val remoteConfig = RemoteConfig.instance()

// Retrieve a String value
val testString = remoteConfig.getString("stringKeyName", "string_fallback_value")

// Retrieve a Boolean value
val testBoolean = remoteConfig.getBoolean("booleanKeyName", false)

// Retrieve a Number value (can be Int, Short, Long, Double, Float, or Byte)
val testNumber = remoteConfig.getNumber("numberKeyName", 1)

// Retrieve the entire config as a Map
val configMap = remoteConfig.getConfig()

Changelog

v1.0.0 (2019-09-09)