OnLaunch Android Client

_{Created and maintained by kula.app and all the amazing contributors.}

OnLaunch is a service allowing app developers to notify app users about updates, warnings and maintenance Our open-source framework provides an easy-to-integrate client to communicate with the backend and display the user interface.

Features

• Display customizable messages to your app users
• Set your app into maintenance mode with blocking messages
• Easy to integrate

Installation

repositories {
    mavenCentral()
}

dependencies {
    implementation("app.kula:onlaunch-android-client:0.0.6")
}

Usage

1. Initialize OnLaunch:

OnLaunch.init(this) {
    publicKey = "<YOUR PUBLIC APP KEY>"
}

2. Optionally manually check for new messages (e.g. in onResume):

override fun onResume() {
    super.onResume()
    OnLaunch.check(this)
}

Options

The OnLaunch Android client provides a couple of configuration options:

Name	Description	Default
publicKey	Public key used to authenticate with the API
baseUrl	Base URL where the OnLaunch API is hosted at. Change this to point to your self-hosted instance of the OnLaunch server.	https://onlaunch.kula.app/api/
shouldCheckOnInit	Flag indicating if the client should check for new messages immediately after it has been initialized.	true

Contributing Guide

Please see our Contributing Guide .

License

Distributed under the MIT License