Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ingresse/android-sdk
Ingresse Android SDK
https://github.com/ingresse/android-sdk
android kotlin mobile sdk
Last synced: 2 months ago
JSON representation
Ingresse Android SDK
- Host: GitHub
- URL: https://github.com/ingresse/android-sdk
- Owner: ingresse
- Created: 2019-01-11T12:43:31.000Z (about 6 years ago)
- Default Branch: dev
- Last Pushed: 2024-08-21T00:40:35.000Z (6 months ago)
- Last Synced: 2024-08-22T01:19:51.800Z (6 months ago)
- Topics: android, kotlin, mobile, sdk
- Language: Kotlin
- Size: 1.31 MB
- Stars: 3
- Watchers: 9
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ingresse Android SDK 
## [ :gear: ] Installation guide
### For production use:
- **Root _build.gradle_ at the end of repositories:**
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
- **Add the dependency**
```gradle
dependencies {
implementation 'com.github.ingresse:android-sdk:'
}
```
## [ :electric_plug: ] Usage guide (V2)
#### With plain functions inside repository
```kotlin
val service = ServiceManager.service.v2.search
fun getEvents() {
val request = SearchEvents(state = "sp")
viewModelScope.launch {
kotlin.runCatching {
service.getSearchedEventsPlain(request)
}.onSuccess { data ->
// TODO
}.onFailure { exception ->
// TODO
}
}
}
```
#### With `Result` functions inside repository
```kotlin
val service = ServiceManager.service.v2.search
fun getEvents() {
val request = SearchEvents(state = "sp")
viewModelScope.launch {
val result = service.getSearchedEvents(request = request)
result.onSuccess { data ->
// TODO
}.onError { code, throwable ->
// TODO
}.connectionError {
// TODO
}.onTokenExpired {
// TODO
}
}
}
```
___
### :hammer_and_wrench: For developing use:
#### Using a jitpack snapshot:
```gradle
ext {
ingresse_sdk_version = "feature~my-new-feature-SNAPSHOT"
}
dependencies {
implementation "com.github.ingresse:android-sdk:$ingresse_sdk_version"
}
```
#### Using local ingresse-sdk repository:
- **Set local path in _settings.gradle_**
```gradle
include ':sdk'
project(':sdk').projectDir = new File(settingsDir, '../android-sdk/sdk')
```
- **Add the dependency**
```gradle
dependencies {
implementation project(':sdk')
}
```