Browse files

updated docs to 1.6.0

  • Loading branch information...
1 parent 3bc9870 commit 66780d6673a06f5667ed1a04e4657918da4954f0 @stevengill stevengill committed Apr 11, 2012
Showing with 2,397 additions and 2,376 deletions.
  1. +143 −143 doc/_index.html
  2. +1 −1 doc/_index.json
  3. +87 −84 doc/{phonegap_accelerometer_accelerometer.md.html → cordova_accelerometer_accelerometer.md.html}
  4. +69 −46 doc/{phonegap_camera_camera.md.html → cordova_camera_camera.md.html}
  5. +608 −0 doc/cordova_compass_compass.md.html
  6. +53 −43 doc/{phonegap_connection_connection.md.html → cordova_connection_connection.md.html}
  7. +161 −161 doc/{phonegap_contacts_contacts.md.html → cordova_contacts_contacts.md.html}
  8. +98 −74 doc/{phonegap_device_device.md.html → cordova_device_device.md.html}
  9. +181 −180 doc/{phonegap_events_events.md.html → cordova_events_events.md.html}
  10. +188 −168 doc/{phonegap_file_file.md.html → cordova_file_file.md.html}
  11. +90 −95 doc/{phonegap_geolocation_geolocation.md.html → cordova_geolocation_geolocation.md.html}
  12. +104 −88 doc/{phonegap_media_capture_capture.md.html → cordova_media_capture_capture.md.html}
  13. +119 −103 doc/{phonegap_media_media.md.html → cordova_media_media.md.html}
  14. +49 −52 doc/{phonegap_notification_notification.md.html → cordova_notification_notification.md.html}
  15. +110 −99 doc/{phonegap_storage_storage.md.html → cordova_storage_storage.md.html}
  16. +66 −58 doc/guide_getting-started_android_index.md.html
  17. +122 −53 doc/guide_getting-started_blackberry_index.md.html
  18. +13 −13 doc/guide_getting-started_index.md.html
  19. +65 −35 doc/guide_getting-started_ios_index.md.html
  20. +13 −13 doc/guide_getting-started_symbian_index.md.html
  21. +13 −13 doc/guide_getting-started_webos_index.md.html
  22. +16 −16 doc/guide_getting-started_windows-phone_index.md.html
  23. +28 −28 doc/index.html
  24. +0 −810 doc/phonegap_compass_compass.md.html
