Repository files navigation

Android Library that checks for updates on Google Play, GitHub, Amazon, F-Droid or your own server. This library notifies your apps' updates by showing a Material dialog, Snackbar or notification. Check out thewiki.

You can download the latest sample APK from Google Play:

Add the repository to your projectbuild.gradle:

repositories {    maven {        url"https://jitpack.io"    }}

And add the library to your modulebuild.gradle:

dependencies {    implementation'com.github.javiersantos:AppUpdater:2.7'}

By default, the basic usage will show a default dialog when a new version is found on the Play Store (otherwise nothing will be shown). By calling the.start() method, the library will work in background. You can cancel it at any time by calling.stop(). Other customizations are explained below.

AppUpdaterappUpdater =newAppUpdater(this);appUpdater.start();

AppUpdaterappUpdater =newAppUpdater(getActivity());appUpdater.start();

The default usage is configured to display a dialog. However, there are other ways to show the update notice.

newAppUpdater(this).setDisplay(Display.SNACKBAR).setDisplay(Display.DIALOG).setDisplay(Display.NOTIFICATION)...

When usingDisplay.DIALOG, you can make the dialog dismissable when touching outside by using.setCancelable(false) (enabled by default).

When usingDisplay.SNACKBAR, you can change the duration by using.setDuration(Duration.NORMAL) (default) or.setDuration(Duration.INDEFINITE).

By default the library will check for updates on the Play Store. However, there are other alternatives, such as GitHub, Amazon, F-Droid or using your own server.

newAppUpdater(this).setUpdateFrom(UpdateFrom.GITHUB).setUpdateFrom(UpdateFrom.GOOGLE_PLAY).setUpdateFrom(UpdateFrom.AMAZON).setUpdateFrom(UpdateFrom.FDROID).setUpdateFrom(UpdateFrom.XML).setUpdateFrom(UpdateFrom.JSON)...

When using GitHub you must provide the repo where the library will check for updates:.setGitHubUserAndRepo("javiersantos", "AppUpdater"). Check out thewiki for more details.

When using the XML source you must upload a .xml file somewhere on the Internet following the structure explained in thewiki and add the URL as shown in this example:.setUpdateXML("https://raw.githubusercontent.com/javiersantos/AppUpdater/master/app/update-changelog.xml").

When using the JSON source you must upload a .json file somewhere on the Internet following the structure explained in thewiki and add the URL as shown in this example:.setUpdateJSON("https://raw.githubusercontent.com/javiersantos/AppUpdater/master/app/update-changelog.json").

A detailed description with examples is available at:https://github.com/javiersantos/AppUpdater/wiki

By default, a dialog/Snackbar/notification will be shown whenever a new version is found. However, this can be set to show only every X times that the app ascertains that a new update is available.

newAppUpdater(this).showEvery(5)...

You can also show the dialog, Snackbar or notification although there aren't updates by using.showAppUpdated(true) (disabled by default).

newAppUpdater(this).setTitleOnUpdateAvailable("Update available").setContentOnUpdateAvailable("Check out the latest version available of my app!").setTitleOnUpdateNotAvailable("Update not available").setContentOnUpdateNotAvailable("No update available. Check for updates again later!").setButtonUpdate("Update now?").setButtonUpdateClickListener(...).setButtonDismiss("Maybe later").setButtonDismissClickListener(...).setButtonDoNotShowAgain("Huh, not interested").setButtonDoNotShowAgainClickListener(...).setIcon(R.drawable.ic_update)// Notification icon.setCancelable(false)// Dialog could not be dismissable...

By default, the "Don't show again" button will be displayed. Use.setButtonDoNotShowAgain(null) to hide the button.

The AppUpdaterUtils class works in the same way that the AppUpdater class does, but it won't display any dialog, Snackbar or notification. When using the AppUpdaterUtils class you must provide a custom callback that will be called when the latest version has been checked.

Adding a callback to the builder allows you to customize what will happen when the latest update has been checked. Keep in mind that when using this method you must be aware of displaying any dialog, snackbar or whatever you want to let the user know that there is a new update available.

AppUpdaterUtilsappUpdaterUtils =newAppUpdaterUtils(this)//.setUpdateFrom(UpdateFrom.AMAZON)//.setUpdateFrom(UpdateFrom.GITHUB)//.setGitHubUserAndRepo("javiersantos", "AppUpdater")//...    .withListener(newAppUpdaterUtils.UpdateListener() {@OverridepublicvoidonSuccess(Updateupdate,BooleanisUpdateAvailable) {Log.d("Latest Version",update.getLatestVersion());Log.d("Latest Version Code",update.getLatestVersionCode());Log.d("Release notes",update.getReleaseNotes());Log.d("URL",update.getUrlToDownload());Log.d("Is update available?",Boolean.toString(isUpdateAvailable));        }@OverridepublicvoidonFailed(AppUpdaterErrorerror) {Log.d("AppUpdater Error","Something went wrong");        }     });appUpdaterUtils.start();

Copyright 2016 Javier SantosLicensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at   http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.