Integrating Updraft Android SDK

Updraft Android Open Source SDK is a Framework to support getupdraft.com mobile app distribution for Android Apps. The SDK includes a graphical feedback & bug reporter and automatic app updates.

Github

Requirements

  • minSdkVersion >=19

Installation

Add the repository into your top-level build.gradle file:

allproject {
    repositories {
        mavenCentral()
    }
}

Add this line to your dependencies in app-level build.gradle file:

dependencies {
    implementation 'com.appswithlove.updraft:updraft-sdk:1.0.7'
}

Setup

    @Override
    public void onCreate() {
        super.onCreate();
        Settings settings = new Settings();
        settings.setAppKey(YOUR_APP_KEY);
        settings.setSdkKey(YOUR_SDK_KEY);
        //Should app be in store
        settings.setStoreRelease(false);
        //Optional base url for updraft
        settings.setBaseUrl(Settings.BASE_URL_STAGING);
        //Optional set log level
        settings.setLogLevel(Settings.LOG_LEVEL_DEBUG);
        //Optional set if should show start alert
        settings.setShowStartAlert(false);
        Updraft.initialize(this, settings);
        Updraft.getInstance().start();
    }
}

Parameters

  • YOUR_SDK_KEY: Your sdk key obtained on Updraft

  • YOUR_APP_KEY: You app key obtained on Updraft

Auto Update

Auto Update functionality can be enabled/disabled on getupdraft.com in your app settings.

AutoUpdate work by comparing the build number of the app installed on the user's device and the app uploaded on GetUpdraft.

A prompt is displayed to the user if his installed version is lower than the version on Updraft. Thus, the build number must be incremented for each new build release to trigger the auto-update process.

Micro version comparison is supported, for example version 1.2.3.20180804 is greater than version 1.2.3.20180803

Feedback & Bug Reporting

Feedback functionality can be enabled/disabled on getupdraft.com in your app edit menu.

A prompt is shown to the user to inform him of the change of state of the feedback functionality.

If enabled, the user is explained how he can give feedback. User can take a screenshot to give a feedback.

Advanced setup: Logging

To check if data is send properly to Updraft and also see some additional SDK log data in the console, you can set different log levels.

To change the log level, add the following line before starting the SDK:

    settings.setLogLevel(Settings.LOG_LEVEL_DEBUG);

Default level: LOG_LEVEL_ERROR => Only warnings and errors will be printed.

Last updated