- Overview
- The Command-line Interface
- Platform Guides
- Configuration Reference
- Embedding WebViews
- Plugin Development Guide
- Privacy Guide
- Domain Whitelist Guide
- Accelerometer
- Camera
- Capture
- Compass
- Connection
- Contacts
- Device
- Events
- File
- Geolocation
- Globalization
- InAppBrowser
- Media
- Notification
- Splashscreen
- Storage
This version of the documentation is outdated!
Click here for the latest released version.
Events
Cordova lifecycle events.
Event Types
- deviceready
- pause
- resume
- online
- offline
- backbutton
- batterycritical
- batterylow
- batterystatus
- menubutton
- searchbutton
- startcallbutton
- endcallbutton
- volumedownbutton
- volumeupbutton
Accessing the Feature
As of version 3.0, Cordova implements battery status and other
device-level APIs as plugins. Access to all other events not related
to battery status are enabled by default. Use the CLI's plugin
command, described in The Command-line Interface, to enable or disable
battery events:
$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
$ cordova plugin rm org.apache.cordova.core.battery-status
These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:
-
Android
(in app/res/xml/config.xml) <feature name="Battery"> <param name="android-package" value="org.apache.cordova.BatteryListener" /> </feature> (in app/AndroidManifest.xml) <uses-permission android:name="android.permission.BROADCAST_STICKY" />
-
BlackBerry WebWorks
(in www/plugins.xml) <feature name="Battery"> <param name="blackberry-package" value="org.apache.cordova.battery.Battery" /> </feature> (in www/config.xml) <feature id="blackberry.app" required="true" version="1.0.0.0" /> <feature id="blackberry.app.event" required="true" version="1.0.0.0" /> <feature id="blackberry.system.event" required="true" version="1.0.0.0" />
-
iOS (in
config.xml
)<feature name="Battery"> <param name="ios-package" value="CDVBattery" /> </feature>
-
Tizen (in
config.xml
)<feature name="http://tizen.org/api/systeminfo" required="true"/>
Some platforms may support this feature without requiring any special configuration. See Platform Support for an overview.