You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/12/18 16:40:09 UTC
svn commit: r1551982 [3/18] - in /cordova/site/public/docs/en: 3.0.0/ 3.3.0/
edge/
Modified: cordova/site/public/docs/en/3.3.0/cordova_events_events.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/cordova_events_events.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/cordova_events_events.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/cordova_events_events.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>Events</h1>
@@ -234,7 +231,9 @@
<p>Cordova lifecycle events.</p>
</blockquote>
-<h2><a name="Events_event_types">Event Types</a></h2>
+<h2>
+<a name="Events_event_types">Event Types</a>
+</h2>
<ul>
<li><a href="cordova_events_events.md.html#deviceready">deviceready</a></li>
@@ -253,8 +252,9 @@
<li><a href="cordova_events_events.md.html#volumedownbutton">volumedownbutton</a></li>
<li><a href="cordova_events_events.md.html#volumeupbutton">volumeupbutton</a></li>
</ul>
-
-<h2><a name="Events_accessing_the_feature">Accessing the Feature</a></h2>
+<h2>
+<a name="Events_accessing_the_feature">Accessing the Feature</a>
+</h2>
<p>As of version 3.0, Cordova implements battery status and other
device-level APIs as <em>plugins</em>. Access to all other events not related
@@ -322,12 +322,10 @@ platform-specific configuration settings
<p>Reference: <a class="external" href="https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures">Application Manifest for Tizen Web Application</a></p>
</li>
</ul>
-
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
-
<h1><a name="deviceready">deviceready</a></h1>
<p>The event fires when Cordova is fully loaded.</p>
@@ -335,7 +333,9 @@ configuration. See <a href="guide_suppo
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="deviceready_details">Details</a></h2>
+<h2>
+<a name="deviceready_details">Details</a>
+</h2>
<p>This event is essential to any application. It signals that Cordova's
device APIs have loaded and are ready to access.</p>
@@ -355,7 +355,9 @@ once the HTML document's DOM has loaded.
event handler registered after the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires has its
callback function called immediately.</p>
-<h2><a name="deviceready_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="deviceready_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -366,8 +368,9 @@ callback function called immediately.</p
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="deviceready_quick_example">Quick Example</a></h2>
+<h2>
+<a name="deviceready_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
@@ -376,7 +379,9 @@ function onDeviceReady() {
}
</code></pre>
-<h2><a name="deviceready_full_example">Full Example</a></h2>
+<h2>
+<a name="deviceready_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -406,7 +411,6 @@ function onDeviceReady() {
</code></pre>
<hr>
-
<h1><a name="pause">pause</a></h1>
<p>The event fires when an application is put into the background.</p>
@@ -414,7 +418,9 @@ function onDeviceReady() {
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#pause">pause</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="pause_details">Details</a></h2>
+<h2>
+<a name="pause_details">Details</a>
+</h2>
<p>The <code><a href="cordova_events_events.md.html#pause">pause</a></code> event fires when the native platform puts the application
into the background, typically when the user switches to a different
@@ -423,7 +429,9 @@ application.</p>
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="pause_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="pause_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -433,8 +441,9 @@ attach an event listener once the <code>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="pause_quick_example">Quick Example</a></h2>
+<h2>
+<a name="pause_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#pause">pause</a>", onPause, false);
@@ -443,7 +452,9 @@ function onPause() {
}
</code></pre>
-<h2><a name="pause_full_example">Full Example</a></h2>
+<h2>
+<a name="pause_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -477,7 +488,9 @@ function onPause() {
</html>
</code></pre>
-<h2><a name="pause_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="pause_ios_quirks">iOS Quirks</a>
+</h2>
<p>In the <code><a href="cordova_events_events.md.html#pause">pause</a></code> handler, any calls to the Cordova API or to native
plugins that go through Objective-C do not work, along with any
@@ -496,7 +509,6 @@ multi-tasking by setting
to <code>YES</code>. To run when locked on iOS 4, this setting does not matter.</p>
<hr>
-
<h1><a name="resume">resume</a></h1>
<p>The event fires when an application is retrieved from the background.</p>
@@ -504,7 +516,9 @@ to <code>YES</code>. To run when locked
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#resume">resume</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="resume_details">Details</a></h2>
+<h2>
+<a name="resume_details">Details</a>
+</h2>
<p>The <code><a href="cordova_events_events.md.html#resume">resume</a></code> event fires when the native platform pulls the
application out from the background.</p>
@@ -512,7 +526,9 @@ application out from the background.</p>
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="resume_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="resume_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -522,8 +538,9 @@ attach an event listener once the <code>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="resume_quick_example">Quick Example</a></h2>
+<h2>
+<a name="resume_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#resume">resume</a>", onResume, false);
@@ -532,7 +549,9 @@ function onResume() {
}
</code></pre>
-<h2><a name="resume_full_example">Full Example</a></h2>
+<h2>
+<a name="resume_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -566,7 +585,9 @@ function onResume() {
</html>
</code></pre>
-<h2><a name="resume_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="resume_ios_quirks">iOS Quirks</a>
+</h2>
<p>Any interactive functions called from a <code><a href="cordova_events_events.md.html#pause">pause</a></code> event handler execute
later when the app resumes, as signaled by the <code><a href="cordova_events_events.md.html#resume">resume</a></code> event. These
@@ -603,9 +624,7 @@ function onResume() {
</code></pre>
</li>
</ul>
-
<hr>
-
<h1><a name="online">online</a></h1>
<p>This event fires when an application goes <a href="cordova_events_events.md.html#online">online</a>, and the device
@@ -614,7 +633,9 @@ becomes connected to the Internet.</p>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#online">online</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="online_details">Details</a></h2>
+<h2>
+<a name="online_details">Details</a>
+</h2>
<p>The <code><a href="cordova_events_events.md.html#online">online</a></code> event fires when a previously unconnected device receives
a network connection to allow an application access to the Internet.
@@ -624,7 +645,9 @@ when the value of <code><a href="cordova
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="online_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="online_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -635,8 +658,9 @@ attach an event listener once the <code>
<li>Tizen</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="online_quick_example">Quick Example</a></h2>
+<h2>
+<a name="online_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#online">online</a>", onOnline, false);
@@ -645,7 +669,9 @@ function onOnline() {
}
</code></pre>
-<h2><a name="online_full_example">Full Example</a></h2>
+<h2>
+<a name="online_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -679,22 +705,27 @@ function onOnline() {
</html>
</code></pre>
-<h2><a name="online_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="online_ios_quirks">iOS Quirks</a>
+</h2>
<p>During initial startup, the first <code><a href="cordova_events_events.md.html#online">online</a></code> event (if applicable) takes
at least a second to fire, prior to which <code><a href="cordova_connection_connection.md.html#connection.type">connection.type</a></code> is
<code>UNKNOWN</code>.</p>
-<h2><a name="online_windows_phone_7_quirks">Windows Phone 7 Quirks</a></h2>
+<h2>
+<a name="online_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
<p>When running in the Emulator, the <code>connection.status</code> is always unknown, so this event does <em>not</em> fire.</p>
-<h2><a name="online_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="online_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<p>The Emulator reports the <a href="#connection%20type">connection type</a> as <code>Cellular</code>, which does not change, so events does <em>not</em> fire.</p>
<hr>
-
<h1><a name="offline">offline</a></h1>
<p>The event fires when an application goes <a href="cordova_events_events.md.html#offline">offline</a>, and the device is
@@ -703,7 +734,9 @@ not connected to the Internet.</p>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#offline">offline</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="offline_details">Details</a></h2>
+<h2>
+<a name="offline_details">Details</a>
+</h2>
<p>The <code><a href="cordova_events_events.md.html#offline">offline</a></code> event fires when a previously connected device loses a
network connection so that an application can no longer access the
@@ -714,7 +747,9 @@ value.</p>
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="offline_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="offline_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -725,8 +760,9 @@ attach an event listener once the <code>
<li>Tizen</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="offline_quick_example">Quick Example</a></h2>
+<h2>
+<a name="offline_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#offline">offline</a>", onOffline, false);
@@ -735,7 +771,9 @@ function onOffline() {
}
</code></pre>
-<h2><a name="offline_full_example">Full Example</a></h2>
+<h2>
+<a name="offline_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -769,20 +807,25 @@ function onOffline() {
</html>
</code></pre>
-<h2><a name="offline_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="offline_ios_quirks">iOS Quirks</a>
+</h2>
<p>During initial startup, the first <a href="cordova_events_events.md.html#offline">offline</a> event (if applicable) takes at least a second to fire.</p>
-<h2><a name="offline_windows_phone_7_quirks">Windows Phone 7 Quirks</a></h2>
+<h2>
+<a name="offline_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
<p>When running in the Emulator, the <code>connection.status</code> is always unknown, so this event does <em>not</em> fire.</p>
-<h2><a name="offline_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="offline_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<p>The Emulator reports the <a href="#connection%20type">connection type</a> as <code>Cellular</code>, which does not change, so the event does <em>not</em> fire.</p>
<hr>
-
<h1><a name="backbutton">backbutton</a></h1>
<p>The event fires when the user presses the back button.</p>
@@ -790,7 +833,9 @@ function onOffline() {
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#backbutton">backbutton</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="backbutton_details">Details</a></h2>
+<h2>
+<a name="backbutton_details">Details</a>
+</h2>
<p>To override the default back-button behavior, register an event
listener for the <code><a href="cordova_events_events.md.html#backbutton">backbutton</a></code> event, typically by calling
@@ -798,7 +843,9 @@ listener for the <code><a href="cordova_
It is no longer necessary to call any other method to override the
back-button behavior.</p>
-<h2><a name="backbutton_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="backbutton_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -806,8 +853,9 @@ back-button behavior.</p>
<li>BlackBerry 10</li>
<li>Windows Phone 7 and 8</li>
</ul>
-
-<h2><a name="backbutton_quick_example">Quick Example</a></h2>
+<h2>
+<a name="backbutton_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#backbutton">backbutton</a>", onBackKeyDown, false);
@@ -816,7 +864,9 @@ function onBackKeyDown() {
}
</code></pre>
-<h2><a name="backbutton_full_example">Full Example</a></h2>
+<h2>
+<a name="backbutton_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -852,7 +902,6 @@ function onBackKeyDown() {
</code></pre>
<hr>
-
<h1><a name="batterycritical">batterycritical</a></h1>
<p>The event fires when the battery has reached the critical level
@@ -861,7 +910,9 @@ threshold.</p>
<pre class="prettyprint"><code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#batterycritical">batterycritical</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="batterycritical_details">Details</a></h2>
+<h2>
+<a name="batterycritical_details">Details</a>
+</h2>
<p>The event fires when the percentage of battery charge has reached the
critical battery threshold. The value is device-specific.</p>
@@ -873,11 +924,12 @@ properties:</p>
<li><p><strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em></p></li>
<li><p><strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em></p></li>
</ul>
-
<p>Applications typically should use <code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to attach
an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="batterycritical_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="batterycritical_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -886,8 +938,9 @@ an event listener once the <code><a href
<li>BlackBerry 10</li>
<li>Tizen</li>
</ul>
-
-<h2><a name="batterycritical_quick_example">Quick Example</a></h2>
+<h2>
+<a name="batterycritical_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#batterycritical">batterycritical</a>", onBatteryCritical, false);
@@ -897,7 +950,9 @@ function onBatteryCritical(info) {
}
</code></pre>
-<h2><a name="batterycritical_full_example">Full Example</a></h2>
+<h2>
+<a name="batterycritical_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -933,7 +988,6 @@ function onBatteryCritical(info) {
</code></pre>
<hr>
-
<h1><a name="batterylow">batterylow</a></h1>
<p>The event fires when the battery has reached the low level threshold.</p>
@@ -941,7 +995,9 @@ function onBatteryCritical(info) {
<pre class="prettyprint"><code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#batterylow">batterylow</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="batterylow_details">Details</a></h2>
+<h2>
+<a name="batterylow_details">Details</a>
+</h2>
<p>The event fires when the percentage of battery charge has reached the
low battery threshold, device-specific value.</p>
@@ -953,11 +1009,12 @@ properties:</p>
<li><p><strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em></p></li>
<li><p><strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em></p></li>
</ul>
-
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="batterylow_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="batterylow_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -966,8 +1023,9 @@ attach an event listener once the <code>
<li>BlackBerry 10</li>
<li>Tizen</li>
</ul>
-
-<h2><a name="batterylow_quick_example">Quick Example</a></h2>
+<h2>
+<a name="batterylow_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#batterylow">batterylow</a>", onBatteryLow, false);
@@ -977,7 +1035,9 @@ function onBatteryLow(info) {
}
</code></pre>
-<h2><a name="batterylow_full_example">Full Example</a></h2>
+<h2>
+<a name="batterylow_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -1013,7 +1073,6 @@ function onBatteryLow(info) {
</code></pre>
<hr>
-
<h1><a name="batterystatus">batterystatus</a></h1>
<p>The event fires when there is a change in the battery status.</p>
@@ -1021,7 +1080,9 @@ function onBatteryLow(info) {
<pre class="prettyprint"><code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#batterystatus">batterystatus</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="batterystatus_details">Details</a></h2>
+<h2>
+<a name="batterystatus_details">Details</a>
+</h2>
<p>This event fires when the percentage of battery charge changes by at
least 1 percent, or if the device is plugged in or unplugged.</p>
@@ -1033,11 +1094,12 @@ properties:</p>
<li><p><strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em></p></li>
<li><p><strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em></p></li>
</ul>
-
<p>Applications typically should use <code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="batterystatus_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="batterystatus_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1047,14 +1109,17 @@ attach an event listener once the <code>
<li>Windows Phone 7 and 8</li>
<li>Tizen</li>
</ul>
-
-<h2><a name="batterystatus_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
+<h2>
+<a name="batterystatus_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
<p>Windows Phone 7 does not provide native APIs to determine battery
level, so the <code>level</code> property is unavailable. The <code>isPlugged</code>
parameter <em>is</em> supported.</p>
-<h2><a name="batterystatus_quick_example">Quick Example</a></h2>
+<h2>
+<a name="batterystatus_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#batterystatus">batterystatus</a>", onBatteryStatus, false);
@@ -1064,7 +1129,9 @@ function onBatteryStatus(info) {
}
</code></pre>
-<h2><a name="batterystatus_full_example">Full Example</a></h2>
+<h2>
+<a name="batterystatus_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -1100,7 +1167,6 @@ function onBatteryStatus(info) {
</code></pre>
<hr>
-
<h1><a name="menubutton">menubutton</a></h1>
<p>The event fires when the user presses the menu button.</p>
@@ -1108,22 +1174,27 @@ function onBatteryStatus(info) {
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#menubutton">menubutton</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="menubutton_details">Details</a></h2>
+<h2>
+<a name="menubutton_details">Details</a>
+</h2>
<p>Applying an event handler overrides the default menu button behavior.</p>
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="menubutton_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="menubutton_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
<li>Android</li>
<li>BlackBerry 10</li>
</ul>
-
-<h2><a name="menubutton_quick_example">Quick Example</a></h2>
+<h2>
+<a name="menubutton_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#menubutton">menubutton</a>", onMenuKeyDown, false);
@@ -1132,7 +1203,9 @@ function onMenuKeyDown() {
}
</code></pre>
-<h2><a name="menubutton_full_example">Full Example</a></h2>
+<h2>
+<a name="menubutton_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
@@ -1169,7 +1242,6 @@ function onMenuKeyDown() {
</code></pre>
<hr>
-
<h1><a name="searchbutton">searchbutton</a></h1>
<p>The event fires when the user presses the search button on Android.</p>
@@ -1177,7 +1249,9 @@ function onMenuKeyDown() {
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#searchbutton">searchbutton</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="searchbutton_details">Details</a></h2>
+<h2>
+<a name="searchbutton_details">Details</a>
+</h2>
<p>If you need to override the default search button behavior on Android
you can register an event listener for the '<a href="cordova_events_events.md.html#searchbutton">searchbutton</a>' event.</p>
@@ -1185,13 +1259,16 @@ you can register an event listener for t
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="searchbutton_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="searchbutton_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Android</li>
</ul>
-
-<h2><a name="searchbutton_quick_example">Quick Example</a></h2>
+<h2>
+<a name="searchbutton_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#searchbutton">searchbutton</a>", onSearchKeyDown, false);
@@ -1200,7 +1277,9 @@ function onSearchKeyDown() {
}
</code></pre>
-<h2><a name="searchbutton_full_example">Full Example</a></h2>
+<h2>
+<a name="searchbutton_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
@@ -1237,7 +1316,6 @@ function onSearchKeyDown() {
</code></pre>
<hr>
-
<h1><a name="startcallbutton">startcallbutton</a></h1>
<p>The event fires when the user presses the start call button.</p>
@@ -1245,7 +1323,9 @@ function onSearchKeyDown() {
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#startcallbutton">startcallbutton</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="startcallbutton_details">Details</a></h2>
+<h2>
+<a name="startcallbutton_details">Details</a>
+</h2>
<p>If you need to override the default start call behavior you can
register an event listener for the <code><a href="cordova_events_events.md.html#startcallbutton">startcallbutton</a></code> event.</p>
@@ -1253,13 +1333,16 @@ register an event listener for the <code
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="startcallbutton_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="startcallbutton_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>BlackBerry 10</li>
</ul>
-
-<h2><a name="startcallbutton_quick_example">Quick Example</a></h2>
+<h2>
+<a name="startcallbutton_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#startcallbutton">startcallbutton</a>", onStartCallKeyDown, false);
@@ -1268,7 +1351,9 @@ function onStartCallKeyDown() {
}
</code></pre>
-<h2><a name="startcallbutton_full_example">Full Example</a></h2>
+<h2>
+<a name="startcallbutton_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
@@ -1305,7 +1390,6 @@ function onStartCallKeyDown() {
</code></pre>
<hr>
-
<h1><a name="endcallbutton">endcallbutton</a></h1>
<p>This event fires when the user presses the end call button.</p>
@@ -1313,20 +1397,25 @@ function onStartCallKeyDown() {
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#endcallbutton">endcallbutton</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="endcallbutton_details">Details</a></h2>
+<h2>
+<a name="endcallbutton_details">Details</a>
+</h2>
<p>The event overrides the default end call behavior.</p>
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="endcallbutton_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="endcallbutton_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>BlackBerry 10</li>
</ul>
-
-<h2><a name="endcallbutton_quick_example">Quick Example</a></h2>
+<h2>
+<a name="endcallbutton_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#endcallbutton">endcallbutton</a>", onEndCallKeyDown, false);
@@ -1335,7 +1424,9 @@ function onEndCallKeyDown() {
}
</code></pre>
-<h2><a name="endcallbutton_full_example">Full Example</a></h2>
+<h2>
+<a name="endcallbutton_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
@@ -1372,7 +1463,6 @@ function onEndCallKeyDown() {
</code></pre>
<hr>
-
<h1><a name="volumedownbutton">volumedownbutton</a></h1>
<p>The event fires when the user presses the volume down button.</p>
@@ -1380,7 +1470,9 @@ function onEndCallKeyDown() {
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#volumedownbutton">volumedownbutton</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="volumedownbutton_details">Details</a></h2>
+<h2>
+<a name="volumedownbutton_details">Details</a>
+</h2>
<p>If you need to override the default volume down behavior you can
register an event listener for the <code><a href="cordova_events_events.md.html#volumedownbutton">volumedownbutton</a></code> event.</p>
@@ -1388,13 +1480,16 @@ register an event listener for the <code
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="volumedownbutton_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="volumedownbutton_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>BlackBerry 10</li>
</ul>
-
-<h2><a name="volumedownbutton_quick_example">Quick Example</a></h2>
+<h2>
+<a name="volumedownbutton_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#volumedownbutton">volumedownbutton</a>", onVolumeDownKeyDown, false);
@@ -1403,7 +1498,9 @@ function onVolumeDownKeyDown() {
}
</code></pre>
-<h2><a name="volumedownbutton_full_example">Full Example</a></h2>
+<h2>
+<a name="volumedownbutton_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
@@ -1440,7 +1537,6 @@ function onVolumeDownKeyDown() {
</code></pre>
<hr>
-
<h1><a name="volumeupbutton">volumeupbutton</a></h1>
<p>The event fires when the user presses the volume up button.</p>
@@ -1448,7 +1544,9 @@ function onVolumeDownKeyDown() {
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#volumeupbutton">volumeupbutton</a>", yourCallbackFunction, false);
</code></pre>
-<h2><a name="volumeupbutton_details">Details</a></h2>
+<h2>
+<a name="volumeupbutton_details">Details</a>
+</h2>
<p>If you need to override the default volume up behavior you can
register an event listener for the <code><a href="cordova_events_events.md.html#volumeupbutton">volumeupbutton</a></code> event.</p>
@@ -1456,13 +1554,16 @@ register an event listener for the <code
<p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to
attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
-<h2><a name="volumeupbutton_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="volumeupbutton_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>BlackBerry 10</li>
</ul>
-
-<h2><a name="volumeupbutton_quick_example">Quick Example</a></h2>
+<h2>
+<a name="volumeupbutton_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#volumeupbutton">volumeupbutton</a>", onVolumeUpKeyDown, false);
@@ -1471,7 +1572,9 @@ function onVolumeUpKeyDown() {
}
</code></pre>
-<h2><a name="volumeupbutton_full_example">Full Example</a></h2>
+<h2>
+<a name="volumeupbutton_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
@@ -1511,7 +1614,6 @@ function onVolumeUpKeyDown() {
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>