@rvuyyuru/react-native-inapp-update

react native inapp-update wrapper

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

You will need to test the app via Internal App Sharing

Use internal app sharing to test in-app updates by performing the following steps:

1. Make sure your test device has a version of your app installed that supports in-app updates and was installed using an internal app sharing URL.
2. Follow the Play Console instructions to share your app internally. Upload a version of your app that uses a version code that is higher than the one you already have installed on the test device.
3. On the test device, click the internal app sharing link for the updated version of your app but do not install the app from the Play Store page that appears after you click the link.
4. Open the app from the device's app drawer or home screen. The update should now be available to your app, and you can test your implementation of in-app updates.

Project Milestone

• [x] startUpdateFlow Basic implementation.
• [x] Implement event emitter for flexible in-app updates download progress and downloaded status.
• [x] 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 @rvuyyuru/react-native-inapp-update --save

or

$ yarn add @rvuyyuru/react-native-inapp-update

For [email protected] or above

As [email protected] or above supports autolinking, so there is no need to run linking process. Read more about autolinking here.

Mostly automatic installation

$ react-native link @rvuyyuru/react-native-inapp-update

Usage

import { startUpdateFlow } from '@rvuyyuru/react-native-inapp-update';
const updateModes = 'FLEXIABLE';

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. |

checkUpdateAvailability()

promise string checkUpdateAvailability()

Promise Resolve

| Value | Description | | ------------------ | ------------------------------- | | Update available | Application update is available |

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 |

onCompleteUpdate()

promise string onCompleteUpdate()

Promise Resolve

| Value | Description | | --------- | -------------------------- | | success | Application update succeed |

Promise Reject

| Value | Description | | --------------------------- | ------------------------------- | | Download is not completed | Application update process fail |

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Made with create-react-native-library