Github/cordova-plugin-run-in-background
1
0
Fork 1
mirror of https://bitbucket.org/TheBosZ/cordova-plugin-run-in-background synced 2025-12-13 09:53:22 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'master' into master

Browse Source
This commit is contained in:
Nathan
2019-03-01 15:01:05 -08:00
committed by GitHub
parent 79e8150d3e 0e95173de0
commit 949a9e721c
7 changed files with 365 additions and 226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

236
www/background-mode.js
View File

@@ -22,11 +22,6 @@
var exec = require('cordova/exec'),
channel = require('cordova/channel');
/*************
* INTERFACE *
*************/
/**
* Activates the background mode. When activated the application
* will be prevented from going to sleep while in background
@@ -34,14 +29,15 @@ var exec = require('cordova/exec'),
*
* @return [ Void ]
*/
exports.enable = function() {
exports.enable = function()
{
if (this.isEnabled())
return;
var fn = function() {
exports._isEnabled = true;
exports.fireEvent('enable');
};
exports._isEnabled = true;
exports.fireEvent('enable');
};
cordova.exec(fn, null, 'BackgroundMode', 'enable', []);
};
@@ -52,14 +48,15 @@ exports.enable = function() {
*
* @return [ Void ]
*/
exports.disable = function() {
exports.disable = function()
{
if (!this.isEnabled())
return;
var fn = function() {
exports._isEnabled = false;
exports.fireEvent('disable');
};
exports._isEnabled = false;
exports.fireEvent('disable');
};
cordova.exec(fn, null, 'BackgroundMode', 'disable', []);
};
@@ -71,7 +68,8 @@ exports.disable = function() {
*
* @return [ Void ]
*/
exports.setEnabled = function (enable) {
exports.setEnabled = function (enable)
{
if (enable) {
this.enable();
} else {
@@ -84,7 +82,8 @@ exports.setEnabled = function (enable) {
*
* @return [ Object ]
*/
exports.getDefaults = function() {
exports.getDefaults = function()
{
return this._defaults;
};
@@ -93,7 +92,8 @@ exports.getDefaults = function() {
*
* @return [ Object ]
*/
exports.getSettings = function() {
exports.getSettings = function()
{
return this._settings || {};
};
@@ -104,16 +104,20 @@ exports.getSettings = function() {
*
* @return [ Void ]
*/
exports.setDefaults = function (overrides) {
exports.setDefaults = function (overrides)
{
var defaults = this.getDefaults();
for (var key in defaults) {
if (overrides.hasOwnProperty(key)) {
for (var key in defaults)
{
if (overrides.hasOwnProperty(key))
{
defaults[key] = overrides[key];
}
}
if (this._isAndroid) {
if (this._isAndroid)
{
cordova.exec(null, null, 'BackgroundMode', 'configure', [defaults, false]);
}
};
@@ -126,14 +130,16 @@ exports.setDefaults = function (overrides) {
*
* @return [ Void ]
*/
exports.configure = function (options) {
exports.configure = function (options)
{
var settings = this.getSettings(),
defaults = this.getDefaults();
if (!this._isAndroid)
return;
if (!this._isActive) {
if (!this._isActive)
{
console.log('BackgroundMode is not active, skipped...');
return;
}
@@ -150,9 +156,41 @@ exports.configure = function (options) {
*
* @return [ Void ]
*/
exports.disableWebViewOptimizations = function() {
if (this._isAndroid) {
cordova.exec(null, null, 'BackgroundMode', 'optimizations', []);
exports.disableWebViewOptimizations = function()
{
if (this._isAndroid)
{
cordova.exec(null, null, 'BackgroundModeExt', 'webview', []);
}
};
/**
* Disables battery optimazation mode for the app.
*
* @return [ Void ]
*/
exports.disableBatteryOptimizations = function()
{
if (this._isAndroid)
{
cordova.exec(null, null, 'BackgroundModeExt', 'battery', []);
}
};
/**
* Opens the system settings dialog where the user can tweak or turn off any
* custom app start settings added by the manufacturer if available.
*
* @param [ Object|Bool ] options Set to false if you dont want to display an
* alert dialog first.
*
* @return [ Void ]
*/
exports.openAppStartSettings = function (options)
{
if (this._isAndroid)
{
cordova.exec(null, null, 'BackgroundModeExt', 'appstart', [options]);
}
};
@@ -161,9 +199,11 @@ exports.disableWebViewOptimizations = function() {
*
* @return [ Void ]
*/
exports.moveToBackground = function() {
if (this._isAndroid) {
cordova.exec(null, null, 'BackgroundMode', 'background', []);
exports.moveToBackground = function()
{
if (this._isAndroid)
{
cordova.exec(null, null, 'BackgroundModeExt', 'background', []);
}
};
@@ -172,9 +212,11 @@ exports.moveToBackground = function() {
*
* @return [ Void ]
*/
exports.moveToForeground = function() {
if (this.isActive() && this._isAndroid) {
cordova.exec(null, null, 'BackgroundMode', 'foreground', []);
exports.moveToForeground = function()
{
if (this.isActive() && this._isAndroid)
{
cordova.exec(null, null, 'BackgroundModeExt', 'foreground', []);
}
};
@@ -183,9 +225,11 @@ exports.moveToForeground = function() {
*
* @return [ Void ]
*/
exports.excludeFromTaskList = function() {
if (this._isAndroid) {
cordova.exec(null, null, 'BackgroundMode', 'tasklist', []);
exports.excludeFromTaskList = function()
{
if (this._isAndroid)
{
cordova.exec(null, null, 'BackgroundModeExt', 'tasklist', []);
}
};
@@ -195,7 +239,8 @@ exports.excludeFromTaskList = function() {
*
* @return [ Void ]
*/
exports.overrideBackButton = function() {
exports.overrideBackButton = function()
{
document.addEventListener('backbutton', function() {
exports.moveToBackground();
}, false);
@@ -208,10 +253,14 @@ exports.overrideBackButton = function() {
*
* @return [ Void ]
*/
exports.isScreenOff = function (fn) {
if (this._isAndroid) {
cordova.exec(fn, null, 'BackgroundMode', 'dimmed', []);
} else {
exports.isScreenOff = function (fn)
{
if (this._isAndroid)
{
cordova.exec(fn, null, 'BackgroundModeExt', 'dimmed', []);
}
else
{
fn(undefined);
}
};
@@ -221,9 +270,11 @@ exports.isScreenOff = function (fn) {
*
* @return [ Void ]
*/
exports.wakeUp = function() {
if (this._isAndroid) {
cordova.exec(null, null, 'BackgroundMode', 'wakeup', []);
exports.wakeUp = function()
{
if (this._isAndroid)
{
cordova.exec(null, null, 'BackgroundModeExt', 'wakeup', []);
}
};
@@ -232,9 +283,11 @@ exports.wakeUp = function() {
*
* @return [ Void ]
*/
exports.unlock = function() {
if (this._isAndroid) {
cordova.exec(null, null, 'BackgroundMode', 'unlock', []);
exports.unlock = function()
{
if (this._isAndroid)
{
cordova.exec(null, null, 'BackgroundModeExt', 'unlock', []);
}
};
@@ -243,7 +296,8 @@ exports.unlock = function() {
*
* @return [ Boolean ]
*/
exports.isEnabled = function() {
exports.isEnabled = function()
{
return this._isEnabled !== false;
};
@@ -252,15 +306,11 @@ exports.isEnabled = function() {
*
* @return [ Boolean ]
*/
exports.isActive = function() {
exports.isActive = function()
{
return this._isActive !== false;
};
/**********
* EVENTS *
**********/
exports._listener = {};
/**
@@ -271,14 +321,16 @@ exports._listener = {};
*
* @return [ Void ]
*/
exports.fireEvent = function (event) {
exports.fireEvent = function (event)
{
var args = Array.apply(null, arguments).slice(1),
listener = this._listener[event];
if (!listener)
return;
for (var i = 0; i < listener.length; i++) {
for (var i = 0; i < listener.length; i++)
{
var fn = listener[i][0],
scope = listener[i][1];
@@ -295,12 +347,13 @@ exports.fireEvent = function (event) {
*
* @return [ Void ]
*/
exports.on = function (event, callback, scope) {
exports.on = function (event, callback, scope)
{
if (typeof callback !== "function")
return;
if (!this._listener[event]) {
if (!this._listener[event])
{
this._listener[event] = [];
}
@@ -317,51 +370,25 @@ exports.on = function (event, callback, scope) {
*
* @return [ Void ]
*/
exports.un = function (event, callback) {
exports.un = function (event, callback)
{
var listener = this._listener[event];
if (!listener)
return;
for (var i = 0; i < listener.length; i++) {
for (var i = 0; i < listener.length; i++)
{
var fn = listener[i][0];
if (fn == callback) {
if (fn == callback)
{
listener.splice(i, 1);
break;
}
}
};
/**
* @deprecated
*
* Called when the background mode has been activated.
*/
exports.onactivate = function() {};
/**
* @deprecated
*
* Called when the background mode has been deaktivated.
*/
exports.ondeactivate = function() {};
/**
* @deprecated
*
* Called when the background mode could not been activated.
*
* @param {Integer} errorCode
* Error code which describes the error
*/
exports.onfailure = function() {};
/***********
* PRIVATE *
***********/
/**
* @private
*
@@ -381,6 +408,7 @@ exports._isActive = false;
*
* Default values of all available options.
*/
exports._defaults = {
title: 'App is running in background',
text: 'Doing heavy tasks.',
@@ -409,9 +437,12 @@ exports._defaults = {
*
* @return [ Object ] Default values merged with custom values.
*/
exports._mergeObjects = function (options, toMergeIn) {
for (var key in toMergeIn) {
if (!options.hasOwnProperty(key)) {
exports._mergeObjects = function (options, toMergeIn)
{
for (var key in toMergeIn)
{
if (!options.hasOwnProperty(key))
{
options[key] = toMergeIn[key];
continue;
}
@@ -430,7 +461,8 @@ exports._mergeObjects = function (options, toMergeIn) {
*
* @return [ Void ]
*/
exports._setActive = function(value) {
exports._setActive = function(value)
{
if (this._isActive == value)
return;
@@ -448,11 +480,13 @@ exports._setActive = function(value) {
*
* @return [ Void ]
*/
exports._pluginInitialize = function() {
exports._pluginInitialize = function()
{
this._isAndroid = device.platform.match(/^android|amazon/i) !== null;
this.setDefaults({});
if (device.platform == 'browser') {
if (device.platform == 'browser')
{
this.enable();
this._isEnabled = true;
}
@@ -461,19 +495,23 @@ exports._pluginInitialize = function() {
};
// Called before 'deviceready' listener will be called
channel.onCordovaReady.subscribe(function() {
channel.onCordovaReady.subscribe(function()
{
channel.onCordovaInfoReady.subscribe(function() {
exports._pluginInitialize();
});
});
// Called after 'deviceready' event
channel.deviceready.subscribe(function() {
if (exports.isEnabled()) {
channel.deviceready.subscribe(function()
{
if (exports.isEnabled())
{
exports.fireEvent('enable');
}
if (exports.isActive()) {
if (exports.isActive())
{
exports.fireEvent('activate');
}
});