diff --git a/README.md b/README.md index 2c8187d..1dd8565 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ ## BackgroundTask -[Call a nanoflow when app is in background] +Call a nanoflow when app is in background based on the BackgroundFetch API for Android and iOS. ## Features -[feature highlights] +Background Fetch is a *very* simple plugin which attempts to awaken an app in the background about **every 15 minutes**, providing a short period of background running-time. + +This widget is build to incorporate the https://github.com/transistorsoft/react-native-background-fetch into Mendix Native apps +### iOS +- There is **no way** to increase the rate which a fetch-event occurs and this plugin sets the rate to the most frequent possible — you will **never** receive an event faster than **15 minutes**. The operating-system will automatically throttle the rate the background-fetch events occur based upon usage patterns. Eg: if user hasn't turned on their phone for a long period of time, fetch events will occur less frequently. +- [__`scheduleTask`__](#executing-custom-tasks) seems only to fire when the device is plugged into power. +- ⚠️ When your app is **terminated**, iOS *no longer fires events* — There is *no such thing* as **`stopOnTerminate: false`** for iOS. +- iOS can take *days* before Apple's machine-learning algorithm settles in and begins regularly firing events. Do not sit staring at your logs waiting for an event to fire. If your [*simulated events*](#debugging) work, that's all you need to know that everything is correctly configured. +- If the user doesn't open your *iOS* app for long periods of time, *iOS* will **stop firing events**. + +### Android +- The Android plugin provides a [HeadlessJS](https://facebook.github.io/react-native/docs/headless-js-android.html) implementation allowing you to continue handling events even after app-termination (see **[`@config enableHeadless`](#config-boolean-enableheadless-false)**) ## Usage - Clone this Git