Events

Signals that Cordova's device APIs have loaded and are ready to access.

pause +

Signals that application is put into the background. Typically when screen is being locked or when user switches to a different application.

resume +

Signals that application is retrieved from the background.

+ +

Table: Button Press Events
Event	Button name
backbutton	Back button
menubutton	Menu button
searchbutton	Search button
startcallbutton	Start call button
endcallbutton	End call button
volumedownbutton	Volume down button
volumeupbutton	Volume up button

Table: Button Press Events

Event

Button name

backbutton

Back button

menubutton

Menu button

searchbutton

Search button

startcallbutton

Start call button

endcallbutton

End call button

volumedownbutton

Volume down button

volumeupbutton

Volume up button

Adding event listeners

Applications typically should use document.addEventListener() to attach an event listener once the deviceready event fires. +This means adding event listeners for events like pause, resume, backbutton, etc. during or after deviceready event handler.

Example:

+document.addEventListener("deviceready", onDeviceReady, false); + +function onDeviceReady() { + document.addEventListener("pause", onPause); + document.addEventListener("volumeupbutton", onVolumeUp); +} + +function onPause() { + console.log("Application has been put into the background"); +} + +function onVolumeUp() { + console.log("Volume up button pressed"); +} + +

+ +

Events: events provided by Cordova for use in Web API applications

+ +

This tutorial demonstrates how you can register and use custom listeners for events like deviceready, pause, resume, and button press events.

+ +

Waiting for deviceready event

This event signals that Cordova's device APIs have loaded and are ready to access. You should wait until this event is fired, and after that you +can start using Cordova features.

+ +

Prepare handler for the event:

function onDeviceReady() {
+  // Now safe to use Cordova
+}
+

Add event listener:

document.addEventListener('deviceready', onDeviceReady);

Alternatively you can add deviceready event listener in <body> onload hadler, for example:

window.onload = function() {
+    document.addEventListener("deviceready", onDeviceReady);
+};

+ +

Pause and resume events

We will add event listeners for pause and resume events.

Pause signals that application is put into the background. Typically when screen is being locked or when user switches to a different application. Resume signals tha native platform pulls the application out from the background.

+ +

Prepare our event handlers for pause and resume events.

+function onPause() {
+    console.log("Application paused");
+}
+
+function onResume() {
+    console.log("Application resumed");
+}

Add event listeners in deviceready event handler (see onDeviceReady above).

document.addEventListener("pause", onPause);
+document.addEventListener("resume", onResume);

+ +

Button press events

We will add event listeners for menu, volume up and volume down buttons. Each event is triggered when corresponding button is pressed.

+ +

Prepare our event handlers for menubutton, volumeupbutton, and volumeupbutton events.

+function onVolumeChanged() {
+    console.log("Volume changed");
+}
+
+function onMenuButton() {
+    console.log("Menu button pressed");
+}

In deviceready event handler (see onDeviceReady above) add listeners. For this example will use one listener for both volume up and down buttons.

document.addEventListener("menubutton", onMenuButton);
+document.addEventListener("volumeupbutton", onVolumeChanged);
+document.addEventListener("volumedownbutton", onVolumeChanged);

Now press buttons and see results in system console.

+ + + + +