In App Updater

Additional

Language
Java
Version
1.0.4-alpha.1 (Jul 29, 2019)
Created
Jul 16, 2019
Updated
Jul 31, 2019
Owner
Sanoj Punchihewa (SanojPunchihewa)
Contributors
dependabot-preview[bot]
Sanoj Punchihewa (SanojPunchihewa)
2
Activity
Badge
Generate
Download
Source code

Show card

InAppUpdater

Android Library to easily implement in-app updates

✏️ Usage

Step 1: Add it in your root build.gradle

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

Step 2: Add the dependency

dependencies {
    implementation 'com.github.SanojPunchihewa:InAppUpdater:1.0.4-alpha.1'
}

Step 3: Initialize the UpdateManager

Declare the UpdateManager in your Activity

    // Declare the UpdateManager
    UpdateManager mUpdateManager;

Initialize the UpdateManager in your onCreate method of the Activity

    // Initialize the Update Manager with the Activity and the Update Mode
    mUpdateManager = UpdateManager.Builder(this).mode(UpdateManagerConstant.FLEXIBLE).start();

Update Mode

There are two modes

  • Flexible(UpdateManagerConstant.FLEXIBLE) (default) - User can use the app during update download, installation and restart needs to be triggered by user

  • Immediate(UpdateManagerConstant.IMMEDIATE) - User will be blocked until download and installation is finished, restart is triggered automatically

Step 4: Resume the updates

Call continueUpdate method in your onResume method to install waiting updates

@Override
protected void onResume() {
    super.onResume();
    // Continue updates when resumed
    mUpdateManager.continueUpdate();
}

Additionally you can get the Available Version Code of the update. You can find these codes in the demo app

mUpdateManager.getAvailableVersionCode(new onVersionCheckListener() {
    @Override
    public void onReceiveVersionCode(final int code) {
        // Do something here
    }
});

🎥 Demo

Flexible Update Immediate Update

❗️ Troubleshoot

  • In-app updates works only with devices running Android 5.0 (API level 21) or higher
  • In-app updates are available only to user accounts that own the app. So, make sure the account you’re using has downloaded your app from Google Play at least once before using the account to test in-app updates.
  • Make sure that the app that you are testing in-app updates with has the same application ID and is signed with the same signing key as the one available from Google Play.
  • Because Google Play can only update an app to a higher version code, make sure the app you are testing as a lower version code than the update version code.

👐 Contributions

Any contributions are welcome!

📄 License

MIT License

Copyright (c) 2019 Sanoj Punchihewa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.