View
286 doc/_index.html
@@ -53,19 +53,19 @@
<div class="vertical_divider"></div>
<h1>API Reference</h1>
<ul>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
-<li><a href="phonegap_camera_camera.md.html#Camera">Camera</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#Capture">Capture</a></li>
-<li><a href="phonegap_compass_compass.md.html#Compass">Compass</a></li>
-<li><a href="phonegap_connection_connection.md.html#Connection">Connection</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#Contacts">Contacts</a></li>
-<li><a href="phonegap_device_device.md.html#Device">Device</a></li>
-<li><a href="phonegap_events_events.md.html#Events">Events</a></li>
-<li><a href="phonegap_file_file.md.html#File">File</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
-<li><a href="phonegap_media_media.md.html#Media">Media</a></li>
-<li><a href="phonegap_notification_notification.md.html#Notification">Notification</a></li>
-<li><a href="phonegap_storage_storage.md.html#Storage">Storage</a></li>
+<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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
</ul>
<h1>Guides</h1>
<ul>
@@ -84,121 +84,121 @@
<h2>A</h2>
<ul>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometerOptions">accelerometerOptions</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerOptions">accelerometerOptions</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></li>
<li><a href="index.html#API%20Reference">API Reference</a></li>
</ul>
<h2>B</h2>
<ul>
-<li><a href="phonegap_events_events.md.html#backbutton">backbutton</a></li>
-<li><a href="phonegap_events_events.md.html#batterycritical">batterycritical</a></li>
-<li><a href="phonegap_events_events.md.html#batterylow">batterylow</a></li>
-<li><a href="phonegap_events_events.md.html#batterystatus">batterystatus</a></li>
+<li><a href="cordova_events_events.md.html#backbutton">backbutton</a></li>
+<li><a href="cordova_events_events.md.html#batterycritical">batterycritical</a></li>
+<li><a href="cordova_events_events.md.html#batterylow">batterylow</a></li>
+<li><a href="cordova_events_events.md.html#batterystatus">batterystatus</a></li>
</ul>
<h2>C</h2>
<ul>
-<li><a href="phonegap_camera_camera.md.html#Camera">Camera</a></li>
-<li><a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a></li>
-<li><a href="phonegap_camera_camera.md.html#cameraError">cameraError</a></li>
-<li><a href="phonegap_camera_camera.md.html#cameraOptions">cameraOptions</a></li>
-<li><a href="phonegap_camera_camera.md.html#cameraSuccess">cameraSuccess</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#Capture">Capture</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#capture.captureAudio">capture.captureAudio</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#capture.captureImage">capture.captureImage</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#capture.captureVideo">capture.captureVideo</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#CaptureAudioOptions">CaptureAudioOptions</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#CaptureCB">CaptureCB</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#CaptureError">CaptureError</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#CaptureErrorCB">CaptureErrorCB</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#CaptureImageOptions">CaptureImageOptions</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#CaptureVideoOptions">CaptureVideoOptions</a></li>
-<li><a href="phonegap_compass_compass.md.html#Compass">Compass</a></li>
-<li><a href="phonegap_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></li>
-<li><a href="phonegap_compass_compass.md.html#compass.clearWatchFilter">compass.clearWatchFilter</a></li>
-<li><a href="phonegap_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a></li>
-<li><a href="phonegap_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></li>
-<li><a href="phonegap_compass_compass.md.html#compass.watchHeadingFilter">compass.watchHeadingFilter</a></li>
-<li><a href="phonegap_compass_compass.md.html#CompassError">CompassError</a></li>
-<li><a href="phonegap_compass_compass.md.html#compassError">compassError</a></li>
-<li><a href="phonegap_compass_compass.md.html#compassHeading">compassHeading</a></li>
-<li><a href="phonegap_compass_compass.md.html#compassOptions">compassOptions</a></li>
-<li><a href="phonegap_compass_compass.md.html#compassSuccess">compassSuccess</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#ConfigurationData">ConfigurationData</a></li>
-<li><a href="phonegap_connection_connection.md.html#Connection">Connection</a></li>
-<li><a href="phonegap_connection_connection.md.html#connection.type">connection.type</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#Contact">Contact</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#ContactAddress">ContactAddress</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#contactError">contactError</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#ContactError">ContactError</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#ContactField">ContactField</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#contactFields">contactFields</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#ContactName">ContactName</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#Contacts">Contacts</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#contacts.create">contacts.create</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#contacts.find">contacts.find</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#contactSuccess">contactSuccess</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#Coordinates">Coordinates</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></li>
+<li><a href="cordova_camera_camera.md.html#cameraError">cameraError</a></li>
+<li><a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a></li>
+<li><a href="cordova_camera_camera.md.html#cameraSuccess">cameraSuccess</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_media_capture_capture.md.html#capture.captureAudio">capture.captureAudio</a></li>
+<li><a href="cordova_media_capture_capture.md.html#capture.captureImage">capture.captureImage</a></li>
+<li><a href="cordova_media_capture_capture.md.html#capture.captureVideo">capture.captureVideo</a></li>
+<li><a href="cordova_media_capture_capture.md.html#CaptureAudioOptions">CaptureAudioOptions</a></li>
+<li><a href="cordova_media_capture_capture.md.html#CaptureCB">CaptureCB</a></li>
+<li><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a></li>
+<li><a href="cordova_media_capture_capture.md.html#CaptureErrorCB">CaptureErrorCB</a></li>
+<li><a href="cordova_media_capture_capture.md.html#CaptureImageOptions">CaptureImageOptions</a></li>
+<li><a href="cordova_media_capture_capture.md.html#CaptureVideoOptions">CaptureVideoOptions</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.clearWatchFilter">compass.clearWatchFilter</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.watchHeadingFilter">compass.watchHeadingFilter</a></li>
+<li><a href="cordova_compass_compass.md.html#CompassError">CompassError</a></li>
+<li><a href="cordova_compass_compass.md.html#compassError">compassError</a></li>
+<li><a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a></li>
+<li><a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a></li>
+<li><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></li>
+<li><a href="cordova_media_capture_capture.md.html#ConfigurationData">ConfigurationData</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_connection_connection.md.html#connection.type">connection.type</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Coordinates">Coordinates</a></li>
</ul>
<h2>D</h2>
<ul>
-<li><a href="phonegap_storage_storage.md.html#Database">Database</a></li>
-<li><a href="phonegap_storage_storage.md.html#database_displayname">database_displayname</a></li>
-<li><a href="phonegap_storage_storage.md.html#database_name">database_name</a></li>
-<li><a href="phonegap_storage_storage.md.html#database_size">database_size</a></li>
-<li><a href="phonegap_storage_storage.md.html#database_version">database_version</a></li>
-<li><a href="phonegap_device_device.md.html#Device">Device</a></li>
-<li><a href="phonegap_device_device.md.html#device.cordova">device.cordova</a></li>
-<li><a href="phonegap_device_device.md.html#device.name">device.name</a></li>
-<li><a href="phonegap_device_device.md.html#device.platform">device.platform</a></li>
-<li><a href="phonegap_device_device.md.html#device.uuid">device.uuid</a></li>
-<li><a href="phonegap_device_device.md.html#device.version">device.version</a></li>
-<li><a href="phonegap_events_events.md.html#deviceready">deviceready</a></li>
-<li><a href="phonegap_file_file.md.html#DirectoryEntry">DirectoryEntry</a></li>
-<li><a href="phonegap_file_file.md.html#DirectoryReader">DirectoryReader</a></li>
+<li><a href="cordova_storage_storage.md.html#Database">Database</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_name">database_name</a></li>
+<li><a href="cordova_storage_storage.md.html#database_size">database_size</a></li>
+<li><a href="cordova_storage_storage.md.html#database_version">database_version</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_device_device.md.html#device.cordova">device.cordova</a></li>
+<li><a href="cordova_device_device.md.html#device.name">device.name</a></li>
+<li><a href="cordova_device_device.md.html#device.platform">device.platform</a></li>
+<li><a href="cordova_device_device.md.html#device.uuid">device.uuid</a></li>
+<li><a href="cordova_device_device.md.html#device.version">device.version</a></li>
+<li><a href="cordova_events_events.md.html#deviceready">deviceready</a></li>
+<li><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></li>
+<li><a href="cordova_file_file.md.html#DirectoryReader">DirectoryReader</a></li>
</ul>
<h2>E</h2>
<ul>
-<li><a href="phonegap_events_events.md.html#endcallbutton">endcallbutton</a></li>
-<li><a href="phonegap_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_events_events.md.html#endcallbutton">endcallbutton</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
</ul>
<h2>F</h2>
<ul>
-<li><a href="phonegap_file_file.md.html#File">File</a></li>
-<li><a href="phonegap_file_file.md.html#FileEntry">FileEntry</a></li>
-<li><a href="phonegap_file_file.md.html#FileError">FileError</a></li>
-<li><a href="phonegap_file_file.md.html#FileReader">FileReader</a></li>
-<li><a href="phonegap_file_file.md.html#FileSystem">FileSystem</a></li>
-<li><a href="phonegap_file_file.md.html#FileTransfer">FileTransfer</a></li>
-<li><a href="phonegap_file_file.md.html#FileTransferError">FileTransferError</a></li>
-<li><a href="phonegap_file_file.md.html#FileUploadOptions">FileUploadOptions</a></li>
-<li><a href="phonegap_file_file.md.html#FileUploadResult">FileUploadResult</a></li>
-<li><a href="phonegap_file_file.md.html#FileWriter">FileWriter</a></li>
-<li><a href="phonegap_file_file.md.html#Flags">Flags</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></li>
+<li><a href="cordova_file_file.md.html#FileError">FileError</a></li>
+<li><a href="cordova_file_file.md.html#FileReader">FileReader</a></li>
+<li><a href="cordova_file_file.md.html#FileSystem">FileSystem</a></li>
+<li><a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a></li>
+<li><a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a></li>
+<li><a href="cordova_file_file.md.html#FileUploadOptions">FileUploadOptions</a></li>
+<li><a href="cordova_file_file.md.html#FileUploadResult">FileUploadResult</a></li>
+<li><a href="cordova_file_file.md.html#FileWriter">FileWriter</a></li>
+<li><a href="cordova_file_file.md.html#Flags">Flags</a></li>
</ul>
<h2>G</h2>
<ul>
-<li><a href="phonegap_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#geolocation.clearWatch">geolocation.clearWatch</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#geolocation.getCurrentPosition">geolocation.getCurrentPosition</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#geolocation.watchPosition">geolocation.watchPosition</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#geolocationError">geolocationError</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#geolocation.clearWatch">geolocation.clearWatch</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#geolocation.getCurrentPosition">geolocation.getCurrentPosition</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#geolocation.watchPosition">geolocation.watchPosition</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></li>
<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
<li><a href="guide_getting-started_android_index.md.html#Getting%20Started%20with%20Android">Getting Started with Android</a></li>
<li><a href="guide_getting-started_blackberry_index.md.html#Getting%20Started%20with%20Blackberry">Getting Started with Blackberry</a></li>
@@ -211,74 +211,74 @@
<h2>L</h2>
<ul>
-<li><a href="phonegap_file_file.md.html#LocalFileSystem">LocalFileSystem</a></li>
-<li><a href="phonegap_storage_storage.md.html#localStorage">localStorage</a></li>
+<li><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a></li>
+<li><a href="cordova_storage_storage.md.html#localStorage">localStorage</a></li>
</ul>
<h2>M</h2>
<ul>
-<li><a href="phonegap_media_media.md.html#Media">Media</a></li>
-<li><a href="phonegap_media_media.md.html#media.getCurrentPosition">media.getCurrentPosition</a></li>
-<li><a href="phonegap_media_media.md.html#media.getDuration">media.getDuration</a></li>
-<li><a href="phonegap_media_media.md.html#media.pause">media.pause</a></li>
-<li><a href="phonegap_media_media.md.html#media.play">media.play</a></li>
-<li><a href="phonegap_media_media.md.html#media.release">media.release</a></li>
-<li><a href="phonegap_media_media.md.html#media.seekTo">media.seekTo</a></li>
-<li><a href="phonegap_media_media.md.html#media.startRecord">media.startRecord</a></li>
-<li><a href="phonegap_media_media.md.html#media.stop">media.stop</a></li>
-<li><a href="phonegap_media_media.md.html#media.stopRecord">media.stopRecord</a></li>
-<li><a href="phonegap_media_media.md.html#mediaError">mediaError</a></li>
-<li><a href="phonegap_media_media.md.html#MediaError">MediaError</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#MediaFile">MediaFile</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#MediaFile.getFormatData">MediaFile.getFormatData</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#MediaFileData">MediaFileData</a></li>
-<li><a href="phonegap_events_events.md.html#menubutton">menubutton</a></li>
-<li><a href="phonegap_file_file.md.html#Metadata">Metadata</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_media_media.md.html#media.getCurrentPosition">media.getCurrentPosition</a></li>
+<li><a href="cordova_media_media.md.html#media.getDuration">media.getDuration</a></li>
+<li><a href="cordova_media_media.md.html#media.pause">media.pause</a></li>
+<li><a href="cordova_media_media.md.html#media.play">media.play</a></li>
+<li><a href="cordova_media_media.md.html#media.release">media.release</a></li>
+<li><a href="cordova_media_media.md.html#media.seekTo">media.seekTo</a></li>
+<li><a href="cordova_media_media.md.html#media.startRecord">media.startRecord</a></li>
+<li><a href="cordova_media_media.md.html#media.stop">media.stop</a></li>
+<li><a href="cordova_media_media.md.html#media.stopRecord">media.stopRecord</a></li>
+<li><a href="cordova_media_media.md.html#mediaError">mediaError</a></li>
+<li><a href="cordova_media_media.md.html#MediaError">MediaError</a></li>
+<li><a href="cordova_media_capture_capture.md.html#MediaFile">MediaFile</a></li>
+<li><a href="cordova_media_capture_capture.md.html#MediaFile.getFormatData">MediaFile.getFormatData</a></li>
+<li><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></li>
+<li><a href="cordova_events_events.md.html#menubutton">menubutton</a></li>
+<li><a href="cordova_file_file.md.html#Metadata">Metadata</a></li>
</ul>
<h2>N</h2>
<ul>
-<li><a href="phonegap_notification_notification.md.html#Notification">Notification</a></li>
-<li><a href="phonegap_notification_notification.md.html#notification.alert">notification.alert</a></li>
-<li><a href="phonegap_notification_notification.md.html#notification.beep">notification.beep</a></li>
-<li><a href="phonegap_notification_notification.md.html#notification.confirm">notification.confirm</a></li>
-<li><a href="phonegap_notification_notification.md.html#notification.vibrate">notification.vibrate</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_notification_notification.md.html#notification.alert">notification.alert</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.confirm">notification.confirm</a></li>
+<li><a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a></li>
</ul>
<h2>O</h2>
<ul>
-<li><a href="phonegap_events_events.md.html#offline">offline</a></li>
-<li><a href="phonegap_events_events.md.html#online">online</a></li>
-<li><a href="phonegap_storage_storage.md.html#openDatabase">openDatabase</a></li>
+<li><a href="cordova_events_events.md.html#offline">offline</a></li>
+<li><a href="cordova_events_events.md.html#online">online</a></li>
+<li><a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a></li>
</ul>
<h2>P</h2>
<ul>
-<li><a href="phonegap_events_events.md.html#pause">pause</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#Position">Position</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#PositionError">PositionError</a></li>
+<li><a href="cordova_events_events.md.html#pause">pause</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Position">Position</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a></li>
</ul>
<h2>R</h2>
<ul>
-<li><a href="phonegap_events_events.md.html#resume">resume</a></li>
+<li><a href="cordova_events_events.md.html#resume">resume</a></li>
</ul>
<h2>S</h2>
<ul>
-<li><a href="phonegap_events_events.md.html#searchbutton">searchbutton</a></li>
-<li><a href="phonegap_storage_storage.md.html#SQLError">SQLError</a></li>
-<li><a href="phonegap_storage_storage.md.html#SQLResultSet">SQLResultSet</a></li>
-<li><a href="phonegap_storage_storage.md.html#SQLResultSetList">SQLResultSetList</a></li>
-<li><a href="phonegap_storage_storage.md.html#SQLTransaction">SQLTransaction</a></li>
-<li><a href="phonegap_events_events.md.html#startcallbutton">startcallbutton</a></li>
-<li><a href="phonegap_storage_storage.md.html#Storage">Storage</a></li>
+<li><a href="cordova_events_events.md.html#searchbutton">searchbutton</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLError">SQLError</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLResultSetList">SQLResultSetList</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a></li>
+<li><a href="cordova_events_events.md.html#startcallbutton">startcallbutton</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
</ul>
<h2>V</h2>
<ul>
-<li><a href="phonegap_events_events.md.html#volumedownbutton">volumedownbutton</a></li>
-<li><a href="phonegap_events_events.md.html#volumeupbutton">volumeupbutton</a></li>
+<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>
</div>
View
2 doc/_index.json
@@ -1 +1 @@
-[{"term":"Acceleration","url":"phonegap_accelerometer_accelerometer.md.html"},{"term":"Accelerometer","url":"phonegap_accelerometer_accelerometer.md.html"},{"term":"accelerometer.clearWatch","url":"phonegap_accelerometer_accelerometer.md.html"},{"term":"accelerometer.getCurrentAcceleration","url":"phonegap_accelerometer_accelerometer.md.html"},{"term":"accelerometer.watchAcceleration","url":"phonegap_accelerometer_accelerometer.md.html"},{"term":"accelerometerError","url":"phonegap_accelerometer_accelerometer.md.html"},{"term":"accelerometerOptions","url":"phonegap_accelerometer_accelerometer.md.html"},{"term":"accelerometerSuccess","url":"phonegap_accelerometer_accelerometer.md.html"},{"term":"API Reference","url":"index.md.html"},{"term":"backbutton","url":"phonegap_events_events.md.html"},{"term":"batterycritical","url":"phonegap_events_events.md.html"},{"term":"batterylow","url":"phonegap_events_events.md.html"},{"term":"batterystatus","url":"phonegap_events_events.md.html"},{"term":"Camera","url":"phonegap_camera_camera.md.html"},{"term":"camera.getPicture","url":"phonegap_camera_camera.md.html"},{"term":"cameraError","url":"phonegap_camera_camera.md.html"},{"term":"cameraOptions","url":"phonegap_camera_camera.md.html"},{"term":"cameraSuccess","url":"phonegap_camera_camera.md.html"},{"term":"Capture","url":"phonegap_media_capture_capture.md.html"},{"term":"capture.captureAudio","url":"phonegap_media_capture_capture.md.html"},{"term":"capture.captureImage","url":"phonegap_media_capture_capture.md.html"},{"term":"capture.captureVideo","url":"phonegap_media_capture_capture.md.html"},{"term":"CaptureAudioOptions","url":"phonegap_media_capture_capture.md.html"},{"term":"CaptureCB","url":"phonegap_media_capture_capture.md.html"},{"term":"CaptureError","url":"phonegap_media_capture_capture.md.html"},{"term":"CaptureErrorCB","url":"phonegap_media_capture_capture.md.html"},{"term":"CaptureImageOptions","url":"phonegap_media_capture_capture.md.html"},{"term":"CaptureVideoOptions","url":"phonegap_media_capture_capture.md.html"},{"term":"Compass","url":"phonegap_compass_compass.md.html"},{"term":"compass.clearWatch","url":"phonegap_compass_compass.md.html"},{"term":"compass.clearWatchFilter","url":"phonegap_compass_compass.md.html"},{"term":"compass.getCurrentHeading","url":"phonegap_compass_compass.md.html"},{"term":"compass.watchHeading","url":"phonegap_compass_compass.md.html"},{"term":"compass.watchHeadingFilter","url":"phonegap_compass_compass.md.html"},{"term":"CompassError","url":"phonegap_compass_compass.md.html"},{"term":"compassError","url":"phonegap_compass_compass.md.html"},{"term":"compassHeading","url":"phonegap_compass_compass.md.html"},{"term":"compassOptions","url":"phonegap_compass_compass.md.html"},{"term":"compassSuccess","url":"phonegap_compass_compass.md.html"},{"term":"ConfigurationData","url":"phonegap_media_capture_capture.md.html"},{"term":"Connection","url":"phonegap_connection_connection.md.html"},{"term":"connection.type","url":"phonegap_connection_connection.md.html"},{"term":"Contact","url":"phonegap_contacts_contacts.md.html"},{"term":"ContactAddress","url":"phonegap_contacts_contacts.md.html"},{"term":"contactError","url":"phonegap_contacts_contacts.md.html"},{"term":"ContactError","url":"phonegap_contacts_contacts.md.html"},{"term":"ContactField","url":"phonegap_contacts_contacts.md.html"},{"term":"contactFields","url":"phonegap_contacts_contacts.md.html"},{"term":"contactFindOptions","url":"phonegap_contacts_contacts.md.html"},{"term":"ContactFindOptions","url":"phonegap_contacts_contacts.md.html"},{"term":"ContactName","url":"phonegap_contacts_contacts.md.html"},{"term":"ContactOrganization","url":"phonegap_contacts_contacts.md.html"},{"term":"Contacts","url":"phonegap_contacts_contacts.md.html"},{"term":"contacts.create","url":"phonegap_contacts_contacts.md.html"},{"term":"contacts.find","url":"phonegap_contacts_contacts.md.html"},{"term":"contactSuccess","url":"phonegap_contacts_contacts.md.html"},{"term":"Coordinates","url":"phonegap_geolocation_geolocation.md.html"},{"term":"Database","url":"phonegap_storage_storage.md.html"},{"term":"database_displayname","url":"phonegap_storage_storage.md.html"},{"term":"database_name","url":"phonegap_storage_storage.md.html"},{"term":"database_size","url":"phonegap_storage_storage.md.html"},{"term":"database_version","url":"phonegap_storage_storage.md.html"},{"term":"Device","url":"phonegap_device_device.md.html"},{"term":"device.cordova","url":"phonegap_device_device.md.html"},{"term":"device.name","url":"phonegap_device_device.md.html"},{"term":"device.platform","url":"phonegap_device_device.md.html"},{"term":"device.uuid","url":"phonegap_device_device.md.html"},{"term":"device.version","url":"phonegap_device_device.md.html"},{"term":"deviceready","url":"phonegap_events_events.md.html"},{"term":"DirectoryEntry","url":"phonegap_file_file.md.html"},{"term":"DirectoryReader","url":"phonegap_file_file.md.html"},{"term":"endcallbutton","url":"phonegap_events_events.md.html"},{"term":"Events","url":"phonegap_events_events.md.html"},{"term":"File","url":"phonegap_file_file.md.html"},{"term":"FileEntry","url":"phonegap_file_file.md.html"},{"term":"FileError","url":"phonegap_file_file.md.html"},{"term":"FileReader","url":"phonegap_file_file.md.html"},{"term":"FileSystem","url":"phonegap_file_file.md.html"},{"term":"FileTransfer","url":"phonegap_file_file.md.html"},{"term":"FileTransferError","url":"phonegap_file_file.md.html"},{"term":"FileUploadOptions","url":"phonegap_file_file.md.html"},{"term":"FileUploadResult","url":"phonegap_file_file.md.html"},{"term":"FileWriter","url":"phonegap_file_file.md.html"},{"term":"Flags","url":"phonegap_file_file.md.html"},{"term":"Geolocation","url":"phonegap_geolocation_geolocation.md.html"},{"term":"geolocation.clearWatch","url":"phonegap_geolocation_geolocation.md.html"},{"term":"geolocation.getCurrentPosition","url":"phonegap_geolocation_geolocation.md.html"},{"term":"geolocation.watchPosition","url":"phonegap_geolocation_geolocation.md.html"},{"term":"geolocationError","url":"phonegap_geolocation_geolocation.md.html"},{"term":"geolocationOptions","url":"phonegap_geolocation_geolocation.md.html"},{"term":"geolocationSuccess","url":"phonegap_geolocation_geolocation.md.html"},{"term":"Getting Started Guides","url":"guide_getting-started_index.md.html"},{"term":"Getting Started with Android","url":"guide_getting-started_android_index.md.html"},{"term":"Getting Started with Blackberry","url":"guide_getting-started_blackberry_index.md.html"},{"term":"Getting Started with iOS","url":"guide_getting-started_ios_index.md.html"},{"term":"Getting Started with Symbian","url":"guide_getting-started_symbian_index.md.html"},{"term":"Getting Started with WebOS","url":"guide_getting-started_webos_index.md.html"},{"term":"Getting Started with Windows Phone","url":"guide_getting-started_windows-phone_index.md.html"},{"term":"Guides","url":"index.md.html"},{"term":"LocalFileSystem","url":"phonegap_file_file.md.html"},{"term":"localStorage","url":"phonegap_storage_storage.md.html"},{"term":"Media","url":"phonegap_media_media.md.html"},{"term":"media.getCurrentPosition","url":"phonegap_media_media.md.html"},{"term":"media.getDuration","url":"phonegap_media_media.md.html"},{"term":"media.pause","url":"phonegap_media_media.md.html"},{"term":"media.play","url":"phonegap_media_media.md.html"},{"term":"media.release","url":"phonegap_media_media.md.html"},{"term":"media.seekTo","url":"phonegap_media_media.md.html"},{"term":"media.startRecord","url":"phonegap_media_media.md.html"},{"term":"media.stop","url":"phonegap_media_media.md.html"},{"term":"media.stopRecord","url":"phonegap_media_media.md.html"},{"term":"mediaError","url":"phonegap_media_media.md.html"},{"term":"MediaError","url":"phonegap_media_media.md.html"},{"term":"MediaFile","url":"phonegap_media_capture_capture.md.html"},{"term":"MediaFile.getFormatData","url":"phonegap_media_capture_capture.md.html"},{"term":"MediaFileData","url":"phonegap_media_capture_capture.md.html"},{"term":"menubutton","url":"phonegap_events_events.md.html"},{"term":"Metadata","url":"phonegap_file_file.md.html"},{"term":"Notification","url":"phonegap_notification_notification.md.html"},{"term":"notification.alert","url":"phonegap_notification_notification.md.html"},{"term":"notification.beep","url":"phonegap_notification_notification.md.html"},{"term":"notification.confirm","url":"phonegap_notification_notification.md.html"},{"term":"notification.vibrate","url":"phonegap_notification_notification.md.html"},{"term":"offline","url":"phonegap_events_events.md.html"},{"term":"online","url":"phonegap_events_events.md.html"},{"term":"openDatabase","url":"phonegap_storage_storage.md.html"},{"term":"pause","url":"phonegap_events_events.md.html"},{"term":"Position","url":"phonegap_geolocation_geolocation.md.html"},{"term":"PositionError","url":"phonegap_geolocation_geolocation.md.html"},{"term":"resume","url":"phonegap_events_events.md.html"},{"term":"searchbutton","url":"phonegap_events_events.md.html"},{"term":"SQLError","url":"phonegap_storage_storage.md.html"},{"term":"SQLResultSet","url":"phonegap_storage_storage.md.html"},{"term":"SQLResultSetList","url":"phonegap_storage_storage.md.html"},{"term":"SQLTransaction","url":"phonegap_storage_storage.md.html"},{"term":"startcallbutton","url":"phonegap_events_events.md.html"},{"term":"Storage","url":"phonegap_storage_storage.md.html"},{"term":"volumedownbutton","url":"phonegap_events_events.md.html"},{"term":"volumeupbutton","url":"phonegap_events_events.md.html"}]
+[{"term":"Acceleration","url":"cordova_accelerometer_accelerometer.md.html"},{"term":"Accelerometer","url":"cordova_accelerometer_accelerometer.md.html"},{"term":"accelerometer.clearWatch","url":"cordova_accelerometer_accelerometer.md.html"},{"term":"accelerometer.getCurrentAcceleration","url":"cordova_accelerometer_accelerometer.md.html"},{"term":"accelerometer.watchAcceleration","url":"cordova_accelerometer_accelerometer.md.html"},{"term":"accelerometerError","url":"cordova_accelerometer_accelerometer.md.html"},{"term":"accelerometerOptions","url":"cordova_accelerometer_accelerometer.md.html"},{"term":"accelerometerSuccess","url":"cordova_accelerometer_accelerometer.md.html"},{"term":"API Reference","url":"index.md.html"},{"term":"backbutton","url":"cordova_events_events.md.html"},{"term":"batterycritical","url":"cordova_events_events.md.html"},{"term":"batterylow","url":"cordova_events_events.md.html"},{"term":"batterystatus","url":"cordova_events_events.md.html"},{"term":"Camera","url":"cordova_camera_camera.md.html"},{"term":"camera.getPicture","url":"cordova_camera_camera.md.html"},{"term":"cameraError","url":"cordova_camera_camera.md.html"},{"term":"cameraOptions","url":"cordova_camera_camera.md.html"},{"term":"cameraSuccess","url":"cordova_camera_camera.md.html"},{"term":"Capture","url":"cordova_media_capture_capture.md.html"},{"term":"capture.captureAudio","url":"cordova_media_capture_capture.md.html"},{"term":"capture.captureImage","url":"cordova_media_capture_capture.md.html"},{"term":"capture.captureVideo","url":"cordova_media_capture_capture.md.html"},{"term":"CaptureAudioOptions","url":"cordova_media_capture_capture.md.html"},{"term":"CaptureCB","url":"cordova_media_capture_capture.md.html"},{"term":"CaptureError","url":"cordova_media_capture_capture.md.html"},{"term":"CaptureErrorCB","url":"cordova_media_capture_capture.md.html"},{"term":"CaptureImageOptions","url":"cordova_media_capture_capture.md.html"},{"term":"CaptureVideoOptions","url":"cordova_media_capture_capture.md.html"},{"term":"Compass","url":"cordova_compass_compass.md.html"},{"term":"compass.clearWatch","url":"cordova_compass_compass.md.html"},{"term":"compass.clearWatchFilter","url":"cordova_compass_compass.md.html"},{"term":"compass.getCurrentHeading","url":"cordova_compass_compass.md.html"},{"term":"compass.watchHeading","url":"cordova_compass_compass.md.html"},{"term":"compass.watchHeadingFilter","url":"cordova_compass_compass.md.html"},{"term":"CompassError","url":"cordova_compass_compass.md.html"},{"term":"compassError","url":"cordova_compass_compass.md.html"},{"term":"compassHeading","url":"cordova_compass_compass.md.html"},{"term":"compassOptions","url":"cordova_compass_compass.md.html"},{"term":"compassSuccess","url":"cordova_compass_compass.md.html"},{"term":"ConfigurationData","url":"cordova_media_capture_capture.md.html"},{"term":"Connection","url":"cordova_connection_connection.md.html"},{"term":"connection.type","url":"cordova_connection_connection.md.html"},{"term":"Contact","url":"cordova_contacts_contacts.md.html"},{"term":"ContactAddress","url":"cordova_contacts_contacts.md.html"},{"term":"contactError","url":"cordova_contacts_contacts.md.html"},{"term":"ContactError","url":"cordova_contacts_contacts.md.html"},{"term":"ContactField","url":"cordova_contacts_contacts.md.html"},{"term":"contactFields","url":"cordova_contacts_contacts.md.html"},{"term":"contactFindOptions","url":"cordova_contacts_contacts.md.html"},{"term":"ContactFindOptions","url":"cordova_contacts_contacts.md.html"},{"term":"ContactName","url":"cordova_contacts_contacts.md.html"},{"term":"ContactOrganization","url":"cordova_contacts_contacts.md.html"},{"term":"Contacts","url":"cordova_contacts_contacts.md.html"},{"term":"contacts.create","url":"cordova_contacts_contacts.md.html"},{"term":"contacts.find","url":"cordova_contacts_contacts.md.html"},{"term":"contactSuccess","url":"cordova_contacts_contacts.md.html"},{"term":"Coordinates","url":"cordova_geolocation_geolocation.md.html"},{"term":"Database","url":"cordova_storage_storage.md.html"},{"term":"database_displayname","url":"cordova_storage_storage.md.html"},{"term":"database_name","url":"cordova_storage_storage.md.html"},{"term":"database_size","url":"cordova_storage_storage.md.html"},{"term":"database_version","url":"cordova_storage_storage.md.html"},{"term":"Device","url":"cordova_device_device.md.html"},{"term":"device.cordova","url":"cordova_device_device.md.html"},{"term":"device.name","url":"cordova_device_device.md.html"},{"term":"device.platform","url":"cordova_device_device.md.html"},{"term":"device.uuid","url":"cordova_device_device.md.html"},{"term":"device.version","url":"cordova_device_device.md.html"},{"term":"deviceready","url":"cordova_events_events.md.html"},{"term":"DirectoryEntry","url":"cordova_file_file.md.html"},{"term":"DirectoryReader","url":"cordova_file_file.md.html"},{"term":"endcallbutton","url":"cordova_events_events.md.html"},{"term":"Events","url":"cordova_events_events.md.html"},{"term":"File","url":"cordova_file_file.md.html"},{"term":"FileEntry","url":"cordova_file_file.md.html"},{"term":"FileError","url":"cordova_file_file.md.html"},{"term":"FileReader","url":"cordova_file_file.md.html"},{"term":"FileSystem","url":"cordova_file_file.md.html"},{"term":"FileTransfer","url":"cordova_file_file.md.html"},{"term":"FileTransferError","url":"cordova_file_file.md.html"},{"term":"FileUploadOptions","url":"cordova_file_file.md.html"},{"term":"FileUploadResult","url":"cordova_file_file.md.html"},{"term":"FileWriter","url":"cordova_file_file.md.html"},{"term":"Flags","url":"cordova_file_file.md.html"},{"term":"Geolocation","url":"cordova_geolocation_geolocation.md.html"},{"term":"geolocation.clearWatch","url":"cordova_geolocation_geolocation.md.html"},{"term":"geolocation.getCurrentPosition","url":"cordova_geolocation_geolocation.md.html"},{"term":"geolocation.watchPosition","url":"cordova_geolocation_geolocation.md.html"},{"term":"geolocationError","url":"cordova_geolocation_geolocation.md.html"},{"term":"geolocationOptions","url":"cordova_geolocation_geolocation.md.html"},{"term":"geolocationSuccess","url":"cordova_geolocation_geolocation.md.html"},{"term":"Getting Started Guides","url":"guide_getting-started_index.md.html"},{"term":"Getting Started with Android","url":"guide_getting-started_android_index.md.html"},{"term":"Getting Started with Blackberry","url":"guide_getting-started_blackberry_index.md.html"},{"term":"Getting Started with iOS","url":"guide_getting-started_ios_index.md.html"},{"term":"Getting Started with Symbian","url":"guide_getting-started_symbian_index.md.html"},{"term":"Getting Started with WebOS","url":"guide_getting-started_webos_index.md.html"},{"term":"Getting Started with Windows Phone","url":"guide_getting-started_windows-phone_index.md.html"},{"term":"Guides","url":"index.md.html"},{"term":"LocalFileSystem","url":"cordova_file_file.md.html"},{"term":"localStorage","url":"cordova_storage_storage.md.html"},{"term":"Media","url":"cordova_media_media.md.html"},{"term":"media.getCurrentPosition","url":"cordova_media_media.md.html"},{"term":"media.getDuration","url":"cordova_media_media.md.html"},{"term":"media.pause","url":"cordova_media_media.md.html"},{"term":"media.play","url":"cordova_media_media.md.html"},{"term":"media.release","url":"cordova_media_media.md.html"},{"term":"media.seekTo","url":"cordova_media_media.md.html"},{"term":"media.startRecord","url":"cordova_media_media.md.html"},{"term":"media.stop","url":"cordova_media_media.md.html"},{"term":"media.stopRecord","url":"cordova_media_media.md.html"},{"term":"mediaError","url":"cordova_media_media.md.html"},{"term":"MediaError","url":"cordova_media_media.md.html"},{"term":"MediaFile","url":"cordova_media_capture_capture.md.html"},{"term":"MediaFile.getFormatData","url":"cordova_media_capture_capture.md.html"},{"term":"MediaFileData","url":"cordova_media_capture_capture.md.html"},{"term":"menubutton","url":"cordova_events_events.md.html"},{"term":"Metadata","url":"cordova_file_file.md.html"},{"term":"Notification","url":"cordova_notification_notification.md.html"},{"term":"notification.alert","url":"cordova_notification_notification.md.html"},{"term":"notification.beep","url":"cordova_notification_notification.md.html"},{"term":"notification.confirm","url":"cordova_notification_notification.md.html"},{"term":"notification.vibrate","url":"cordova_notification_notification.md.html"},{"term":"offline","url":"cordova_events_events.md.html"},{"term":"online","url":"cordova_events_events.md.html"},{"term":"openDatabase","url":"cordova_storage_storage.md.html"},{"term":"pause","url":"cordova_events_events.md.html"},{"term":"Position","url":"cordova_geolocation_geolocation.md.html"},{"term":"PositionError","url":"cordova_geolocation_geolocation.md.html"},{"term":"resume","url":"cordova_events_events.md.html"},{"term":"searchbutton","url":"cordova_events_events.md.html"},{"term":"SQLError","url":"cordova_storage_storage.md.html"},{"term":"SQLResultSet","url":"cordova_storage_storage.md.html"},{"term":"SQLResultSetList","url":"cordova_storage_storage.md.html"},{"term":"SQLTransaction","url":"cordova_storage_storage.md.html"},{"term":"startcallbutton","url":"cordova_events_events.md.html"},{"term":"Storage","url":"cordova_storage_storage.md.html"},{"term":"volumedownbutton","url":"cordova_events_events.md.html"},{"term":"volumeupbutton","url":"cordova_events_events.md.html"}]
View
171 ...negap_accelerometer_accelerometer.md.html → ...rdova_accelerometer_accelerometer.md.html
@@ -84,19 +84,19 @@
<div class="vertical_divider"></div>
<h1>API Reference</h1>
<ul>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
-<li><a href="phonegap_camera_camera.md.html#Camera">Camera</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#Capture">Capture</a></li>
-<li><a href="phonegap_compass_compass.md.html#Compass">Compass</a></li>
-<li><a href="phonegap_connection_connection.md.html#Connection">Connection</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#Contacts">Contacts</a></li>
-<li><a href="phonegap_device_device.md.html#Device">Device</a></li>
-<li><a href="phonegap_events_events.md.html#Events">Events</a></li>
-<li><a href="phonegap_file_file.md.html#File">File</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
-<li><a href="phonegap_media_media.md.html#Media">Media</a></li>
-<li><a href="phonegap_notification_notification.md.html#Notification">Notification</a></li>
-<li><a href="phonegap_storage_storage.md.html#Storage">Storage</a></li>
+<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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
</ul>
<h1>Guides</h1>
<ul>
@@ -118,32 +118,32 @@
</h2>
<ul>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a></li>
</ul>
<h2>
<a name="Accelerometer_arguments">Arguments</a>
</h2>
<ul>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a></li>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#accelerometerOptions">accelerometerOptions</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerOptions">accelerometerOptions</a></li>
</ul>
<h2>
<a name="Accelerometer_objects_read_only">Objects (Read-Only)</a>
</h2>
<ul>
-<li><a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></li>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></li>
</ul>
<hr>
<h1><a name="accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a></h1>
<p>Get the current acceleration along the x, y, and z axis.</p>
-<pre class="prettyprint"><code>navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(<a href="phonegap_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a>, <a href="phonegap_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a>);
+<pre class="prettyprint"><code>navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(<a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a>, <a href="cordova_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a>);
</code></pre>
<h2>
@@ -152,7 +152,7 @@
<p>The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis.</p>
-<p>The acceleration is returned using the <code><a href="phonegap_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></code> callback function.</p>
+<p>The acceleration is returned using the <code><a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></code> callback function.</p>
<h2>
<a name="accelerometer.getCurrentAcceleration_supported_platforms">Supported Platforms</a>
@@ -162,23 +162,24 @@
<li>Android</li>
<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
<li>iPhone</li>
+<li>Windows Phone 7 (Mango)</li>
</ul>
<h2>
<a name="accelerometer.getCurrentAcceleration_quick_example">Quick Example</a>
</h2>
<pre class="prettyprint"><code>function onSuccess(acceleration) {
- alert('<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
function onError() {
alert('onError!');
};
-navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
+navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
</code></pre>
<h2>
@@ -188,27 +189,27 @@
<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;head&gt;
- &lt;title&gt;<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example&lt;/title&gt;
+ &lt;title&gt;<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example&lt;/title&gt;
&lt;script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"&gt;&lt;/script&gt;
&lt;script type="text/javascript" charset="utf-8"&gt;
// Wait for Cordova to load
//
- document.addEventListener("<a href="phonegap_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+ document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// Cordova is ready
//
function onDeviceReady() {
- navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
+ navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
- alert('<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
}
@@ -241,9 +242,9 @@
<p>At a regular interval, get the acceleration along the x, y, and z axis.</p>
-<pre class="prettyprint"><code>var watchID = navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(<a href="phonegap_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a>,
- <a href="phonegap_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a>,
- [<a href="phonegap_accelerometer_accelerometer.md.html#accelerometerOptions">accelerometerOptions</a>]);
+<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(<a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a>,
+ <a href="cordova_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a>,
+ [<a href="cordova_accelerometer_accelerometer.md.html#accelerometerOptions">accelerometerOptions</a>]);
</code></pre>
<h2>
@@ -252,9 +253,9 @@
<p>The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis.</p>
-<p>The <code><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></code> gets the device's current acceleration at a regular interval. Each time the <code><a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> is retrieved, the <code><a href="phonegap_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></code> callback function is executed. Specify the interval in milliseconds via the <code>frequency</code> parameter in the <code>acceleratorOptions</code> object.</p>
+<p>The <code><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></code> gets the device's current acceleration at a regular interval. Each time the <code><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> is retrieved, the <code><a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></code> callback function is executed. Specify the interval in milliseconds via the <code>frequency</code> parameter in the <code>acceleratorOptions</code> object.</p>
-<p>The returned watch ID references references the accelerometer watch interval. The watch ID can be used with <code><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a></code> to stop watching the accelerometer.</p>
+<p>The returned watch ID references references the accelerometer watch interval. The watch ID can be used with <code><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a></code> to stop watching the accelerometer.</p>
<h2>
<a name="accelerometer.watchAcceleration_supported_platforms">Supported Platforms</a>
@@ -264,15 +265,16 @@
<li>Android</li>
<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
<li>iPhone</li>
+<li>Windows Phone 7 (Mango)</li>
</ul>
<h2>
<a name="accelerometer.watchAcceleration_quick_example">Quick Example</a>
</h2>
<pre class="prettyprint"><code>function onSuccess(acceleration) {
- alert('<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -282,7 +284,7 @@
var options = { frequency: 3000 }; // Update every 3 seconds
-var watchID = navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
+var watchID = navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
</code></pre>
<h2>
@@ -292,7 +294,7 @@
<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;head&gt;
- &lt;title&gt;<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example&lt;/title&gt;
+ &lt;title&gt;<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example&lt;/title&gt;
&lt;script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"&gt;&lt;/script&gt;
&lt;script type="text/javascript" charset="utf-8"&gt;
@@ -302,7 +304,7 @@
// Wait for Cordova to load
//
- document.addEventListener("<a href="phonegap_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+ document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// Cordova is ready
//
@@ -317,14 +319,14 @@
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
+ watchID = navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
}
// Stop watching the acceleration
//
function stopWatch() {
if (watchID) {
- navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
+ navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
watchID = null;
}
}
@@ -333,9 +335,9 @@
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '&lt;br /&gt;' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '&lt;br /&gt;' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '&lt;br /&gt;' +
+ element.innerHTML = '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '&lt;br /&gt;' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '&lt;br /&gt;' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '&lt;br /&gt;' +
'Timestamp: ' + acceleration.timestamp + '&lt;br /&gt;';
}
@@ -368,14 +370,14 @@
<hr>
<h1><a name="accelerometer.clearWatch">accelerometer.clearWatch</a></h1>
-<p>Stop watching the <code><a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> referenced by the watch ID parameter.</p>
+<p>Stop watching the <code><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> referenced by the watch ID parameter.</p>
-<pre class="prettyprint"><code>navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
+<pre class="prettyprint"><code>navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
</code></pre>
<ul>
<li>
-<strong>watchID</strong>: The ID returned by <code><a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></code>.</li>
+<strong>watchID</strong>: The ID returned by <code><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></code>.</li>
</ul>
<h2>
<a name="accelerometer.clearWatch_supported_platforms">Supported Platforms</a>
@@ -385,16 +387,17 @@
<li>Android</li>
<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
<li>iPhone</li>
+<li>Windows Phone 7 (Mango)</li>
</ul>
<h2>
<a name="accelerometer.clearWatch_quick_example">Quick Example</a>
</h2>
-<pre class="prettyprint"><code>var watchID = navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
+<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
// ... later on ...
-navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
+navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
</code></pre>
<h2>
@@ -404,7 +407,7 @@
<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;head&gt;
- &lt;title&gt;<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example&lt;/title&gt;
+ &lt;title&gt;<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example&lt;/title&gt;
&lt;script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"&gt;&lt;/script&gt;
&lt;script type="text/javascript" charset="utf-8"&gt;
@@ -414,7 +417,7 @@
// Wait for Cordova to load
//
- document.addEventListener("<a href="phonegap_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+ document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// Cordova is ready
//
@@ -429,14 +432,14 @@
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
+ watchID = navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
}
// Stop watching the acceleration
//
function stopWatch() {
if (watchID) {
- navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
+ navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
watchID = null;
}
}
@@ -445,9 +448,9 @@
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '&lt;br /&gt;' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '&lt;br /&gt;' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '&lt;br /&gt;' +
+ element.innerHTML = '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '&lt;br /&gt;' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '&lt;br /&gt;' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '&lt;br /&gt;' +
'Timestamp: ' + acceleration.timestamp + '&lt;br /&gt;';
}
@@ -469,27 +472,27 @@
<hr>
<h1><a name="Acceleration">Acceleration</a></h1>
-<p>Contains <code><a href="phonegap_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></code> data captured at a specific point in time.</p>
+<p>Contains <code><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></code> data captured at a specific point in time.</p>
<h2>
<a name="Acceleration_properties">Properties</a>
</h2>
<ul>
<li>
-<strong>x:</strong> Amount of motion on the x-axis. Range [0, 1] (<code>Number</code>)</li>
+<strong>x:</strong> Amount of acceleration on the x-axis. (in m/s^2) (<code>Number</code>)</li>
<li>
-<strong>y:</strong> Amount of motion on the y-axis. Range [0, 1] (<code>Number</code>)</li>
+<strong>y:</strong> Amount of acceleration on the y-axis. (in m/s^2) (<code>Number</code>)</li>
<li>
-<strong>z:</strong> Amount of motion on the z-axis. Range [0, 1] (<code>Number</code>)</li>
+<strong>z:</strong> Amount of acceleration on the z-axis. (in m/s^2) (<code>Number</code>)</li>
<li>
<strong>timestamp:</strong> Creation timestamp in milliseconds. (<code>DOMTimeStamp</code>)</li>
</ul>
<h2>
<a name="Acceleration_description">Description</a>
</h2>
-<p>This object is created and populated by Cordova, and returned by an <code><a href="phonegap_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></code> method.</p>
+<p>This object is created and populated by Cordova, and returned by an <code><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></code> method. The x, y, z acceleration values include the effect of gravity (9.81 m/s^2), so at when a device is lying flat on a table facing up, the value returned should be x=0, y=0, z=9.81.</p>
<h2>
<a name="Acceleration_supported_platforms">Supported Platforms</a>
@@ -498,25 +501,25 @@
<ul>
<li>Android</li>
<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
-<li>iPhone</li>
-<li>Windows Phone 7 ( Mango )</li>
+<li>iOS</li>
+<li>Windows Phone 7 (Mango)</li>
</ul>
<h2>
<a name="Acceleration_quick_example">Quick Example</a>
</h2>
<pre class="prettyprint"><code>function onSuccess(acceleration) {
- alert('<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
function onError() {
alert('onError!');
};
-navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
+navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
</code></pre>
<h2>
@@ -526,27 +529,27 @@
<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;head&gt;
- &lt;title&gt;<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example&lt;/title&gt;
+ &lt;title&gt;<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example&lt;/title&gt;
&lt;script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"&gt;&lt;/script&gt;
&lt;script type="text/javascript" charset="utf-8"&gt;
// Wait for Cordova to load
//
- document.addEventListener("<a href="phonegap_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+ document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// Cordova is ready
//
function onDeviceReady() {
- navigator.<a href="phonegap_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
+ navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
//
- function onSuccess() {
- alert('<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ function onSuccess(acceleration) {
+ alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
}
@@ -568,7 +571,7 @@
<hr>
<h1><a name="accelerometerSuccess">accelerometerSuccess</a></h1>
-<p>onSuccess callback function that provides the <a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> information.</p>
+<p>onSuccess callback function that provides the <a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> information.</p>
<pre class="prettyprint"><code>function(acceleration) {
// Do something
@@ -581,16 +584,16 @@
<ul>
<li>
-<strong>acceleration:</strong> The acceleration at a single moment in time. (<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a>)</li>
+<strong>acceleration:</strong> The acceleration at a single moment in time. (<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a>)</li>
</ul>
<h2>
<a name="accelerometerSuccess_example">Example</a>
</h2>
<pre class="prettyprint"><code>function onSuccess(acceleration) {
- alert('<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Y: ' + acceleration.y + '\n' +
+ '<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
</code></pre>
@@ -616,7 +619,7 @@
<ul>
<li>
-<strong>frequency:</strong> How often to retrieve the <code><a href="phonegap_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> in milliseconds. <em>(Number)</em> (Default: 10000)</li>
+<strong>frequency:</strong> How often to retrieve the <code><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> in milliseconds. <em>(Number)</em> (Default: 10000)</li>
</ul>
</div>
</div>
View
115 doc/phonegap_camera_camera.md.html → doc/cordova_camera_camera.md.html
@@ -51,6 +51,7 @@
<option value="camera.getPicture">camera.getPicture</option>
<option value="camera.getPicture_description">      - Description</option>
<option value="camera.getPicture_supported_platforms">      - Supported Platforms</option>
+<option value="camera.getPicture_windows_phone_7_quirks">      - Windows Phone 7 Quirks</option>
<option value="camera.getPicture_quick_example">      - Quick Example</option>
<option value="camera.getPicture_full_example">      - Full Example</option>
<option value="cameraSuccess">cameraSuccess</option>
@@ -63,27 +64,27 @@
<option value="cameraOptions_android_quirks">      - Android Quirks</option>
<option value="cameraOptions_blackberry_quirks">      - BlackBerry Quirks</option>
<option value="cameraOptions_palm_quirks">      - Palm Quirks</option>
-<option value="cameraOptions_iphone_quirks">      - iPhone Quirks</option>
+<option value="cameraOptions_ios_quirks">      - iOS Quirks</option>
<option value="cameraOptions_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="phonegap_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
-<li><a href="phonegap_camera_camera.md.html#Camera">Camera</a></li>
-<li><a href="phonegap_media_capture_capture.md.html#Capture">Capture</a></li>
-<li><a href="phonegap_compass_compass.md.html#Compass">Compass</a></li>
-<li><a href="phonegap_connection_connection.md.html#Connection">Connection</a></li>
-<li><a href="phonegap_contacts_contacts.md.html#Contacts">Contacts</a></li>
-<li><a href="phonegap_device_device.md.html#Device">Device</a></li>
-<li><a href="phonegap_events_events.md.html#Events">Events</a></li>
-<li><a href="phonegap_file_file.md.html#File">File</a></li>
-<li><a href="phonegap_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
-<li><a href="phonegap_media_media.md.html#Media">Media</a></li>
-<li><a href="phonegap_notification_notification.md.html#Notification">Notification</a></li>
-<li><a href="phonegap_storage_storage.md.html#Storage">Storage</a></li>
+<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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
</ul>
<h1>Guides</h1>
<ul>
@@ -105,25 +106,25 @@
</h2>
<ul>
-<li><a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a></li>
+<li><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></li>
</ul>
<hr>
<h1><a name="camera.getPicture">camera.getPicture</a></h1>
<p>Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded <code>String</code> or as the URI of an image file.</p>
-<pre class="prettyprint"><code>navigator.<a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a>( <a href="phonegap_camera_camera.md.html#cameraSuccess">cameraSuccess</a>, <a href="phonegap_camera_camera.md.html#cameraError">cameraError</a>, [ <a href="phonegap_camera_camera.md.html#cameraOptions">cameraOptions</a> ] );
+<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>( <a href="cordova_camera_camera.md.html#cameraSuccess">cameraSuccess</a>, <a href="cordova_camera_camera.md.html#cameraError">cameraError</a>, [ <a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a> ] );
</code></pre>
<h2>
<a name="camera.getPicture_description">Description</a>
</h2>
-<p>Function <code><a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a></code> opens the device's default camera application so that the user can take a picture (if <code><a href="phonegap_camera_camera.md.html#Camera">Camera</a>.sourceType = <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.CAMERA</code>, which is the default). Once the photo is taken, the camera application closes and your application is restored.</p>
+<p>Function <code><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></code> opens the device's default camera application so that the user can take a picture (if <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.sourceType = <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.CAMERA</code>, which is the default). Once the photo is taken, the camera application closes and your application is restored.</p>
-<p>If <code><a href="phonegap_camera_camera.md.html#Camera">Camera</a>.sourceType = <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> or <code><a href="phonegap_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code>, then a photo chooser dialog is shown, from which a photo from the album can be selected.</p>
+<p>If <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.sourceType = <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> or <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code>, then a photo chooser dialog is shown, from which a photo from the album can be selected.</p>
-<p>The return value will be sent to the <code><a href="phonegap_camera_camera.md.html#cameraSuccess">cameraSuccess</a></code> function, in one of the following formats, depending on the <code><a href="phonegap_camera_camera.md.html#cameraOptions">cameraOptions</a></code> you specify:</p>
+<p>The return value will be sent to the <code><a href="cordova_camera_camera.md.html#cameraSuccess">cameraSuccess</a></code> function, in one of the following formats, depending on the <code><a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a></code> you specify:</p>
<ul>
<li>A <code>String</code> containing the Base64 encoded photo image (default). </li>
@@ -137,7 +138,7 @@
<li>Save the data locally (<code>LocalStorage</code>, <a class="external" href="http://brianleroux.github.com/lawnchair/">Lawnchair</a>, etc)</li>
<li>Post the data to a remote server</li>
</ul>
-<p>Note: The image quality of pictures taken using the camera on newer devices is quite good. <em>Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800).</em> Therefore, using FILE_URI as the '<a href="phonegap_camera_camera.md.html#Camera">Camera</a>.destinationType' is highly recommended.</p>
+<p>Note: The image quality of pictures taken using the camera on newer devices is quite good. <em>Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800).</em> Therefore, using FILE_URI as the '<a href="cordova_camera_camera.md.html#Camera">Camera</a>.destinationType' is highly recommended.</p>
<h2>
<a name="camera.getPicture_supported_platforms">Supported Platforms</a>
@@ -150,12 +151,21 @@
<li>Windows Phone 7 ( Mango )</li>
</ul>
<h2>
+<a name="camera.getPicture_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
+
+<p>Invoking the native camera application while your device is connected
+via Zune will not work, and the error callback will be triggered.</p>
+
+<h2>
<a name="camera.getPicture_quick_example">Quick Example</a>
</h2>
<p>Take photo and retrieve Base64-encoded image:</p>
-<pre class="prettyprint"><code>navigator.<a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onSuccess, onFail, { quality: 50 });
+<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onSuccess, onFail, { quality: 50,
+ destinationType: <a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.DATA_URL
+ });
function onSuccess(imageData) {
var image = document.getElementById('myImage');
@@ -169,8 +179,8 @@
<p>Take photo and retrieve image file location: </p>
-<pre class="prettyprint"><code>navigator.<a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onSuccess, onFail, { quality: 50,
- destinationType: <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.DestinationType.FILE_URI });
+<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onSuccess, onFail, { quality: 50,
+ destinationType: <a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.FILE_URI });
function onSuccess(imageURI) {
var image = document.getElementById('myImage');
@@ -189,7 +199,7 @@
<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;head&gt;
- &lt;title&gt;<a href="phonegap_media_capture_capture.md.html#Capture">Capture</a> Photo&lt;/title&gt;
+ &lt;title&gt;<a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Photo&lt;/title&gt;
&lt;script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"&gt;&lt;/script&gt;
&lt;script type="text/javascript" charset="utf-8"&gt;
@@ -199,7 +209,7 @@
// Wait for Cordova to connect with the device
//
- document.addEventListener("<a href="phonegap_events_events.md.html#deviceready">deviceready</a>",onDeviceReady,false);
+ document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>",onDeviceReady,false);
// Cordova is ready to be used!
//
@@ -252,21 +262,23 @@
//
function capturePhoto() {
// Take picture using device camera and retrieve image as base64-encoded string
- navigator.<a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onPhotoDataSuccess, onFail, { quality: 50 });
+ navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onPhotoDataSuccess, onFail, { quality: 50,
+ destinationType.DATA_URL });
}
// A button will call this function
//
function capturePhotoEdit() {
// Take picture using device camera, allow edit, and retrieve image as base64-encoded string
- navigator.<a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onPhotoDataSuccess, onFail, { quality: 20, allowEdit: true });
+ navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onPhotoDataSuccess, onFail, { quality: 20, allowEdit: true,
+ destinationType.DATA_URL });
}
// A button will call this function
//
function getPhoto(source) {
// Retrieve image file location from specified source
- navigator.<a href="phonegap_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onPhotoURISuccess, onFail, { quality: 50,
+ navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onPhotoURISuccess, onFail, { quality: 50,
destinationType: destinationType.FILE_URI,
sourceType: source });
}
@@ -280,8 +292,8 @@
&lt;/script&gt;
&lt;/head&gt;
&lt;body&gt;
- &lt;button onclick="capturePhoto();"&gt;<a href="phonegap_media_capture_capture.md.html#Capture">Capture</a> Photo&lt;/button&gt; &lt;br&gt;
- &lt;button onclick="capturePhotoEdit();"&gt;<a href="phonegap_media_capture_capture.md.html#Capture">Capture</a> Editable Photo&lt;/button&gt; &lt;br&gt;
+ &lt;button onclick="capturePhoto();"&gt;<a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Photo&lt;/button&gt; &lt;br&gt;
+ &lt;button onclick="capturePhotoEdit();"&gt;<a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Editable Photo&lt;/button&gt; &lt;br&gt;
&lt;button onclick="getPhoto(pictureSource.PHOTOLIBRARY);"&gt;From Photo Library&lt;/button&gt;&lt;br&gt;
&lt;button onclick="getPhoto(pictureSource.SAVEDPHOTOALBUM);"&gt;From Photo Album&lt;/button&gt;&lt;br&gt;
&lt;img style="display:none;width:60px;height:60px;" id="smallImage" src="" /&gt;
@@ -306,7 +318,7 @@
<ul>
<li>
-<strong>imageData:</strong> Base64 encoding of the image data, OR the image file URI, depending on <code><a href="phonegap_camera_camera.md.html#cameraOptions">cameraOptions</a></code> used. (<code>String</code>)</li>
+<strong>imageData:</strong> Base64 encoding of the image data, OR the image file URI, depending on <code><a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a></code> used. (<code>String</code>)</li>
</ul>
<h2>
<a name="cameraSuccess_example">Example</a>
@@ -344,10 +356,10 @@
<p>Optional parameters to customize the camera settings.</p>
<pre class="prettyprint"><code>{ quality : 75,
- destinationType : <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.DestinationType.DATA_URL,
- sourceType : <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.CAMERA,
+ destinationType : <a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.DATA_URL,
+ sourceType : <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.CAMERA,
allowEdit : true,
- encodingType: <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.EncodingType.JPEG,
+ encodingType: <a href="cordova_camera_camera.md.html#Camera">Camera</a>.EncodingType.JPEG,
targetWidth: 100,
targetHeight: 100 };
</code></pre>
@@ -361,7 +373,7 @@
<li>
<p><strong>destinationType:</strong> Choose the format of the return value. Defined in navigator.camera.DestinationType (<code>Number</code>)</p>
-<pre class="prettyprint"><code> <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.DestinationType = {
+<pre class="prettyprint"><code> <a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType = {
DATA_URL : 0, // Return image as base64 encoded string
FILE_URI : 1 // Return image file URI
};
@@ -370,7 +382,7 @@
<li>
<p><strong>sourceType:</strong> Set the source of the picture. Defined in nagivator.camera.PictureSourceType (<code>Number</code>)</p>
-<pre class="prettyprint"><code><a href="phonegap_camera_camera.md.html#Camera">Camera</a>.PictureSourceType = {
+<pre class="prettyprint"><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType = {
PHOTOLIBRARY : 0,
CAMERA : 1,
SAVEDPHOTOALBUM : 2
@@ -379,9 +391,9 @@
</li>
<li><p><strong>allowEdit:</strong> Allow simple editing of image before selection. (<code>Boolean</code>)</p></li>
<li>
-<p><strong>EncodingType:</strong> Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (<code>Number</code>)</p>
+<p><strong>encodingType:</strong> Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (<code>Number</code>)</p>
-<pre class="prettyprint"><code> <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.EncodingType = {
+<pre class="prettyprint"><code> <a href="cordova_camera_camera.md.html#Camera">Camera</a>.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
@@ -390,16 +402,19 @@
<li><p><strong>targetWidth:</strong> Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (<code>Number</code>)</p></li>
<li><p><strong>targetHeight:</strong> Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (<code>Number</code>)</p></li>
<li>
-<p><strong>MediaType:</strong> Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (<code>Number</code>)</p>
+<p><strong>mediaType:</strong> Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (<code>Number</code>)</p>
-<pre class="prettyprint"><code><a href="phonegap_camera_camera.md.html#Camera">Camera</a>.MediaType = {
+<pre class="prettyprint"><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.MediaType = {
PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
ALLMEDIA : 2 // allow selection from all media types
</code></pre>
<p>};</p>
</li>
+<li><p><strong>correctOrientation:</strong> Rotate the image to correct for the orientation of the device during capture. (<code>Boolean</code>)</p></li>
+<li>
+<strong>saveToPhotoAlbum:</strong> Save the image to the photo album on the device after capture. (<code>Boolean</code>)</li>
</ul>
<h2>
<a name="cameraOptions_android_quirks">Android Quirks</a>
@@ -408,9 +423,11 @@
<ul>
<li>Ignores the <code>allowEdit</code> parameter.</li>
<li>
-<a href="phonegap_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY and <a href="phonegap_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.</li>
+<a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY and <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.</li>
<li>
-<a href="phonegap_camera_camera.md.html#Camera">Camera</a>.EncodingType is not supported.</li>
+<a href="cordova_camera_camera.md.html#Camera">Camera</a>.EncodingType is not supported.</li>
+<li>Ignores the <code>correctOrientation</code> parameter.</li>
+<li>Ignores the <code>saveToPhotoAlbum</code> parameter.</li>
</ul>
<h2>
<a name="cameraOptions_blackberry_quirks">BlackBerry Quirks</a>
@@ -420,10 +437,12 @@
<li>Ignores the <code>quality</code> parameter.</li>
<li>Ignores the <code>sourceType</code> parameter.</li>
<li>Ignores the <code>allowEdit</code> parameter.</li>
-<li>Application must have key injection permissions to close native <a href="phonegap_camera_camera.md.html#Camera">Camera</a> application after photo is taken.</li>
+<li>Application must have key injection permissions to close native <a href="cordova_camera_camera.md.html#Camera">Camera</a> application after photo is taken.</li>
<li>Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).</li>
<li>
-<a href="phonegap_camera_camera.md.html#Camera">Camera</a>.MediaType is not supported.</li>
+<a href="cordova_camera_camera.md.html#Camera">Camera</a>.MediaType is not supported.</li>
+<li>Ignores the <code>correctOrientation</code> parameter.</li>
+<li>Ignores the <code>saveToPhotoAlbum</code> parameter.</li>
</ul>
<h2>
<a name="cameraOptions_palm_quirks">Palm Quirks</a>
@@ -434,10 +453,12 @@
<li>Ignores the <code>sourceType</code> parameter.</li>
<li>Ignores the <code>allowEdit</code> parameter.</li>
<li>
-<a href="phonegap_camera_camera.md.html#Camera">Camera</a>.MediaType is not supported.</li>
+<a href="cordova_camera_camera.md.html#Camera">Camera</a>.MediaType is not supported.</li>
+<li>Ignores the <code>correctOrientation</code> parameter.</li>
+<li>Ignores the <code>saveToPhotoAlbum</code> parameter.</li>
</ul>
<h2>
-<a name="cameraOptions_iphone_quirks">iPhone Quirks</a>
+<a name="cameraOptions_ios_quirks">iOS Quirks</a>
</h2>
<ul>
@@ -451,6 +472,8 @@
<ul>
<li>Ignores the <code>allowEdit</code> parameter.</li>
+<li>Ignores the <code>correctOrientation</code> parameter.</li>
+<li>Ignores the <code>saveToPhotoAlbum</code> parameter.</li>
</ul>
</div>
</div>
View
608 doc/cordova_compass_compass.md.html
@@ -0,0 +1,608 @@
+<!DOCTYPE html>
+<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>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"><strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option selected 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>
+<option value="1.4.1">1.4.1</option>
+<option value="1.4.0rc1">1.4.0rc1</option>
+<option value="1.4.0">1.4.0</option>
+<option value="1.3.0">1.3.0</option>
+<option value="1.2.0">1.2.0</option>
+<option value="1.1.0">1.1.0</option>
+<option value="1.0.0rc3">1.0.0rc3</option>
+<option value="1.0.0rc2">1.0.0rc2</option>
+<option value="1.0.0rc1">1.0.0rc1</option>
+<option value="1.0.0">1.0.0</option>
+<option value="0.9.6">0.9.6</option>
+<option value="0.9.5.1">0.9.5.1</option>
+<option value="0.9.5">0.9.5</option>
+<option value="0.9.4">0.9.4</option>
+<option value="0.9.3">0.9.3</option>
+<option value="0.9.2">0.9.2</option>
+</optgroup>
+<optgroup label="Español" value="es"><option value="1.0.0">1.0.0</option></optgroup>
+<optgroup label="Français" value="fr">
+<option value="1.3.0">1.3.0</option>
+<option value="1.2.0">1.2.0</option>
+<option value="1.1.0">1.1.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp"><option value="0.9.5">0.9.5</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Compass</h1>
+ <small><select><option value="Compass">Compass</option>
+<option value="Compass_methods">      - Methods</option>
+<option value="Compass_arguments">      - Arguments</option>
+<option value="compass.getCurrentHeading">compass.getCurrentHeading</option>
+<option value="compass.getCurrentHeading_description">      - Description</option>
+<option value="compass.getCurrentHeading_supported_platforms">      - Supported Platforms</option>
+<option value="compass.getCurrentHeading_quick_example">      - Quick Example</option>
+<option value="compass.getCurrentHeading_full_example">      - Full Example</option>
+<option value="compass.watchHeading">compass.watchHeading</option>
+<option value="compass.watchHeading_description">      - Description</option>
+<option value="compass.watchHeading_supported_platforms">      - Supported Platforms</option>
+<option value="compass.watchHeading_quick_example">      - Quick Example</option>
+<option value="compass.watchHeading_full_example">      - Full Example</option>
+<option value="compass.watchHeading_ios_quirks">      - iOS Quirks</option>
+<option value="compass.clearWatch">compass.clearWatch</option>
+<option value="compass.clearWatch_supported_platforms">      - Supported Platforms</option>
+<option value="compass.clearWatch_quick_example">      - Quick Example</option>
+<option value="compass.clearWatch_full_example">      - Full Example</option>
+<option value="compass.watchHeadingFilter">compass.watchHeadingFilter</option>
+<option value="compass.clearWatchFilter">compass.clearWatchFilter</option>
+<option value="compassSuccess">compassSuccess</option>
+<option value="compassSuccess_parameters">      - Parameters</option>
+<option value="compassSuccess_example">      - Example</option>
+<option value="compassError">compassError</option>
+<option value="compassError_example">      - Example</option>
+<option value="compassOptions">compassOptions</option>
+<option value="compassOptions_options">      - Options</option>
+<option value="compassOptions_windows_phone_7_quirks">      - Windows Phone 7 Quirks</option>
+<option value="compassHeading">compassHeading</option>
+<option value="compassHeading_properties">      - Properties</option>
+<option value="compassHeading_description">      - Description</option>
+<option value="compassHeading_android_quirks">      - Android Quirks</option>
+<option value="compassHeading_ios_quirks">      - iOS Quirks</option>
+<option value="CompassError">CompassError</option>
+<option value="CompassError_properties">      - Properties</option>
+<option value="CompassError_constants">      - Constants</option>
+<option value="CompassError_description">      - Description</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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</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="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Compass">Compass</a></h1>
+
+<blockquote>
+ <p>Obtains the direction that the device is pointing.</p>
+</blockquote>
+
+<h2>
+<a name="Compass_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></li>
+<li>
+<a href="cordova_compass_compass.md.html#compass.watchHeadingFilter">compass.watchHeadingFilter</a> (obsolete)</li>
+<li>
+<a href="cordova_compass_compass.md.html#compass.clearWatchFilter">compass.clearWatchFilter</a> (obsolete)</li>
+</ul>
+<h2>
+<a name="Compass_arguments">Arguments</a>
+</h2>
+
+<ul>
+<li><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></li>
+<li><a href="cordova_compass_compass.md.html#compassError">compassError</a></li>
+<li><a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a></li>
+<li><a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a></li>
+</ul>
+<hr>
+<h1><a name="compass.getCurrentHeading">compass.getCurrentHeading</a></h1>
+
+<p>Get the current compass heading.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a>(<a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a>, <a href="cordova_compass_compass.md.html#compassError">compassError</a>, <a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a>);
+</code></pre>
+
+<h2>
+<a name="compass.getCurrentHeading_description">Description</a>
+</h2>
+
+<p>The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.</p>
+
+<p>The compass heading information is returned via a CompassHeading object using the <code><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></code> callback function.</p>
+
+<h2>
+<a name="compass.getCurrentHeading_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iPhone</li>
+<li>Windows Phone 7 ( Mango ) if available in hardware</li>
+</ul>
+<h2>
+<a name="compass.getCurrentHeading_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+};
+
+function onError(error) {
+ alert('<a href="cordova_compass_compass.md.html#CompassError">CompassError</a>: ' error.code);
+};
+
+navigator.<a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a>(onSuccess, onError);
+</code></pre>
+
+<h2>
+<a name="compass.getCurrentHeading_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+ &lt;head&gt;
+ &lt;title&gt;<a href="cordova_compass_compass.md.html#Compass">Compass</a> Example&lt;/title&gt;
+
+ &lt;script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"&gt;&lt;/script&gt;
+ &lt;script type="text/javascript" charset="utf-8"&gt;
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.<a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a>(onSuccess, onError);
+ }
+
+ // onSuccess: Get the current heading
+ //
+ function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+ }
+
+ // onError: Failed to get the heading
+ //
+ function onError(<a href="cordova_compass_compass.md.html#compassError">compassError</a>) {
+ alert('<a href="cordova_compass_compass.md.html#Compass">Compass</a> Error: ' + <a href="cordova_compass_compass.md.html#compassError">compassError</a>.code);
+ }
+
+ &lt;/script&gt;
+ &lt;/head&gt;
+ &lt;body&gt;
+ &lt;h1&gt;Example&lt;/h1&gt;
+ &lt;p&gt;getCurrentHeading&lt;/p&gt;
+ &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<hr>
+<h1><a name="compass.watchHeading">compass.watchHeading</a></h1>
+
+<p>At a regular interval, get the compass heading in degrees.</p>
+
+<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(<a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a>, <a href="cordova_compass_compass.md.html#compassError">compassError</a>, [<a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a>]);
+</code></pre>
+
+<h2>
+<a name="compass.watchHeading_description">Description</a>
+</h2>
+
+<p>The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.</p>
+
+<p>The <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code> gets the device's current heading at a regular interval. Each time the heading is retrieved, the <code>headingSuccess</code> callback function is executed. Specify the interval in milliseconds via the <code>frequency</code> parameter in the <code><a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a></code> object.</p>
+
+<p>The returned watch ID references references the compass watch interval. The watch ID can be used with <code><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></code> to stop watching the compass.</p>
+
+<h2>
+<a name="compass.watchHeading_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iPhone</li>
+<li>Windows Phone 7 ( Mango ) if available in hardware</li>
+</ul>
+<h2>
+<a name="compass.watchHeading_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(heading) {
+ var element = document.getElementById('heading');
+ element.innerHTML = 'Heading: ' + heading.magneticHeading;
+};
+
+function onError(<a href="cordova_compass_compass.md.html#compassError">compassError</a>) {
+ alert('<a href="cordova_compass_compass.md.html#Compass">Compass</a> error: ' + <a href="cordova_compass_compass.md.html#compassError">compassError</a>.code);
+};
+
+var options = { frequency: 3000 }; // Update every 3 seconds
+
+var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
+</code></pre>
+
+<h2>
+<a name="compass.watchHeading_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+ &lt;head&gt;
+ &lt;title&gt;<a href="cordova_compass_compass.md.html#Compass">Compass</a> Example&lt;/title&gt;
+
+ &lt;script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"&gt;&lt;/script&gt;
+ &lt;script type="text/javascript" charset="utf-8"&gt;
+
+ // The watch id references the current `watchHeading`
+ var watchID = null;
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ startWatch();
+ }
+
+ // Start watching the compass
+ //
+ function startWatch() {
+
+ // Update compass every 3 seconds
+ var options = { frequency: 3000 };
+
+ watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
+ }
+
+ // Stop watching the compass
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(watchID);
+ watchID = null;
+ }
+ }
+
+ // onSuccess: Get the current heading
+ //
+ function onSuccess(heading) {
+ var element = document.getElementById('heading');
+ element.innerHTML = 'Heading: ' + heading.magneticHeading;
+ }
+
+ // onError: Failed to get the heading
+ //
+ function onError(<a href="cordova_compass_compass.md.html#compassError">compassError</a>) {
+ alert('<a href="cordova_compass_compass.md.html#Compass">Compass</a> error: ' + <a href="cordova_compass_compass.md.html#compassError">compassError</a>.code);
+ }
+
+ &lt;/script&gt;
+ &lt;/head&gt;
+ &lt;body&gt;
+ &lt;div id="heading"&gt;Waiting for heading...&lt;/div&gt;
+ &lt;button onclick="startWatch();"&gt;Start Watching&lt;/button&gt;
+ &lt;button onclick="stopWatch();"&gt;Stop Watching&lt;/button&gt;
+ &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<h2>
+<a name="compass.watchHeading_ios_quirks">iOS Quirks</a>
+</h2>
+
+<p>In iOS <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code> can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the <code>headingSuccess</code> callback function is called. Specify the degrees of change via the <code>filter</code> parameter in the <code><a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a></code> object. Clear the watch as normal by passing the returned watch ID to <code><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></code>. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.</p>
+
+<p>In iOS only one watchHeading can be in effect at one time. If a watchHeading via filter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS watching heading changes via a filter is more efficient than via time.</p>
+
+<hr>
+<h1><a name="compass.clearWatch">compass.clearWatch</a></h1>
+
+<p>Stop watching the compass referenced by the watch ID parameter.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(watchID);
+</code></pre>
+
+<ul>
+<li>
+<strong>watchID</strong>: The ID returned by <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code>.</li>
+</ul>
+<h2>
+<a name="compass.clearWatch_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iPhone</li>
+<li>Windows Phone 7 ( Mango ) if available in hardware</li>
+</ul>
+<h2>
+<a name="compass.clearWatch_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
+
+// ... later on ...
+
+navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(watchID);
+</code></pre>
+
+<h2>
+<a name="compass.clearWatch_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+ &lt;head&gt;
+ &lt;title&gt;<a href="cordova_compass_compass.md.html#Compass">Compass</a> Example&lt;/title&gt;
+
+ &lt;script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"&gt;&lt;/script&gt;
+ &lt;script type="text/javascript" charset="utf-8"&gt;
+
+ // The watch id references the current `watchHeading`
+ var watchID = null;
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ startWatch();
+ }
+
+ // Start watching the compass
+ //
+ function startWatch() {
+
+ // Update compass every 3 seconds
+ var options = { frequency: 3000 };
+
+ watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
+ }
+
+ // Stop watching the compass
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(watchID);
+ watchID = null;
+ }
+ }
+
+ // onSuccess: Get the current heading
+ //
+ function onSuccess(heading) {
+ var element = document.getElementById('heading');
+ element.innerHTML = 'Heading: ' + heading.magneticHeading;
+ }
+
+ // onError: Failed to get the heading
+ //
+ function onError(<a href="cordova_compass_compass.md.html#compassError">compassError</a>) {
+ alert('<a href="cordova_compass_compass.md.html#Compass">Compass</a> error: ' + <a href="cordova_compass_compass.md.html#compassError">compassError</a>.code);
+ }
+
+
+ &lt;/script&gt;
+ &lt;/head&gt;
+ &lt;body&gt;
+ &lt;div id="heading"&gt;Waiting for heading...&lt;/div&gt;
+ &lt;button onclick="startWatch();"&gt;Start Watching&lt;/button&gt;
+ &lt;button onclick="stopWatch();"&gt;Stop Watching&lt;/button&gt;
+ &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<hr>
+<h1><a name="compass.watchHeadingFilter">compass.watchHeadingFilter</a></h1>
+
+<p>No longer supported as of 1.6, see <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code> for equivalent functionality.</p>
+
+<hr>
+<h1><a name="compass.clearWatchFilter">compass.clearWatchFilter</a></h1>
+
+<p>No longer supported as of 1.6. See <code><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></code>.</p>
+
+<hr>
+<h1><a name="compassSuccess">compassSuccess</a></h1>
+
+<p>onSuccess callback function that provides the compass heading information via a <a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a> object.</p>
+
+<pre class="prettyprint"><code>function(heading) {
+ // Do something
+}
+</code></pre>
+
+<h2>
+<a name="compassSuccess_parameters">Parameters</a>
+</h2>
+
+<ul>
+<li>
+<strong>heading:</strong> The heading information. <em>(<a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a>)</em>
+</li>
+</ul>
+<h2>
+<a name="compassSuccess_example">Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+};
+</code></pre>
+
+<hr>
+<h1><a name="compassError">compassError</a></h1>
+
+<p>onError callback function for compass functions. </p>
+
+<h2>
+<a name="compassError_example">Example</a>
+</h2>
+
+<p>function(<a href="cordova_compass_compass.md.html#CompassError">CompassError</a>) {
+ // Handle the error
+}</p>
+
+<hr>
+<h1><a name="compassOptions">compassOptions</a></h1>
+
+<p>An optional parameter to customize the retrieval of the compass.</p>
+
+<h2>
+<a name="compassOptions_options">Options</a>
+</h2>
+
+<ul>
+<li>
+<strong>frequency:</strong> How often to retrieve the compass heading in milliseconds. <em>(Number)</em> (Default: 100)</li>
+<li>
+<strong>filter:</strong> The change in degrees required to initiate a watchHeading success callback. <em>(Number)</em>
+</li>
+</ul>
+<p>Android Quirks</p>
+
+<hr>
+<ul>
+<li>filter is not supported.</li>
+</ul>
+<h2>
+<a name="compassOptions_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>