Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id DBE6BD81E for ; Thu, 1 Nov 2012 17:32:15 +0000 (UTC) Received: (qmail 34095 invoked by uid 500); 1 Nov 2012 17:32:14 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 34027 invoked by uid 500); 1 Nov 2012 17:32:14 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 33582 invoked by uid 500); 1 Nov 2012 17:32:11 -0000 Delivered-To: apmail-incubator-callback-commits@incubator.apache.org Received: (qmail 33552 invoked by uid 99); 1 Nov 2012 17:32:11 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Nov 2012 17:32:10 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id AB194517FF; Thu, 1 Nov 2012 17:32:10 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mwbrooks@apache.org To: callback-commits@incubator.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [1/10] docs commit: Version 2.2.0 Message-Id: <20121101173210.AB194517FF@tyr.zones.apache.org> Date: Thu, 1 Nov 2012 17:32:10 +0000 (UTC) Updated Branches: refs/heads/master 809f99131 -> 6ecf3e804 Version 2.2.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/6ecf3e80 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/6ecf3e80 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/6ecf3e80 Branch: refs/heads/master Commit: 6ecf3e804c7a0dfcddc6e87048e41aaa208ef85b Parents: 809f991 Author: Michael Brooks Authored: Thu Nov 1 10:29:45 2012 -0700 Committer: Michael Brooks Committed: Thu Nov 1 10:30:37 2012 -0700 ---------------------------------------------------------------------- VERSION | 2 +- docs/en/2.2.0/config.json | 192 ++++++++ .../accelerometer/acceleration/acceleration.md | 107 ++++ .../accelerometer/accelerometer.clearWatch.md | 113 +++++ .../accelerometer.getCurrentAcceleration.md | 109 ++++ .../2.2.0/cordova/accelerometer/accelerometer.md | 94 ++++ .../accelerometer.watchAcceleration.md | 138 ++++++ .../accelerometer/parameters/accelerometerError.md | 27 + .../parameters/accelerometerOptions.md | 28 + .../parameters/accelerometerSuccess.md | 42 ++ docs/en/2.2.0/cordova/camera/camera.cleanup.md | 50 ++ docs/en/2.2.0/cordova/camera/camera.getPicture.md | 217 ++++++++ docs/en/2.2.0/cordova/camera/camera.md | 102 ++++ .../camera/parameter/CameraPopoverOptions.md | 71 +++ .../2.2.0/cordova/camera/parameter/cameraError.md | 32 ++ .../cordova/camera/parameter/cameraOptions.md | 126 +++++ .../cordova/camera/parameter/cameraSuccess.md | 42 ++ .../en/2.2.0/cordova/compass/compass.clearWatch.md | 112 +++++ .../cordova/compass/compass.clearWatchFilter.md | 23 + .../cordova/compass/compass.getCurrentHeading.md | 97 ++++ docs/en/2.2.0/cordova/compass/compass.md | 85 ++++ .../2.2.0/cordova/compass/compass.watchHeading.md | 133 +++++ .../cordova/compass/compass.watchHeadingFilter.md | 23 + .../cordova/compass/compassError/compassError.md | 40 ++ .../cordova/compass/parameters/compassError.md | 30 ++ .../cordova/compass/parameters/compassHeading.md | 48 ++ .../cordova/compass/parameters/compassOptions.md | 46 ++ .../cordova/compass/parameters/compassSuccess.md | 40 ++ docs/en/2.2.0/cordova/connection/connection.md | 100 ++++ .../en/2.2.0/cordova/connection/connection.type.md | 138 ++++++ docs/en/2.2.0/cordova/contacts/Contact/contact.md | 237 +++++++++ .../contacts/ContactAddress/contactaddress.md | 159 ++++++ .../cordova/contacts/ContactError/contactError.md | 45 ++ .../cordova/contacts/ContactField/contactfield.md | 146 ++++++ .../ContactFindOptions/contactfindoptions.md | 116 +++++ .../cordova/contacts/ContactName/contactname.md | 145 ++++++ .../ContactOrganization/contactorganization.md | 146 ++++++ docs/en/2.2.0/cordova/contacts/contacts.create.md | 78 +++ docs/en/2.2.0/cordova/contacts/contacts.find.md | 118 +++++ docs/en/2.2.0/cordova/contacts/contacts.md | 108 ++++ .../cordova/contacts/parameters/contactError.md | 27 + .../cordova/contacts/parameters/contactFields.md | 25 + .../contacts/parameters/contactFindOptions.md | 35 ++ .../cordova/contacts/parameters/contactSuccess.md | 40 ++ docs/en/2.2.0/cordova/device/device.cordova.md | 80 +++ docs/en/2.2.0/cordova/device/device.md | 103 ++++ docs/en/2.2.0/cordova/device/device.name.md | 113 +++++ docs/en/2.2.0/cordova/device/device.platform.md | 97 ++++ docs/en/2.2.0/cordova/device/device.uuid.md | 107 ++++ docs/en/2.2.0/cordova/device/device.version.md | 86 ++++ docs/en/2.2.0/cordova/events/events.backbutton.md | 87 ++++ .../2.2.0/cordova/events/events.batterycritical.md | 94 ++++ docs/en/2.2.0/cordova/events/events.batterylow.md | 94 ++++ .../2.2.0/cordova/events/events.batterystatus.md | 102 ++++ docs/en/2.2.0/cordova/events/events.deviceready.md | 90 ++++ .../2.2.0/cordova/events/events.endcallbutton.md | 86 ++++ docs/en/2.2.0/cordova/events/events.md | 101 ++++ docs/en/2.2.0/cordova/events/events.menubutton.md | 87 ++++ docs/en/2.2.0/cordova/events/events.offline.md | 96 ++++ docs/en/2.2.0/cordova/events/events.online.md | 96 ++++ docs/en/2.2.0/cordova/events/events.pause.md | 97 ++++ docs/en/2.2.0/cordova/events/events.resume.md | 108 ++++ .../en/2.2.0/cordova/events/events.searchbutton.md | 86 ++++ .../2.2.0/cordova/events/events.startcallbutton.md | 86 ++++ .../cordova/events/events.volumedownbutton.md | 86 ++++ .../2.2.0/cordova/events/events.volumeupbutton.md | 86 ++++ .../cordova/file/directoryentry/directoryentry.md | 383 +++++++++++++++ .../file/directoryreader/directoryreader.md | 66 +++ docs/en/2.2.0/cordova/file/file.md | 100 ++++ docs/en/2.2.0/cordova/file/fileentry/fileentry.md | 326 ++++++++++++ docs/en/2.2.0/cordova/file/fileerror/fileerror.md | 49 ++ docs/en/2.2.0/cordova/file/fileobj/fileobj.md | 45 ++ .../en/2.2.0/cordova/file/filereader/filereader.md | 196 ++++++++ .../en/2.2.0/cordova/file/filesystem/filesystem.md | 91 ++++ .../cordova/file/filetransfer/filetransfer.md | 253 ++++++++++ .../file/filetransfererror/filetransfererror.md | 44 ++ .../file/fileuploadoptions/fileuploadoptions.md | 45 ++ .../file/fileuploadresult/fileuploadresult.md | 40 ++ .../en/2.2.0/cordova/file/filewriter/filewriter.md | 194 ++++++++ docs/en/2.2.0/cordova/file/flags/flags.md | 46 ++ .../file/localfilesystem/localfilesystem.md | 110 ++++ docs/en/2.2.0/cordova/file/metadata/metadata.md | 51 ++ .../cordova/geolocation/Coordinates/coordinates.md | 126 +++++ .../2.2.0/cordova/geolocation/Position/position.md | 120 +++++ .../geolocation/PositionError/positionError.md | 59 +++ .../cordova/geolocation/geolocation.clearWatch.md | 118 +++++ .../geolocation/geolocation.getCurrentPosition.md | 127 +++++ docs/en/2.2.0/cordova/geolocation/geolocation.md | 108 ++++ .../geolocation/geolocation.watchPosition.md | 129 +++++ .../geolocation/parameters/geolocation.options.md | 41 ++ .../geolocation/parameters/geolocationError.md | 32 ++ .../geolocation/parameters/geolocationSuccess.md | 46 ++ .../GlobalizationError/globalizationerror.md | 93 ++++ .../globalization/globalization.dateToString.md | 86 ++++ .../globalization.getCurrencyPattern.md | 106 ++++ .../globalization/globalization.getDateNames.md | 92 ++++ .../globalization/globalization.getDatePattern.md | 89 ++++ .../globalization.getFirstDayOfWeek.md | 75 +++ .../globalization/globalization.getLocaleName.md | 77 +++ .../globalization.getNumberPattern.md | 114 +++++ .../globalization.getPreferredLanguage.md | 76 +++ .../globalization.isDayLightSavingsTime.md | 78 +++ .../2.2.0/cordova/globalization/globalization.md | 61 +++ .../globalization/globalization.numberToString.md | 80 +++ .../globalization/globalization.stringToDate.md | 102 ++++ .../globalization/globalization.stringToNumber.md | 83 ++++ .../2.2.0/cordova/media/MediaError/mediaError.md | 44 ++ .../2.2.0/cordova/media/Parameters/mediaError.md | 32 ++ docs/en/2.2.0/cordova/media/capture/CaptureCB.md | 44 ++ .../en/2.2.0/cordova/media/capture/CaptureError.md | 37 ++ .../2.2.0/cordova/media/capture/CaptureErrorCB.md | 40 ++ .../cordova/media/capture/ConfigurationData.md | 62 +++ .../media/capture/MediaFile.getFormatData.md | 53 ++ docs/en/2.2.0/cordova/media/capture/MediaFile.md | 37 ++ .../2.2.0/cordova/media/capture/MediaFileData.md | 62 +++ docs/en/2.2.0/cordova/media/capture/capture.md | 134 +++++ .../en/2.2.0/cordova/media/capture/captureAudio.md | 140 ++++++ .../cordova/media/capture/captureAudioOptions.md | 56 +++ .../en/2.2.0/cordova/media/capture/captureImage.md | 158 ++++++ .../cordova/media/capture/captureImageOptions.md | 53 ++ .../en/2.2.0/cordova/media/capture/captureVideo.md | 159 ++++++ .../cordova/media/capture/captureVideoOptions.md | 59 +++ .../cordova/media/media.getCurrentPosition.md | 174 +++++++ docs/en/2.2.0/cordova/media/media.getDuration.md | 166 +++++++ docs/en/2.2.0/cordova/media/media.md | 142 ++++++ docs/en/2.2.0/cordova/media/media.pause.md | 171 +++++++ docs/en/2.2.0/cordova/media/media.play.md | 189 +++++++ docs/en/2.2.0/cordova/media/media.release.md | 155 ++++++ docs/en/2.2.0/cordova/media/media.seekTo.md | 158 ++++++ docs/en/2.2.0/cordova/media/media.startRecord.md | 151 ++++++ docs/en/2.2.0/cordova/media/media.stop.md | 170 +++++++ docs/en/2.2.0/cordova/media/media.stopRecord.md | 141 ++++++ .../cordova/notification/notification.alert.md | 124 +++++ .../cordova/notification/notification.beep.md | 120 +++++ .../cordova/notification/notification.confirm.md | 133 +++++ docs/en/2.2.0/cordova/notification/notification.md | 84 ++++ .../cordova/notification/notification.vibrate.md | 103 ++++ .../cordova/splashscreen/splashscreen.hide.md | 80 +++ docs/en/2.2.0/cordova/splashscreen/splashscreen.md | 87 ++++ .../cordova/splashscreen/splashscreen.show.md | 69 +++ docs/en/2.2.0/cordova/storage/database/database.md | 121 +++++ .../cordova/storage/localstorage/localstorage.md | 121 +++++ .../cordova/storage/parameters/display_name.md | 23 + docs/en/2.2.0/cordova/storage/parameters/name.md | 23 + docs/en/2.2.0/cordova/storage/parameters/size.md | 23 + .../en/2.2.0/cordova/storage/parameters/version.md | 23 + docs/en/2.2.0/cordova/storage/sqlerror/sqlerror.md | 47 ++ .../cordova/storage/sqlresultset/sqlresultset.md | 140 ++++++ .../storage/sqlresultsetlist/sqlresultsetlist.md | 137 +++++ .../storage/sqltransaction/sqltransaction.md | 114 +++++ docs/en/2.2.0/cordova/storage/storage.md | 83 ++++ .../2.2.0/cordova/storage/storage.opendatabase.md | 75 +++ docs/en/2.2.0/guide/command-line/index.md | 190 +++++++ docs/en/2.2.0/guide/cordova-webview/android.md | 66 +++ docs/en/2.2.0/guide/cordova-webview/index.md | 27 + docs/en/2.2.0/guide/cordova-webview/ios.md | 131 +++++ .../2.2.0/guide/getting-started/android/index.md | 75 +++ docs/en/2.2.0/guide/getting-started/bada/index.md | 93 ++++ .../guide/getting-started/blackberry/index.md | 101 ++++ docs/en/2.2.0/guide/getting-started/index.md | 31 ++ docs/en/2.2.0/guide/getting-started/ios/index.md | 123 +++++ .../2.2.0/guide/getting-started/symbian/index.md | 78 +++ docs/en/2.2.0/guide/getting-started/tizen/index.md | 108 ++++ docs/en/2.2.0/guide/getting-started/webos/index.md | 79 +++ .../2.2.0/guide/getting-started/windows-8/index.md | 104 ++++ .../guide/getting-started/windows-phone/index.md | 115 +++++ .../guide/plugin-development/android/index.md | 188 +++++++ .../2.2.0/guide/plugin-development/bada/index.md | 74 +++ .../guide/plugin-development/blackberry/index.md | 136 +++++ docs/en/2.2.0/guide/plugin-development/index.md | 112 +++++ .../en/2.2.0/guide/plugin-development/ios/index.md | 174 +++++++ .../2.2.0/guide/plugin-development/tizen/index.md | 23 + .../2.2.0/guide/plugin-development/webos/index.md | 23 + .../plugin-development/windows-phone/index.md | 191 +++++++ docs/en/2.2.0/guide/project-settings/index.md | 23 + docs/en/2.2.0/guide/project-settings/ios/index.md | 53 ++ docs/en/2.2.0/guide/upgrading/android/index.md | 188 +++++++ docs/en/2.2.0/guide/upgrading/bada/index.md | 48 ++ docs/en/2.2.0/guide/upgrading/blackberry/index.md | 117 +++++ docs/en/2.2.0/guide/upgrading/index.md | 32 ++ docs/en/2.2.0/guide/upgrading/ios/index.md | 322 ++++++++++++ docs/en/2.2.0/guide/upgrading/symbian/index.md | 21 + docs/en/2.2.0/guide/upgrading/tizen/index.md | 23 + docs/en/2.2.0/guide/upgrading/webos/index.md | 38 ++ .../2.2.0/guide/upgrading/windows-phone/index.md | 147 ++++++ docs/en/2.2.0/guide/whitelist/index.md | 189 +++++++ docs/en/2.2.0/index.md | 119 +++++ 187 files changed, 18135 insertions(+), 1 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/VERSION ---------------------------------------------------------------------- diff --git a/VERSION b/VERSION index 01a6c09..e3a4f19 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.2.0rc2 \ No newline at end of file +2.2.0 \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/config.json ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/config.json b/docs/en/2.2.0/config.json new file mode 100644 index 0000000..4583fce --- /dev/null +++ b/docs/en/2.2.0/config.json @@ -0,0 +1,192 @@ +{ + "language": "English", + "merge": { + "accelerometer.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": [ + "cordova/camera/camera.md", + "cordova/camera/camera.getPicture.md", + "cordova/camera/parameter/cameraSuccess.md", + "cordova/camera/parameter/cameraError.md", + "cordova/camera/parameter/cameraOptions.md", + "cordova/camera/parameter/CameraPopoverOptions.md" + ], + "capture.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": [ + "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": [ + "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": [ + "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": [ + "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": [ + "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": [ + "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" + ], + "globalization.md": [ + "cordova/globalization/globalization.md", + "cordova/globalization/globalization.getPreferredLanguage.md", + "cordova/globalization/globalization.getLocaleName.md", + "cordova/globalization/globalization.dateToString.md", + "cordova/globalization/globalization.stringToDate.md", + "cordova/globalization/globalization.getDatePattern.md", + "cordova/globalization/globalization.getDateNames.md", + "cordova/globalization/globalization.isDayLightSavingsTime.md", + "cordova/globalization/globalization.getFirstDayOfWeek.md", + "cordova/globalization/globalization.numberToString.md", + "cordova/globalization/globalization.stringToNumber.md", + "cordova/globalization/globalization.getNumberPattern.md", + "cordova/globalization/globalization.getCurrencyPattern.md", + "cordova/globalization/GlobalizationError/globalizationerror.md" + ], + "media.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": [ + "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": [ + "cordova/connection/connection.md", + "cordova/connection/connection.type.md" + ], + "notification.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" + ], + "splashscreen.md": [ + "cordova/splashscreen/splashscreen.md", + "cordova/splashscreen/splashscreen.show.md", + "cordova/splashscreen/splashscreen.hide.md" + ], + "storage.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/6ecf3e80/docs/en/2.2.0/cordova/accelerometer/acceleration/acceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/accelerometer/acceleration/acceleration.md b/docs/en/2.2.0/cordova/accelerometer/acceleration/acceleration.md new file mode 100644 index 0000000..e935b5e --- /dev/null +++ b/docs/en/2.2.0/cordova/accelerometer/acceleration/acceleration.md @@ -0,0 +1,107 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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) +- Bada 1.2 & 2.x +- webOS +- Tizen + +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 +------------ + + + + + Acceleration Example + + + + + +

Example

+

getCurrentAcceleration

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/accelerometer/accelerometer.clearWatch.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/2.2.0/cordova/accelerometer/accelerometer.clearWatch.md new file mode 100644 index 0000000..2119b1d --- /dev/null +++ b/docs/en/2.2.0/cordova/accelerometer/accelerometer.clearWatch.md @@ -0,0 +1,113 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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) +- Bada 1.2 & 2.x +- Tizen + +Quick Example +------------- + + var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options); + + // ... later on ... + + navigator.accelerometer.clearWatch(watchID); + +Full Example +------------ + + + + + Acceleration Example + + + + + +
Waiting for accelerometer...
+ + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/2.2.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md new file mode 100644 index 0000000..aefc53e --- /dev/null +++ b/docs/en/2.2.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md @@ -0,0 +1,109 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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) +- Bada 1.2 & 2.x +- Tizen + +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 +------------ + + + + + Acceleration Example + + + + + +

Example

+

getCurrentAcceleration

+ + + +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/6ecf3e80/docs/en/2.2.0/cordova/accelerometer/accelerometer.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/accelerometer/accelerometer.md b/docs/en/2.2.0/cordova/accelerometer/accelerometer.md new file mode 100644 index 0000000..51da4e3 --- /dev/null +++ b/docs/en/2.2.0/cordova/accelerometer/accelerometer.md @@ -0,0 +1,94 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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 + +Permissions +----------- + +### Android + +#### app/res/xml/config.xml + + + +### Bada + + No permissions are required. + +### BlackBerry WebWorks + +#### www/plugins.xml + + + +#### www/config.xml + + + + +### iOS + +#### App/Supporting Files/Cordova.plist + + Plugins + + Accelerometer + CDVAccelerometer + + +### webOS + + No permissions are required. + +### Windows Phone + +#### Properties/WPAppManifest.xml + + + + + +Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) + +### Tizen + + No permissions are required. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/accelerometer/accelerometer.watchAcceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/2.2.0/cordova/accelerometer/accelerometer.watchAcceleration.md new file mode 100644 index 0000000..d9bc427 --- /dev/null +++ b/docs/en/2.2.0/cordova/accelerometer/accelerometer.watchAcceleration.md @@ -0,0 +1,138 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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 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) +- Bada 1.2 & 2.x +- Tizen + + +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 +------------ + + + + + Acceleration Example + + + + + +
Waiting for accelerometer...
+ + + + 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/6ecf3e80/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerError.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerError.md b/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerError.md new file mode 100644 index 0000000..c908c16 --- /dev/null +++ b/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerError.md @@ -0,0 +1,27 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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/6ecf3e80/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerOptions.md b/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerOptions.md new file mode 100644 index 0000000..197f416 --- /dev/null +++ b/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerOptions.md @@ -0,0 +1,28 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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/6ecf3e80/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerSuccess.md b/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerSuccess.md new file mode 100644 index 0000000..277fca8 --- /dev/null +++ b/docs/en/2.2.0/cordova/accelerometer/parameters/accelerometerSuccess.md @@ -0,0 +1,42 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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/6ecf3e80/docs/en/2.2.0/cordova/camera/camera.cleanup.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/camera/camera.cleanup.md b/docs/en/2.2.0/cordova/camera/camera.cleanup.md new file mode 100644 index 0000000..fbf9e13 --- /dev/null +++ b/docs/en/2.2.0/cordova/camera/camera.cleanup.md @@ -0,0 +1,50 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +camera.cleanup +================= + +Cleans up the image files that were taken by the camera, that were stored in a temporary storage location. + + navigator.camera.cleanup( cameraSuccess, cameraError ); + +Description +----------- + +Cleans up the image files stored in the temporary storage location, when the function `camera.getPicture` is used with `Camera.sourceType = Camera.PictureSourceType.CAMERA` and `Camera.destinationType = Camera.DestinationType.FILE_URI` + + +Supported Platforms +------------------- + +- iOS + + +Example +------------- + + navigator.camera.cleanup(onSuccess, onFail); + + function onSuccess() { + console.log("Camera cleanup success.") + } + + function onFail(message) { + alert('Failed because: ' + message); + } http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/camera/camera.getPicture.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/camera/camera.getPicture.md b/docs/en/2.2.0/cordova/camera/camera.getPicture.md new file mode 100644 index 0000000..46d990a --- /dev/null +++ b/docs/en/2.2.0/cordova/camera/camera.getPicture.md @@ -0,0 +1,217 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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 `` 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, and images from the Photo Album will not be downscaled to a lower quality, even if a quality parameter is specified. ___Encoding such images using Base64 has caused memory issues on many newer devices. Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended.___ + +Supported Platforms +------------------- + +- Android +- Blackberry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) +- Bada 1.2 +- webOS +- Tizen + +iOS Quirks +---------- + +Including a JavaScript alert() in either of the callback functions can cause problems. Wrap the alert in a setTimeout() to allow the iOS image picker or popover to fully close before the alert is displayed: + + setTimeout(function() { + // do your thing here! + }, 0); + +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. + +Tizen Quirks +---------------------- + +Only 'destinationType: Camera.DestinationType.FILE_URI' and 'sourceType: Camera.PictureSourceType.PHOTOLIBRARY' are supported. + +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 +------------ + + + + + Capture Photo + + + + + +
+
+
+
+ + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/camera/camera.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/camera/camera.md b/docs/en/2.2.0/cordova/camera/camera.md new file mode 100644 index 0000000..310f516 --- /dev/null +++ b/docs/en/2.2.0/cordova/camera/camera.md @@ -0,0 +1,102 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +Camera +====== + +> The `camera` object provides access to the device's default camera application. + +Methods +------- + +- camera.getPicture +- camera.cleanup + +Permissions +----------- + +### Android + +#### app/res/xml/config.xml + + + +#### app/AndroidManifest + + + +### Bada + +#### manifest.xml + + + CAMERA + + + RECORDING + + +### BlackBerry WebWorks + +#### www/plugins.xml + + + +#### www/config.xml + + + + + use_camera + + +### iOS + +#### App/Supporting Files/Cordova.plist + + Plugins + + Camera + CDVCamera + + +### webOS + + No permissions are required. + +### Windows Phone + +#### Properties/WPAppManifest.xml + + + + + + + +Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) + +### Tizen + +#### config.xml + + + + +Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/camera/parameter/CameraPopoverOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/2.2.0/cordova/camera/parameter/CameraPopoverOptions.md new file mode 100644 index 0000000..6314e8a --- /dev/null +++ b/docs/en/2.2.0/cordova/camera/parameter/CameraPopoverOptions.md @@ -0,0 +1,71 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +CameraPopoverOptions +==================== + +Parameters only used by iOS to specify the anchor element location and arrow direction of popover used on iPad when selecting images from the library or album. + + { x : 0, + y : 32, + width : 320, + height : 480, + arrowDir : Camera.PopoverArrowDirection.ARROW_ANY + }; + +CameraPopoverOptions +-------------------- + +- __x:__ x pixel coordinate of element on the screen to anchor popover onto. (`Number`) + +- __y:__ y pixel coordinate of element on the screen to anchor popover onto. (`Number`) + +- __width:__ width, in pixels, of the element on the screen to anchor popover onto. (`Number`) + +- __height:__ height, in pixels, of the element on the screen to anchor popover onto. (`Number`) + +- __arrowDir:__ Direction the arrow on the popover should point. Defined in Camera.PopoverArrowDirection (`Number`) + + Camera.PopoverArrowDirection = { + ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants + ARROW_DOWN : 2, + ARROW_LEFT : 4, + ARROW_RIGHT : 8, + ARROW_ANY : 15 + }; + +Note that the size of the popover may change to adjust to the direction of the arrow and orientation of the screen. Make sure to account for orientation changes when specifying the anchor element location. + +Quick Example +------------- + + var popover = new CameraPopoverOptions(300,300,100,100,Camera.PopoverArrowDirection.ARROW_ANY); + var options = { quality: 50, destinationType: Camera.DestinationType.DATA_URL,sourceType: Camera.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover }; + + navigator.camera.getPicture(onSuccess, onFail, options); + + function onSuccess(imageData) { + var image = document.getElementById('myImage'); + image.src = "data:image/jpeg;base64," + imageData; + } + + function onFail(message) { + alert('Failed because: ' + message); + } + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/camera/parameter/cameraError.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/camera/parameter/cameraError.md b/docs/en/2.2.0/cordova/camera/parameter/cameraError.md new file mode 100644 index 0000000..7ee091b --- /dev/null +++ b/docs/en/2.2.0/cordova/camera/parameter/cameraError.md @@ -0,0 +1,32 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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/6ecf3e80/docs/en/2.2.0/cordova/camera/parameter/cameraOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/camera/parameter/cameraOptions.md b/docs/en/2.2.0/cordova/camera/parameter/cameraOptions.md new file mode 100644 index 0000000..b964205 --- /dev/null +++ b/docs/en/2.2.0/cordova/camera/parameter/cameraOptions.md @@ -0,0 +1,126 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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, + popoverOptions: CameraPopoverOptions, + saveToPhotoAlbum: false }; + +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`) +- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in CameraPopoverOptions + +Android Quirks +-------------- + +- Ignores the `allowEdit` parameter. +- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album. + +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. + +webOS 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. Developers may 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. + +Bada 1.2 Quirks +-------------- +- options not supported +- always returns a FILE URI + +Tizen Quirks +-------------- +- options not supported +- always returns a FILE URI http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/camera/parameter/cameraSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/camera/parameter/cameraSuccess.md b/docs/en/2.2.0/cordova/camera/parameter/cameraSuccess.md new file mode 100644 index 0000000..773fba4 --- /dev/null +++ b/docs/en/2.2.0/cordova/camera/parameter/cameraSuccess.md @@ -0,0 +1,42 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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/6ecf3e80/docs/en/2.2.0/cordova/compass/compass.clearWatch.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/compass/compass.clearWatch.md b/docs/en/2.2.0/cordova/compass/compass.clearWatch.md new file mode 100755 index 0000000..ccfbd0b --- /dev/null +++ b/docs/en/2.2.0/cordova/compass/compass.clearWatch.md @@ -0,0 +1,112 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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 +- Bada 1.2 & 2.x +- webOS +- Tizen + +Quick Example +------------- + + var watchID = navigator.compass.watchHeading(onSuccess, onError, options); + + // ... later on ... + + navigator.compass.clearWatch(watchID); + +Full Example +------------ + + + + + Compass Example + + + + + +
Waiting for heading...
+ + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/compass/compass.clearWatchFilter.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/compass/compass.clearWatchFilter.md b/docs/en/2.2.0/cordova/compass/compass.clearWatchFilter.md new file mode 100644 index 0000000..8c92c03 --- /dev/null +++ b/docs/en/2.2.0/cordova/compass/compass.clearWatchFilter.md @@ -0,0 +1,23 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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/6ecf3e80/docs/en/2.2.0/cordova/compass/compass.getCurrentHeading.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/compass/compass.getCurrentHeading.md b/docs/en/2.2.0/cordova/compass/compass.getCurrentHeading.md new file mode 100755 index 0000000..33d922a --- /dev/null +++ b/docs/en/2.2.0/cordova/compass/compass.getCurrentHeading.md @@ -0,0 +1,97 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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 +- Bada 1.2 & 2.x +- webOS +- Tizen + +Quick Example +------------- + + function onSuccess(heading) { + alert('Heading: ' + heading.magneticHeading); + }; + + function onError(error) { + alert('CompassError: ' + error.code); + }; + + navigator.compass.getCurrentHeading(onSuccess, onError); + +Full Example +------------ + + + + + Compass Example + + + + + +

Example

+

getCurrentHeading

+ + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/compass/compass.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/compass/compass.md b/docs/en/2.2.0/cordova/compass/compass.md new file mode 100755 index 0000000..b907698 --- /dev/null +++ b/docs/en/2.2.0/cordova/compass/compass.md @@ -0,0 +1,85 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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 + +Permissions +----------- + +### Android + +#### app/res/xml/config.xml + + + +### Bada + + No permissions are required. + +### BlackBerry WebWorks + + No permissions are required. + +### iOS + +#### App/Supporting Files/Cordova.plist + + Plugins + + Compass + CDVLocation + + +### webOS + + No permissions are required. + +### Windows Phone + +#### Properties/WPAppManifest.xml + + + + + +Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) + +### Tizen + + No permissions are required.