From a3063aed68b270a63323b366568da317c4ae094a Mon Sep 17 00:00:00 2001 From: Nathan Kerr Date: Wed, 31 Jul 2019 18:48:02 +0000 Subject: [PATCH] Add information about battery optimizations --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index cab5ae0..1b04cba 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,14 @@ cordova.plugins.backgroundMode.wakeUp(); cordova.plugins.backgroundMode.unlock(); ``` +### Request to disable battery optimizations +Starting in Android 8, apps can be put to sleep to conserve battery. When this happens (usually after 5 minutes or so), the background task is killed. This will cause things like MQTT connections to break. +This method will show a permission prompt for the user (only if the app hasn't been granted permission) to ignore the optimization. + +```js +cordova.plugins.backgroundMode.disableWebViewOptimizations(); +``` + ### Notification To indicate that the app is executing tasks in background and being paused would disrupt the user, the plug-in has to create a notification while in background - like a download progress bar.