Data4Life Result SDK
This is the Result SDK which provides unified result types and base errors for other SDK's.
Table Of Contents
About The Project
This is the Result SDK which provides unified result types and errors for other SDK’s.
Features
Results
-
D4LSDKFlow
Errors
-
D4LRuntimeException
-
D4LException
Built With
Getting Started
Requirements
-
Java 11 | Limitations of Java language features and APIs | Desugaring
-
Android 6.0 (API 23) to Android 11.0 (API 30)
Installation
Add the following maven repository url to your root build.gradle:
allprojects { repositories { ... maven { url = URI("https://maven.pkg.github.com/d4l-data4life/hc-result-sdk-kmp") credentials { username = project.findProperty("gpr.user") as String? ?: System.getenv("PACKAGE_REGISTRY_USERNAME") password = project.findProperty("gpr.key") as String? ?: System.getenv("PACKAGE_REGISTRY_TOKEN") } } } }
Your GitHub username and token needs to be stored in your global Gradle properties: ~/.gradle/gradle.properties
- NOTICE
-
You need to have read access to this repository and generate a personal access token with
repo
,write:packages
andread:packages
scope.
gpr.user=github-username gpr.key=github-token
Flow
Add following dependencies to your app build.gradle.
dependencies { implementation "care.data4life.hc-result-sdk-kmp:flow:$version" }
Error
Add following dependencies to your app build.gradle.
dependencies { implementation "care.data4life.hc-result-sdk-kmp:error:$version" }
Roadmap
This project is work in progress. We are working on adding more functionality, guidelines, documentation and other improvements.
Changelog
See changelog
Versioning
We use Semantic Versioning as a guideline for our versioning.
Releases use this format: {major}.{minor}.{patch}
-
Breaking changes bump
{major}
and reset{minor}
&{patch}
-
Backward compatible changes bump
{minor}
and reset{patch}
-
Bug fixes bump
{patch}
Contributing
You want to help or share a proposal? You have a specific problem? Read the following:
-
Code of conduct for details on our code of conduct.
-
Contributing for details about how to report bugs and propose features.
-
Developing for details about our development process and how to build and test the project.
Copyright and License
Copyright (c) 2021 D4L data4life gGmbH / All rights reserved. Please refer to our License for further details.