App Configuration client SDK for Android

Prerequisites

Following are the prerequisites for using the App Configuration service SDK for Android:

• Android API level 22 or later
• Android Studio
• Gradle

Integrating client SDK for Android app written in Kotlin

App Configuration service provides Android client SDK to integrate with your Android application. You can evaluate the values of your property and feature flag by integrating the SDK.

1. Install the SDK by using either one of the options:

   • Download and import the package to your Android studio project.
   • Get the package through Gradle by adding the:

     • Add App Configuration Android client SDK dependency to Project level build.gradle file.

       repositories {
           mavenCentral()
       }
       

     • Add App Configuration Android client SDK dependency to Module level build.gradle file.

       dependencies {
          implementation "com.ibm.cloud:appconfiguration-android-sdk:0.3.1"
       }
       

2. Configure the AndroidManifest.xml file for internet permission.

   <uses-permission android:name="android.permission.INTERNET"/>
   

3. Initialize the SDK.

   val appConfiguration = AppConfiguration.getInstance()
   
   appConfiguration.init( application,
                        "region",
                        "guid",
                        "apikey")
   
   //To start the configuration fetching operation, set the collectionId and environmentId in the following way.
    appConfiguration.setContext("collectionId","environmentId")
   

   Where:

   • region - Region name where the service instance is created. Use AppConfiguration.REGION_US_SOUTH for Dallas, AppConfiguration.REGION_US_EAST for Washington DC, AppConfiguration.REGION_EU_GB for London, AppConfiguration.REGION_EU_DE for Frankfurt and AppConfiguration.REGION_AU_SYD for Sydney.
   • guid - GUID of the App Configuration service. Get it from the service credentials section of the dashboard.
   • apikey - ApiKey of the App Configuration service. Get it from the service credentials section of the dashboard.
   • collectionId - ID of the collection created in App Configuration service instance under the Collections section.
   • environmentId - Id of the environment created in App Configuration service instance under the Environments section.

4. Set listener for feature or property data changes

   appConfiguration.registerConfigurationUpdateListener(object : ConfigurationUpdateListener {
   
       override fun onConfigurationUpdate() {
           // ADD YOUR CODE
       }
   })
   

val feature: Feature? = appConfiguration.getFeature("json-feature")
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // JSON

// Example below (traversing the returned JSONObject)
if (feature != null) {
   val result = feature.getCurrentValue(entityId, entityAttributes) as JSONObject
   result.get("key") // returns the value of the key
}

val feature: Feature? = appConfiguration.getFeature("yaml-feature")
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // YAML
feature.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check Table 1)

val property: Property? = appConfiguration.getProperty("json-property")
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // JSON

// Example below (traversing the returned JSONObject)
if (property != null) {
  val result = property.getCurrentValue(entityId, entityAttributes) as JSONObject
  result.get("key") // returns the value of the key
}

val property: Property? = appConfiguration.getProperty("yaml-property")
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // YAML
property.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check above Table 1)

Integrating client SDK for Android app written in Java

App Configuration service provides Android client SDK to integrate with your Android application. You can evaluate the values of your property and feature flag by integrating the SDK.

1. Install the SDK by using either one of the options:

   • Download and import the package to your Android studio project.
   • Get the package through Gradle by adding:

     • Add App Configuration Android client SDK dependency to Project level build.gradle file.

       repositories {
          mavenCentral()
       }
       

     • Add App Configuration Android client SDK dependency to Module level build.gradle file.

       dependencies {
          implementation "com.ibm.cloud:appconfiguration-android-sdk:0.3.1"
       }
       

2. Configure the AndroidManifest.xml file for internet permission.

   <uses-permission android:name="android.permission.INTERNET"/>
   

3. Integrate Kotlin to your Java project with these steps:

   • Add the Kotlin Gradle plug-in to the Module level build.gradle

     dependencies {
       classpath "com.android.tools.build:gradle:4.1.1"
       classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
     

   • Add kotlin-android plugin to the App level build.gradle

     plugins {
        id 'com.android.application'
        id 'kotlin-android'
     }
     

4. Initialize the SDK.

   AppConfiguration appConfiguration = AppConfiguration.getInstance();
   appConfiguration.init(getApplication(), "region", "guid", "apikey");
   
   // To start the configuration fetching operation, set the collectionId in the following way.
   appConfiguration.setContext("collectionId", "environmentId");
   

   Where:

   • region - Region name where the service instance is created. Use AppConfiguration.REGION_US_SOUTH for Dallas, AppConfiguration.REGION_US_EAST for Washington DC, AppConfiguration.REGION_EU_GB for London, and AppConfiguration.REGION_AU_SYD for Sydney.
   • guid - GUID of the App Configuration service. Get it from the service credentials section of the dashboard.
   • apikey - ApiKey of the App Configuration service. Get it from the service credentials section of the dashboard.
   • collectionId - ID of the collection created in App Configuration service instance.
   • environmentId- ID of the environment created in App Configuration service instance under the Environments section.

5. Listen to the feature changes

   appConfiguration.registerConfigurationUpdateListener(new ConfigurationUpdateListener() {
       @Override
       public void onConfigurationUpdate() {
          // ADD YOUR CODE
       }
   });
   

Feature feature = appConfiguration.getFeature("json-feature");
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // JSON

// Example below (traversing the returned JSONObject)
if (feature != null) {
  JSONObject result = (JSONObject) feature.getCurrentValue(entityId, entityAttributes);
  result.get("key") // returns the value of the key
}

Feature feature = appConfiguration.getFeature("yaml-feature");
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // YAML
feature.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check above Table 1)

Property property = appConfiguration.getProperty("json-property");
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // JSON

// Example below (traversing the returned JSONObject)
if (property != null) {
  JSONObject result = (JSONObject) property.getCurrentValue(entityId, entityAttributes);
  result.get("key") // returns the value of the key
}

Property property = appConfiguration.getProperty("yaml-property");
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // YAML
property.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check Table 1)