Return-Path: X-Original-To: apmail-incubator-callback-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-callback-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 0EE7699AF for ; Mon, 30 Jan 2012 22:42:12 +0000 (UTC) Received: (qmail 87032 invoked by uid 500); 30 Jan 2012 22:42:12 -0000 Delivered-To: apmail-incubator-callback-commits-archive@incubator.apache.org Received: (qmail 87007 invoked by uid 500); 30 Jan 2012 22:42:11 -0000 Mailing-List: contact callback-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@incubator.apache.org Delivered-To: mailing list callback-commits@incubator.apache.org Received: (qmail 86999 invoked by uid 99); 30 Jan 2012 22:42:11 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 30 Jan 2012 22:42:11 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED,T_FILL_THIS_FORM_SHORT X-Spam-Check-By: apache.org Received: from [140.211.11.114] (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 30 Jan 2012 22:42:07 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id E421B31A8C0; Mon, 30 Jan 2012 22:41:23 +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: [6/10] git commit: Version 1.4.0rc1 Message-Id: <20120130224123.E421B31A8C0@tyr.zones.apache.org> Date: Mon, 30 Jan 2012 22:41:23 +0000 (UTC) Version 1.4.0rc1 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/42ac3f67 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/42ac3f67 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/42ac3f67 Branch: refs/heads/master Commit: 42ac3f67264a2b7bb089734eef2bbd32aa0b7f0e Parents: 9362302 Author: Michael Brooks Authored: Mon Jan 30 14:32:56 2012 -0800 Committer: Michael Brooks Committed: Mon Jan 30 14:32:56 2012 -0800 ---------------------------------------------------------------------- docs/en/1.4.0rc1/config.json | 170 ++++++++ .../guide/getting-started/android/index.md | 111 ++++++ .../guide/getting-started/blackberry/index.md | 63 +++ docs/en/1.4.0rc1/guide/getting-started/index.md | 9 + .../en/1.4.0rc1/guide/getting-started/ios/index.md | 75 ++++ .../guide/getting-started/symbian/index.md | 58 +++ .../1.4.0rc1/guide/getting-started/webos/index.md | 58 +++ .../guide/getting-started/windows-phone/index.md | 76 ++++ docs/en/1.4.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.4.0rc1/phonegap/camera/camera.getPicture.md | 171 ++++++++ docs/en/1.4.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.4.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.4.0rc1/phonegap/connection/connection.md | 23 ++ .../phonegap/connection/connection.type.md | 82 ++++ .../1.4.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.4.0rc1/phonegap/contacts/contacts.create.md | 57 +++ .../en/1.4.0rc1/phonegap/contacts/contacts.find.md | 96 +++++ docs/en/1.4.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.4.0rc1/phonegap/device/device.md | 23 ++ docs/en/1.4.0rc1/phonegap/device/device.name.md | 79 ++++ .../en/1.4.0rc1/phonegap/device/device.phonegap.md | 60 +++ .../en/1.4.0rc1/phonegap/device/device.platform.md | 70 ++++ docs/en/1.4.0rc1/phonegap/device/device.uuid.md | 72 ++++ docs/en/1.4.0rc1/phonegap/device/device.version.md | 63 +++ .../1.4.0rc1/phonegap/events/events.backbutton.md | 67 ++++ .../phonegap/events/events.batterycritical.md | 74 ++++ .../1.4.0rc1/phonegap/events/events.batterylow.md | 74 ++++ .../phonegap/events/events.batterystatus.md | 74 ++++ .../1.4.0rc1/phonegap/events/events.deviceready.md | 92 +++++ .../phonegap/events/events.endcallbutton.md | 67 ++++ docs/en/1.4.0rc1/phonegap/events/events.md | 24 ++ .../1.4.0rc1/phonegap/events/events.menubutton.md | 68 ++++ docs/en/1.4.0rc1/phonegap/events/events.offline.md | 71 ++++ docs/en/1.4.0rc1/phonegap/events/events.online.md | 71 ++++ docs/en/1.4.0rc1/phonegap/events/events.pause.md | 71 ++++ docs/en/1.4.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.4.0rc1/phonegap/file/file.md | 23 ++ .../1.4.0rc1/phonegap/file/fileentry/fileentry.md | 242 ++++++++++++ .../1.4.0rc1/phonegap/file/fileerror/fileerror.md | 30 ++ docs/en/1.4.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.4.0rc1/phonegap/file/flags/flags.md | 27 ++ .../file/localfilesystem/localfilesystem.md | 91 +++++ .../en/1.4.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.4.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.4.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.4.0rc1/phonegap/media/capture/MediaFile.md | 18 + .../phonegap/media/capture/MediaFileData.md | 43 ++ docs/en/1.4.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.4.0rc1/phonegap/media/media.getDuration.md | 145 +++++++ docs/en/1.4.0rc1/phonegap/media/media.md | 44 +++ docs/en/1.4.0rc1/phonegap/media/media.pause.md | 150 +++++++ docs/en/1.4.0rc1/phonegap/media/media.play.md | 146 +++++++ docs/en/1.4.0rc1/phonegap/media/media.release.md | 134 +++++++ docs/en/1.4.0rc1/phonegap/media/media.seekTo.md | 132 +++++++ .../1.4.0rc1/phonegap/media/media.startRecord.md | 117 ++++++ docs/en/1.4.0rc1/phonegap/media/media.stop.md | 149 +++++++ .../en/1.4.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.4.0rc1/phonegap/notification/notification.md | 12 + .../phonegap/notification/notification.vibrate.md | 84 ++++ .../1.4.0rc1/phonegap/storage/database/database.md | 104 +++++ .../phonegap/storage/localstorage/localstorage.md | 91 +++++ .../phonegap/storage/parameters/display_name.md | 4 + .../1.4.0rc1/phonegap/storage/parameters/name.md | 4 + .../1.4.0rc1/phonegap/storage/parameters/size.md | 4 + .../phonegap/storage/parameters/version.md | 4 + .../1.4.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.4.0rc1/phonegap/storage/storage.md | 29 ++ .../phonegap/storage/storage.opendatabase.md | 54 +++ 140 files changed, 9814 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/config.json ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/config.json b/docs/en/1.4.0rc1/config.json new file mode 100644 index 0000000..5752429 --- /dev/null +++ b/docs/en/1.4.0rc1/config.json @@ -0,0 +1,170 @@ +{ + "language": "English", + "merge": { + "accelerometer.md": [ + "phonegap/accelerometer/accelerometer.md", + "phonegap/accelerometer/accelerometer.getCurrentAcceleration.md", + "phonegap/accelerometer/accelerometer.watchAcceleration.md", + "phonegap/accelerometer/accelerometer.clearWatch.md", + "phonegap/accelerometer/acceleration/acceleration.md", + "phonegap/accelerometer/parameters/accelerometerSuccess.md", + "phonegap/accelerometer/parameters/accelerometerError.md", + "phonegap/accelerometer/parameters/accelerometerOptions.md" + ], + "camera.md": [ + "phonegap/camera/camera.md", + "phonegap/camera/camera.getPicture.md", + "phonegap/camera/parameter/cameraSuccess.md", + "phonegap/camera/parameter/cameraError.md", + "phonegap/camera/parameter/cameraOptions.md" + ], + "capture.md": [ + "phonegap/media/capture/capture.md", + "phonegap/media/capture/captureAudio.md", + "phonegap/media/capture/captureAudioOptions.md", + "phonegap/media/capture/captureImage.md", + "phonegap/media/capture/captureImageOptions.md", + "phonegap/media/capture/captureVideo.md", + "phonegap/media/capture/captureVideoOptions.md", + "phonegap/media/capture/CaptureError.md", + "phonegap/media/capture/CaptureCB.md", + "phonegap/media/capture/CaptureErrorCB.md", + "phonegap/media/capture/ConfigurationData.md", + "phonegap/media/capture/MediaFile.md", + "phonegap/media/capture/MediaFile.getFormatData.md", + "phonegap/media/capture/MediaFileData.md" + ], + "compass.md": [ + "phonegap/compass/compass.md", + "phonegap/compass/compass.getCurrentHeading.md", + "phonegap/compass/compass.watchHeading.md", + "phonegap/compass/compass.clearWatch.md", + "phonegap/compass/compass.watchHeadingFilter.md", + "phonegap/compass/compass.clearWatchFilter.md", + "phonegap/compass/parameters/compassSuccess.md", + "phonegap/compass/parameters/compassError.md", + "phonegap/compass/parameters/compassOptions.md", + "phonegap/compass/parameters/compassHeading.md", + "phonegap/compass/compassError/compassError.md" + ], + "contacts.md": [ + "phonegap/contacts/contacts.md", + "phonegap/contacts/contacts.create.md", + "phonegap/contacts/contacts.find.md", + "phonegap/contacts/Contact/contact.md", + "phonegap/contacts/ContactAddress/contactaddress.md", + "phonegap/contacts/ContactField/contactfield.md", + "phonegap/contacts/ContactFindOptions/contactfindoptions.md", + "phonegap/contacts/ContactName/contactname.md", + "phonegap/contacts/ContactOrganization/contactorganization.md", + "phonegap/contacts/ContactError/contactError.md", + "phonegap/contacts/parameters/contactSuccess.md", + "phonegap/contacts/parameters/contactError.md", + "phonegap/contacts/parameters/contactFields.md", + "phonegap/contacts/parameters/contactFindOptions.md" + ], + "device.md": [ + "phonegap/device/device.md", + "phonegap/device/device.name.md", + "phonegap/device/device.phonegap.md", + "phonegap/device/device.platform.md", + "phonegap/device/device.uuid.md", + "phonegap/device/device.version.md" + ], + "events.md": [ + "phonegap/events/events.md", + "phonegap/events/events.deviceready.md", + "phonegap/events/events.pause.md", + "phonegap/events/events.resume.md", + "phonegap/events/events.online.md", + "phonegap/events/events.offline.md", + "phonegap/events/events.backbutton.md", + "phonegap/events/events.batterycritical.md", + "phonegap/events/events.batterylow.md", + "phonegap/events/events.batterystatus.md", + "phonegap/events/events.menubutton.md", + "phonegap/events/events.searchbutton.md", + "phonegap/events/events.startcallbutton.md", + "phonegap/events/events.endcallbutton.md", + "phonegap/events/events.volumedownbutton.md", + "phonegap/events/events.volumeupbutton.md" + ], + "file.md": [ + "phonegap/file/file.md", + "phonegap/file/fileobj/fileobj.md", + "phonegap/file/filereader/filereader.md", + "phonegap/file/filewriter/filewriter.md", + "phonegap/file/filesystem/filesystem.md", + "phonegap/file/fileentry/fileentry.md", + "phonegap/file/directoryentry/directoryentry.md", + "phonegap/file/directoryreader/directoryreader.md", + "phonegap/file/filetransfer/filetransfer.md", + "phonegap/file/fileuploadoptions/fileuploadoptions.md", + "phonegap/file/fileuploadresult/fileuploadresult.md", + "phonegap/file/flags/flags.md", + "phonegap/file/localfilesystem/localfilesystem.md", + "phonegap/file/metadata/metadata.md", + "phonegap/file/fileerror/fileerror.md", + "phonegap/file/filetransfererror/filetransfererror.md" + ], + "geolocation.md": [ + "phonegap/geolocation/geolocation.md", + "phonegap/geolocation/geolocation.getCurrentPosition.md", + "phonegap/geolocation/geolocation.watchPosition.md", + "phonegap/geolocation/geolocation.clearWatch.md", + "phonegap/geolocation/Coordinates/coordinates.md", + "phonegap/geolocation/Position/position.md", + "phonegap/geolocation/PositionError/positionError.md", + "phonegap/geolocation/parameters/geolocationSuccess.md", + "phonegap/geolocation/parameters/geolocationError.md", + "phonegap/geolocation/parameters/geolocation.options.md" + ], + "media.md": [ + "phonegap/media/media.md", + "phonegap/media/media.getCurrentPosition.md", + "phonegap/media/media.getDuration.md", + "phonegap/media/media.pause.md", + "phonegap/media/media.play.md", + "phonegap/media/media.release.md", + "phonegap/media/media.seekTo.md", + "phonegap/media/media.startRecord.md", + "phonegap/media/media.stop.md", + "phonegap/media/media.stopRecord.md", + "phonegap/media/MediaError/mediaError.md", + "phonegap/media/Parameters/mediaError.md" + ], + "network.md": [ + "phonegap/network/network.md", + "phonegap/network/network.isReachable.md", + "phonegap/network/NetworkStatus/NetworkStatus.md", + "phonegap/network/parameters/reachableCallback.md", + "phonegap/network/parameters/reachableHostname.md", + "phonegap/network/parameters/reachableOptions.md" + ], + "connection.md": [ + "phonegap/connection/connection.md", + "phonegap/connection/connection.type.md" + ], + "notification.md": [ + "phonegap/notification/notification.md", + "phonegap/notification/notification.alert.md", + "phonegap/notification/notification.confirm.md", + "phonegap/notification/notification.beep.md", + "phonegap/notification/notification.vibrate.md" + ], + "storage.md": [ + "phonegap/storage/storage.md", + "phonegap/storage/storage.opendatabase.md", + "phonegap/storage/parameters/name.md", + "phonegap/storage/parameters/version.md", + "phonegap/storage/parameters/display_name.md", + "phonegap/storage/parameters/size.md", + "phonegap/storage/database/database.md", + "phonegap/storage/sqltransaction/sqltransaction.md", + "phonegap/storage/sqlresultset/sqlresultset.md", + "phonegap/storage/sqlresultsetlist/sqlresultsetlist.md", + "phonegap/storage/sqlerror/sqlerror.md", + "phonegap/storage/localstorage/localstorage.md" + ] + } +} http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/guide/getting-started/android/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/guide/getting-started/android/index.md b/docs/en/1.4.0rc1/guide/getting-started/android/index.md new file mode 100644 index 0000000..8379d41 --- /dev/null +++ b/docs/en/1.4.0rc1/guide/getting-started/android/index.md @@ -0,0 +1,111 @@ +Getting Started with Android +============================ + + +Video Tutorials: +---------------- + +- [PhoneGap and Android Quick Start Video Using Ecliplse](http://www.youtube.com/v/MzcIcyBYJMA?autoplay=1) + + +1. Requirements +--------------- + +- Eclipse 3.4+ + +There is also a [Terminal](http://wiki.phonegap.com/w/page/30864168/phonegap-android-terminal-quickstart) of this tutorial that doesn't use Eclipse. + + +2. Install SDK + PhoneGap +---------------------------- + +- Download and install [Eclipse Classic](http://www.eclipse.org/downloads/) +- Download and install [Android SDK](http://developer.android.com/sdk/index.html) +- Download and install [ADT Plugin](http://developer.android.com/sdk/eclipse-adt.html#installing) +- Donwload the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + 3. Setup New Project +----------------------- + +- Launch Eclipse, then under the menu select **New > Android Project** + + ![](img/guide/getting-started/android/new_android_project.jpeg) +- In the root directory of the project, create two new directories: + - **/libs** + - **guides/images/www** +- Copy **phonegap.js** from your PhoneGap download earlier to **guides/images/www** +- Copy **phonegap.jar** from your PhoneGap download earlier to **/libs** +- Copy **xml** folder from your PhoneGap download earlier to **/res** +- Make a few adjustments too the project's main Java file found in the **src** folder in Eclipse: (view image below) + - Change the class's extend from **Activity** to **DroidGap** + - Replace the **setContentView()** line with **super.loadUrl("file:///android_asset/www/index.html");** + - Add **import com.phonegap.*;** + - Remove **import android.app.Activity;** + + ![](img/guide/getting-started/android/javaSrc.jpg) +- You might experience an error here, where Eclipse can't find phonegap-1.0.0.jar. In this case, right click on the /libs folder and go to Build Paths/ > Configure Build Paths. Then, in the Libraries tab, add phonegap-1.0.0.jar to the Project. If Eclipse is being temperamental, you might need to refresh (F5) the project once again. +- Right click on AndroidManifest.xml and select **Open With > Text Editor** +- Paste the following permissions under versionName: (view image below) + + + + + + + + + + + + + + + + + + +- Add `android:configChanges="orientation|keyboardHidden"` to the activity tag in AndroidManifest. (view image below) +- Add a second activity under you appliction tag in AndroidManifest. (view image below) + + + + ![](img/guide/getting-started/android/manifest.jpg) + +4. Hello World +-------------- + +Now create and open a new file named **index.html** in the **guides/images/www** directory. Paste the following code: + + + + + PhoneGap + + + +

Hello World

+ + + + *phonegap.js might need to be replaced with phonegap.<VERSION NUMER>.js + + +5A. Deploy to Simulator +----------------------- + +- Right click the project and go to **Run As** and click **Android Application** +- Eclipse will ask you to select an appropriate AVD. If there isn't one, then you'll need to create it. + + +5B. Deploy to Device +-------------------- + +- Make sure USB debugging is enabled on your device and plug it into your system. (Settings > Applications > Development) +- Right click the project and go to **Run As** and click **Android Application** + + +Done! +----- + +You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/30862722/phonegap-android-eclipse-quickstart). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/guide/getting-started/blackberry/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/guide/getting-started/blackberry/index.md b/docs/en/1.4.0rc1/guide/getting-started/blackberry/index.md new file mode 100644 index 0000000..dd7a67b --- /dev/null +++ b/docs/en/1.4.0rc1/guide/getting-started/blackberry/index.md @@ -0,0 +1,63 @@ +Getting Started with Blackberry +============================ + + +Video Tutorials: +---------------- + +- [PhoneGap and BlackBerry Widgets uick Start Video](http://www.youtube.com/v/eF0h0K0OLwI?autoplay=1) + + + +1. Requirements +--------------- + +- Windows XP (32-bit) or Windows 7 (32-bit and 64-bit) or Mac OSX 10.6.4+ + +For 4.x devices check out [this guide](http://wiki.phonegap.com/w/page/25653281/Getting%20Started%20with%20PhoneGap-BlackBerry%20with%20the%20Latest%20Environment). + + +2. Install SDK + PhoneGap +------------------------- + +- (Windows Only) Download and install [SUN JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html#jdk) (32-Bit Version). Add it to your PATH variable. +- (Windows Only) Download and extract [Apache Ant](http://ant.apache.org/bindownload.cgi). Add it to your PATH variable. +- Download [BlackBerry WebWorks Smartphone SDK](ttps://bdsc.webapps.blackberry.com/html5/download/sdk) for BlackBerry development and/or [BlackBerry WebWorks Tablet OS SDK](https://bdsc.webapps.blackberry.com/html5/download/sdk) for Playbook development. Keep note of the directories you install these SDKs. +- Donwload the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + +3. Setup New Project +-------------------- + +- Open up a command prompt/terminal and navigate to where you extracted PhoneGap. CD into the PhoneGapBlackBerry directory. +- Create a PhoneGap BlackBerry and PlayBook project. Type 'ant create -Dproject.path='followed by the location you wish to create your project into the command prompt/terminal. +- Change to the newly created directory located at `C:\Dev\bbw\sample`. +- Open up the project.properties file with your favourite editor and change the lines `BlackBerry.bbwp.dir=` and `PlayBook.bbwp.dir=` to equal the respective install locations of the SDKs you downloaded earlier. + + +4. Hello World +-------------- + +Build the PhoneGap sample project by typing `ant target build` in your command prompt/terminal while you are in your project's directory. Replace the target with either blackberry or playbook. Note this is the sample PhoneGap project and not a basic hello world application. You can go edit the index.html file located in the www directory of your project to make it say Hello World if you wish. + + +5A. Deploy to Simulator (Windows Only) +-------------------------------------- + +- While in your project directory, in command prompt/terminal type `ant target load-simulator`. Replace the target with either blackberry or playbook. +- Press the BlackBerry button on the simulator, go to downloads and you should see your app loaded there. + + +5B. Deploy to Device (Windows and Mac) +-------------------------------------- + +- You have to have your signing keys from RIM by filling out this [form](https://www.blackberry.com/SignedKeys/). +- While in your project directory, in command prompt/terminal type `ant target load-device`. Replace the target with either blackberry or playbook. +- Press the BlackBerry button on the simulator, go to downloads and you should see your app loaded there. + + +Done! +----- + +You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/31930982/Getting-Started-with-PhoneGap-BlackBerry-WebWorks). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/guide/getting-started/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/guide/getting-started/index.md b/docs/en/1.4.0rc1/guide/getting-started/index.md new file mode 100644 index 0000000..dd04ef8 --- /dev/null +++ b/docs/en/1.4.0rc1/guide/getting-started/index.md @@ -0,0 +1,9 @@ +Getting Started Guides +====================== + +- Getting Started with Android +- Getting Started with Blackberry +- Getting Started with iOS +- Getting Started with Symbian +- Getting Started with WebOS +- Getting Started with Windows Phone \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/guide/getting-started/ios/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/guide/getting-started/ios/index.md b/docs/en/1.4.0rc1/guide/getting-started/ios/index.md new file mode 100644 index 0000000..32002ac --- /dev/null +++ b/docs/en/1.4.0rc1/guide/getting-started/ios/index.md @@ -0,0 +1,75 @@ +Getting Started with iOS +======================== + + +Video Tutorials: +---------------- + +- [PhoneGap Installer - Xcode 4 Template](http://www.youtube.com/v/R9zktJUN7AI?autoplay=1) + + +1. Requirements +--------------- +- Intel-based computer with Mac OS X Snow Leopard (10.6) +- Necessary for Installing on Device: + - An Apple iOS device (iPhone, iPad, iPod Touch) + - iOS developer certification + + +2. Install SDK + PhoneGap +------------------------- + +- Download and install Xcode from [Apple Developer Portal](http://developer.apple.com) (Membership required)

+- Donwload the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + +3. Setup New Project +-------------------- + +- Launch Xcode, then under the File menu select **New** and then **New Project...** +- Select **PhoneGap-based Application** from the list of templates + + ![](img/guide/getting-started/ios/XCode4-templates.png) +- Select the **Next** button, Fill in the "Product Name" & "Company Identifier" for your app + + ![](img/guide/getting-started/ios/xcode4-name_your_app.png) + +- Choose a directory to store your app +- You should see your project in Xcode 4 now. Press the **Run** button in the top left corner. Your build should succeed and launch in the simulator +- You should see a error in your simulator informing you index.html was not found +- To fix this, we need to copy the **www** directory into the project. Right click on the project in the left navigation window and click show in finder +- In Finder, you should see the **www** directory beside your project +- Next step is **IMPORTANT**! Drag the **www** folder into Xcode 4. You can't just drag the www folder into your app's folder. It needs to be dragged into Xcode 4!! In my case I would drag it and drop it on HiWorld shown below. + + ![](img/guide/getting-started/ios/project.jpg) +- After you drag, you should see a prompt with a few options. Make sure to select **Create folder references for any added folders**. Click Finish + + +4. Hello World +-------------- + +Open the folder named **www** and type `

Hello World

` after the `` tag in **index.html**. You can also add any associated Javascript and CSS files there as well. + + +5A. Deploy to Simulator +----------------------- + +- Make sure to change the Active SDK in the top left menu to **Simulator+version#**. +- Hit **Run** in your project window header. + + +5B. Deploy to Device +-------------------- + +- Open [AppName]-Info.plist and change **BundleIdentifier** to the identifier provided by Apple. If you have a developer license, you can access and run the Assistant at [here](http://developer.apple.com/iphone/manage/overview/index.action) and register your App. +- Make sure to change the Active SDK in the top left menu to **Device+version#**. +- Hit **Run** in your project window header. + + ![](img/guide/getting-started/ios/HelloWorldiPhone4.png) + + +Done! +----- + +You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/39991939/Getting-Started-with-PhoneGap-iOS-using-Xcode-4-%28Template-Version%29). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/guide/getting-started/symbian/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/guide/getting-started/symbian/index.md b/docs/en/1.4.0rc1/guide/getting-started/symbian/index.md new file mode 100644 index 0000000..448c1f7 --- /dev/null +++ b/docs/en/1.4.0rc1/guide/getting-started/symbian/index.md @@ -0,0 +1,58 @@ +Getting Started with Symbian +============================ + + +Video Tutorials: +---------------- + +- [PhoneGap Installer - Xcode 4 Template](http://www.youtube.com/v/R9zktJUN7AI?autoplay=1) + + +1. Requirements +--------------- + +- Windows, OS X, or Linux + +There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGap-Symbian-%28Qt%29) and [Symbian with Sony Ericsson](http://wiki.phonegap.com/w/page/16494782/Getting-Started-with-PhoneGap-Symbian-(WRT-on-Sony-Ericsson)) guides. + + +2. Install SDK + PhoneGap +------------------------- + +- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure you select "make" as it is not included by default +- Donwload the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + +3. Setup New Project +-------------------- + +- In cygwin, navigate to where you extracted PhoneGap and go into the Symbian directory + + +4. Hello World +-------------- + +- Open up index.html located in phonegap/symbian/framework/www with your favourite editor. +- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the line `

Hello World

` +- In cygwin/terminal, type make. This will produce phonegap-symbian.wrt/app.wgz. + + +5A. Deploy to Simulator +----------------------- + +- For Mac or Linux you should install [Aptana Studio](http://www.aptana.org/products/studio2/download) and [Nokia WRT Plug-in for Aptana Studio](http://www.forum.nokia.com/info/sw.nokia.com/id/00d62bd8-4214-4c86-b608-5f11b94dad54/Nokia_WRT_Plug_in_for_Aptana_Studio.html). This has a browser-based javascript emulator +- For Windows you can download the [S60 SDK](http://www.forum.nokia.com/info/sw.nokia.com/id/ec866fab-4b76-49f6-b5a5-af0631419e9c/S60_All_in_One_SDKs.html) which includes the S60 Emulator +- Load the phonegap-symbian.wrt/app.wgz file into the emulator. + + +5B. Deploy to Device +-------------------- + +- Load the phonegap-symbian.wrt/app.wgz file into the device using bluetooth or email. + + +Done! +----- + +You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/16494780/Getting-Started-with-Phonegap-Nokia-WRT). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/guide/getting-started/webos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/guide/getting-started/webos/index.md b/docs/en/1.4.0rc1/guide/getting-started/webos/index.md new file mode 100644 index 0000000..059763c --- /dev/null +++ b/docs/en/1.4.0rc1/guide/getting-started/webos/index.md @@ -0,0 +1,58 @@ +Getting Started with WebOS +========================== + + +Video Tutorials: +---------------- + +- [PhoneGapPhoneGap and HP Palm webOS quick start video](http://www.youtube.com/v/XEnAUbDRZfw?autoplay=1) +- [How to convert iPhone app to a Palm](http://www.youtube.com/v/wWoJfQw79XI?autoplay=1) + + +1. Requirements +--------------- + +- Windows, OS X, or Linux + + +2. Install SDK + PhoneGap +---------------------------- + +- Download and install [Virtual Box](http://www.virtualbox.org/) +- Download and install [WebOS SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321/) +- Download and install [cygwin SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321) (Windows only). Make sure you select "make" as it is not included by default +- Donwload the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + + +3. Setup New Project +-------------------- + +- Open up terminal/cygwin and navigate to where you extracted your PhoneGap Download. Go into the webOS directory. + + +4. Hello World +-------------- + +In phonegap/webOS/framework/www, open up index.html with your favourite editor. After the body tag add `

Hello World

` + + +5A. Deploy to Simulator +----------------------- + +- Open up your Palm Emulator from your applications folder/start menu. +- Type `make` in your terminal/cygwin while in the webOS directory. + + +5B. Deploy to Device +-------------------- + +- Make sure your device is in [Developer Mode and plug it in.](http://developer.palm.com/index.php?option=com_content&view=article&id=1552&Itemid=59#dev_mode) +- Type `make` in your terminal/cygwin while in the webOS directory. + + +Done! +----- + +You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/16494781/Getting-Started-with-PhoneGap-webOS). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/guide/getting-started/windows-phone/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/guide/getting-started/windows-phone/index.md b/docs/en/1.4.0rc1/guide/getting-started/windows-phone/index.md new file mode 100644 index 0000000..665b922 --- /dev/null +++ b/docs/en/1.4.0rc1/guide/getting-started/windows-phone/index.md @@ -0,0 +1,76 @@ +Getting Started with Windows Phone +================================== + + +Video Tutorials: +---------------- + +- [PhoneGap and Windows Phone quick setup video](http://www.youtube.com/v/wO9xdRcNHIM?autoplay=1) +- [PhoneGap and Windows Phone deep dive](http://www.youtube.com/v/BJFX1GRUXj8?autoplay=1) + + +1. Requirements +--------------- + +- Windows 7 or Windows Vista with SP2 + +Note: Running in VM has issues, if you are on a Mac, you will need to setup a bootcamp partition with Windows 7 or Vista + +Necessary for Installing on Device and Submitting to Market Place: + +- Become an [App Hub member](http://create.msdn.com/en-US/home/membership). + + +2. Install SDK + PhoneGap +---------------------------- + +- Download and install [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/) +- Donwload the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + +3. Setup New Project +-------------------- + +- Open Visual Studio Express for Windows Phone and choose **New Project**. +- Select **PhoneGapStarter**. +- Give your project a name, and select OK. + + ![](img/guide/getting-started/windows-phone/wpnewproj.PNG) + + +4. Review the project structure +------------------------------- + +- The 'www' folder contains your PhoneGap html/js/css and any other resources included in your app. +- Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content. + + ![](img/guide/getting-started/windows-phone/wp7projectstructure.PNG) + + +5. Build and Deploy to Emulator +------------------------------- + +- Make sure to have **Windows Phone Emulator** selected in the top drop-down menu. +- Hit the green **play button** beside the Windows Phone Emulator drop-down menu to start debugging or press F5. + + ![](img/guide/getting-started/windows-phone/wprun.png) + ![](img/guide/getting-started/windows-phone/wpfirstrun.PNG) + + +6. Build your project for the device +------------------------------------ + +In order to test your application on a device, the device must be registered. Click [here](http://msdn.microsoft.com/en-us/library/gg588378(v=VS.92).aspx) to read documentation on deploying and testing on your Windows Phone. + +- Make sure your phone is connected, and the screen is unlocked +- In Visual Studio, select 'Windows Phone Device' from the top drop-down menu. +- Hit the green **play button** beside the drop-down menu to start debugging or press F5. + + ![](img/guide/getting-started/windows-phone/wpd.png) + + +Done! +----- + +You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/48672055/Getting%20Started%20with%20PhoneGap%20Windows%20Phone%207). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/index.md b/docs/en/1.4.0rc1/index.md new file mode 100644 index 0000000..a36b93a --- /dev/null +++ b/docs/en/1.4.0rc1/index.md @@ -0,0 +1,68 @@ +
+

API Reference

+
    +
  • +

    Accelerometer

    + Tap into the device's motion sensor. +
    • +
  • +

    Camera

    + Capture a photo using the device's camera. +
    • +
  • +

    Capture

    + Capture media files using device's media capture applications. +
    • +
  • +

    Compass

    + Obtain the direction that the device is pointing. +
    • +
  • +

    Connection

    + Quickly check the network state, and cellular network information. +
    • +
  • +

    Contacts

    + Work with the devices contact database. +
    • +
  • +

    Device

    + Gather device specific information. +
    • +
  • +

    Events

    + Hook into native events through JavaScript. +
    • +
  • +

    File

    + Hook into native file system through JavaScript. +
    • +
  • +

    Geolocation

    + Make your application location aware. +
    • +
  • +

    Media

    + Record and play back audio files. +
    • +
  • +

    Notification

    + Visual, audible, and tactile device notifications. +
    • +
  • +

    Storage

    + Hook into the devices native storage options. +
    • +
+

Guides

+
    +
  • +

    Getting Started Guides

    + Setup each SDK and create your first PhoneGap app. +
    • +
  • +

    Keyword Index

    + Full index of the PhoneGap Documentation. +
    • +
+
\ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/accelerometer/acceleration/acceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/accelerometer/acceleration/acceleration.md b/docs/en/1.4.0rc1/phonegap/accelerometer/acceleration/acceleration.md new file mode 100644 index 0000000..9aea51b --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/accelerometer/acceleration/acceleration.md @@ -0,0 +1,85 @@ +Acceleration +============ + +Contains `Accelerometer` data captured at a specific point in time. + +Properties +---------- + +- __x:__ Amount of motion on the x-axis. Range [0, 1] (`Number`) +- __y:__ Amount of motion on the y-axis. Range [0, 1] (`Number`) +- __z:__ Amount of motion on the z-axis. Range [0, 1] (`Number`) +- __timestamp:__ Creation timestamp in milliseconds. (`DOMTimeStamp`) + +Description +----------- + +This object is created and populated by PhoneGap, and returned by an `Accelerometer` method. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone +- Windows Phone 7 ( Mango ) + +Quick Example +------------- + + function onSuccess(acceleration) { + alert('Acceleration X: ' + acceleration.x + '\n' + + 'Acceleration Y: ' + acceleration.y + '\n' + + 'Acceleration Z: ' + acceleration.z + '\n' + + 'Timestamp: ' + acceleration.timestamp + '\n'); + }; + + function onError() { + alert('onError!'); + }; + + navigator.accelerometer.getCurrentAcceleration(onSuccess, onError); + +Full Example +------------ + + + + + Acceleration Example + + + + + +

Example

+

getCurrentAcceleration

+ + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.clearWatch.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.clearWatch.md b/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.clearWatch.md new file mode 100644 index 0000000..d5c5c12 --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.clearWatch.md @@ -0,0 +1,91 @@ +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 + +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/42ac3f67/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md new file mode 100644 index 0000000..2c2e69d --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md @@ -0,0 +1,87 @@ +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 + +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 phoneGap `watchAccelerometer` call. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.md b/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.md new file mode 100644 index 0000000..ccb6812 --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.md @@ -0,0 +1,23 @@ +Accelerometer +============= + +> Captures device motion in the x, y, and z direction. + +Methods +------- + +- accelerometer.getCurrentAcceleration +- accelerometer.watchAcceleration +- accelerometer.clearWatch + +Arguments +--------- + +- accelerometerSuccess +- accelerometerError +- accelerometerOptions + +Objects (Read-Only) +------------------- + +- Acceleration \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.watchAcceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.watchAcceleration.md b/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.watchAcceleration.md new file mode 100644 index 0000000..27fc13a --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/accelerometer/accelerometer.watchAcceleration.md @@ -0,0 +1,116 @@ +accelerometer.watchAcceleration +=============================== + +At a regular interval, get the acceleration along the x, y, and z axis. + + var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess, + accelerometerError, + [accelerometerOptions]); + +Description +----------- + +The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis. + +The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object. + +The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + + +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, PhoneGap will call the success callback function and pass the accelerometer results. +- However, in requests to the device PhoneGap 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), PhoneGap 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/42ac3f67/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerError.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerError.md b/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerError.md new file mode 100644 index 0000000..0765bfb --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerError.md @@ -0,0 +1,8 @@ +accelerometerError +================== + +onError callback function for acceleration functions. + + function() { + // Handle the error + } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerOptions.md b/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerOptions.md new file mode 100644 index 0000000..82066ac --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerOptions.md @@ -0,0 +1,9 @@ +accelerometerOptions +==================== + +An optional parameter to customize the retrieval of the accelerometer. + +Options +------- + +- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerSuccess.md b/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerSuccess.md new file mode 100644 index 0000000..23e7a43 --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/accelerometer/parameters/accelerometerSuccess.md @@ -0,0 +1,23 @@ +accelerometerSuccess +==================== + +onSuccess callback function that provides the Acceleration information. + + function(acceleration) { + // Do something + } + +Parameters +---------- + +- __acceleration:__ The acceleration at a single moment in time. (Acceleration) + +Example +------- + + function onSuccess(acceleration) { + alert('Acceleration X: ' + acceleration.x + '\n' + + 'Acceleration Y: ' + acceleration.y + '\n' + + 'Acceleration Z: ' + acceleration.z + '\n' + + 'Timestamp: ' + acceleration.timestamp + '\n'); + }; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/camera/camera.getPicture.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/camera/camera.getPicture.md b/docs/en/1.4.0rc1/phonegap/camera/camera.getPicture.md new file mode 100644 index 0000000..268002b --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/camera/camera.getPicture.md @@ -0,0 +1,171 @@ +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. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended. + +Supported Platforms +------------------- + +- Android +- Blackberry WebWorks (OS 5.0 and higher) +- iPhone +- Windows Phone 7 ( Mango ) + +Quick Example +------------- + +Take photo and retrieve Base64-encoded image: + + navigator.camera.getPicture(onSuccess, onFail, { quality: 50 }); + + 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/42ac3f67/docs/en/1.4.0rc1/phonegap/camera/camera.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/camera/camera.md b/docs/en/1.4.0rc1/phonegap/camera/camera.md new file mode 100644 index 0000000..e8ec1d8 --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/camera/camera.md @@ -0,0 +1,9 @@ +Camera +====== + +> The `camera` object provides access to the device's default camera application. + +Methods +------- + +- camera.getPicture \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraError.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraError.md b/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraError.md new file mode 100644 index 0000000..cc219eb --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraError.md @@ -0,0 +1,13 @@ +cameraError +=========== + +onError callback function that provides an error message. + + function(message) { + // Show a helpful message + } + +Parameters +---------- + +- __message:__ The message is provided by the device's native code. (`String`) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraOptions.md b/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraOptions.md new file mode 100644 index 0000000..6c2414b --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraOptions.md @@ -0,0 +1,90 @@ +cameraOptions +============= + +Optional parameters to customize the camera settings. + + { quality : 75, + destinationType : Camera.DestinationType.DATA_URL, + sourceType : Camera.PictureSourceType.CAMERA, + allowEdit : true, + encodingType: Camera.EncodingType.JPEG, + targetWidth: 100, + targetHeight: 100 }; + +Options +------- + +- __quality:__ Quality of saved image. Range is [0, 100]. (`Number`) + +- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`) + + Camera.DestinationType = { + DATA_URL : 0, // Return image as base64 encoded string + FILE_URI : 1 // Return image file URI + }; + +- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`) + + Camera.PictureSourceType = { + PHOTOLIBRARY : 0, + CAMERA : 1, + SAVEDPHOTOALBUM : 2 + }; + +- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`) + +- __EncodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`) + + Camera.EncodingType = { + JPEG : 0, // Return JPEG encoded image + PNG : 1 // Return PNG encoded image + }; + +- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`) +- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`) + +- __MediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`) + + Camera.MediaType = { + PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType + VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI + ALLMEDIA : 2 // allow selection from all media types +}; + +Android Quirks +-------------- + +- Ignores the `allowEdit` parameter. +- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album. +- Camera.EncodingType is not supported. + +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. + +Palm Quirks +----------- + +- Ignores the `quality` parameter. +- Ignores the `sourceType` parameter. +- Ignores the `allowEdit` parameter. +- Camera.MediaType is not supported. + +iPhone Quirks +-------------- + +- Set `quality` below 50 to avoid memory error on some devices. +- When `destinationType.FILE_URI` is used, photos are saved in the application's temporary directory. +- The contents of the application's temporary directory is deleted when the application ends. Developers may also delete the contents of this directory using the navigator.fileMgr APIs if storage space is a concern. + +Windows Phone 7 Quirks +-------------- + +- Ignores the `allowEdit` parameter. + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraSuccess.md b/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraSuccess.md new file mode 100644 index 0000000..a64a8ef --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/camera/parameter/cameraSuccess.md @@ -0,0 +1,23 @@ +cameraSuccess +============= + +onSuccess callback function that provides the image data. + + function(imageData) { + // Do something with the image + } + +Parameters +---------- + +- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`) + +Example +------- + + // Show image + // + function cameraCallback(imageData) { + var image = document.getElementById('myImage'); + image.src = "data:image/jpeg;base64," + imageData; + } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/compass/compass.clearWatch.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/compass/compass.clearWatch.md b/docs/en/1.4.0rc1/phonegap/compass/compass.clearWatch.md new file mode 100755 index 0000000..c65dc87 --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/compass/compass.clearWatch.md @@ -0,0 +1,90 @@ +compass.clearWatch +======================== + +Stop watching the compass referenced by the watch ID parameter. + + navigator.compass.clearWatch(watchID); + +- __watchID__: The ID returned by `compass.watchHeading`. + +Supported Platforms +------------------- + +- Android +- iPhone +- Windows Phone 7 ( Mango ) if available in hardware + +Quick Example +------------- + + var watchID = navigator.compass.watchHeading(onSuccess, onError, options); + + // ... later on ... + + navigator.compass.clearWatch(watchID); + +Full Example +------------ + + + + + Compass Example + + + + + +
Waiting for heading...
+ + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/compass/compass.clearWatchFilter.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/compass/compass.clearWatchFilter.md b/docs/en/1.4.0rc1/phonegap/compass/compass.clearWatchFilter.md new file mode 100644 index 0000000..d80502c --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/compass/compass.clearWatchFilter.md @@ -0,0 +1,88 @@ +compass.clearWatchFilter +======================== + +Stop watching the compass referenced by the watch ID parameter. + + navigator.compass.clearWatchFilter(watchID); + +- __watchID__: The ID returned by `compass.watchHeadingFilter`. + +Supported Platforms +------------------- + +- iPhone + +Quick Example +------------- + + var watchID = navigator.compass.watchHeadingFilter(onSuccess, onError, options); + + // ... later on ... + + navigator.compass.clearWatchFilter(watchID); + +Full Example +------------ + + + + + Compass Example + + + + + +
Waiting for heading...
+ + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/compass/compass.getCurrentHeading.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/compass/compass.getCurrentHeading.md b/docs/en/1.4.0rc1/phonegap/compass/compass.getCurrentHeading.md new file mode 100755 index 0000000..7fc02e6 --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/compass/compass.getCurrentHeading.md @@ -0,0 +1,75 @@ +compass.getCurrentHeading +========================= + +Get the current compass heading. + + navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions); + +Description +----------- + +The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99. + +The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function. + +Supported Platforms +------------------- + +- Android +- iPhone +- Windows Phone 7 ( Mango ) if available in hardware + +Quick Example +------------- + + function onSuccess(heading) { + alert('Heading: ' + heading.magneticHeading); + }; + + function onError(error) { + alert('CompassError: ' error.code); + }; + + navigator.compass.getCurrentHeading(onSuccess, onError); + +Full Example +------------ + + + + + Compass Example + + + + + +

Example

+

getCurrentHeading

+ + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/compass/compass.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/compass/compass.md b/docs/en/1.4.0rc1/phonegap/compass/compass.md new file mode 100755 index 0000000..82470c5 --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/compass/compass.md @@ -0,0 +1,21 @@ +Compass +======= + +> Obtains the direction that the device is pointing. + +Methods +------- + +- compass.getCurrentHeading +- compass.watchHeading +- compass.clearWatch +- compass.watchHeadingFilter +- compass.clearWatchFilter + +Arguments +--------- + +- compassSuccess +- compassError +- compassOptions +- compassHeading http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/42ac3f67/docs/en/1.4.0rc1/phonegap/compass/compass.watchHeading.md ---------------------------------------------------------------------- diff --git a/docs/en/1.4.0rc1/phonegap/compass/compass.watchHeading.md b/docs/en/1.4.0rc1/phonegap/compass/compass.watchHeading.md new file mode 100755 index 0000000..66d89bf --- /dev/null +++ b/docs/en/1.4.0rc1/phonegap/compass/compass.watchHeading.md @@ -0,0 +1,105 @@ +compass.watchHeading +==================== + +At a regular interval, get the compass heading in degrees. + + var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]); + +Description +----------- + +The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99. + +The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object. + +The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass. + +Supported Platforms +------------------- + +- Android +- iPhone +- Windows Phone 7 ( Mango ) if available in hardware + + +Quick Example +------------- + + function onSuccess(heading) { + var element = document.getElementById('heading'); + element.innerHTML = 'Heading: ' + heading.magneticHeading; + }; + + function onError(compassError) { + alert('Compass error: ' + compassError.code); + }; + + var options = { frequency: 3000 }; // Update every 3 seconds + + var watchID = navigator.compass.watchHeading(onSuccess, onError, options); + +Full Example +------------ + + + + + Compass Example + + + + + +
Waiting for heading...
+ + + + +