microCMS Android SDK

It helps you to use microCMS from Android(Kotlin) applications. Check the official documentation for more information

Getting Started

Installation

The library is located in maven central.

buildscript {
    repositories {
        mavenCentral() //need this line
    }
}

Install dependency:

dependencies {
    implementation 'io.microcms:android-sdk:1.0.1'
}

And you need to get android.permission.INTERNET permission in the manifest:

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

How to use

First, create a client.

val client = Client(
  serviceDomain = "YOUR_DOMAIN", //YOUR_DOMAIN is the XXXX part of XXXX.microcms.io
  apiKey = "YOUR_API_KEY",
)

Next, you can call some api like below. result(Result<JSONObject>) is a instance of kotlin standard class.

Get content list

client.get(
        "API_ENDPOINT"
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getJSONArray("contents").toString(2)) }
}

Get content list with parameters

client.get(
        "API_ENDPOINT",
        listOf(Limit(2), Filters("createdAt[greater_than]2021")) //some params
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getJSONArray("contents").toString(2)) }
}

Get single content

client.get(
        "API_ENDPOINT",
        "CONTENT_ID",
        listOf(Fields("id")) //some params
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}

Get object form content

client.get(
        "API_ENDPOINT",
        listOf(Fields("id")) //some params
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}

Create content

client.create(
        "API_ENDPOINT",
        null,
        mapOf("text" to  "Hello Android SDK!"),
        false
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}

Create content with specified ID

client.create(
        "API_ENDPOINT",
        "CONTENT_ID",
        mapOf("text" to  "Hello Android SDK!"),
        false
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}

Create draft content

client.create(
        "API_ENDPOINT",
        "CONTENT_ID",
        mapOf("text" to  "Hello Android SDK!"),
        true
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}

Update content

client.update(
        "API_ENDPOINT",
        "CONTENT_ID",
        mapOf("text" to "Hello Android SDK update method!")
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}

Update object form content

client.update(
        "API_ENDPOINT",
        null,
        mapOf("message" to "Hello Android SDK!")
) { result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}

Delete content

client.delete(
        "API_ENDPOINT",
        "CONTENT_ID")
{ result ->
    result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}