You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2012/04/11 22:59:20 UTC
[1/9] docs commit: added 1.6.0
Updated Branches:
refs/heads/master 3107f6813 -> 72364fb99
added 1.6.0
Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/commit/72364fb9
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/72364fb9
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/72364fb9
Branch: refs/heads/master
Commit: 72364fb9989a35f16fe7b1c43ad7d7762df142f0
Parents: 3107f68
Author: Steven Gill <st...@gmail.com>
Authored: Wed Apr 11 13:58:54 2012 -0700
Committer: Steven Gill <st...@gmail.com>
Committed: Wed Apr 11 13:58:54 2012 -0700
----------------------------------------------------------------------
docs/en/1.6.0/config.json | 274 +++++++-------
.../accelerometer/acceleration/acceleration.md | 85 ++++
.../accelerometer/accelerometer.clearWatch.md | 92 +++++
.../accelerometer.getCurrentAcceleration.md | 88 +++++
.../1.6.0/cordova/accelerometer/accelerometer.md | 23 ++
.../accelerometer.watchAcceleration.md | 117 ++++++
.../accelerometer/parameters/accelerometerError.md | 8 +
.../parameters/accelerometerOptions.md | 9 +
.../parameters/accelerometerSuccess.md | 23 ++
docs/en/1.6.0/cordova/camera/camera.getPicture.md | 183 +++++++++
docs/en/1.6.0/cordova/camera/camera.md | 9 +
.../1.6.0/cordova/camera/parameter/cameraError.md | 13 +
.../cordova/camera/parameter/cameraOptions.md | 101 +++++
.../cordova/camera/parameter/cameraSuccess.md | 23 ++
.../en/1.6.0/cordova/compass/compass.clearWatch.md | 90 +++++
.../cordova/compass/compass.clearWatchFilter.md | 4 +
.../cordova/compass/compass.getCurrentHeading.md | 75 ++++
docs/en/1.6.0/cordova/compass/compass.md | 21 +
.../1.6.0/cordova/compass/compass.watchHeading.md | 111 ++++++
.../cordova/compass/compass.watchHeadingFilter.md | 4 +
.../cordova/compass/compassError/compassError.md | 21 +
.../cordova/compass/parameters/compassError.md | 11 +
.../cordova/compass/parameters/compassHeading.md | 29 ++
.../cordova/compass/parameters/compassOptions.md | 19 +
.../cordova/compass/parameters/compassSuccess.md | 21 +
docs/en/1.6.0/cordova/connection/connection.md | 29 ++
.../en/1.6.0/cordova/connection/connection.type.md | 82 ++++
docs/en/1.6.0/cordova/contacts/Contact/contact.md | 202 ++++++++++
.../contacts/ContactAddress/contactaddress.md | 145 +++++++
.../cordova/contacts/ContactError/contactError.md | 26 ++
.../cordova/contacts/ContactField/contactfield.md | 122 ++++++
.../ContactFindOptions/contactfindoptions.md | 93 +++++
.../cordova/contacts/ContactName/contactname.md | 118 ++++++
.../ContactOrganization/contactorganization.md | 131 +++++++
docs/en/1.6.0/cordova/contacts/contacts.create.md | 57 +++
docs/en/1.6.0/cordova/contacts/contacts.find.md | 96 +++++
docs/en/1.6.0/cordova/contacts/contacts.md | 29 ++
.../cordova/contacts/parameters/contactError.md | 8 +
.../cordova/contacts/parameters/contactFields.md | 6 +
.../contacts/parameters/contactFindOptions.md | 16 +
.../cordova/contacts/parameters/contactSuccess.md | 21 +
docs/en/1.6.0/cordova/device/device.cordova.md | 59 +++
docs/en/1.6.0/cordova/device/device.md | 23 ++
docs/en/1.6.0/cordova/device/device.name.md | 83 ++++
docs/en/1.6.0/cordova/device/device.platform.md | 74 ++++
docs/en/1.6.0/cordova/device/device.uuid.md | 81 ++++
docs/en/1.6.0/cordova/device/device.version.md | 62 +++
docs/en/1.6.0/cordova/events/events.backbutton.md | 68 ++++
.../1.6.0/cordova/events/events.batterycritical.md | 74 ++++
docs/en/1.6.0/cordova/events/events.batterylow.md | 74 ++++
.../1.6.0/cordova/events/events.batterystatus.md | 83 ++++
docs/en/1.6.0/cordova/events/events.deviceready.md | 67 ++++
.../1.6.0/cordova/events/events.endcallbutton.md | 67 ++++
docs/en/1.6.0/cordova/events/events.md | 24 ++
docs/en/1.6.0/cordova/events/events.menubutton.md | 68 ++++
docs/en/1.6.0/cordova/events/events.offline.md | 76 ++++
docs/en/1.6.0/cordova/events/events.online.md | 76 ++++
docs/en/1.6.0/cordova/events/events.pause.md | 72 ++++
docs/en/1.6.0/cordova/events/events.resume.md | 68 ++++
.../en/1.6.0/cordova/events/events.searchbutton.md | 67 ++++
.../1.6.0/cordova/events/events.startcallbutton.md | 67 ++++
.../cordova/events/events.volumedownbutton.md | 67 ++++
.../1.6.0/cordova/events/events.volumeupbutton.md | 67 ++++
.../cordova/file/directoryentry/directoryentry.md | 300 +++++++++++++++
.../file/directoryreader/directoryreader.md | 47 +++
docs/en/1.6.0/cordova/file/file.md | 23 ++
docs/en/1.6.0/cordova/file/fileentry/fileentry.md | 242 ++++++++++++
docs/en/1.6.0/cordova/file/fileerror/fileerror.md | 30 ++
docs/en/1.6.0/cordova/file/fileobj/fileobj.md | 26 ++
.../en/1.6.0/cordova/file/filereader/filereader.md | 177 +++++++++
.../en/1.6.0/cordova/file/filesystem/filesystem.md | 72 ++++
.../cordova/file/filetransfer/filetransfer.md | 163 ++++++++
.../file/filetransfererror/filetransfererror.md | 23 ++
.../file/fileuploadoptions/fileuploadoptions.md | 31 ++
.../file/fileuploadresult/fileuploadresult.md | 21 +
.../en/1.6.0/cordova/file/filewriter/filewriter.md | 175 +++++++++
docs/en/1.6.0/cordova/file/flags/flags.md | 27 ++
.../file/localfilesystem/localfilesystem.md | 91 +++++
docs/en/1.6.0/cordova/file/metadata/metadata.md | 32 ++
.../cordova/geolocation/Coordinates/coordinates.md | 104 +++++
.../1.6.0/cordova/geolocation/Position/position.md | 110 ++++++
.../geolocation/PositionError/positionError.md | 23 ++
.../cordova/geolocation/geolocation.clearWatch.md | 94 +++++
.../geolocation/geolocation.getCurrentPosition.md | 105 +++++
docs/en/1.6.0/cordova/geolocation/geolocation.md | 30 ++
.../geolocation/geolocation.watchPosition.md | 107 +++++
.../geolocation/parameters/geolocation.options.md | 22 +
.../geolocation/parameters/geolocationError.md | 13 +
.../geolocation/parameters/geolocationSuccess.md | 27 ++
.../1.6.0/cordova/media/MediaError/mediaError.md | 25 ++
.../1.6.0/cordova/media/Parameters/mediaError.md | 13 +
docs/en/1.6.0/cordova/media/capture/CaptureCB.md | 25 ++
.../en/1.6.0/cordova/media/capture/CaptureError.md | 18 +
.../1.6.0/cordova/media/capture/CaptureErrorCB.md | 21 +
.../cordova/media/capture/ConfigurationData.md | 43 ++
.../media/capture/MediaFile.getFormatData.md | 34 ++
docs/en/1.6.0/cordova/media/capture/MediaFile.md | 18 +
.../1.6.0/cordova/media/capture/MediaFileData.md | 43 ++
docs/en/1.6.0/cordova/media/capture/capture.md | 56 +++
.../en/1.6.0/cordova/media/capture/captureAudio.md | 121 ++++++
.../cordova/media/capture/captureAudioOptions.md | 37 ++
.../en/1.6.0/cordova/media/capture/captureImage.md | 114 ++++++
.../cordova/media/capture/captureImageOptions.md | 34 ++
.../en/1.6.0/cordova/media/capture/captureVideo.md | 111 ++++++
.../cordova/media/capture/captureVideoOptions.md | 40 ++
.../cordova/media/media.getCurrentPosition.md | 153 ++++++++
docs/en/1.6.0/cordova/media/media.getDuration.md | 145 +++++++
docs/en/1.6.0/cordova/media/media.md | 44 +++
docs/en/1.6.0/cordova/media/media.pause.md | 150 +++++++
docs/en/1.6.0/cordova/media/media.play.md | 156 ++++++++
docs/en/1.6.0/cordova/media/media.release.md | 134 +++++++
docs/en/1.6.0/cordova/media/media.seekTo.md | 132 +++++++
docs/en/1.6.0/cordova/media/media.startRecord.md | 117 ++++++
docs/en/1.6.0/cordova/media/media.stop.md | 149 +++++++
docs/en/1.6.0/cordova/media/media.stopRecord.md | 119 ++++++
.../cordova/notification/notification.alert.md | 91 +++++
.../cordova/notification/notification.beep.md | 93 +++++
.../cordova/notification/notification.confirm.md | 94 +++++
docs/en/1.6.0/cordova/notification/notification.md | 12 +
.../cordova/notification/notification.vibrate.md | 83 ++++
docs/en/1.6.0/cordova/storage/database/database.md | 104 +++++
.../cordova/storage/localstorage/localstorage.md | 100 +++++
.../cordova/storage/parameters/display_name.md | 4 +
docs/en/1.6.0/cordova/storage/parameters/name.md | 4 +
docs/en/1.6.0/cordova/storage/parameters/size.md | 4 +
.../en/1.6.0/cordova/storage/parameters/version.md | 4 +
docs/en/1.6.0/cordova/storage/sqlerror/sqlerror.md | 28 ++
.../cordova/storage/sqlresultset/sqlresultset.md | 115 ++++++
.../storage/sqlresultsetlist/sqlresultsetlist.md | 116 ++++++
.../storage/sqltransaction/sqltransaction.md | 93 +++++
docs/en/1.6.0/cordova/storage/storage.md | 29 ++
.../1.6.0/cordova/storage/storage.opendatabase.md | 54 +++
.../1.6.0/guide/getting-started/android/index.md | 66 ++--
.../guide/getting-started/blackberry/index.md | 107 +++---
docs/en/1.6.0/guide/getting-started/ios/index.md | 69 +++--
.../guide/getting-started/windows-phone/index.md | 2 +-
.../accelerometer/acceleration/acceleration.md | 85 ----
.../accelerometer/accelerometer.clearWatch.md | 91 -----
.../accelerometer.getCurrentAcceleration.md | 87 -----
.../1.6.0/phonegap/accelerometer/accelerometer.md | 23 --
.../accelerometer.watchAcceleration.md | 116 ------
.../accelerometer/parameters/accelerometerError.md | 8 -
.../parameters/accelerometerOptions.md | 9 -
.../parameters/accelerometerSuccess.md | 23 --
docs/en/1.6.0/phonegap/camera/camera.getPicture.md | 171 --------
docs/en/1.6.0/phonegap/camera/camera.md | 9 -
.../1.6.0/phonegap/camera/parameter/cameraError.md | 13 -
.../phonegap/camera/parameter/cameraOptions.md | 90 -----
.../phonegap/camera/parameter/cameraSuccess.md | 23 --
.../1.6.0/phonegap/compass/compass.clearWatch.md | 90 -----
.../phonegap/compass/compass.clearWatchFilter.md | 88 -----
.../phonegap/compass/compass.getCurrentHeading.md | 75 ----
docs/en/1.6.0/phonegap/compass/compass.md | 21 -
.../1.6.0/phonegap/compass/compass.watchHeading.md | 105 -----
.../phonegap/compass/compass.watchHeadingFilter.md | 103 -----
.../phonegap/compass/compassError/compassError.md | 21 -
.../phonegap/compass/parameters/compassError.md | 11 -
.../phonegap/compass/parameters/compassHeading.md | 33 --
.../phonegap/compass/parameters/compassOptions.md | 19 -
.../phonegap/compass/parameters/compassSuccess.md | 21 -
docs/en/1.6.0/phonegap/connection/connection.md | 23 --
.../1.6.0/phonegap/connection/connection.type.md | 82 ----
docs/en/1.6.0/phonegap/contacts/Contact/contact.md | 202 ----------
.../contacts/ContactAddress/contactaddress.md | 145 -------
.../phonegap/contacts/ContactError/contactError.md | 26 --
.../phonegap/contacts/ContactField/contactfield.md | 122 ------
.../ContactFindOptions/contactfindoptions.md | 93 -----
.../phonegap/contacts/ContactName/contactname.md | 118 ------
.../ContactOrganization/contactorganization.md | 131 -------
docs/en/1.6.0/phonegap/contacts/contacts.create.md | 57 ---
docs/en/1.6.0/phonegap/contacts/contacts.find.md | 96 -----
docs/en/1.6.0/phonegap/contacts/contacts.md | 29 --
.../phonegap/contacts/parameters/contactError.md | 8 -
.../phonegap/contacts/parameters/contactFields.md | 6 -
.../contacts/parameters/contactFindOptions.md | 16 -
.../phonegap/contacts/parameters/contactSuccess.md | 21 -
docs/en/1.6.0/phonegap/device/device.cordova.md | 60 ---
docs/en/1.6.0/phonegap/device/device.md | 23 --
docs/en/1.6.0/phonegap/device/device.name.md | 79 ----
docs/en/1.6.0/phonegap/device/device.platform.md | 70 ----
docs/en/1.6.0/phonegap/device/device.uuid.md | 72 ----
docs/en/1.6.0/phonegap/device/device.version.md | 63 ---
docs/en/1.6.0/phonegap/events/events.backbutton.md | 67 ----
.../phonegap/events/events.batterycritical.md | 74 ----
docs/en/1.6.0/phonegap/events/events.batterylow.md | 74 ----
.../1.6.0/phonegap/events/events.batterystatus.md | 74 ----
.../en/1.6.0/phonegap/events/events.deviceready.md | 92 -----
.../1.6.0/phonegap/events/events.endcallbutton.md | 67 ----
docs/en/1.6.0/phonegap/events/events.md | 24 --
docs/en/1.6.0/phonegap/events/events.menubutton.md | 68 ----
docs/en/1.6.0/phonegap/events/events.offline.md | 71 ----
docs/en/1.6.0/phonegap/events/events.online.md | 71 ----
docs/en/1.6.0/phonegap/events/events.pause.md | 71 ----
docs/en/1.6.0/phonegap/events/events.resume.md | 67 ----
.../1.6.0/phonegap/events/events.searchbutton.md | 67 ----
.../phonegap/events/events.startcallbutton.md | 67 ----
.../phonegap/events/events.volumedownbutton.md | 67 ----
.../1.6.0/phonegap/events/events.volumeupbutton.md | 67 ----
.../phonegap/file/directoryentry/directoryentry.md | 300 ---------------
.../file/directoryreader/directoryreader.md | 47 ---
docs/en/1.6.0/phonegap/file/file.md | 23 --
docs/en/1.6.0/phonegap/file/fileentry/fileentry.md | 242 ------------
docs/en/1.6.0/phonegap/file/fileerror/fileerror.md | 30 --
docs/en/1.6.0/phonegap/file/fileobj/fileobj.md | 26 --
.../1.6.0/phonegap/file/filereader/filereader.md | 177 ---------
.../1.6.0/phonegap/file/filesystem/filesystem.md | 72 ----
.../phonegap/file/filetransfer/filetransfer.md | 163 --------
.../file/filetransfererror/filetransfererror.md | 23 --
.../file/fileuploadoptions/fileuploadoptions.md | 19 -
.../file/fileuploadresult/fileuploadresult.md | 21 -
.../1.6.0/phonegap/file/filewriter/filewriter.md | 175 ---------
docs/en/1.6.0/phonegap/file/flags/flags.md | 27 --
.../file/localfilesystem/localfilesystem.md | 91 -----
docs/en/1.6.0/phonegap/file/metadata/metadata.md | 32 --
.../geolocation/Coordinates/coordinates.md | 105 -----
.../phonegap/geolocation/Position/position.md | 111 ------
.../geolocation/PositionError/positionError.md | 23 --
.../phonegap/geolocation/geolocation.clearWatch.md | 95 -----
.../geolocation/geolocation.getCurrentPosition.md | 106 -----
docs/en/1.6.0/phonegap/geolocation/geolocation.md | 30 --
.../geolocation/geolocation.watchPosition.md | 108 ------
.../geolocation/parameters/geolocation.options.md | 22 -
.../geolocation/parameters/geolocationError.md | 13 -
.../geolocation/parameters/geolocationSuccess.md | 27 --
.../1.6.0/phonegap/media/MediaError/mediaError.md | 25 --
.../1.6.0/phonegap/media/Parameters/mediaError.md | 13 -
docs/en/1.6.0/phonegap/media/capture/CaptureCB.md | 25 --
.../1.6.0/phonegap/media/capture/CaptureError.md | 18 -
.../1.6.0/phonegap/media/capture/CaptureErrorCB.md | 21 -
.../phonegap/media/capture/ConfigurationData.md | 43 --
.../media/capture/MediaFile.getFormatData.md | 34 --
docs/en/1.6.0/phonegap/media/capture/MediaFile.md | 18 -
.../1.6.0/phonegap/media/capture/MediaFileData.md | 43 --
docs/en/1.6.0/phonegap/media/capture/capture.md | 56 ---
.../1.6.0/phonegap/media/capture/captureAudio.md | 116 ------
.../phonegap/media/capture/captureAudioOptions.md | 37 --
.../1.6.0/phonegap/media/capture/captureImage.md | 108 ------
.../phonegap/media/capture/captureImageOptions.md | 34 --
.../1.6.0/phonegap/media/capture/captureVideo.md | 111 ------
.../phonegap/media/capture/captureVideoOptions.md | 40 --
.../phonegap/media/media.getCurrentPosition.md | 153 --------
docs/en/1.6.0/phonegap/media/media.getDuration.md | 145 -------
docs/en/1.6.0/phonegap/media/media.md | 44 ---
docs/en/1.6.0/phonegap/media/media.pause.md | 150 -------
docs/en/1.6.0/phonegap/media/media.play.md | 146 -------
docs/en/1.6.0/phonegap/media/media.release.md | 134 -------
docs/en/1.6.0/phonegap/media/media.seekTo.md | 132 -------
docs/en/1.6.0/phonegap/media/media.startRecord.md | 117 ------
docs/en/1.6.0/phonegap/media/media.stop.md | 149 -------
docs/en/1.6.0/phonegap/media/media.stopRecord.md | 119 ------
.../phonegap/notification/notification.alert.md | 94 -----
.../phonegap/notification/notification.beep.md | 94 -----
.../phonegap/notification/notification.confirm.md | 92 -----
.../en/1.6.0/phonegap/notification/notification.md | 12 -
.../phonegap/notification/notification.vibrate.md | 84 ----
.../en/1.6.0/phonegap/storage/database/database.md | 104 -----
.../phonegap/storage/localstorage/localstorage.md | 91 -----
.../phonegap/storage/parameters/display_name.md | 4 -
docs/en/1.6.0/phonegap/storage/parameters/name.md | 4 -
docs/en/1.6.0/phonegap/storage/parameters/size.md | 4 -
.../1.6.0/phonegap/storage/parameters/version.md | 4 -
.../en/1.6.0/phonegap/storage/sqlerror/sqlerror.md | 28 --
.../phonegap/storage/sqlresultset/sqlresultset.md | 115 ------
.../storage/sqlresultsetlist/sqlresultsetlist.md | 116 ------
.../storage/sqltransaction/sqltransaction.md | 93 -----
docs/en/1.6.0/phonegap/storage/storage.md | 29 --
.../1.6.0/phonegap/storage/storage.opendatabase.md | 54 ---
267 files changed, 9304 insertions(+), 9363 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/config.json
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/config.json b/docs/en/1.6.0/config.json
index 0131a42..a4aa16e 100644
--- a/docs/en/1.6.0/config.json
+++ b/docs/en/1.6.0/config.json
@@ -2,169 +2,169 @@
"language": "English",
"merge": {
"accelerometer.md": [
- "phonegap/accelerometer/accelerometer.md",
- "phonegap/accelerometer/accelerometer.getCurrentAcceleration.md",
- "phonegap/accelerometer/accelerometer.watchAcceleration.md",
- "phonegap/accelerometer/accelerometer.clearWatch.md",
- "phonegap/accelerometer/acceleration/acceleration.md",
- "phonegap/accelerometer/parameters/accelerometerSuccess.md",
- "phonegap/accelerometer/parameters/accelerometerError.md",
- "phonegap/accelerometer/parameters/accelerometerOptions.md"
+ "cordova/accelerometer/accelerometer.md",
+ "cordova/accelerometer/accelerometer.getCurrentAcceleration.md",
+ "cordova/accelerometer/accelerometer.watchAcceleration.md",
+ "cordova/accelerometer/accelerometer.clearWatch.md",
+ "cordova/accelerometer/acceleration/acceleration.md",
+ "cordova/accelerometer/parameters/accelerometerSuccess.md",
+ "cordova/accelerometer/parameters/accelerometerError.md",
+ "cordova/accelerometer/parameters/accelerometerOptions.md"
],
"camera.md": [
- "phonegap/camera/camera.md",
- "phonegap/camera/camera.getPicture.md",
- "phonegap/camera/parameter/cameraSuccess.md",
- "phonegap/camera/parameter/cameraError.md",
- "phonegap/camera/parameter/cameraOptions.md"
+ "cordova/camera/camera.md",
+ "cordova/camera/camera.getPicture.md",
+ "cordova/camera/parameter/cameraSuccess.md",
+ "cordova/camera/parameter/cameraError.md",
+ "cordova/camera/parameter/cameraOptions.md"
],
"capture.md": [
- "phonegap/media/capture/capture.md",
- "phonegap/media/capture/captureAudio.md",
- "phonegap/media/capture/captureAudioOptions.md",
- "phonegap/media/capture/captureImage.md",
- "phonegap/media/capture/captureImageOptions.md",
- "phonegap/media/capture/captureVideo.md",
- "phonegap/media/capture/captureVideoOptions.md",
- "phonegap/media/capture/CaptureError.md",
- "phonegap/media/capture/CaptureCB.md",
- "phonegap/media/capture/CaptureErrorCB.md",
- "phonegap/media/capture/ConfigurationData.md",
- "phonegap/media/capture/MediaFile.md",
- "phonegap/media/capture/MediaFile.getFormatData.md",
- "phonegap/media/capture/MediaFileData.md"
+ "cordova/media/capture/capture.md",
+ "cordova/media/capture/captureAudio.md",
+ "cordova/media/capture/captureAudioOptions.md",
+ "cordova/media/capture/captureImage.md",
+ "cordova/media/capture/captureImageOptions.md",
+ "cordova/media/capture/captureVideo.md",
+ "cordova/media/capture/captureVideoOptions.md",
+ "cordova/media/capture/CaptureError.md",
+ "cordova/media/capture/CaptureCB.md",
+ "cordova/media/capture/CaptureErrorCB.md",
+ "cordova/media/capture/ConfigurationData.md",
+ "cordova/media/capture/MediaFile.md",
+ "cordova/media/capture/MediaFile.getFormatData.md",
+ "cordova/media/capture/MediaFileData.md"
],
"compass.md": [
- "phonegap/compass/compass.md",
- "phonegap/compass/compass.getCurrentHeading.md",
- "phonegap/compass/compass.watchHeading.md",
- "phonegap/compass/compass.clearWatch.md",
- "phonegap/compass/compass.watchHeadingFilter.md",
- "phonegap/compass/compass.clearWatchFilter.md",
- "phonegap/compass/parameters/compassSuccess.md",
- "phonegap/compass/parameters/compassError.md",
- "phonegap/compass/parameters/compassOptions.md",
- "phonegap/compass/parameters/compassHeading.md",
- "phonegap/compass/compassError/compassError.md"
+ "cordova/compass/compass.md",
+ "cordova/compass/compass.getCurrentHeading.md",
+ "cordova/compass/compass.watchHeading.md",
+ "cordova/compass/compass.clearWatch.md",
+ "cordova/compass/compass.watchHeadingFilter.md",
+ "cordova/compass/compass.clearWatchFilter.md",
+ "cordova/compass/parameters/compassSuccess.md",
+ "cordova/compass/parameters/compassError.md",
+ "cordova/compass/parameters/compassOptions.md",
+ "cordova/compass/parameters/compassHeading.md",
+ "cordova/compass/compassError/compassError.md"
],
"contacts.md": [
- "phonegap/contacts/contacts.md",
- "phonegap/contacts/contacts.create.md",
- "phonegap/contacts/contacts.find.md",
- "phonegap/contacts/Contact/contact.md",
- "phonegap/contacts/ContactAddress/contactaddress.md",
- "phonegap/contacts/ContactField/contactfield.md",
- "phonegap/contacts/ContactFindOptions/contactfindoptions.md",
- "phonegap/contacts/ContactName/contactname.md",
- "phonegap/contacts/ContactOrganization/contactorganization.md",
- "phonegap/contacts/ContactError/contactError.md",
- "phonegap/contacts/parameters/contactSuccess.md",
- "phonegap/contacts/parameters/contactError.md",
- "phonegap/contacts/parameters/contactFields.md",
- "phonegap/contacts/parameters/contactFindOptions.md"
+ "cordova/contacts/contacts.md",
+ "cordova/contacts/contacts.create.md",
+ "cordova/contacts/contacts.find.md",
+ "cordova/contacts/Contact/contact.md",
+ "cordova/contacts/ContactAddress/contactaddress.md",
+ "cordova/contacts/ContactField/contactfield.md",
+ "cordova/contacts/ContactFindOptions/contactfindoptions.md",
+ "cordova/contacts/ContactName/contactname.md",
+ "cordova/contacts/ContactOrganization/contactorganization.md",
+ "cordova/contacts/ContactError/contactError.md",
+ "cordova/contacts/parameters/contactSuccess.md",
+ "cordova/contacts/parameters/contactError.md",
+ "cordova/contacts/parameters/contactFields.md",
+ "cordova/contacts/parameters/contactFindOptions.md"
],
"device.md": [
- "phonegap/device/device.md",
- "phonegap/device/device.name.md",
- "phonegap/device/device.cordova.md",
- "phonegap/device/device.platform.md",
- "phonegap/device/device.uuid.md",
- "phonegap/device/device.version.md"
+ "cordova/device/device.md",
+ "cordova/device/device.name.md",
+ "cordova/device/device.cordova.md",
+ "cordova/device/device.platform.md",
+ "cordova/device/device.uuid.md",
+ "cordova/device/device.version.md"
],
"events.md": [
- "phonegap/events/events.md",
- "phonegap/events/events.deviceready.md",
- "phonegap/events/events.pause.md",
- "phonegap/events/events.resume.md",
- "phonegap/events/events.online.md",
- "phonegap/events/events.offline.md",
- "phonegap/events/events.backbutton.md",
- "phonegap/events/events.batterycritical.md",
- "phonegap/events/events.batterylow.md",
- "phonegap/events/events.batterystatus.md",
- "phonegap/events/events.menubutton.md",
- "phonegap/events/events.searchbutton.md",
- "phonegap/events/events.startcallbutton.md",
- "phonegap/events/events.endcallbutton.md",
- "phonegap/events/events.volumedownbutton.md",
- "phonegap/events/events.volumeupbutton.md"
+ "cordova/events/events.md",
+ "cordova/events/events.deviceready.md",
+ "cordova/events/events.pause.md",
+ "cordova/events/events.resume.md",
+ "cordova/events/events.online.md",
+ "cordova/events/events.offline.md",
+ "cordova/events/events.backbutton.md",
+ "cordova/events/events.batterycritical.md",
+ "cordova/events/events.batterylow.md",
+ "cordova/events/events.batterystatus.md",
+ "cordova/events/events.menubutton.md",
+ "cordova/events/events.searchbutton.md",
+ "cordova/events/events.startcallbutton.md",
+ "cordova/events/events.endcallbutton.md",
+ "cordova/events/events.volumedownbutton.md",
+ "cordova/events/events.volumeupbutton.md"
],
"file.md": [
- "phonegap/file/file.md",
- "phonegap/file/fileobj/fileobj.md",
- "phonegap/file/filereader/filereader.md",
- "phonegap/file/filewriter/filewriter.md",
- "phonegap/file/filesystem/filesystem.md",
- "phonegap/file/fileentry/fileentry.md",
- "phonegap/file/directoryentry/directoryentry.md",
- "phonegap/file/directoryreader/directoryreader.md",
- "phonegap/file/filetransfer/filetransfer.md",
- "phonegap/file/fileuploadoptions/fileuploadoptions.md",
- "phonegap/file/fileuploadresult/fileuploadresult.md",
- "phonegap/file/flags/flags.md",
- "phonegap/file/localfilesystem/localfilesystem.md",
- "phonegap/file/metadata/metadata.md",
- "phonegap/file/fileerror/fileerror.md",
- "phonegap/file/filetransfererror/filetransfererror.md"
+ "cordova/file/file.md",
+ "cordova/file/fileobj/fileobj.md",
+ "cordova/file/filereader/filereader.md",
+ "cordova/file/filewriter/filewriter.md",
+ "cordova/file/filesystem/filesystem.md",
+ "cordova/file/fileentry/fileentry.md",
+ "cordova/file/directoryentry/directoryentry.md",
+ "cordova/file/directoryreader/directoryreader.md",
+ "cordova/file/filetransfer/filetransfer.md",
+ "cordova/file/fileuploadoptions/fileuploadoptions.md",
+ "cordova/file/fileuploadresult/fileuploadresult.md",
+ "cordova/file/flags/flags.md",
+ "cordova/file/localfilesystem/localfilesystem.md",
+ "cordova/file/metadata/metadata.md",
+ "cordova/file/fileerror/fileerror.md",
+ "cordova/file/filetransfererror/filetransfererror.md"
],
"geolocation.md": [
- "phonegap/geolocation/geolocation.md",
- "phonegap/geolocation/geolocation.getCurrentPosition.md",
- "phonegap/geolocation/geolocation.watchPosition.md",
- "phonegap/geolocation/geolocation.clearWatch.md",
- "phonegap/geolocation/Coordinates/coordinates.md",
- "phonegap/geolocation/Position/position.md",
- "phonegap/geolocation/PositionError/positionError.md",
- "phonegap/geolocation/parameters/geolocationSuccess.md",
- "phonegap/geolocation/parameters/geolocationError.md",
- "phonegap/geolocation/parameters/geolocation.options.md"
+ "cordova/geolocation/geolocation.md",
+ "cordova/geolocation/geolocation.getCurrentPosition.md",
+ "cordova/geolocation/geolocation.watchPosition.md",
+ "cordova/geolocation/geolocation.clearWatch.md",
+ "cordova/geolocation/Coordinates/coordinates.md",
+ "cordova/geolocation/Position/position.md",
+ "cordova/geolocation/PositionError/positionError.md",
+ "cordova/geolocation/parameters/geolocationSuccess.md",
+ "cordova/geolocation/parameters/geolocationError.md",
+ "cordova/geolocation/parameters/geolocation.options.md"
],
"media.md": [
- "phonegap/media/media.md",
- "phonegap/media/media.getCurrentPosition.md",
- "phonegap/media/media.getDuration.md",
- "phonegap/media/media.pause.md",
- "phonegap/media/media.play.md",
- "phonegap/media/media.release.md",
- "phonegap/media/media.seekTo.md",
- "phonegap/media/media.startRecord.md",
- "phonegap/media/media.stop.md",
- "phonegap/media/media.stopRecord.md",
- "phonegap/media/MediaError/mediaError.md",
- "phonegap/media/Parameters/mediaError.md"
+ "cordova/media/media.md",
+ "cordova/media/media.getCurrentPosition.md",
+ "cordova/media/media.getDuration.md",
+ "cordova/media/media.pause.md",
+ "cordova/media/media.play.md",
+ "cordova/media/media.release.md",
+ "cordova/media/media.seekTo.md",
+ "cordova/media/media.startRecord.md",
+ "cordova/media/media.stop.md",
+ "cordova/media/media.stopRecord.md",
+ "cordova/media/MediaError/mediaError.md",
+ "cordova/media/Parameters/mediaError.md"
],
"network.md": [
- "phonegap/network/network.md",
- "phonegap/network/network.isReachable.md",
- "phonegap/network/NetworkStatus/NetworkStatus.md",
- "phonegap/network/parameters/reachableCallback.md",
- "phonegap/network/parameters/reachableHostname.md",
- "phonegap/network/parameters/reachableOptions.md"
+ "cordova/network/network.md",
+ "cordova/network/network.isReachable.md",
+ "cordova/network/NetworkStatus/NetworkStatus.md",
+ "cordova/network/parameters/reachableCallback.md",
+ "cordova/network/parameters/reachableHostname.md",
+ "cordova/network/parameters/reachableOptions.md"
],
"connection.md": [
- "phonegap/connection/connection.md",
- "phonegap/connection/connection.type.md"
+ "cordova/connection/connection.md",
+ "cordova/connection/connection.type.md"
],
"notification.md": [
- "phonegap/notification/notification.md",
- "phonegap/notification/notification.alert.md",
- "phonegap/notification/notification.confirm.md",
- "phonegap/notification/notification.beep.md",
- "phonegap/notification/notification.vibrate.md"
+ "cordova/notification/notification.md",
+ "cordova/notification/notification.alert.md",
+ "cordova/notification/notification.confirm.md",
+ "cordova/notification/notification.beep.md",
+ "cordova/notification/notification.vibrate.md"
],
"storage.md": [
- "phonegap/storage/storage.md",
- "phonegap/storage/storage.opendatabase.md",
- "phonegap/storage/parameters/name.md",
- "phonegap/storage/parameters/version.md",
- "phonegap/storage/parameters/display_name.md",
- "phonegap/storage/parameters/size.md",
- "phonegap/storage/database/database.md",
- "phonegap/storage/sqltransaction/sqltransaction.md",
- "phonegap/storage/sqlresultset/sqlresultset.md",
- "phonegap/storage/sqlresultsetlist/sqlresultsetlist.md",
- "phonegap/storage/sqlerror/sqlerror.md",
- "phonegap/storage/localstorage/localstorage.md"
+ "cordova/storage/storage.md",
+ "cordova/storage/storage.opendatabase.md",
+ "cordova/storage/parameters/name.md",
+ "cordova/storage/parameters/version.md",
+ "cordova/storage/parameters/display_name.md",
+ "cordova/storage/parameters/size.md",
+ "cordova/storage/database/database.md",
+ "cordova/storage/sqltransaction/sqltransaction.md",
+ "cordova/storage/sqlresultset/sqlresultset.md",
+ "cordova/storage/sqlresultsetlist/sqlresultsetlist.md",
+ "cordova/storage/sqlerror/sqlerror.md",
+ "cordova/storage/localstorage/localstorage.md"
]
}
}
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md b/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md
new file mode 100644
index 0000000..a656545
--- /dev/null
+++ b/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md
@@ -0,0 +1,85 @@
+Acceleration
+============
+
+Contains `Accelerometer` data captured at a specific point in time.
+
+Properties
+----------
+
+- __x:__ Amount of acceleration on the x-axis. (in m/s^2) (`Number`)
+- __y:__ Amount of acceleration on the y-axis. (in m/s^2) (`Number`)
+- __z:__ Amount of acceleration on the z-axis. (in m/s^2) (`Number`)
+- __timestamp:__ Creation timestamp in milliseconds. (`DOMTimeStamp`)
+
+Description
+-----------
+
+This object is created and populated by Cordova, and returned by an `Accelerometer` 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.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 (Mango)
+
+Quick Example
+-------------
+
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ };
+
+ function onError() {
+ alert('onError!');
+ };
+
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Acceleration Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ }
+
+ // onSuccess: Get a snapshot of the current acceleration
+ //
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ }
+
+ // onError: Failed to get the acceleration
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>getCurrentAcceleration</p>
+ </body>
+ </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md
new file mode 100644
index 0000000..e4d77d0
--- /dev/null
+++ b/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md
@@ -0,0 +1,92 @@
+accelerometer.clearWatch
+========================
+
+Stop watching the `Acceleration` referenced by the watch ID parameter.
+
+ navigator.accelerometer.clearWatch(watchID);
+
+- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 (Mango)
+
+Quick Example
+-------------
+
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+
+ // ... later on ...
+
+ navigator.accelerometer.clearWatch(watchID);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Acceleration Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // The watch id references the current `watchAcceleration`
+ var watchID = null;
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ startWatch();
+ }
+
+ // Start watching the acceleration
+ //
+ function startWatch() {
+
+ // Update acceleration every 3 seconds
+ var options = { frequency: 3000 };
+
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ }
+
+ // Stop watching the acceleration
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.accelerometer.clearWatch(watchID);
+ watchID = null;
+ }
+ }
+
+ // onSuccess: Get a snapshot of the current acceleration
+ //
+ function onSuccess(acceleration) {
+ var element = document.getElementById('accelerometer');
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
+ 'Timestamp: ' + acceleration.timestamp + '<br />';
+ }
+
+ // onError: Failed to get the acceleration
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <div id="accelerometer">Waiting for accelerometer...</div>
+ <button onclick="stopWatch();">Stop Watching</button>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
new file mode 100644
index 0000000..0914053
--- /dev/null
+++ b/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -0,0 +1,88 @@
+accelerometer.getCurrentAcceleration
+====================================
+
+Get the current acceleration along the x, y, and z axis.
+
+ navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
+
+Description
+-----------
+
+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.
+
+The acceleration is returned using the `accelerometerSuccess` callback function.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 (Mango)
+
+Quick Example
+-------------
+
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ };
+
+ function onError() {
+ alert('onError!');
+ };
+
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Acceleration Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ }
+
+ // onSuccess: Get a snapshot of the current acceleration
+ //
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ }
+
+ // onError: Failed to get the acceleration
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>getCurrentAcceleration</p>
+ </body>
+ </html>
+
+iPhone Quirks
+-------------
+
+- iPhone doesn't have the concept of getting the current acceleration at any given point.
+- You must watch the acceleration and capture the data at given time intervals.
+- Thus, the `getCurrentAcceleration` function will give you the last value reported from a Cordova `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/accelerometer/accelerometer.md b/docs/en/1.6.0/cordova/accelerometer/accelerometer.md
new file mode 100644
index 0000000..ccb6812
--- /dev/null
+++ b/docs/en/1.6.0/cordova/accelerometer/accelerometer.md
@@ -0,0 +1,23 @@
+Accelerometer
+=============
+
+> Captures device motion in the x, y, and z direction.
+
+Methods
+-------
+
+- accelerometer.getCurrentAcceleration
+- accelerometer.watchAcceleration
+- accelerometer.clearWatch
+
+Arguments
+---------
+
+- accelerometerSuccess
+- accelerometerError
+- accelerometerOptions
+
+Objects (Read-Only)
+-------------------
+
+- Acceleration
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md
new file mode 100644
index 0000000..8068c02
--- /dev/null
+++ b/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -0,0 +1,117 @@
+accelerometer.watchAcceleration
+===============================
+
+At a regular interval, get the acceleration along the x, y, and z axis.
+
+ var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
+ accelerometerError,
+ [accelerometerOptions]);
+
+Description
+-----------
+
+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.
+
+The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
+
+The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 (Mango)
+
+
+Quick Example
+-------------
+
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ };
+
+ function onError() {
+ alert('onError!');
+ };
+
+ var options = { frequency: 3000 }; // Update every 3 seconds
+
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Acceleration Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // The watch id references the current `watchAcceleration`
+ var watchID = null;
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ startWatch();
+ }
+
+ // Start watching the acceleration
+ //
+ function startWatch() {
+
+ // Update acceleration every 3 seconds
+ var options = { frequency: 3000 };
+
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ }
+
+ // Stop watching the acceleration
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.accelerometer.clearWatch(watchID);
+ watchID = null;
+ }
+ }
+
+ // onSuccess: Get a snapshot of the current acceleration
+ //
+ function onSuccess(acceleration) {
+ var element = document.getElementById('accelerometer');
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
+ 'Timestamp: ' + acceleration.timestamp + '<br />';
+ }
+
+ // onError: Failed to get the acceleration
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <div id="accelerometer">Waiting for accelerometer...</div>
+ </body>
+ </html>
+
+ iPhone Quirks
+-------------
+
+- At the interval requested, Cordova will call the success callback function and pass the accelerometer results.
+- However, in requests to the device Cordova restricts the interval to minimum of every 40ms and a maximum of every 1000ms.
+ - For example, if you request an interval of 3 seconds (3000ms), Cordova will request an interval of 1 second from the device but invoke the success callback at the requested interval of 3 seconds.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerError.md b/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerError.md
new file mode 100644
index 0000000..0765bfb
--- /dev/null
+++ b/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerError.md
@@ -0,0 +1,8 @@
+accelerometerError
+==================
+
+onError callback function for acceleration functions.
+
+ function() {
+ // Handle the error
+ }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md b/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md
new file mode 100644
index 0000000..82066ac
--- /dev/null
+++ b/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md
@@ -0,0 +1,9 @@
+accelerometerOptions
+====================
+
+An optional parameter to customize the retrieval of the accelerometer.
+
+Options
+-------
+
+- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md b/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md
new file mode 100644
index 0000000..23e7a43
--- /dev/null
+++ b/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -0,0 +1,23 @@
+accelerometerSuccess
+====================
+
+onSuccess callback function that provides the Acceleration information.
+
+ function(acceleration) {
+ // Do something
+ }
+
+Parameters
+----------
+
+- __acceleration:__ The acceleration at a single moment in time. (Acceleration)
+
+Example
+-------
+
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ };
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/camera/camera.getPicture.md b/docs/en/1.6.0/cordova/camera/camera.getPicture.md
new file mode 100644
index 0000000..a37bae0
--- /dev/null
+++ b/docs/en/1.6.0/cordova/camera/camera.getPicture.md
@@ -0,0 +1,183 @@
+camera.getPicture
+=================
+
+Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded `String` or as the URI of an image file.
+
+ navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
+
+Description
+-----------
+
+Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
+
+If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
+
+The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
+
+- A `String` containing the Base64 encoded photo image (default).
+- A `String` representing the image file location on local storage.
+
+You can do whatever you want with the encoded image or URI, for example:
+
+- Render the image in an `<img>` tag _(see example below)_
+- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
+- Post the data to a remote server
+
+Note: The image quality of pictures taken using the camera on newer devices is quite good. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended.
+
+Supported Platforms
+-------------------
+
+- Android
+- Blackberry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 ( Mango )
+
+
+Windows Phone 7 Quirks
+----------------------
+
+Invoking the native camera application while your device is connected
+via Zune will not work, and the error callback will be triggered.
+
+
+Quick Example
+-------------
+
+Take photo and retrieve Base64-encoded image:
+
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
+ destinationType: Camera.DestinationType.DATA_URL
+ });
+
+ function onSuccess(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+Take photo and retrieve image file location:
+
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
+ destinationType: Camera.DestinationType.FILE_URI });
+
+ function onSuccess(imageURI) {
+ var image = document.getElementById('myImage');
+ image.src = imageURI;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Capture Photo</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ var pictureSource; // picture source
+ var destinationType; // sets the format of returned value
+
+ // Wait for Cordova to connect with the device
+ //
+ document.addEventListener("deviceready",onDeviceReady,false);
+
+ // Cordova is ready to be used!
+ //
+ function onDeviceReady() {
+ pictureSource=navigator.camera.PictureSourceType;
+ destinationType=navigator.camera.DestinationType;
+ }
+
+ // Called when a photo is successfully retrieved
+ //
+ function onPhotoDataSuccess(imageData) {
+ // Uncomment to view the base64 encoded image data
+ // console.log(imageData);
+
+ // Get image handle
+ //
+ var smallImage = document.getElementById('smallImage');
+
+ // Unhide image elements
+ //
+ smallImage.style.display = 'block';
+
+ // Show the captured photo
+ // The inline CSS rules are used to resize the image
+ //
+ smallImage.src = "data:image/jpeg;base64," + imageData;
+ }
+
+ // Called when a photo is successfully retrieved
+ //
+ function onPhotoURISuccess(imageURI) {
+ // Uncomment to view the image file URI
+ // console.log(imageURI);
+
+ // Get image handle
+ //
+ var largeImage = document.getElementById('largeImage');
+
+ // Unhide image elements
+ //
+ largeImage.style.display = 'block';
+
+ // Show the captured photo
+ // The inline CSS rules are used to resize the image
+ //
+ largeImage.src = imageURI;
+ }
+
+ // A button will call this function
+ //
+ function capturePhoto() {
+ // Take picture using device camera and retrieve image as base64-encoded string
+ navigator.camera.getPicture(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.camera.getPicture(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.camera.getPicture(onPhotoURISuccess, onFail, { quality: 50,
+ destinationType: destinationType.FILE_URI,
+ sourceType: source });
+ }
+
+ // Called if something bad happens.
+ //
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="capturePhoto();">Capture Photo</button> <br>
+ <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
+ <button onclick="getPhoto(pictureSource.PHOTOLIBRARY);">From Photo Library</button><br>
+ <button onclick="getPhoto(pictureSource.SAVEDPHOTOALBUM);">From Photo Album</button><br>
+ <img style="display:none;width:60px;height:60px;" id="smallImage" src="" />
+ <img style="display:none;" id="largeImage" src="" />
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/camera/camera.md b/docs/en/1.6.0/cordova/camera/camera.md
new file mode 100644
index 0000000..e8ec1d8
--- /dev/null
+++ b/docs/en/1.6.0/cordova/camera/camera.md
@@ -0,0 +1,9 @@
+Camera
+======
+
+> The `camera` object provides access to the device's default camera application.
+
+Methods
+-------
+
+- camera.getPicture
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/camera/parameter/cameraError.md b/docs/en/1.6.0/cordova/camera/parameter/cameraError.md
new file mode 100644
index 0000000..cc219eb
--- /dev/null
+++ b/docs/en/1.6.0/cordova/camera/parameter/cameraError.md
@@ -0,0 +1,13 @@
+cameraError
+===========
+
+onError callback function that provides an error message.
+
+ function(message) {
+ // Show a helpful message
+ }
+
+Parameters
+----------
+
+- __message:__ The message is provided by the device's native code. (`String`)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md b/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md
new file mode 100644
index 0000000..6411288
--- /dev/null
+++ b/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md
@@ -0,0 +1,101 @@
+cameraOptions
+=============
+
+Optional parameters to customize the camera settings.
+
+ { quality : 75,
+ destinationType : Camera.DestinationType.DATA_URL,
+ sourceType : Camera.PictureSourceType.CAMERA,
+ allowEdit : true,
+ encodingType: Camera.EncodingType.JPEG,
+ targetWidth: 100,
+ targetHeight: 100 };
+
+Options
+-------
+
+- __quality:__ Quality of saved image. Range is [0, 100]. (`Number`)
+
+- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
+
+ Camera.DestinationType = {
+ DATA_URL : 0, // Return image as base64 encoded string
+ FILE_URI : 1 // Return image file URI
+ };
+
+- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
+
+ Camera.PictureSourceType = {
+ PHOTOLIBRARY : 0,
+ CAMERA : 1,
+ SAVEDPHOTOALBUM : 2
+ };
+
+- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`)
+
+- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
+
+ Camera.EncodingType = {
+ JPEG : 0, // Return JPEG encoded image
+ PNG : 1 // Return PNG encoded image
+ };
+
+- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`)
+- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`)
+
+- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`)
+
+ Camera.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
+};
+
+- __correctOrientation:__ Rotate the image to correct for the orientation of the device during capture. (`Boolean`)
+- __saveToPhotoAlbum:__ Save the image to the photo album on the device after capture. (`Boolean`)
+
+Android Quirks
+--------------
+
+- Ignores the `allowEdit` parameter.
+- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
+- Camera.EncodingType is not supported.
+- Ignores the `correctOrientation` parameter.
+- Ignores the `saveToPhotoAlbum` parameter.
+
+BlackBerry Quirks
+-----------------
+
+- Ignores the `quality` parameter.
+- Ignores the `sourceType` parameter.
+- Ignores the `allowEdit` parameter.
+- Application must have key injection permissions to close native Camera application after photo is taken.
+- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
+- Camera.MediaType is not supported.
+- Ignores the `correctOrientation` parameter.
+- Ignores the `saveToPhotoAlbum` parameter.
+
+Palm Quirks
+-----------
+
+- Ignores the `quality` parameter.
+- Ignores the `sourceType` parameter.
+- Ignores the `allowEdit` parameter.
+- Camera.MediaType is not supported.
+- Ignores the `correctOrientation` parameter.
+- Ignores the `saveToPhotoAlbum` parameter.
+
+iOS Quirks
+--------------
+
+- Set `quality` below 50 to avoid memory error on some devices.
+- When `destinationType.FILE_URI` is used, photos are saved in the application's temporary directory.
+- The contents of the application's temporary directory is deleted when the application ends. Developers may also delete the contents of this directory using the navigator.fileMgr APIs if storage space is a concern.
+
+Windows Phone 7 Quirks
+--------------
+
+- Ignores the `allowEdit` parameter.
+- Ignores the `correctOrientation` parameter.
+- Ignores the `saveToPhotoAlbum` parameter.
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md b/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md
new file mode 100644
index 0000000..a64a8ef
--- /dev/null
+++ b/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md
@@ -0,0 +1,23 @@
+cameraSuccess
+=============
+
+onSuccess callback function that provides the image data.
+
+ function(imageData) {
+ // Do something with the image
+ }
+
+Parameters
+----------
+
+- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
+
+Example
+-------
+
+ // Show image
+ //
+ function cameraCallback(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+ }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/compass.clearWatch.md b/docs/en/1.6.0/cordova/compass/compass.clearWatch.md
new file mode 100755
index 0000000..4422f88
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/compass.clearWatch.md
@@ -0,0 +1,90 @@
+compass.clearWatch
+========================
+
+Stop watching the compass referenced by the watch ID parameter.
+
+ navigator.compass.clearWatch(watchID);
+
+- __watchID__: The ID returned by `compass.watchHeading`.
+
+Supported Platforms
+-------------------
+
+- Android
+- iPhone
+- Windows Phone 7 ( Mango ) if available in hardware
+
+Quick Example
+-------------
+
+ var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+
+ // ... later on ...
+
+ navigator.compass.clearWatch(watchID);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Compass Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // The watch id references the current `watchHeading`
+ var watchID = null;
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", 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.compass.watchHeading(onSuccess, onError, options);
+ }
+
+ // Stop watching the compass
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.compass.clearWatch(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(compassError) {
+ alert('Compass error: ' + compassError.code);
+ }
+
+
+ </script>
+ </head>
+ <body>
+ <div id="heading">Waiting for heading...</div>
+ <button onclick="startWatch();">Start Watching</button>
+ <button onclick="stopWatch();">Stop Watching</button>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md b/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md
new file mode 100644
index 0000000..a8bc96e
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md
@@ -0,0 +1,4 @@
+compass.clearWatchFilter
+========================
+
+No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md b/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md
new file mode 100755
index 0000000..940955c
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md
@@ -0,0 +1,75 @@
+compass.getCurrentHeading
+=========================
+
+Get the current compass heading.
+
+ navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
+
+Description
+-----------
+
+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.
+
+The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
+
+Supported Platforms
+-------------------
+
+- Android
+- iPhone
+- Windows Phone 7 ( Mango ) if available in hardware
+
+Quick Example
+-------------
+
+ function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+ };
+
+ function onError(error) {
+ alert('CompassError: ' error.code);
+ };
+
+ navigator.compass.getCurrentHeading(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Compass Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.compass.getCurrentHeading(onSuccess, onError);
+ }
+
+ // onSuccess: Get the current heading
+ //
+ function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+ }
+
+ // onError: Failed to get the heading
+ //
+ function onError(compassError) {
+ alert('Compass Error: ' + compassError.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>getCurrentHeading</p>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/compass.md b/docs/en/1.6.0/cordova/compass/compass.md
new file mode 100755
index 0000000..25c8008
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/compass.md
@@ -0,0 +1,21 @@
+Compass
+=======
+
+> Obtains the direction that the device is pointing.
+
+Methods
+-------
+
+- compass.getCurrentHeading
+- compass.watchHeading
+- compass.clearWatch
+- compass.watchHeadingFilter (obsolete)
+- compass.clearWatchFilter (obsolete)
+
+Arguments
+---------
+
+- compassSuccess
+- compassError
+- compassOptions
+- compassHeading
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/compass.watchHeading.md b/docs/en/1.6.0/cordova/compass/compass.watchHeading.md
new file mode 100755
index 0000000..d5043a3
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/compass.watchHeading.md
@@ -0,0 +1,111 @@
+compass.watchHeading
+====================
+
+At a regular interval, get the compass heading in degrees.
+
+ var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
+
+Description
+-----------
+
+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.
+
+The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object.
+
+The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
+
+Supported Platforms
+-------------------
+
+- Android
+- iPhone
+- Windows Phone 7 ( Mango ) if available in hardware
+
+
+Quick Example
+-------------
+
+ function onSuccess(heading) {
+ var element = document.getElementById('heading');
+ element.innerHTML = 'Heading: ' + heading.magneticHeading;
+ };
+
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
+ };
+
+ var options = { frequency: 3000 }; // Update every 3 seconds
+
+ var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Compass Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // The watch id references the current `watchHeading`
+ var watchID = null;
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", 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.compass.watchHeading(onSuccess, onError, options);
+ }
+
+ // Stop watching the compass
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.compass.clearWatch(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(compassError) {
+ alert('Compass error: ' + compassError.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <div id="heading">Waiting for heading...</div>
+ <button onclick="startWatch();">Start Watching</button>
+ <button onclick="stopWatch();">Stop Watching</button>
+ </body>
+ </html>
+
+iOS Quirks
+--------------
+
+In iOS `compass.watchHeading` 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 `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
+
+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.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md b/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md
new file mode 100644
index 0000000..bd4e784
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md
@@ -0,0 +1,4 @@
+compass.watchHeadingFilter
+==========================
+
+No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/compassError/compassError.md b/docs/en/1.6.0/cordova/compass/compassError/compassError.md
new file mode 100644
index 0000000..2e1a24d
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/compassError/compassError.md
@@ -0,0 +1,21 @@
+CompassError
+==========
+
+A `CompassError` object is returned to the `compassError` callback function when an error occurs.
+
+Properties
+----------
+
+- __code:__ One of the predefined error codes listed below.
+
+Constants
+---------
+- `CompassError.COMPASS_INTERNAL_ERR`
+- `CompassError.COMPASS_NOT_SUPPORTED`
+
+Description
+-----------
+
+The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
+
+
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/parameters/compassError.md b/docs/en/1.6.0/cordova/compass/parameters/compassError.md
new file mode 100755
index 0000000..c150f29
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/parameters/compassError.md
@@ -0,0 +1,11 @@
+compassError
+==========
+
+onError callback function for compass functions.
+
+Example
+-------
+
+function(CompassError) {
+ // Handle the error
+}
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md b/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md
new file mode 100644
index 0000000..49b4c1d
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md
@@ -0,0 +1,29 @@
+compassHeading
+==========
+
+A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
+
+Properties
+----------
+- __magneticHeading:__ The heading in degrees from 0 - 359.99 at a single moment in time. _(Number)_
+- __trueHeading:__ The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading could not be determined. _(Number)_
+- __headingAccuracy:__ The deviation in degrees between the reported heading and the true heading. _(Number)_
+- __timestamp:__ The time at which this heading was determined. _(milliseconds)_
+
+Description
+-----------
+
+The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
+
+Android Quirks
+--------------
+- trueHeading is not supported. It will report the same value as magneticHeading
+- headingAccuracy will always be 0 as there is no difference between the magneticHeading and trueHeading on Android.
+
+iOS Quirks
+----------
+
+- trueHeading is only returned when location services are running via `navigator.geolocation.watchLocation()`
+- For iOS > 4 devices, if the device is rotated and the app supports that orientation, the heading values will be reported
+back with respect to the current orientation.
+
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/parameters/compassOptions.md b/docs/en/1.6.0/cordova/compass/parameters/compassOptions.md
new file mode 100755
index 0000000..fc203e2
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/parameters/compassOptions.md
@@ -0,0 +1,19 @@
+compassOptions
+==============
+
+An optional parameter to customize the retrieval of the compass.
+
+Options
+-------
+
+- __frequency:__ How often to retrieve the compass heading in milliseconds. _(Number)_ (Default: 100)
+- __filter:__ The change in degrees required to initiate a watchHeading success callback. _(Number)_
+
+Android Quirks
+______________
+- filter is not supported.
+
+Windows Phone 7 Quirks
+--------------
+
+- filter is not supported.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md b/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md
new file mode 100644
index 0000000..9e12a64
--- /dev/null
+++ b/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md
@@ -0,0 +1,21 @@
+compassSuccess
+==============
+
+onSuccess callback function that provides the compass heading information via a compassHeading object.
+
+ function(heading) {
+ // Do something
+ }
+
+Parameters
+----------
+
+
+- __heading:__ The heading information. _(compassHeading)_
+
+Example
+-------
+
+ function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+ };
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/connection/connection.md b/docs/en/1.6.0/cordova/connection/connection.md
new file mode 100644
index 0000000..c888441
--- /dev/null
+++ b/docs/en/1.6.0/cordova/connection/connection.md
@@ -0,0 +1,29 @@
+Connection
+==========
+
+> The `connection` object gives access to the device's cellular and wifi connection information.
+
+This object is accessed under the navigator.network interface.
+
+Properties
+----------
+
+- connection.type
+
+Constants
+---------
+
+- Connection.UNKNOWN
+- Connection.ETHERNET
+- Connection.WIFI
+- Connection.CELL_2G
+- Connection.CELL_3G
+- Connection.CELL_4G
+- Connection.NONE
+
+WP7 Quirk
+---------
+
+- __type:__
+Windows Phone Emulator always reports navigator.network.connection.type is Connection.UNKNOWN
+
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/72364fb9/docs/en/1.6.0/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.0/cordova/connection/connection.type.md b/docs/en/1.6.0/cordova/connection/connection.type.md
new file mode 100644
index 0000000..6155894
--- /dev/null
+++ b/docs/en/1.6.0/cordova/connection/connection.type.md
@@ -0,0 +1,82 @@
+connection.type
+===================
+
+Checks the active network connection that is being used.
+
+Description
+-----------
+
+This property is a fast way to determine the device's network connection state, and type of connection.
+
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Windows Phone 7 ( Mango )
+
+Quick Example
+-------------
+
+ function checkConnection() {
+ var networkState = navigator.network.connection.type;
+
+ var states = {};
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.NONE] = 'No network connection';
+
+ alert('Connection type: ' + states[networkState]);
+ }
+
+ checkConnection();
+
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>navigator.network.connection.type Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ checkConnection();
+ }
+
+ function checkConnection() {
+ var networkState = navigator.network.connection.type;
+
+ var states = {};
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.NONE] = 'No network connection';
+
+ alert('Connection type: ' + states[networkState]);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p>A dialog box will report the network state.</p>
+ </body>
+ </html>