README

react-native-android-inapp-updates

React Native implementation of the Android In-App Update API. For more information on InApp Updates you can check the official documentation.

Build with ReasonML. This project is still on beta.

Project Milestone

startUpdateFlow Basic implementation.
Implement event emitter for flexible in-app updates download progress and downloaded status.
Implement clientVersionStalenessDays check for startUpdateFlow.

Requirements

In-app updates works only with devices running Android 5.0 (API level 21) or higher.
In-app updates can only work when signed with the same signing key as your app on the play store.

Getting started

$ npm install react-native-android-inapp-updates --save

$ yarn add react-native-android-inapp-updates

For react-native@0.60.0 or above

As react-native@0.60.0 or above supports autolinking, so there is no need to run linking process. Read more about autolinking here.

Mostly automatic installation

$ react-native link react-native-android-inapp-updates

Usage

import {startUpdateFlow} from 'react-native-android-inapp-updates';
const updateModes = 'flexible';

try {
    const result = await startUpdateFlow(updateModes);
} catch (e) {
    console.log('error:', e);
}

Reference

Methods

startUpdateFlow()

promise string startUpdateFlow(appUpdateType,clientVersionStalenessDays)

Input | Input | Description | Type | Default Value | ------------- | ------------- | ------------- | ------------- | | appUpdateType | Android In-app updates type | enum(flexible or immediate) | immediate | | clientVersionStalenessDays | If an update is available In-app modal will only triger after x number of days since the Google Play Store app on the user's device has learnt about an available update. | int | 0 |

Promise Resolve | Value | Description
| ------------- | -------------
| Canceled | In-app modal canceled by user | Successful | User press the update button

Promise Reject | Value | Description
| ------------- | -------------
| checkAppUpdate failure: | appUpdateInfoTask failed getting result. This can mean numerous reason check the log for more explanation. | No update available: | There is no update available with the appUpdateType type.
| startUpdateFlow failure: | Failed starting the Google Play In-app updates modal.

❤️ From Indonesia

Usage no npm install needed!