Applivery SDK: Integrate App Distribution and User Management

Current version: 4.8.0
Minimum Android version: Android 7.0 (API level 24)
Language: Kotlin
Distribution: Maven Central

Installation

Add the dependency to your App's build.gradle. The SDK is designed for non-production Builds:

// Use debugImplementation so Applivery only runs in debug/testing builds
debugImplementation("com.applivery:applivery-sdk:${latestVersion}")

No-op artifact for release Builds

To avoid a complex source set configuration for excluding the SDK from release Builds, use the no-op artifact. It exposes the same public API as the full SDK but does nothing at runtime:

releaseImplementation("com.applivery:applivery-sdk-no-op:${latestVersion}")

This lets you call Applivery SDK methods throughout your codebase without affecting release Builds.

Setup

Initialize the SDK in your Application.onCreate() method:

import com.applivery.android.sdk.Applivery
import com.applivery.android.sdk.start

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        Applivery.start(APPLIVERY_TOKEN)
        // For private Applivery instances, also pass the tenant:
        // Applivery.start(APPLIVERY_TOKEN, TENANT)
    }
}

Your App Token is available in App Settings → API Tokens in the Applivery dashboard.

Configuration

Pass a Configuration object to Applivery.start() to customize behavior:

val configuration = Configuration(
    postponeDurations = listOf(2.hours, 30.minutes, 5.minutes),
    enforceAuthentication = false,
    downloadAction = BuildDownloadAction.IMMEDIATE
)

Applivery.start(APPLIVERY_TOKEN, configuration = configuration)

Update Management

// Check for updates manually
Applivery.getInstance().checkForUpdates()

// Automatically check when app returns from background
Applivery.getInstance().setCheckForUpdatesBackground(true)

// Download the latest update without installing immediately
val callback = object : DownloadLastUpdateCallback {
    override fun onSuccess(update: CachedAppUpdate) {
        update.install() // install when ready
    }
    override fun onError(error: Throwable) { /* handle error */ }
}
Applivery.getInstance().downloadLastUpdate(callback)

// Enable background auto-download
Applivery.getInstance().enableDownloadLastUpdateBackground(callback)

// Trigger immediate download + install (follows configured downloadAction)
Applivery.getInstance().update()

Feedback

// Enable/disable screenshot-triggered feedback
Applivery.getInstance().enableScreenshotFeedback()
Applivery.getInstance().disableScreenshotFeedback()

// Show feedback UI programmatically
Applivery.getInstance().feedbackEvent()

User Management

// Bind a user for analytics and feedback tracking
Applivery.getInstance().bindUser(email, firstName, lastName, tags)

// Remove the bound user
Applivery.getInstance().unbindUser()

// Get current user
Applivery.getInstance().getUser(getUserCallback)

Required Permissions

The SDK requires the following runtime permissions. Request them in your App before the features that need them are used:

UI Customization

Create a res/values/applivery.xml file to override default colors and strings:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <color name="applivery_primary_color">#FF0241E3</color>
    <color name="applivery_accent_color">#FF0241E3</color>
    <color name="applivery_foreground_color">#FF010258</color>

    <string name="appliveryUpdateMsg">A new version is available. Update now?</string>
    <string name="appliveryMustUpdateAppLocked">This version is outdated. Please update to continue.</string>
</resources>