You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/02/23 00:43:56 UTC
svn commit: r1449255 [22/34] - in /cordova/site/public/docs: en/1.5.0/
en/1.5.0rc1/ en/1.6.0/ en/1.6.0rc1/ en/1.6.1/ en/1.7.0/ en/1.7.0rc1/
en/1.8.0/ en/1.8.0rc1/ en/1.8.1/ en/1.9.0/ en/1.9.0rc1/ en/2.0.0/
en/2.0.0rc1/ en/2.1.0/ en/2.1.0rc1/ en/2.1.0rc...
Added: cordova/site/public/docs/en/2.5.0rc1/cordova_notification_notification.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.5.0rc1/cordova_notification_notification.md.html?rev=1449255&view=auto
==============================================================================
--- cordova/site/public/docs/en/2.5.0rc1/cordova_notification_notification.md.html (added)
+++ cordova/site/public/docs/en/2.5.0rc1/cordova_notification_notification.md.html Fri Feb 22 23:42:47 2013
@@ -0,0 +1,702 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ 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>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="2.5.0rc1">2.5.0rc1</option>
+<option value="2.4.0rc1">2.4.0rc1</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0rc2">2.3.0rc2</option>
+<option value="2.3.0rc1">2.3.0rc1</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0rc2">2.2.0rc2</option>
+<option value="2.2.0rc1">2.2.0rc1</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0rc2">2.1.0rc2</option>
+<option value="2.1.0rc1">2.1.0rc1</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0rc1">2.0.0rc1</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0rc1">1.9.0rc1</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0rc1">1.8.0rc1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0rc1">1.7.0rc1</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0rc1">1.5.0rc1</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp">
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Notification</h1>
+ <small><select><option value="Notification">Notification</option>
+<option value="Notification_methods">Â Â Â Â Â Â - Methods</option>
+<option value="Notification_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="notification.alert">notification.alert</option>
+<option value="notification.alert_description">Â Â Â Â Â Â - Description</option>
+<option value="notification.alert_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="notification.alert_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="notification.alert_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="notification.alert_windows_phone_7_and_8_quirks">Â Â Â Â Â Â - Windows Phone 7 and 8 Quirks</option>
+<option value="notification.alert_bada_2_x_quirks">Â Â Â Â Â Â - Bada 2.x Quirks</option>
+<option value="notification.confirm">notification.confirm</option>
+<option value="notification.confirm_description">Â Â Â Â Â Â - Description</option>
+<option value="notification.confirm_confirmcallback">Â Â Â Â Â Â - confirmCallback</option>
+<option value="notification.confirm_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="notification.confirm_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="notification.confirm_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="notification.confirm_windows_phone_7_and_8_quirks">Â Â Â Â Â Â - Windows Phone 7 and 8 Quirks</option>
+<option value="notification.confirm_bada_2_x_quirks">Â Â Â Â Â Â - Bada 2.x Quirks</option>
+<option value="notification.confirm_bada_1_2_quirks">Â Â Â Â Â Â - Bada 1.2 Quirks</option>
+<option value="notification.beep">notification.beep</option>
+<option value="notification.beep_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="notification.beep_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="notification.beep_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="notification.beep_android_quirks">Â Â Â Â Â Â - Android Quirks</option>
+<option value="notification.beep_iphone_quirks">Â Â Â Â Â Â - iPhone Quirks</option>
+<option value="notification.beep_windows_phone_7_and_8_quirks">Â Â Â Â Â Â - Windows Phone 7 and 8 Quirks</option>
+<option value="notification.beep_tizen_quirks">Â Â Â Â Â Â - Tizen Quirks</option>
+<option value="notification.vibrate">notification.vibrate</option>
+<option value="notification.vibrate_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="notification.vibrate_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="notification.vibrate_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="notification.vibrate_iphone_quirks">Â Â Â Â Â Â - iPhone Quirks</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
+<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Notification">Notification</a></h1>
+
+<blockquote>
+ <p>Visual, audible, and tactile device notifications.</p>
+</blockquote>
+
+<h2>
+<a name="Notification_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_notification_notification.md.html#notification.alert">notification.alert</a></li>
+<li><a href="cordova_notification_notification.md.html#notification.confirm">notification.confirm</a></li>
+<li><a href="cordova_notification_notification.md.html#notification.beep">notification.beep</a></li>
+<li><a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a></li>
+</ul>
+<h2>
+<a name="Notification_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>" value="org.apache.cordova.<a href="cordova_notification_notification.md.html#Notification">Notification</a>"/>
+</code></pre>
+
+<h4>app/AndroidManifest.xml</h4>
+
+<pre class="prettyprint"><code><uses-permission android:name="android.permission.VIBRATE" />
+</code></pre>
+
+<h3>Bada</h3>
+
+<h4>manifest.xml</h4>
+
+<pre class="prettyprint"><code><Privilege>
+ <Name>SYSTEM_SERVICE</Name>
+</Privilege>
+</code></pre>
+
+<h3>BlackBerry WebWorks</h3>
+
+<h4>www/plugins.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>" value="org.apache.cordova.notification.<a href="cordova_notification_notification.md.html#Notification">Notification</a>" />
+</code></pre>
+
+<h4>www/config.xml</h4>
+
+<pre class="prettyprint"><code><feature id="blackberry.ui.dialog" />
+</code></pre>
+
+<h3>iOS</h3>
+
+<h4>config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>" value="CDVNotification" />
+</code></pre>
+
+<h3>webOS</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>Windows Phone</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>Tizen</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<hr>
+<h1><a name="notification.alert">notification.alert</a></h1>
+
+<p>Shows a custom alert or dialog box.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_notification_notification.md.html#notification.alert">notification.alert</a>(message, alertCallback, [title], [buttonName])
+</code></pre>
+
+<ul>
+<li>
+<strong>message:</strong> Dialog message (<code>String</code>)</li>
+<li>
+<strong>alertCallback:</strong> Callback to invoke when alert dialog is dismissed. (<code>Function</code>)</li>
+<li>
+<strong>title:</strong> Dialog title (<code>String</code>) (Optional, Default: "Alert")</li>
+<li>
+<strong>buttonName:</strong> Button name (<code>String</code>) (Optional, Default: "OK")</li>
+</ul>
+<h2>
+<a name="notification.alert_description">Description</a>
+</h2>
+
+<p>Most Cordova implementations use a native dialog box for this feature. However, some platforms simply use the browser's <code>alert</code> function, which is typically less customizable.</p>
+
+<h2>
+<a name="notification.alert_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 7 and 8</li>
+<li>Bada 1.2 & 2.x</li>
+<li>webOS</li>
+<li>Tizen</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="notification.alert_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// Android / BlackBerry WebWorks (OS 5.0 and higher) / iPhone / Tizen
+//
+function alertDismissed() {
+ // do something
+}
+
+navigator.<a href="cordova_notification_notification.md.html#notification.alert">notification.alert</a>(
+ 'You are the winner!', // message
+ alertDismissed, // callback
+ 'Game Over', // title
+ 'Done' // buttonName
+);
+</code></pre>
+
+<h2>
+<a name="notification.alert_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // alert dialog dismissed
+ function alertDismissed() {
+ // do something
+ }
+
+ // Show a custom alertDismissed
+ //
+ function showAlert() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.alert">notification.alert</a>(
+ 'You are the winner!', // message
+ alertDismissed, // callback
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="notification.alert_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
+
+<ul>
+<li>There is no built in browser alert, so if you want to just write alert('foo'); you can assign window.alert = navigator.<a href="cordova_notification_notification.md.html#notification.alert">notification.alert</a>;</li>
+<li>alert + confirm calls are non-blocking, and result is only available asynchronously.</li>
+</ul>
+<h2>
+<a name="notification.alert_bada_2_x_quirks">Bada 2.x Quirks</a>
+</h2>
+
+<ul>
+<li>alert uses javascript alert</li>
+</ul>
+<hr>
+<h1><a name="notification.confirm">notification.confirm</a></h1>
+
+<p>Shows a customizable confirmation dialog box.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_notification_notification.md.html#notification.confirm">notification.confirm</a>(message, confirmCallback, [title], [buttonLabels])
+</code></pre>
+
+<ul>
+<li>
+<strong>message:</strong> Dialog message (<code>String</code>)</li>
+<li>
+<strong>confirmCallback:</strong> - Callback to invoke with index of button pressed (1, 2 or 3) or when the dialog is dismissed without a button press (0), (<code>Function</code>)</li>
+<li>
+<strong>title:</strong> Dialog title (<code>String</code>) (Optional, Default: "Confirm")</li>
+<li>
+<strong>buttonLabels:</strong> Comma separated string with button labels (<code>String</code>) (Optional, Default: "OK,Cancel")</li>
+</ul>
+<h2>
+<a name="notification.confirm_description">Description</a>
+</h2>
+
+<p>Function <code><a href="cordova_notification_notification.md.html#notification.confirm">notification.confirm</a></code> displays a native dialog box that is more customizable than the browser's <code>confirm</code> function.</p>
+
+<h2>
+<a name="notification.confirm_confirmcallback">confirmCallback</a>
+</h2>
+
+<p>The <code>confirmCallback</code> is called when the user has pressed one of the buttons on the confirmation dialog box.</p>
+
+<p>The callback takes the argument <code>buttonIndex</code> (<code>Number</code>), which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be <code>1</code>, <code>2</code>, <code>3</code>, etc.</p>
+
+<h2>
+<a name="notification.confirm_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 7 and 8</li>
+<li>Bada 1.2 & 2.x</li>
+<li>Tizen</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="notification.confirm_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// process the confirmation dialog result
+function onConfirm(buttonIndex) {
+ alert('You selected button ' + buttonIndex);
+}
+
+// Show a custom confirmation dialog
+//
+function showConfirm() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.confirm">notification.confirm</a>(
+ 'You are the winner!', // message
+ onConfirm, // callback to invoke with index of button pressed
+ 'Game Over', // title
+ 'Restart,Exit' // buttonLabels
+ );
+}
+</code></pre>
+
+<h2>
+<a name="notification.confirm_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // process the confirmation dialog result
+ function onConfirm(buttonIndex) {
+ alert('You selected button ' + buttonIndex);
+ }
+
+ // Show a custom confirmation dialog
+ //
+ function showConfirm() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.confirm">notification.confirm</a>(
+ 'You are the winner!', // message
+ onConfirm, // callback to invoke with index of button pressed
+ 'Game Over', // title
+ 'Restart,Exit' // buttonLabels
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showConfirm(); return false;">Show Confirm</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="notification.confirm_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
+
+<ul>
+<li>There is no built-in browser function for <code>window.confirm</code>
+<ul>
+<li>You can bind <code>window.confirm</code> by assigning <code>window.confirm = navigator.<a href="cordova_notification_notification.md.html#notification.confirm">notification.confirm</a>;</code>.</li>
+</ul>
+</li>
+<li>Calls to <code>alert</code> and <code>confirm</code> are non-blocking and result is only available asynchronously.</li>
+</ul>
+<h2>
+<a name="notification.confirm_bada_2_x_quirks">Bada 2.x Quirks</a>
+</h2>
+
+<ul>
+<li>
+<code>confirm</code> uses the browser's built-in <code>alert</code> function.</li>
+</ul>
+<h2>
+<a name="notification.confirm_bada_1_2_quirks">Bada 1.2 Quirks</a>
+</h2>
+
+<ul>
+<li>Ignore button names, always <code>'OK|Cancel'</code>.</li>
+</ul>
+<hr>
+<h1><a name="notification.beep">notification.beep</a></h1>
+
+<p>The device will play a beep sound.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_notification_notification.md.html#notification.beep">notification.beep</a>(times);
+</code></pre>
+
+<ul>
+<li>
+<strong>times:</strong> The number of times to repeat the beep (<code>Number</code>)</li>
+</ul>
+<h2>
+<a name="notification.beep_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 7 and 8</li>
+<li>Bada 1.2 & 2.x</li>
+<li>Tizen</li>
+</ul>
+<h2>
+<a name="notification.beep_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// Beep twice!
+navigator.<a href="cordova_notification_notification.md.html#notification.beep">notification.beep</a>(2);
+</code></pre>
+
+<h2>
+<a name="notification.beep_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // Show a custom alert
+ //
+ function showAlert() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.alert">notification.alert</a>(
+ 'You are the winner!', // message
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+ }
+
+ // Beep three times
+ //
+ function playBeep() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.beep">notification.beep</a>(3);
+ }
+
+ // Vibrate for 2 seconds
+ //
+ function vibrate() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a>(2000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
+ <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
+ <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="notification.beep_android_quirks">Android Quirks</a>
+</h2>
+
+<ul>
+<li>Android plays the default "<a href="cordova_notification_notification.md.html#Notification">Notification</a> ringtone" specified under the "Settings/Sound & Display" panel.</li>
+</ul>
+<h2>
+<a name="notification.beep_iphone_quirks">iPhone Quirks</a>
+</h2>
+
+<ul>
+<li>Ignores the beep count argument.</li>
+<li>There is no native beep API for iPhone.
+<ul>
+<li>Cordova implements beep by playing an audio file via the media API.</li>
+<li>The user must provide a file with the desired beep tone.</li>
+<li>This file must be less than 30 seconds long, located in the www/ root, and must be named <code>beep.wav</code>.</li>
+</ul>
+</li>
+</ul>
+<h2>
+<a name="notification.beep_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
+
+<ul>
+<li>Cordova lib includes a generic beep file that is used. </li>
+</ul>
+<h2>
+<a name="notification.beep_tizen_quirks">Tizen Quirks</a>
+</h2>
+
+<ul>
+<li>Tizen implements beep by playing an audio file via the media API.</li>
+<li>This beep file must be short, named <code>beep.wav</code> and has to be located in a 'sounds' sub-directory of the application root directory.</li>
+</ul>
+<hr>
+<h1><a name="notification.vibrate">notification.vibrate</a></h1>
+
+<p>Vibrates the device for the specified amount of time.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a>(milliseconds)
+</code></pre>
+
+<ul>
+<li>
+<strong>time:</strong> Milliseconds to vibrate the device. 1000 milliseconds equals 1 second (<code>Number</code>)</li>
+</ul>
+<h2>
+<a name="notification.vibrate_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 7 and 8</li>
+<li>Bada 1.2 & 2.x</li>
+</ul>
+<h2>
+<a name="notification.vibrate_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// Vibrate for 2.5 seconds
+//
+navigator.<a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a>(2500);
+</code></pre>
+
+<h2>
+<a name="notification.vibrate_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // Show a custom alert
+ //
+ function showAlert() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.alert">notification.alert</a>(
+ 'You are the winner!', // message
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+ }
+
+ // Beep three times
+ //
+ function playBeep() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.beep">notification.beep</a>(3);
+ }
+
+ // Vibrate for 2 seconds
+ //
+ function vibrate() {
+ navigator.<a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a>(2000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
+ <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
+ <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="notification.vibrate_iphone_quirks">iPhone Quirks</a>
+</h2>
+
+<ul>
+<li>
+<p><strong>time:</strong> Ignores the time and vibrates for a pre-set amount of time.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a>();
+navigator.<a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a>(2500); // 2500 is ignored
+</code></pre>
+</li>
+</ul>
+</div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>
Added: cordova/site/public/docs/en/2.5.0rc1/cordova_splashscreen_splashscreen.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.5.0rc1/cordova_splashscreen_splashscreen.md.html?rev=1449255&view=auto
==============================================================================
--- cordova/site/public/docs/en/2.5.0rc1/cordova_splashscreen_splashscreen.md.html (added)
+++ cordova/site/public/docs/en/2.5.0rc1/cordova_splashscreen_splashscreen.md.html Fri Feb 22 23:42:47 2013
@@ -0,0 +1,344 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ 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>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="2.5.0rc1">2.5.0rc1</option>
+<option value="2.4.0rc1">2.4.0rc1</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0rc2">2.3.0rc2</option>
+<option value="2.3.0rc1">2.3.0rc1</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0rc2">2.2.0rc2</option>
+<option value="2.2.0rc1">2.2.0rc1</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0rc2">2.1.0rc2</option>
+<option value="2.1.0rc1">2.1.0rc1</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0rc1">2.0.0rc1</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0rc1">1.9.0rc1</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0rc1">1.8.0rc1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0rc1">1.7.0rc1</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0rc1">1.5.0rc1</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp">
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Splashscreen</h1>
+ <small><select><option value="Splashscreen">Splashscreen</option>
+<option value="Splashscreen_methods">Â Â Â Â Â Â - Methods</option>
+<option value="Splashscreen_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Splashscreen_setup">Â Â Â Â Â Â - Setup</option>
+<option value="show">show</option>
+<option value="show_description">Â Â Â Â Â Â - Description</option>
+<option value="show_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="show_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="show_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="hide">hide</option>
+<option value="hide_description">Â Â Â Â Â Â - Description</option>
+<option value="hide_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="hide_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="hide_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="hide_ios_quirk">Â Â Â Â Â Â - iOS Quirk</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
+<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Splashscreen">Splashscreen</a></h1>
+
+<blockquote>
+ <p>Enables developers to <a href="cordova_splashscreen_splashscreen.md.html#show">show</a>/<a href="cordova_splashscreen_splashscreen.md.html#hide">hide</a> the application's splash screen.</p>
+</blockquote>
+
+<h2>
+<a name="Splashscreen_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_splashscreen_splashscreen.md.html#show">show</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#hide">hide</a></li>
+</ul>
+<h2>
+<a name="Splashscreen_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="SplashScreen" value="org.apache.cordova.SplashScreen"/>
+</code></pre>
+
+<h3>iOS</h3>
+
+<h4>config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="SplashScreen" value="CDVSplashScreen" />
+</code></pre>
+
+<h2>
+<a name="Splashscreen_setup">Setup</a>
+</h2>
+
+<h3>Android</h3>
+
+<ol>
+<li>
+<p>Copy your splash screen image into the res/drawable directories of your Android project. The sizes of each image should be:</p>
+
+<ul>
+<li>xlarge (xhdpi): at least 960 x 720</li>
+<li>large (hdpi): at least 640 x 480</li>
+<li>medium (mdpi): at least 470 x 320</li>
+<li>small (ldpi): at least 426 x 320</li>
+</ul>
+<p>It is highly recommended that you use a <a class="external" href="https://developer.android.com/tools/help/draw9patch.html">9-patch image</a> for your splash screen.</p>
+</li>
+<li>
+<p>In the onCreate method of the class that extends DroidGap add the following two lines:</p>
+
+<pre class="prettyprint"><code>super.setIntegerProperty("splashscreen", R.drawable.splash);
+super.loadUrl(Config.getStartUrl(), 10000);
+</code></pre>
+
+<p>The first line 'super.setIntegerProperty' sets the image to be displayed as the splashscreen. If you have named your image anything other than splash.png you will have to modify this line.
+The second line is the normal 'super.loadUrl' line but it has a second parameter which is the timeout value for the splash screen. In this example the splash screen will display for 10 seconds. If you want to dismiss the splash screen once you get the "<a href="cordova_events_events.md.html#deviceready">deviceready</a>" event you should call the navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#hide">hide</a>() method.</p>
+</li>
+</ol>
+<h3>iOS</h3>
+
+<ol>
+<li>
+<p>Copy your splash screen images into the <strong>Resources/splash</strong> directory of your iOS project. Only add the images for the devices you want to support (iPad screen size or iPhone screen size). The sizes of each image should be:</p>
+
+<ul>
+<li>Default-568h@2x~iphone.png (640x1136 pixels)</li>
+<li>Default-Landscape@2x~ipad.png (2048x1496 pixels)</li>
+<li>Default-Landscape~ipad.png (1024x768 pixels)</li>
+<li>Default-Portrait@2x~ipad.png (1536x2008 pixels)</li>
+<li>Default-Portrait~ipad.png (768x1024 pixels)</li>
+<li>Default@2x~iphone.png (640x960 pixels)</li>
+<li>Default~iphone.png (320x240 pixels)</li>
+</ul>
+</li>
+</ol>
+<hr>
+<h1><a name="show">show</a></h1>
+
+<p>Displays the splash screen.</p>
+
+<pre class="prettyprint"><code>navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#show">show</a>();
+</code></pre>
+
+<h2>
+<a name="show_description">Description</a>
+</h2>
+
+<p>navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#show">show</a>() displays the applications splash screen.</p>
+
+<h2>
+<a name="show_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iOS</li>
+</ul>
+<h2>
+<a name="show_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#show">show</a>();
+</code></pre>
+
+<h2>
+<a name="show_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#show">show</a>();
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="hide">hide</a></h1>
+
+<p>Dismiss the splash screen.</p>
+
+<pre class="prettyprint"><code>navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#hide">hide</a>();
+</code></pre>
+
+<h2>
+<a name="hide_description">Description</a>
+</h2>
+
+<p>navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#hide">hide</a>() dismisses the applications splash screen.</p>
+
+<h2>
+<a name="hide_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iOS</li>
+</ul>
+<h2>
+<a name="hide_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#hide">hide</a>();
+</code></pre>
+
+<h2>
+<a name="hide_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#hide">hide</a>();
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="hide_ios_quirk">iOS Quirk</a>
+</h2>
+
+<ol>
+<li><p>In your <strong>config.xml</strong>, you need to <a href="guide_project-settings_index.md.html#Project%20Settings">modify the value</a> for <strong>"AutoHideSplashScreenâ</strong> to false</p></li>
+<li>
+<p>Then, if you want to delay hiding the splash screen for 2 seconds, you can do this in your <strong><a href="cordova_events_events.md.html#deviceready">deviceready</a></strong> event handler:</p>
+
+<pre class="prettyprint"><code>setTimeout(function() {
+ navigator.splashscreen.<a href="cordova_splashscreen_splashscreen.md.html#hide">hide</a>();
+}, 2000);
+</code></pre>
+</li>
+</ol>
+</div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>
Added: cordova/site/public/docs/en/2.5.0rc1/cordova_storage_storage.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.5.0rc1/cordova_storage_storage.md.html?rev=1449255&view=auto
==============================================================================
--- cordova/site/public/docs/en/2.5.0rc1/cordova_storage_storage.md.html (added)
+++ cordova/site/public/docs/en/2.5.0rc1/cordova_storage_storage.md.html Fri Feb 22 23:42:47 2013
@@ -0,0 +1,988 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ 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>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="2.5.0rc1">2.5.0rc1</option>
+<option value="2.4.0rc1">2.4.0rc1</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0rc2">2.3.0rc2</option>
+<option value="2.3.0rc1">2.3.0rc1</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0rc2">2.2.0rc2</option>
+<option value="2.2.0rc1">2.2.0rc1</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0rc2">2.1.0rc2</option>
+<option value="2.1.0rc1">2.1.0rc1</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0rc1">2.0.0rc1</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0rc1">1.9.0rc1</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0rc1">1.8.0rc1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0rc1">1.7.0rc1</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0rc1">1.5.0rc1</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp">
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Storage</h1>
+ <small><select><option value="Storage">Storage</option>
+<option value="Storage_methods">Â Â Â Â Â Â - Methods</option>
+<option value="Storage_arguments">Â Â Â Â Â Â - Arguments</option>
+<option value="Storage_objects">Â Â Â Â Â Â - Objects</option>
+<option value="Storage_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="openDatabase">openDatabase</option>
+<option value="openDatabase_description">Â Â Â Â Â Â - Description</option>
+<option value="openDatabase_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="openDatabase_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="openDatabase_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="database_name">database_name</option>
+<option value="database_version">database_version</option>
+<option value="database_displayname">database_displayname</option>
+<option value="database_size">database_size</option>
+<option value="Database">Database</option>
+<option value="Database_methods">Â Â Â Â Â Â - Methods</option>
+<option value="Database_details">Â Â Â Â Â Â - Details</option>
+<option value="Database_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="Database_transaction_quick_example">Â Â Â Â Â Â - Transaction Quick Example</option>
+<option value="Database_change_version_quick_example">Â Â Â Â Â Â - Change Version Quick Example</option>
+<option value="Database_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="SQLTransaction">SQLTransaction</option>
+<option value="SQLTransaction_methods">Â Â Â Â Â Â - Methods</option>
+<option value="SQLTransaction_details">Â Â Â Â Â Â - Details</option>
+<option value="SQLTransaction_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="SQLTransaction_execute_sql_quick_example">Â Â Â Â Â Â - Execute SQL Quick Example</option>
+<option value="SQLTransaction_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="SQLResultSet">SQLResultSet</option>
+<option value="SQLResultSet_properties">Â Â Â Â Â Â - Properties</option>
+<option value="SQLResultSet_details">Â Â Â Â Â Â - Details</option>
+<option value="SQLResultSet_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="SQLResultSet_execute_sql_quick_example">Â Â Â Â Â Â - Execute SQL Quick Example</option>
+<option value="SQLResultSet_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="SQLResultSetRowList">SQLResultSetRowList</option>
+<option value="SQLResultSetRowList_properties">Â Â Â Â Â Â - Properties</option>
+<option value="SQLResultSetRowList_methods">Â Â Â Â Â Â - Methods</option>
+<option value="SQLResultSetRowList_details">Â Â Â Â Â Â - Details</option>
+<option value="SQLResultSetRowList_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="SQLResultSetRowList_execute_sql_quick_example">Â Â Â Â Â Â - Execute SQL Quick Example</option>
+<option value="SQLResultSetRowList_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="SQLError">SQLError</option>
+<option value="SQLError_properties">Â Â Â Â Â Â - Properties</option>
+<option value="SQLError_constants">Â Â Â Â Â Â - Constants</option>
+<option value="SQLError_description">Â Â Â Â Â Â - Description</option>
+<option value="localStorage">localStorage</option>
+<option value="localStorage_methods">Â Â Â Â Â Â - Methods</option>
+<option value="localStorage_details">Â Â Â Â Â Â - Details</option>
+<option value="localStorage_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="localStorage_key_quick_example">Â Â Â Â Â Â - Key Quick Example</option>
+<option value="localStorage_set_item_quick_example">Â Â Â Â Â Â - Set Item Quick Example</option>
+<option value="localStorage_get_item_quick_example">Â Â Â Â Â Â - Get Item Quick Example</option>
+<option value="localStorage_remove_item_quick_example">Â Â Â Â Â Â - Remove Item Quick Example</option>
+<option value="localStorage_clear_quick_example">Â Â Â Â Â Â - Clear Quick Example</option>
+<option value="localStorage_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="localStorage_windows_phone_7_quirks">Â Â Â Â Â Â - Windows Phone 7 Quirks</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
+<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Storage">Storage</a></h1>
+
+<blockquote>
+ <p>Provides access to the devices storage options.</p>
+</blockquote>
+
+<p>This API is based on the <a class="external" href="http://dev.w3.org/html5/webdatabase/">W3C Web SQL </a><a href="cordova_storage_storage.md.html#Database">Database</a> Specification and <a class="external" href="http://dev.w3.org/html5/webstorage/">W3C Web </a><a href="cordova_storage_storage.md.html#Storage">Storage</a> API Specification. Some devices already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have storage support, Cordova's implementation should be compatible with the W3C specification.</p>
+
+<h2>
+<a name="Storage_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a></li>
+</ul>
+<h2>
+<a name="Storage_arguments">Arguments</a>
+</h2>
+
+<ul>
+<li><a href="cordova_storage_storage.md.html#database_name">database_name</a></li>
+<li><a href="cordova_storage_storage.md.html#database_version">database_version</a></li>
+<li><a href="cordova_storage_storage.md.html#database_displayname">database_displayname</a></li>
+<li><a href="cordova_storage_storage.md.html#database_size">database_size</a></li>
+</ul>
+<h2>
+<a name="Storage_objects">Objects</a>
+</h2>
+
+<ul>
+<li><a href="cordova_storage_storage.md.html#Database">Database</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLResultSetRowList">SQLResultSetRowList</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLError">SQLError</a></li>
+<li><a href="cordova_storage_storage.md.html#localStorage">localStorage</a></li>
+</ul>
+<h2>
+<a name="Storage_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_storage_storage.md.html#Storage">Storage</a>" value="org.apache.cordova.<a href="cordova_storage_storage.md.html#Storage">Storage</a>" />
+</code></pre>
+
+<h3>Bada</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>BlackBerry WebWorks</h3>
+
+<h4>www/config.xml</h4>
+
+<pre class="prettyprint"><code><feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
+</code></pre>
+
+<h3>iOS</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>webOS</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>Windows Phone</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>Tizen</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<hr>
+<h1><a name="openDatabase">openDatabase</a></h1>
+
+<p>Returns a new <a href="cordova_storage_storage.md.html#Database">Database</a> object.</p>
+
+<pre class="prettyprint"><code>var dbShell = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>(<a href="cordova_storage_storage.md.html#database_name">database_name</a>, <a href="cordova_storage_storage.md.html#database_version">database_version</a>, <a href="cordova_storage_storage.md.html#database_displayname">database_displayname</a>, <a href="cordova_storage_storage.md.html#database_size">database_size</a>);
+</code></pre>
+
+<h2>
+<a name="openDatabase_description">Description</a>
+</h2>
+
+<p>window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a> returns a new <a href="cordova_storage_storage.md.html#Database">Database</a> object.</p>
+
+<p>This method will create a new SQL Lite <a href="cordova_storage_storage.md.html#Database">Database</a> and return a <a href="cordova_storage_storage.md.html#Database">Database</a> object. Use the <a href="cordova_storage_storage.md.html#Database">Database</a> Object to manipulate the data.</p>
+
+<h2>
+<a name="openDatabase_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+<li>Tizen</li>
+</ul>
+<h2>
+<a name="openDatabase_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("test", "1.0", "Test DB", 1000000);
+</code></pre>
+
+<h2>
+<a name="openDatabase_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_storage_storage.md.html#Storage">Storage</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("test", "1.0", "Test DB", 1000000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Open <a href="cordova_storage_storage.md.html#Database">Database</a></p>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="database_name">database_name</a></h1>
+
+<p>The name of the database.</p>
+
+<hr>
+<h1><a name="database_version">database_version</a></h1>
+
+<p>The version of the database.</p>
+
+<hr>
+<h1><a name="database_displayname">database_displayname</a></h1>
+
+<p>The display name of the database.</p>
+
+<hr>
+<h1><a name="database_size">database_size</a></h1>
+
+<p>The size of the database in bytes.</p>
+
+<hr>
+<h1><a name="Database">Database</a></h1>
+
+<p>Contains methods that allow the user to manipulate the <a href="cordova_storage_storage.md.html#Database">Database</a></p>
+
+<h2>
+<a name="Database_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>transaction</strong>: Runs a database transaction. </li>
+<li>
+<strong>changeVersion</strong>: method allows scripts to atomically verify the version number and change it at the same time as doing a schema update. </li>
+</ul>
+<h2>
+<a name="Database_details">Details</a>
+</h2>
+
+<p>A <a href="cordova_storage_storage.md.html#Database">Database</a> object is returned from a call to <code>window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>()</code>.</p>
+
+<h2>
+<a name="Database_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+<li>Tizen</li>
+</ul>
+<h2>
+<a name="Database_transaction_quick_example">Transaction Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+}
+
+function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+}
+
+function successCB() {
+ alert("success!");
+}
+
+var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.transaction(populateDB, errorCB, successCB);
+</code></pre>
+
+<h2>
+<a name="Database_change_version_quick_example">Change Version Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.changeVersion("1.0", "1.1");
+</code></pre>
+
+<h2>
+<a name="Database_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_storage_storage.md.html#Storage">Storage</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(tx, err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ alert("success!");
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p><a href="cordova_storage_storage.md.html#Database">Database</a></p>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="SQLTransaction">SQLTransaction</a></h1>
+
+<p>Contains methods that allow the user to execute SQL statements against the <a href="cordova_storage_storage.md.html#Database">Database</a>.</p>
+
+<h2>
+<a name="SQLTransaction_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>executeSql</strong>: executes a SQL statement</li>
+</ul>
+<h2>
+<a name="SQLTransaction_details">Details</a>
+</h2>
+
+<p>When you call a <a href="cordova_storage_storage.md.html#Database">Database</a> objects transaction method it's callback methods will be called with a <a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a> object. The user can build up a database transaction by calling the executeSql method multiple times. </p>
+
+<h2>
+<a name="SQLTransaction_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+<li>Tizen</li>
+</ul>
+<h2>
+<a name="SQLTransaction_execute_sql_quick_example">Execute SQL Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+}
+
+function errorCB(err) {
+ alert("Error processing SQL: "+err);
+}
+
+function successCB() {
+ alert("success!");
+}
+
+var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.transaction(populateDB, errorCB, successCB);
+</code></pre>
+
+<h2>
+<a name="SQLTransaction_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_storage_storage.md.html#Storage">Storage</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ alert("success!");
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p><a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a></p>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="SQLResultSet">SQLResultSet</a></h1>
+
+<p>When the executeSql method of a <a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a> is called it will invoke it's callback with a <a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a>.</p>
+
+<h2>
+<a name="SQLResultSet_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>insertId</strong>: the row ID of the row that the <a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a> object's SQL statement inserted into the database</li>
+<li>
+<strong>rowsAffected</strong>: the number of rows that were changed by the SQL statement. If the statement did not affect any rows then it is set to 0. </li>
+<li>
+<strong>rows</strong>: a <a href="cordova_storage_storage.md.html#SQLResultSetRowList">SQLResultSetRowList</a> representing the rows returned. If no rows are returned the object will be empty.</li>
+</ul>
+<h2>
+<a name="SQLResultSet_details">Details</a>
+</h2>
+
+<p>When you call the <a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a> executeSql method its callback methods will be called with a <a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a> object. The result object has three properties. The first is the <code>insertId</code> which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the <code>insertId</code> is not set. The <code>rowsAffected</code> is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.</p>
+
+<h2>
+<a name="SQLResultSet_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+<li>Tizen</li>
+</ul>
+<h2>
+<a name="SQLResultSet_execute_sql_quick_example">Execute SQL Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+}
+
+function querySuccess(tx, results) {
+ console.log("Returned rows = " + results.rows.length);
+ // this will be true since it was a select statement and so rowsAffected was 0
+ if (!results.rowsAffected) {
+ console.log('No rows affected!');
+ return false;
+ }
+ // for an insert statement, this property will return the ID of the last inserted row
+ console.log("Last inserted row ID = " + results.insertId);
+}
+
+function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+}
+
+var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.transaction(queryDB, errorCB);
+</code></pre>
+
+<h2>
+<a name="SQLResultSet_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_storage_storage.md.html#Storage">Storage</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Query the database
+ //
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ // Query the success callback
+ //
+ function querySuccess(tx, results) {
+ console.log("Returned rows = " + results.rows.length);
+ // this will be true since it was a select statement and so rowsAffected was 0
+ if (!results.rowsAffected) {
+ console.log('No rows affected!');
+ return false;
+ }
+ // for an insert statement, this property will return the ID of the last inserted row
+ console.log("Last inserted row ID = " + results.insertId);
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ console.log("Error processing SQL: "+err.code);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+ }
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p><a href="cordova_storage_storage.md.html#Database">Database</a></p>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="SQLResultSetRowList">SQLResultSetRowList</a></h1>
+
+<p>One of the properties of the <a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a> containing the rows returned from a SQL query.</p>
+
+<h2>
+<a name="SQLResultSetRowList_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>length</strong>: the number of rows returned by the SQL query</li>
+</ul>
+<h2>
+<a name="SQLResultSetRowList_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>item</strong>: returns the row at the specified index represented by a JavaScript object.</li>
+</ul>
+<h2>
+<a name="SQLResultSetRowList_details">Details</a>
+</h2>
+
+<p>The <a href="cordova_storage_storage.md.html#SQLResultSetRowList">SQLResultSetRowList</a> contains the data returned from a SQL select statement. The object contains a length property letting you know how many rows the select statement has been returned. To get a row of data you would call the <code>item</code> method specifying an index. The item method returns a JavaScript Object who's properties are the columns of the database the select statement was executed against.</p>
+
+<h2>
+<a name="SQLResultSetRowList_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+<li>Tizen</li>
+</ul>
+<h2>
+<a name="SQLResultSetRowList_execute_sql_quick_example">Execute SQL Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+}
+
+function querySuccess(tx, results) {
+ var len = results.rows.length;
+ console.log("DEMO table: " + len + " rows found.");
+ for (var i=0; i<len; i++){
+ console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
+ }
+}
+
+function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+}
+
+var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.transaction(queryDB, errorCB);
+</code></pre>
+
+<h2>
+<a name="SQLResultSetRowList_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_storage_storage.md.html#Storage">Storage</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Query the database
+ //
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ // Query the success callback
+ //
+ function querySuccess(tx, results) {
+ var len = results.rows.length;
+ console.log("DEMO table: " + len + " rows found.");
+ for (var i=0; i<len; i++){
+ console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
+ }
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ console.log("Error processing SQL: "+err.code);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+ }
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p><a href="cordova_storage_storage.md.html#Database">Database</a></p>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="SQLError">SQLError</a></h1>
+
+<p>A <code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a></code> object is thrown when an error occurs.</p>
+
+<h2>
+<a name="SQLError_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>code:</strong> One of the predefined error codes listed below.</li>
+<li>
+<strong>message:</strong> A description of the error.</li>
+</ul>
+<h2>
+<a name="SQLError_constants">Constants</a>
+</h2>
+
+<ul>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.UNKNOWN_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.DATABASE_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.VERSION_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.TOO_LARGE_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.QUOTA_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.SYNTAX_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.CONSTRAINT_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.TIMEOUT_ERR</code></li>
+</ul>
+<h2>
+<a name="SQLError_description">Description</a>
+</h2>
+
+<p>The <code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a></code> object is thrown when an error occurs when manipulating a database.</p>
+
+<hr>
+<h1><a name="localStorage">localStorage</a></h1>
+
+<p>Provides access to a W3C <a href="cordova_storage_storage.md.html#Storage">Storage</a> interface (http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)</p>
+
+<pre class="prettyprint"><code>var storage = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>;
+</code></pre>
+
+<h2>
+<a name="localStorage_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>key</strong>: Returns the name of the key at the position specified. </li>
+<li>
+<strong>getItem</strong>: Returns the item identified by it's key.</li>
+<li>
+<strong>setItem</strong>: Saves and item at the key provided.</li>
+<li>
+<strong>removeItem</strong>: Removes the item identified by it's key.</li>
+<li>
+<strong>clear</strong>: Removes all of the key value pairs.</li>
+</ul>
+<h2>
+<a name="localStorage_details">Details</a>
+</h2>
+
+<p><a href="cordova_storage_storage.md.html#localStorage">localStorage</a> provides an interface to a W3C <a href="cordova_storage_storage.md.html#Storage">Storage</a> interface. It allows one to save data as key-value pairs.</p>
+
+<p>Note: window.sessionStorage provides the same interface, but is cleared between app launches.</p>
+
+<h2>
+<a name="localStorage_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 7 and 8</li>
+<li>webOS</li>
+<li>Tizen</li>
+</ul>
+<h2>
+<a name="localStorage_key_quick_example">Key Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var keyName = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.key(0);
+</code></pre>
+
+<h2>
+<a name="localStorage_set_item_quick_example">Set Item Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.setItem("key", "value");
+</code></pre>
+
+<h2>
+<a name="localStorage_get_item_quick_example">Get Item Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var value = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.getItem("key");
+// value is now equal to "value"
+</code></pre>
+
+<h2>
+<a name="localStorage_remove_item_quick_example">Remove Item Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.removeItem("key");
+</code></pre>
+
+<h2>
+<a name="localStorage_clear_quick_example">Clear Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.clear();
+</code></pre>
+
+<h2>
+<a name="localStorage_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_storage_storage.md.html#Storage">Storage</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.setItem("key", "value");
+ var keyname = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.key(i);
+ // keyname is now equal to "key"
+ var value = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.getItem("key");
+ // value is now equal to "value"
+ window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.removeItem("key");
+ window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.setItem("key2", "value2");
+ window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.clear();
+ // <a href="cordova_storage_storage.md.html#localStorage">localStorage</a> is now empty
+ }
+
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p><a href="cordova_storage_storage.md.html#localStorage">localStorage</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="localStorage_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
+
+<ul>
+<li>dot notation is NOT available on Windows Phone 7. Be sure to use : window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.setItem/getItem, and not the w3 spec defined calls to window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.someKey = 'someValue';</li>
+</ul>
+</div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>