Cordova BackgroundMode-Plugin

A bunch of background mode plugins for Cordova 3.x.x

by Sebastián Katzer (github.com/katzer)

Supported Platforms

iOS (>=5)

Adding the Plugin to your project

Through the Command-line Interface:

cordova plugin add https://github.com/katzer/cordova-plugin-background-mode.git

Removing the Plugin from your project

Through the Command-line Interface:

cordova plugin rm de.appplant.cordova.plugin.background-mode

Release Notes

Version 0.2.1 (09.10.2013)

Added js interface to manually enable/disable the background mode.

Version 0.2.0 (08.10.2013)

Added iOS (>= 5) support
The plugin turns the app into an location tracking app for the time it runs in the background.

Using the plugin

Simply add the plugin to your project and the app will run while in background.

The plugin creates the object window.plugin.notification.backgroundMode with two methods:

enable()

The method enables the background mode. The mode is activated once the app has entered the background and will be deactivated after the app has entered the foreground.
Please be aware, to activate the background mode the app needs to be in foreground.

iOS 5-6
The app still runs in background, even if the location service is not active.

iOS 7
The location service needs to be enabled.

/**
 * Enables the background mode. The app will not pause while in background.
 */
window.plugin.backgroundMode.enable();

disable()

The method disables the background mode. If the mode is disabled while the app is running in the background, the app will be paused immediately.

/**
 * Disables the background mode. The app will pause in background as usual.
 */
window.plugin.backgroundMode.disable();

Quirks

The app crashes under iOS

If the app crashes after installing the plugin, make sure that your *-Info.plist is valid. Do to some bugs in cordova or Plugman please reset all occurences like

<key>NSMainNibFile</key>
<string>

</string>

<key>NSMainNibFile</key>
<string></string>

2.3 KiB Raw Blame History