Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microcmsio/microcms-android-sdk
https://github.com/microcmsio/microcms-android-sdk
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/microcmsio/microcms-android-sdk
- Owner: microcmsio
- License: apache-2.0
- Created: 2021-03-29T00:29:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-02T03:21:20.000Z (over 1 year ago)
- Last Synced: 2024-04-28T05:52:24.274Z (7 months ago)
- Language: Kotlin
- Size: 170 KB
- Stars: 7
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# microCMS Android SDK
It helps you to use microCMS from Android(Kotlin) applications.
Check [the official documentation](https://document.microcms.io/tutorial/android/android-top) for more information
## Getting Started
### Installation
The library is located in maven central.
```gradle
buildscript {
repositories {
mavenCentral() //need this line
}
}
```
Install dependency:
```gradle
dependencies {
implementation 'io.microcms:android-sdk:1.0.1'
}
```
And you need to get `android.permission.INTERNET` permission in the manifest:
```xml
```
### How to use
First, create a client.
```kotlin
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`) is a instance of [kotlin standard class](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/).
### Get content list
```kotlin
client.get(
"API_ENDPOINT"
) { result ->
result.onSuccess { json -> Log.d("microCMS example", json.getJSONArray("contents").toString(2)) }
}
```
### Get content list with parameters
```kotlin
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
```kotlin
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
```kotlin
client.get(
"API_ENDPOINT",
listOf(Fields("id")) //some params
) { result ->
result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}
```
### Create content
```kotlin
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
```kotlin
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
```kotlin
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
```kotlin
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
```kotlin
client.update(
"API_ENDPOINT",
null,
mapOf("message" to "Hello Android SDK!")
) { result ->
result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}
```
### Delete content
```kotlin
client.delete(
"API_ENDPOINT",
"CONTENT_ID")
{ result ->
result.onSuccess { json -> Log.d("microCMS example", json.getString("publishedAt")) }
}
```