Updated Branches: refs/heads/master 72364fb99 -> f15009f93
Merge branch 'master' of https://git-wip-us.apache.org/repos/asf/incubator-cordova-docs 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/f15009f9 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/f15009f9 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/f15009f9 Branch: refs/heads/master Commit: f15009f934babee37ae4e9c27e0381483a6879c4 Parents: 0d835e1 72364fb Author: macdonst <simon.macdon...@gmail.com> Authored: Fri Apr 13 10:20:43 2012 -0400 Committer: macdonst <simon.macdon...@gmail.com> Committed: Fri Apr 13 10:20:43 2012 -0400 ---------------------------------------------------------------------- LICENSE | 283 ++++++++++++++- NOTICE | 5 + README.md | 23 +- VERSION | 2 +- bin/generate | 8 + bin/phonegap-docs | 8 - .../accelerometer/acceleration/acceleration.md | 3 +- .../1.5.0rc1/phonegap/camera/camera.getPicture.md | 1 + .../phonegap/camera/parameter/cameraOptions.md | 4 +- .../phonegap/connection/connection.type.md | 5 + docs/en/1.5.0rc1/phonegap/device/device.name.md | 3 +- .../en/1.5.0rc1/phonegap/device/device.platform.md | 3 +- docs/en/1.5.0rc1/phonegap/device/device.uuid.md | 4 +- docs/en/1.5.0rc1/phonegap/device/device.version.md | 3 + .../geolocation/Coordinates/coordinates.md | 1 + .../phonegap/geolocation/Position/position.md | 3 +- .../phonegap/notification/notification.alert.md | 3 +- .../1.5.0rc1/phonegap/storage/database/database.md | 1 + .../phonegap/storage/localstorage/localstorage.md | 1 + .../phonegap/storage/sqlresultset/sqlresultset.md | 1 + .../storage/sqlresultsetlist/sqlresultsetlist.md | 1 + .../storage/sqltransaction/sqltransaction.md | 1 + .../phonegap/storage/storage.opendatabase.md | 1 + docs/en/1.6.0/config.json | 170 ++++++++ .../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 | 112 ++++++ .../guide/getting-started/blackberry/index.md | 82 ++++ docs/en/1.6.0/guide/getting-started/index.md | 9 + docs/en/1.6.0/guide/getting-started/ios/index.md | 100 +++++ .../1.6.0/guide/getting-started/symbian/index.md | 59 +++ docs/en/1.6.0/guide/getting-started/webos/index.md | 59 +++ .../guide/getting-started/windows-phone/index.md | 77 ++++ docs/en/1.6.0/index.md | 68 ++++ docs/en/1.6.0rc1/config.json | 170 ++++++++ .../guide/getting-started/android/index.md | 108 ++++++ .../guide/getting-started/blackberry/index.md | 65 +++ docs/en/1.6.0rc1/guide/getting-started/index.md | 9 + .../en/1.6.0rc1/guide/getting-started/ios/index.md | 77 ++++ .../guide/getting-started/symbian/index.md | 59 +++ .../1.6.0rc1/guide/getting-started/webos/index.md | 59 +++ .../guide/getting-started/windows-phone/index.md | 77 ++++ docs/en/1.6.0rc1/index.md | 68 ++++ .../accelerometer/acceleration/acceleration.md | 85 ++++ .../accelerometer/accelerometer.clearWatch.md | 91 +++++ .../accelerometer.getCurrentAcceleration.md | 87 +++++ .../phonegap/accelerometer/accelerometer.md | 23 ++ .../accelerometer.watchAcceleration.md | 116 ++++++ .../accelerometer/parameters/accelerometerError.md | 8 + .../parameters/accelerometerOptions.md | 9 + .../parameters/accelerometerSuccess.md | 23 ++ .../1.6.0rc1/phonegap/camera/camera.getPicture.md | 171 ++++++++ docs/en/1.6.0rc1/phonegap/camera/camera.md | 9 + .../phonegap/camera/parameter/cameraError.md | 13 + .../phonegap/camera/parameter/cameraOptions.md | 90 +++++ .../phonegap/camera/parameter/cameraSuccess.md | 23 ++ .../phonegap/compass/compass.clearWatch.md | 90 +++++ .../phonegap/compass/compass.clearWatchFilter.md | 88 +++++ .../phonegap/compass/compass.getCurrentHeading.md | 75 ++++ docs/en/1.6.0rc1/phonegap/compass/compass.md | 21 + .../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.0rc1/phonegap/connection/connection.md | 23 ++ .../phonegap/connection/connection.type.md | 82 ++++ .../1.6.0rc1/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 +++++++ .../1.6.0rc1/phonegap/contacts/contacts.create.md | 57 +++ .../en/1.6.0rc1/phonegap/contacts/contacts.find.md | 96 +++++ docs/en/1.6.0rc1/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.0rc1/phonegap/device/device.cordova.md | 60 +++ docs/en/1.6.0rc1/phonegap/device/device.md | 23 ++ docs/en/1.6.0rc1/phonegap/device/device.name.md | 79 ++++ .../en/1.6.0rc1/phonegap/device/device.platform.md | 70 ++++ docs/en/1.6.0rc1/phonegap/device/device.uuid.md | 72 ++++ docs/en/1.6.0rc1/phonegap/device/device.version.md | 63 +++ .../1.6.0rc1/phonegap/events/events.backbutton.md | 67 ++++ .../phonegap/events/events.batterycritical.md | 74 ++++ .../1.6.0rc1/phonegap/events/events.batterylow.md | 74 ++++ .../phonegap/events/events.batterystatus.md | 74 ++++ .../1.6.0rc1/phonegap/events/events.deviceready.md | 92 +++++ .../phonegap/events/events.endcallbutton.md | 67 ++++ docs/en/1.6.0rc1/phonegap/events/events.md | 24 ++ .../1.6.0rc1/phonegap/events/events.menubutton.md | 68 ++++ docs/en/1.6.0rc1/phonegap/events/events.offline.md | 71 ++++ docs/en/1.6.0rc1/phonegap/events/events.online.md | 71 ++++ docs/en/1.6.0rc1/phonegap/events/events.pause.md | 71 ++++ docs/en/1.6.0rc1/phonegap/events/events.resume.md | 67 ++++ .../phonegap/events/events.searchbutton.md | 67 ++++ .../phonegap/events/events.startcallbutton.md | 67 ++++ .../phonegap/events/events.volumedownbutton.md | 67 ++++ .../phonegap/events/events.volumeupbutton.md | 67 ++++ .../phonegap/file/directoryentry/directoryentry.md | 300 +++++++++++++++ .../file/directoryreader/directoryreader.md | 47 +++ docs/en/1.6.0rc1/phonegap/file/file.md | 23 ++ .../1.6.0rc1/phonegap/file/fileentry/fileentry.md | 242 ++++++++++++ .../1.6.0rc1/phonegap/file/fileerror/fileerror.md | 30 ++ docs/en/1.6.0rc1/phonegap/file/fileobj/fileobj.md | 26 ++ .../phonegap/file/filereader/filereader.md | 177 +++++++++ .../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 + .../phonegap/file/filewriter/filewriter.md | 175 +++++++++ docs/en/1.6.0rc1/phonegap/file/flags/flags.md | 27 ++ .../file/localfilesystem/localfilesystem.md | 91 +++++ .../en/1.6.0rc1/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 +++++ .../1.6.0rc1/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 ++ .../phonegap/media/MediaError/mediaError.md | 25 ++ .../phonegap/media/Parameters/mediaError.md | 13 + .../1.6.0rc1/phonegap/media/capture/CaptureCB.md | 25 ++ .../phonegap/media/capture/CaptureError.md | 18 + .../phonegap/media/capture/CaptureErrorCB.md | 21 + .../phonegap/media/capture/ConfigurationData.md | 43 ++ .../media/capture/MediaFile.getFormatData.md | 34 ++ .../1.6.0rc1/phonegap/media/capture/MediaFile.md | 18 + .../phonegap/media/capture/MediaFileData.md | 43 ++ docs/en/1.6.0rc1/phonegap/media/capture/capture.md | 56 +++ .../phonegap/media/capture/captureAudio.md | 116 ++++++ .../phonegap/media/capture/captureAudioOptions.md | 37 ++ .../phonegap/media/capture/captureImage.md | 108 ++++++ .../phonegap/media/capture/captureImageOptions.md | 34 ++ .../phonegap/media/capture/captureVideo.md | 111 ++++++ .../phonegap/media/capture/captureVideoOptions.md | 40 ++ .../phonegap/media/media.getCurrentPosition.md | 153 ++++++++ .../1.6.0rc1/phonegap/media/media.getDuration.md | 145 +++++++ docs/en/1.6.0rc1/phonegap/media/media.md | 44 +++ docs/en/1.6.0rc1/phonegap/media/media.pause.md | 150 +++++++ docs/en/1.6.0rc1/phonegap/media/media.play.md | 146 +++++++ docs/en/1.6.0rc1/phonegap/media/media.release.md | 134 +++++++ docs/en/1.6.0rc1/phonegap/media/media.seekTo.md | 132 +++++++ .../1.6.0rc1/phonegap/media/media.startRecord.md | 117 ++++++ docs/en/1.6.0rc1/phonegap/media/media.stop.md | 149 +++++++ .../en/1.6.0rc1/phonegap/media/media.stopRecord.md | 119 ++++++ .../phonegap/notification/notification.alert.md | 94 +++++ .../phonegap/notification/notification.beep.md | 94 +++++ .../phonegap/notification/notification.confirm.md | 92 +++++ .../1.6.0rc1/phonegap/notification/notification.md | 12 + .../phonegap/notification/notification.vibrate.md | 84 ++++ .../1.6.0rc1/phonegap/storage/database/database.md | 104 +++++ .../phonegap/storage/localstorage/localstorage.md | 91 +++++ .../phonegap/storage/parameters/display_name.md | 4 + .../1.6.0rc1/phonegap/storage/parameters/name.md | 4 + .../1.6.0rc1/phonegap/storage/parameters/size.md | 4 + .../phonegap/storage/parameters/version.md | 4 + .../1.6.0rc1/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.0rc1/phonegap/storage/storage.md | 29 ++ .../phonegap/storage/storage.opendatabase.md | 54 +++ docs/en/edge/config.json | 274 +++++++------- .../accelerometer/acceleration/acceleration.md | 85 ++++ .../accelerometer/accelerometer.clearWatch.md | 92 +++++ .../accelerometer.getCurrentAcceleration.md | 88 +++++ .../en/edge/cordova/accelerometer/accelerometer.md | 23 ++ .../accelerometer.watchAcceleration.md | 117 ++++++ .../accelerometer/parameters/accelerometerError.md | 8 + .../parameters/accelerometerOptions.md | 9 + .../parameters/accelerometerSuccess.md | 23 ++ docs/en/edge/cordova/camera/camera.getPicture.md | 183 +++++++++ docs/en/edge/cordova/camera/camera.md | 9 + .../edge/cordova/camera/parameter/cameraError.md | 13 + .../edge/cordova/camera/parameter/cameraOptions.md | 101 +++++ .../edge/cordova/camera/parameter/cameraSuccess.md | 23 ++ docs/en/edge/cordova/compass/compass.clearWatch.md | 90 +++++ .../cordova/compass/compass.clearWatchFilter.md | 4 + .../cordova/compass/compass.getCurrentHeading.md | 75 ++++ docs/en/edge/cordova/compass/compass.md | 21 + .../edge/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/edge/cordova/connection/connection.md | 29 ++ docs/en/edge/cordova/connection/connection.type.md | 82 ++++ docs/en/edge/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/edge/cordova/contacts/contacts.create.md | 57 +++ docs/en/edge/cordova/contacts/contacts.find.md | 96 +++++ docs/en/edge/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/edge/cordova/device/device.cordova.md | 59 +++ docs/en/edge/cordova/device/device.md | 23 ++ docs/en/edge/cordova/device/device.name.md | 83 ++++ docs/en/edge/cordova/device/device.platform.md | 74 ++++ docs/en/edge/cordova/device/device.uuid.md | 81 ++++ docs/en/edge/cordova/device/device.version.md | 62 +++ docs/en/edge/cordova/events/events.backbutton.md | 68 ++++ .../edge/cordova/events/events.batterycritical.md | 74 ++++ docs/en/edge/cordova/events/events.batterylow.md | 74 ++++ .../en/edge/cordova/events/events.batterystatus.md | 83 ++++ docs/en/edge/cordova/events/events.deviceready.md | 67 ++++ .../en/edge/cordova/events/events.endcallbutton.md | 67 ++++ docs/en/edge/cordova/events/events.md | 24 ++ docs/en/edge/cordova/events/events.menubutton.md | 68 ++++ docs/en/edge/cordova/events/events.offline.md | 76 ++++ docs/en/edge/cordova/events/events.online.md | 76 ++++ docs/en/edge/cordova/events/events.pause.md | 72 ++++ docs/en/edge/cordova/events/events.resume.md | 68 ++++ docs/en/edge/cordova/events/events.searchbutton.md | 67 ++++ .../edge/cordova/events/events.startcallbutton.md | 67 ++++ .../edge/cordova/events/events.volumedownbutton.md | 67 ++++ .../edge/cordova/events/events.volumeupbutton.md | 67 ++++ .../cordova/file/directoryentry/directoryentry.md | 300 +++++++++++++++ .../file/directoryreader/directoryreader.md | 47 +++ docs/en/edge/cordova/file/file.md | 23 ++ docs/en/edge/cordova/file/fileentry/fileentry.md | 242 ++++++++++++ docs/en/edge/cordova/file/fileerror/fileerror.md | 30 ++ docs/en/edge/cordova/file/fileobj/fileobj.md | 26 ++ docs/en/edge/cordova/file/filereader/filereader.md | 177 +++++++++ docs/en/edge/cordova/file/filesystem/filesystem.md | 72 ++++ .../edge/cordova/file/filetransfer/filetransfer.md | 163 ++++++++ .../file/filetransfererror/filetransfererror.md | 23 ++ .../file/fileuploadoptions/fileuploadoptions.md | 31 ++ .../file/fileuploadresult/fileuploadresult.md | 21 + docs/en/edge/cordova/file/filewriter/filewriter.md | 175 +++++++++ docs/en/edge/cordova/file/flags/flags.md | 27 ++ .../file/localfilesystem/localfilesystem.md | 91 +++++ docs/en/edge/cordova/file/metadata/metadata.md | 32 ++ .../cordova/geolocation/Coordinates/coordinates.md | 104 +++++ .../edge/cordova/geolocation/Position/position.md | 110 ++++++ .../geolocation/PositionError/positionError.md | 23 ++ .../cordova/geolocation/geolocation.clearWatch.md | 94 +++++ .../geolocation/geolocation.getCurrentPosition.md | 105 +++++ docs/en/edge/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 ++ .../en/edge/cordova/media/MediaError/mediaError.md | 25 ++ .../en/edge/cordova/media/Parameters/mediaError.md | 13 + docs/en/edge/cordova/media/capture/CaptureCB.md | 25 ++ docs/en/edge/cordova/media/capture/CaptureError.md | 18 + .../edge/cordova/media/capture/CaptureErrorCB.md | 21 + .../cordova/media/capture/ConfigurationData.md | 43 ++ .../media/capture/MediaFile.getFormatData.md | 34 ++ docs/en/edge/cordova/media/capture/MediaFile.md | 18 + .../en/edge/cordova/media/capture/MediaFileData.md | 43 ++ docs/en/edge/cordova/media/capture/capture.md | 56 +++ docs/en/edge/cordova/media/capture/captureAudio.md | 121 ++++++ .../cordova/media/capture/captureAudioOptions.md | 37 ++ docs/en/edge/cordova/media/capture/captureImage.md | 114 ++++++ .../cordova/media/capture/captureImageOptions.md | 34 ++ docs/en/edge/cordova/media/capture/captureVideo.md | 111 ++++++ .../cordova/media/capture/captureVideoOptions.md | 40 ++ .../edge/cordova/media/media.getCurrentPosition.md | 153 ++++++++ docs/en/edge/cordova/media/media.getDuration.md | 145 +++++++ docs/en/edge/cordova/media/media.md | 44 +++ docs/en/edge/cordova/media/media.pause.md | 150 +++++++ docs/en/edge/cordova/media/media.play.md | 156 ++++++++ docs/en/edge/cordova/media/media.release.md | 134 +++++++ docs/en/edge/cordova/media/media.seekTo.md | 132 +++++++ docs/en/edge/cordova/media/media.startRecord.md | 117 ++++++ docs/en/edge/cordova/media/media.stop.md | 149 +++++++ docs/en/edge/cordova/media/media.stopRecord.md | 119 ++++++ .../cordova/notification/notification.alert.md | 91 +++++ .../edge/cordova/notification/notification.beep.md | 93 +++++ .../cordova/notification/notification.confirm.md | 94 +++++ docs/en/edge/cordova/notification/notification.md | 12 + .../cordova/notification/notification.vibrate.md | 83 ++++ docs/en/edge/cordova/storage/database/database.md | 104 +++++ .../cordova/storage/localstorage/localstorage.md | 100 +++++ .../cordova/storage/parameters/display_name.md | 4 + docs/en/edge/cordova/storage/parameters/name.md | 4 + docs/en/edge/cordova/storage/parameters/size.md | 4 + docs/en/edge/cordova/storage/parameters/version.md | 4 + docs/en/edge/cordova/storage/sqlerror/sqlerror.md | 28 ++ .../cordova/storage/sqlresultset/sqlresultset.md | 115 ++++++ .../storage/sqlresultsetlist/sqlresultsetlist.md | 116 ++++++ .../storage/sqltransaction/sqltransaction.md | 93 +++++ docs/en/edge/cordova/storage/storage.md | 29 ++ .../edge/cordova/storage/storage.opendatabase.md | 54 +++ .../en/edge/guide/getting-started/android/index.md | 79 ++-- .../edge/guide/getting-started/blackberry/index.md | 99 +++-- docs/en/edge/guide/getting-started/ios/index.md | 75 +++-- .../en/edge/guide/getting-started/symbian/index.md | 9 +- docs/en/edge/guide/getting-started/webos/index.md | 9 +- .../guide/getting-started/windows-phone/index.md | 13 +- docs/en/edge/index.md | 4 +- .../accelerometer/acceleration/acceleration.md | 85 ---- .../accelerometer/accelerometer.clearWatch.md | 91 ----- .../accelerometer.getCurrentAcceleration.md | 87 ----- .../edge/phonegap/accelerometer/accelerometer.md | 23 -- .../accelerometer.watchAcceleration.md | 116 ------ .../accelerometer/parameters/accelerometerError.md | 8 - .../parameters/accelerometerOptions.md | 9 - .../parameters/accelerometerSuccess.md | 23 -- docs/en/edge/phonegap/camera/camera.getPicture.md | 171 -------- docs/en/edge/phonegap/camera/camera.md | 9 - .../edge/phonegap/camera/parameter/cameraError.md | 13 - .../phonegap/camera/parameter/cameraOptions.md | 90 ----- .../phonegap/camera/parameter/cameraSuccess.md | 23 -- .../en/edge/phonegap/compass/compass.clearWatch.md | 90 ----- .../phonegap/compass/compass.clearWatchFilter.md | 88 ----- .../phonegap/compass/compass.getCurrentHeading.md | 75 ---- docs/en/edge/phonegap/compass/compass.md | 21 - .../edge/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/edge/phonegap/connection/connection.md | 23 -- .../en/edge/phonegap/connection/connection.type.md | 82 ---- docs/en/edge/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/edge/phonegap/contacts/contacts.create.md | 57 --- docs/en/edge/phonegap/contacts/contacts.find.md | 96 ----- docs/en/edge/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/edge/phonegap/device/device.md | 23 -- docs/en/edge/phonegap/device/device.name.md | 79 ---- docs/en/edge/phonegap/device/device.phonegap.md | 60 --- docs/en/edge/phonegap/device/device.platform.md | 70 ---- docs/en/edge/phonegap/device/device.uuid.md | 72 ---- docs/en/edge/phonegap/device/device.version.md | 63 --- docs/en/edge/phonegap/events/events.backbutton.md | 67 ---- .../edge/phonegap/events/events.batterycritical.md | 74 ---- docs/en/edge/phonegap/events/events.batterylow.md | 74 ---- .../edge/phonegap/events/events.batterystatus.md | 74 ---- docs/en/edge/phonegap/events/events.deviceready.md | 92 ----- .../edge/phonegap/events/events.endcallbutton.md | 67 ---- docs/en/edge/phonegap/events/events.md | 24 -- docs/en/edge/phonegap/events/events.menubutton.md | 68 ---- docs/en/edge/phonegap/events/events.offline.md | 71 ---- docs/en/edge/phonegap/events/events.online.md | 71 ---- docs/en/edge/phonegap/events/events.pause.md | 71 ---- docs/en/edge/phonegap/events/events.resume.md | 67 ---- .../en/edge/phonegap/events/events.searchbutton.md | 67 ---- .../edge/phonegap/events/events.startcallbutton.md | 67 ---- .../phonegap/events/events.volumedownbutton.md | 67 ---- .../edge/phonegap/events/events.volumeupbutton.md | 67 ---- .../phonegap/file/directoryentry/directoryentry.md | 300 --------------- .../file/directoryreader/directoryreader.md | 47 --- docs/en/edge/phonegap/file/file.md | 23 -- docs/en/edge/phonegap/file/fileentry/fileentry.md | 242 ------------ docs/en/edge/phonegap/file/fileerror/fileerror.md | 30 -- docs/en/edge/phonegap/file/fileobj/fileobj.md | 26 -- .../en/edge/phonegap/file/filereader/filereader.md | 177 --------- .../en/edge/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 - .../en/edge/phonegap/file/filewriter/filewriter.md | 175 --------- docs/en/edge/phonegap/file/flags/flags.md | 27 -- .../file/localfilesystem/localfilesystem.md | 91 ----- docs/en/edge/phonegap/file/metadata/metadata.md | 32 -- .../geolocation/Coordinates/coordinates.md | 105 ----- .../edge/phonegap/geolocation/Position/position.md | 111 ------ .../geolocation/PositionError/positionError.md | 23 -- .../phonegap/geolocation/geolocation.clearWatch.md | 95 ----- .../geolocation/geolocation.getCurrentPosition.md | 106 ----- docs/en/edge/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 -- .../edge/phonegap/media/MediaError/mediaError.md | 25 -- .../edge/phonegap/media/Parameters/mediaError.md | 13 - docs/en/edge/phonegap/media/capture/CaptureCB.md | 25 -- .../en/edge/phonegap/media/capture/CaptureError.md | 18 - .../edge/phonegap/media/capture/CaptureErrorCB.md | 21 - .../phonegap/media/capture/ConfigurationData.md | 43 -- .../media/capture/MediaFile.getFormatData.md | 34 -- docs/en/edge/phonegap/media/capture/MediaFile.md | 18 - .../edge/phonegap/media/capture/MediaFileData.md | 43 -- docs/en/edge/phonegap/media/capture/capture.md | 56 --- .../en/edge/phonegap/media/capture/captureAudio.md | 116 ------ .../phonegap/media/capture/captureAudioOptions.md | 37 -- .../en/edge/phonegap/media/capture/captureImage.md | 108 ------ .../phonegap/media/capture/captureImageOptions.md | 34 -- .../en/edge/phonegap/media/capture/captureVideo.md | 111 ------ .../phonegap/media/capture/captureVideoOptions.md | 40 -- .../phonegap/media/media.getCurrentPosition.md | 153 -------- docs/en/edge/phonegap/media/media.getDuration.md | 145 ------- docs/en/edge/phonegap/media/media.md | 44 --- docs/en/edge/phonegap/media/media.pause.md | 150 ------- docs/en/edge/phonegap/media/media.play.md | 146 ------- docs/en/edge/phonegap/media/media.release.md | 134 ------- docs/en/edge/phonegap/media/media.seekTo.md | 132 ------- docs/en/edge/phonegap/media/media.startRecord.md | 117 ------ docs/en/edge/phonegap/media/media.stop.md | 149 ------- docs/en/edge/phonegap/media/media.stopRecord.md | 119 ------ .../phonegap/notification/notification.alert.md | 94 ----- .../phonegap/notification/notification.beep.md | 94 ----- .../phonegap/notification/notification.confirm.md | 92 ----- docs/en/edge/phonegap/notification/notification.md | 12 - .../phonegap/notification/notification.vibrate.md | 84 ---- docs/en/edge/phonegap/storage/database/database.md | 104 ----- .../phonegap/storage/localstorage/localstorage.md | 91 ----- .../phonegap/storage/parameters/display_name.md | 4 - docs/en/edge/phonegap/storage/parameters/name.md | 4 - docs/en/edge/phonegap/storage/parameters/size.md | 4 - .../en/edge/phonegap/storage/parameters/version.md | 4 - docs/en/edge/phonegap/storage/sqlerror/sqlerror.md | 28 -- .../phonegap/storage/sqlresultset/sqlresultset.md | 115 ------ .../storage/sqlresultsetlist/sqlresultsetlist.md | 116 ------ .../storage/sqltransaction/sqltransaction.md | 93 ----- docs/en/edge/phonegap/storage/storage.md | 29 -- .../edge/phonegap/storage/storage.opendatabase.md | 54 --- lib/cordova/add_title.rb | 19 + lib/cordova/file_merger.rb | 62 +++ lib/cordova/jodoc.rb | 51 +++ lib/cordova/navigation_menu.rb | 61 +++ lib/cordova/prettify.rb | 16 + lib/cordova/table_of_contents.rb | 59 +++ lib/cordova/update_index.rb | 29 ++ lib/cordova/update_keyword_index.rb | 34 ++ lib/cordova/version_menu.rb | 65 +++ lib/cordova/yaml_front_matter.rb | 26 ++ lib/docs_generator.rb | 96 +++++ lib/phonegap/add_title.rb | 19 - lib/phonegap/file_merger.rb | 47 --- lib/phonegap/jodoc.rb | 51 --- lib/phonegap/navigation_menu.rb | 61 --- lib/phonegap/prettify.rb | 16 - lib/phonegap/quirks_merger.rb | 47 --- lib/phonegap/table_of_contents.rb | 59 --- lib/phonegap/update_index.rb | 29 -- lib/phonegap/update_keyword_index.rb | 34 -- lib/phonegap/version_menu.rb | 65 --- lib/phonegap/yaml_front_matter.rb | 26 -- lib/phonegap_docs.rb | 97 ----- spec/docs_generator_spec.rb | 32 ++ spec/phonegap/add_title_spec.rb | 2 +- spec/phonegap/jodoc_spec.rb | 2 +- spec/phonegap/prettify_spec.rb | 2 +- spec/phonegap/table_of_contents_spec.rb | 2 +- spec/phonegap_docs_spec.rb | 32 -- spec/spec_helpers.rb | 2 +- .../guide/getting-started/android/buildPath.jpg | Bin 0 -> 80516 bytes .../img/guide/getting-started/android/javaSrc.jpg | Bin 420745 -> 141340 bytes .../img/guide/getting-started/android/manifest.jpg | Bin 247181 -> 268212 bytes .../getting-started/ios/HelloWorldiPhone4.png | Bin 101624 -> 120055 bytes .../guide/getting-started/ios/XCode4-templates.png | Bin 207971 -> 169771 bytes .../ios/create-folder-reference.png | Bin 0 -> 172173 bytes .../guide/getting-started/ios/index-not-found.png | Bin 0 -> 95265 bytes .../img/guide/getting-started/ios/project.jpg | Bin 39552 -> 43884 bytes .../img/guide/getting-started/ios/www-folder.png | Bin 0 -> 17844 bytes .../getting-started/ios/xcode4-name_your_app.png | Bin 186383 -> 163603 bytes template/docs/default/index.html | 4 +- template/docs/es/index.html | 4 +- template/docs/fr/index.html | 4 +- template/docs/jp/index.html | 4 +- 617 files changed, 29804 insertions(+), 10011 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/f15009f9/docs/en/1.6.0/cordova/file/filetransfer/filetransfer.md ---------------------------------------------------------------------- diff --cc docs/en/1.6.0/cordova/file/filetransfer/filetransfer.md index 0000000,9035cca..cbcd272 mode 000000,100644..100644 --- a/docs/en/1.6.0/cordova/file/filetransfer/filetransfer.md +++ b/docs/en/1.6.0/cordova/file/filetransfer/filetransfer.md @@@ -1,0 -1,163 +1,163 @@@ + FileTransfer + ========== + + FileTransfer is an object that allows you to upload files to a server or download files from a server. + + Properties + ---------- + + N/A + + Methods + ------- + + - __upload__: sends a file to a server. + - __download__: downloads a file from server. + + Details + ------- + + The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object. + It is also possible to download a file from remote and save it on the device (only iOS and Android). + + Supported Platforms + ------------------- + + - Android + - BlackBerry WebWorks (OS 5.0 and higher) + - iOS + - Windows Phone 7 ( Mango ) + + upload + -------------- + + __Parameters:__ + + - __filePath__ - Full path of the file on the device + - __server__ - URL of the server to receive the file -- __successCallback__ - A callback that is called with a Metadata object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_ ++- __successCallback__ - A callback that is called with a FileUploadResult object. _(Function)_ ++- __errorCallback__ - A callback that is called if an error occurs uploading the file. Invoked with a FileTransferError object. _(Function)_ + - __options__ - Optional parameters such as file name and mimetype + + __Quick Example__ + + // !! Assumes variable fileURI contains a valid URI to a text file on the device + + var win = function(r) { + console.log("Code = " + r.responseCode); + console.log("Response = " + r.response); + console.log("Sent = " + r.bytesSent); + } + + var fail = function(error) { + alert("An error has occurred: Code = " + error.code); + console.log("upload error source " + error.source); + console.log("upload error target " + error.target); + } + + var options = new FileUploadOptions(); + options.fileKey="file"; + options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1); + options.mimeType="text/plain"; + + var params = new Object(); + params.value1 = "test"; + params.value2 = "param"; + + options.params = params; + + var ft = new FileTransfer(); + ft.upload(fileURI, "http://some.server.com/upload.php";, win, fail, options); + + __Full Example__ + + <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd";> + <html> + <head> + <title>File Transfer 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() { + + // Retrieve image file location from specified source + navigator.camera.getPicture(uploadPhoto, + function(message) { alert('get picture failed'); }, + { quality: 50, + destinationType: navigator.camera.DestinationType.FILE_URI, + sourceType: navigator.camera.PictureSourceType.PHOTOLIBRARY } + ); + + } + + function uploadPhoto(imageURI) { + var options = new FileUploadOptions(); + options.fileKey="file"; + options.fileName=imageURI.substr(imageURI.lastIndexOf('/')+1); + options.mimeType="image/jpeg"; + + var params = new Object(); + params.value1 = "test"; + params.value2 = "param"; + + options.params = params; + + var ft = new FileTransfer(); + ft.upload(imageURI, "http://some.server.com/upload.php";, win, fail, options); + } + + function win(r) { + console.log("Code = " + r.responseCode); + console.log("Response = " + r.response); + console.log("Sent = " + r.bytesSent); + } + + function fail(error) { + alert("An error has occurred: Code = " + error.code); + console.log("upload error source " + error.source); + console.log("upload error target " + error.target); + } + + </script> + </head> + <body> + <h1>Example</h1> + <p>Upload File</p> + </body> + </html> + + download + -------------- + + __Parameters:__ + + - __source__ - URL of the server to receive the file + - __target__ - Full path of the file on the device + - __successCallback__ - A callback that is called with a FileEntry object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_ ++- __errorCallback__ - A callback that is called if an error occurs retrieving the FileEntry. Invoked with a FileTransferError object. _(Function)_ + + __Quick Example__ + + // !! Assumes variable url contains a valid URI to a file on a server and filePath is a valid path on the device + + var fileTransfer = new FileTransfer(); + + fileTransfer.download( + url, + filePath, + function(entry) { + console.log("download complete: " + entry.fullPath); + }, + function(error) { + console.log("download error source " + error.source); + console.log("download error target " + error.target); + console.log("upload error code" + error.code); + } + );
