You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/07/29 20:58:23 UTC
[5/9] docs commit: [CB-3962] fix inline text in upgrading sections;
add more vertical space in listings
[CB-3962] fix inline text in upgrading sections; add more vertical space in listings
Conflicts:
docs/en/edge/guide/platforms/blackberry10/index.md
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/7e5cc869
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/7e5cc869
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/7e5cc869
Branch: refs/heads/master
Commit: 7e5cc869df7e8b04fbca8a49cc980c86c881e6bb
Parents: 1904513
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Jul 29 11:10:40 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Mon Jul 29 11:55:58 2013 -0700
----------------------------------------------------------------------
STYLESHEET.md | 10 +
docs/en/edge/config_ref/index.md | 2 +-
.../accelerometer.getCurrentAcceleration.md | 2 +
.../en/edge/cordova/camera/camera.getPicture.md | 3 +
.../camera/parameter/CameraPopoverHandle.md | 1 +
.../cordova/camera/parameter/cameraOptions.md | 17 +
.../compass/parameters/compassHeading.md | 6 +
.../compass/parameters/compassOptions.md | 4 +
.../edge/cordova/connection/connection.type.md | 1 +
.../en/edge/cordova/contacts/Contact/contact.md | 37 +
.../contacts/ContactAddress/contactaddress.md | 17 +
.../contacts/ContactField/contactfield.md | 5 +
.../ContactFindOptions/contactfindoptions.md | 1 +
.../cordova/contacts/ContactName/contactname.md | 10 +
.../ContactOrganization/contactorganization.md | 15 +-
.../en/edge/cordova/contacts/contacts.create.md | 1 -
docs/en/edge/cordova/contacts/contacts.find.md | 3 +
.../contacts/parameters/contactFindOptions.md | 1 +
docs/en/edge/cordova/device/device.model.md | 1 +
docs/en/edge/cordova/device/device.name.md | 2 +-
.../en/edge/cordova/events/events.backbutton.md | 1 -
.../cordova/events/events.batterycritical.md | 1 +
.../en/edge/cordova/events/events.batterylow.md | 1 +
.../edge/cordova/events/events.batterystatus.md | 1 +
docs/en/edge/cordova/events/events.pause.md | 1 -
.../file/directoryentry/directoryentry.md | 36 +
.../file/directoryreader/directoryreader.md | 1 +
.../en/edge/cordova/file/fileentry/fileentry.md | 26 +
docs/en/edge/cordova/file/fileobj/fileobj.md | 5 +
.../edge/cordova/file/filereader/filereader.md | 13 +
.../edge/cordova/file/filesystem/filesystem.md | 1 +
.../cordova/file/filetransfer/filetransfer.md | 12 +
.../file/filetransfererror/filetransfererror.md | 3 +
.../file/fileuploadoptions/fileuploadoptions.md | 5 +
.../file/fileuploadresult/fileuploadresult.md | 2 +
.../edge/cordova/file/filewriter/filewriter.md | 12 +
docs/en/edge/cordova/file/flags/flags.md | 1 +
.../file/localfilesystem/localfilesystem.md | 2 +
.../geolocation/Coordinates/coordinates.md | 6 +
.../cordova/geolocation/Position/position.md | 1 +
.../geolocation/PositionError/positionError.md | 1 +
.../geolocation.getCurrentPosition.md | 2 +
.../geolocation/geolocation.watchPosition.md | 2 +
.../parameters/geolocation.options.md | 2 +
.../globalization.getCurrencyPattern.md | 5 +
.../globalization.getDatePattern.md | 6 +
.../globalization.getLocaleName.md | 2 +-
.../globalization.getNumberPattern.md | 9 +
.../globalization.getPreferredLanguage.md | 2 +-
.../globalization/globalization.stringToDate.md | 6 +
.../edge/cordova/inappbrowser/inappbrowser.md | 10 +-
.../en/edge/cordova/inappbrowser/window.open.md | 2 +
.../edge/cordova/media/MediaError/mediaError.md | 1 +
.../edge/cordova/media/capture/CaptureError.md | 4 +
.../cordova/media/capture/ConfigurationData.md | 2 +
docs/en/edge/cordova/media/capture/MediaFile.md | 4 +
.../edge/cordova/media/capture/MediaFileData.md | 16 +
docs/en/edge/cordova/media/capture/capture.md | 4 +
.../media/capture/captureAudioOptions.md | 1 +
.../media/capture/captureVideoOptions.md | 1 +
.../cordova/media/media.getCurrentPosition.md | 6 +
docs/en/edge/cordova/media/media.md | 14 +
docs/en/edge/cordova/media/media.setVolume.md | 1 -
docs/en/edge/cordova/media/media.startRecord.md | 2 +
.../cordova/notification/notification.alert.md | 3 +
.../cordova/notification/notification.beep.md | 1 +
.../notification/notification.confirm.md | 3 +
.../edge/cordova/notification/notification.md | 1 -
.../cordova/notification/notification.prompt.md | 6 +
.../edge/cordova/storage/database/database.md | 1 +
.../storage/localstorage/localstorage.md | 4 +
.../edge/cordova/storage/sqlerror/sqlerror.md | 1 +
.../storage/sqlresultset/sqlresultset.md | 2 +
docs/en/edge/guide/platforms/android/config.md | 53 +-
docs/en/edge/guide/platforms/android/index.md | 13 +-
docs/en/edge/guide/platforms/android/plugin.md | 3 +-
docs/en/edge/guide/platforms/android/tools.md | 1 +
.../edge/guide/platforms/android/upgrading.md | 463 +++++++----
docs/en/edge/guide/platforms/android/webview.md | 11 +-
.../en/edge/guide/platforms/blackberry/index.md | 12 +-
.../edge/guide/platforms/blackberry/plugin.md | 14 +-
.../en/edge/guide/platforms/blackberry/tools.md | 2 +-
.../guide/platforms/blackberry/upgrading.md | 436 +++++++----
.../edge/guide/platforms/blackberry10/index.md | 52 +-
.../edge/guide/platforms/blackberry10/plugin.md | 42 +-
.../edge/guide/platforms/blackberry10/tools.md | 4 +
.../guide/platforms/blackberry10/upgrading.md | 448 +++++++----
docs/en/edge/guide/platforms/ios/config.md | 108 ++-
docs/en/edge/guide/platforms/ios/plugin.md | 8 +-
docs/en/edge/guide/platforms/ios/upgrading.md | 772 ++++++++++++-------
docs/en/edge/guide/platforms/ios/webview.md | 78 +-
docs/en/edge/guide/platforms/tizen/index.md | 4 +
docs/en/edge/guide/platforms/win8/index.md | 6 +-
docs/en/edge/guide/platforms/win8/tools.md | 2 +
docs/en/edge/guide/platforms/win8/upgrading.md | 8 +-
docs/en/edge/guide/platforms/wp7/index.md | 9 +
docs/en/edge/guide/platforms/wp8/index.md | 10 +
docs/en/edge/guide/platforms/wp8/plugin.md | 16 +-
docs/en/edge/guide/platforms/wp8/tools.md | 2 +
docs/en/edge/guide/platforms/wp8/upgrading.md | 250 ++++--
docs/en/edge/plugin_ref/spec.md | 31 +-
101 files changed, 2295 insertions(+), 960 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/STYLESHEET.md
----------------------------------------------------------------------
diff --git a/STYLESHEET.md b/STYLESHEET.md
index 5ed1f2b..66fe450 100644
--- a/STYLESHEET.md
+++ b/STYLESHEET.md
@@ -56,6 +56,16 @@ editorial guidelines.
can go wrong. Try to clarify variations on a procedure within the
text.
+* Use numbered lists for sequential procedures only, otherwise use
+ bullet lists.
+
+* Punctuation at the end of bullet/number list items that consist of
+ full sentences.
+
+* To improve readability, add vertical space around top-level
+ bullet/numbered list items that consist of full sentences. OK to
+ collapse lists of short, easily scannable items.
+
## Language and Tone
* Use present tense. "This happens," not "this will happen." (Future
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/config_ref/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/config_ref/index.md b/docs/en/edge/config_ref/index.md
index d721300..5c5403f 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -74,5 +74,5 @@ Domain Whitelist Guide for more information.
### `<content>`
This element defines your application's start page relative to the
-project's standard web assets root folder. This element is optional,
+project's standard web assets root directory. This element is optional,
the default is `index.html`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 22cb2c8..c623b95 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -108,5 +108,7 @@ iOS Quirks
-------------
- iOS doesn't recognize 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 yields the last value reported from a `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index c8f65bf..8e2f8cd 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.md
@@ -49,13 +49,16 @@ one of the following formats, depending on the specified
`cameraOptions`:
- A `String` containing the base64-encoded photo image.
+
- A `String` representing the image file location on local storage (default).
You can do whatever you want with the encoded image or URI, for
example:
- Render the image in an `<img>` tag, as in the example below
+
- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc.)
+
- Post the data to a remote server
__NOTE:__ Photo resolution on newer devices is quite good. Photos
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
index ff5a9dd..c8e07d2 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
@@ -38,6 +38,7 @@ setPosition
Set the position of the popover.
__Parameters:__
+
- `cameraPopoverOptions`: the `CameraPopoverOptions` that specify the new position
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraOptions.md b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
index a3a7542..f428459 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
@@ -63,6 +63,7 @@ Options
};
- __targetWidth__: Width in pixels to scale image. Must be used with __targetHeight__. Aspect ratio remains constant. _(Number)_
+
- __targetHeight__: Height in pixels to scale image. Must be used with __targetWidth__. Aspect ratio remains constant. _(Number)_
- __mediaType__: Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. Defined in `nagivator.camera.MediaType` _(Number)_
@@ -74,8 +75,11 @@ Options
};
- __correctOrientation__: Rotate the image to correct for the orientation of the device during capture. _(Boolean)_
+
- __saveToPhotoAlbum__: Save the image to the photo album on the device after capture. _(Boolean)_
+
- __popoverOptions__: iOS-only options that specify popover location in iPad. Defined in `CameraPopoverOptions`.
+
- __cameraDirection__: Choose the camera to use (front- or back-facing). Defined in `navigator.camera.Direction` _(Number)_
Camera.Direction = {
@@ -87,34 +91,47 @@ Android Quirks
--------------
- Ignores the `allowEdit` parameter.
+
- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
BlackBerry Quirks
-----------------
- Ignores the `quality` parameter.
+
- Ignores the `sourceType` parameter.
+
- Ignores the `allowEdit` parameter.
+
- Application must have key injection permissions to close the native Camera application after the user snaps the photo.
+
- Using large image sizes may result in the inability to encode images on later-model devices (e.g. Torch 9800) that feature high-resolution cameras.
+
- `Camera.MediaType` is not supported.
+
- Ignores the `correctOrientation` parameter.
+
- Ignores the `cameraDirection` parameter.
iOS Quirks
--------------
- Set `quality` below 50 to avoid memory errors on some devices.
+
- When using `destinationType.FILE_URI`, photos are saved in the application's temporary directory. You may delete the contents of this directory using the `navigator.fileMgr` APIs if storage space is a concern.
Tizen Quirks
--------------
+
- options not supported
+
- always returns a FILE URI
Windows Phone 7 and 8 Quirks
--------------
- Ignores the `allowEdit` parameter.
+
- Ignores the `correctOrientation` parameter.
+
- Ignores the `cameraDirection` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassHeading.md b/docs/en/edge/cordova/compass/parameters/compassHeading.md
index 7e541b1..0d96acf 100644
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/edge/cordova/compass/parameters/compassHeading.md
@@ -26,8 +26,11 @@ Properties
----------
- __magneticHeading__: The heading in degrees from 0 - 359.99 at a single moment in time. _(Number)_
+
- __trueHeading__: The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading cannot be determined. _(Number)_
+
- __headingAccuracy__: The deviation in degrees between the reported heading and the true heading. _(Number)_
+
- __timestamp__: The time at which this heading was determined. _(milliseconds)_
Description
@@ -37,11 +40,14 @@ The `CompassHeading` object is returned to the `compassSuccess` callback functio
Android Quirks
--------------
+
- `trueHeading` is not supported, but reports the same value as `magneticHeading`
+
- `headingAccuracy` is always 0 because there is no difference between the `magneticHeading` and `trueHeading`.
iOS Quirks
----------
- `trueHeading` is only returned when location services are enabled via `navigator.geolocation.watchLocation()`
+
- For iOS 4 devices and above, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassOptions.md b/docs/en/edge/cordova/compass/parameters/compassOptions.md
index aed37ca..75f4922 100755
--- a/docs/en/edge/cordova/compass/parameters/compassOptions.md
+++ b/docs/en/edge/cordova/compass/parameters/compassOptions.md
@@ -26,16 +26,20 @@ Options
-------
- __frequency__: How often to retrieve the compass heading in milliseconds. _(Number)_ (Default: 100)
+
- __filter__: The change in degrees required to initiate a watchHeading success callback. _(Number)_
Android Quirks
______________
+
- `filter` is not supported.
Tizen Quirks
-----------
+
- `filter` is not supported.
Windows Phone 7 and 8 Quirks
--------------
+
- `filter` is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.type.md b/docs/en/edge/cordova/connection/connection.type.md
index 5a51756..c6de634 100644
--- a/docs/en/edge/cordova/connection/connection.type.md
+++ b/docs/en/edge/cordova/connection/connection.type.md
@@ -122,6 +122,7 @@ Windows Phone Quirks
--------------------
- When running in the emulator, always detects `navigator.connection.type` as `Connection.UNKNOWN`.
+
- Windows Phone cannot detect the type of cellular network connection.
- `navigator.connection.type` is set to `Connection.CELL` for all cellular data.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/Contact/contact.md b/docs/en/edge/cordova/contacts/Contact/contact.md
index 574912e..9e953f4 100644
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ b/docs/en/edge/cordova/contacts/Contact/contact.md
@@ -26,25 +26,40 @@ Properties
----------
- __id__: A globally unique identifier. _(DOMString)_
+
- __displayName__: The name of this Contact, suitable for display to end-users. _(DOMString)_
+
- __name__: An object containing all components of a persons name. _(ContactName)_
+
- __nickname__: A casual name by which to address the contact. _(DOMString)_
+
- __phoneNumbers__: An array of all the contact's phone numbers. _(ContactField[])_
+
- __emails__: An array of all the contact's email addresses. _(ContactField[])_
+
- __addresses__: An array of all the contact's addresses. _(ContactAddress[])_
+
- __ims__: An array of all the contact's IM addresses. _(ContactField[])_
+
- __organizations__: An array of all the contact's organizations. _(ContactOrganization[])_
+
- __birthday__: The birthday of the contact. _(Date)_
+
- __note__: A note about the contact. _(DOMString)_
+
- __photos__: An array of the contact's photos. _(ContactField[])_
+
- __categories__: An array of all the user-defined categories associated with the contact. _(ContactField[])_
+
- __urls__: An array of web pages associated with the contact. _(ContactField[])_
Methods
-------
- __clone__: Returns a new `Contact` object that is a deep copy of the calling object, with the `id` property set to `null`.
+
- __remove__: Removes the contact from the device contacts database, otherwise executes an error callback with a `ContactError` object.
+
- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
Details
@@ -197,36 +212,58 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
- __id__: Supported. Assigned by the device when saving the contact.
+
- __displayName__: Supported. Stored in BlackBerry __user1__ field.
+
- __nickname__: Not supported, returning `null`.
+
- __phoneNumbers__: Partially supported. Phone numbers are stored in BlackBerry fields __homePhone1__ and __homePhone2__ if _type_ is 'home', __workPhone1__ and __workPhone2__ if _type_ is 'work', __mobilePhone__ if _type_ is 'mobile', __faxPhone__ if _type_ is 'fax', __pagerPhone__ if _type_ is 'pager', and __otherPhone__ if _type_ is none of the above.
+
- __emails__: Partially supported. The first three email addresses are stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
+
- __addresses__: Partially supported. The first and second addresses are stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
+
- __ims__: Not supported, returning `null`.
+
- __organizations__: Partially supported. The __name__ and __title__ of the first organization are stored in the BlackBerry __company__ and __title__ fields, respectively.
+
- __photos__: Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a base64-encoded image, or a URL pointing to the image. The image is scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a base64-encoded image.
+
- __categories__: Partially supported. Only _Business_ and _Personal_ categories are supported.
+
- __urls__: Partially supported. The first URL is stored in BlackBerry __webpage__ field.
iOS Quirks
----------
- __displayName__: Not supported on iOS, returning `null` unless there is no `ContactName` specified, in which case it returns the composite name, __nickname__ or `""`, respectively.
+
- __birthday__: Must be input as a JavaScript `Date` object, the same way it is returned.
+
- __photos__: Returns a File URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.
+
- __categories__: This property is currently not supported, returning `null`.
Windows Phone 7 and 8 Quirks
-----------
- __displayName__: When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.
+
- __urls__: When creating a contact, users can input and save more than one web address, but only one is available is available when searching the contact.
+
- __phoneNumbers__: The _pref_ option is not supported. The _type_ is not supported in a _find_ operation. Only one `phoneNumber` is allowed for each _type_.
+
- __emails__: The _pref_ option is not supported. Home and personal references same email entry. Only one entry is allowed for each _type_.
+
- __addresses__: Supports only work, and home/personal _type_. The home and personal _type_ reference the same address entry. Only one entry is allowed for each _type_.
+
- __organizations__: Only one is allowed, and does not support the _pref_, _type_, and _department_ attributes.
+
- __note__: Not supported, returning `null`.
+
- __ims__: Not supported, returning `null`.
+
- __birthdays__: Not supported, returning `null`.
+
- __categories__: Not supported, returning `null`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
index 0258c55..f60ae07 100644
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
@@ -26,12 +26,19 @@ Properties
----------
- __pref__: Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
+
- __type__: A string indicating what type of field this is, _home_ for example. _(DOMString)_
+
- __formatted__: The full address formatted for display. _(DOMString)_
+
- __streetAddress__: The full street address. _(DOMString)_
+
- __locality__: The city or locality. _(DOMString)_
+
- __region__: The state or region. _(DOMString)_
+
- __postalCode__: The zip code or postal code. _(DOMString)_
+
- __country__: The country name. _(DOMString)_
Details
@@ -144,17 +151,27 @@ Android 2.X Quirks
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
+
- __pref__: Not supported on BlackBerry devices, returning `false`.
+
- __type__: Partially supported. Only one each of _Work_ and _Home_ type addresses can be stored per contact.
+
- __formatted__: Partially supported. Returns a concatenation of all BlackBerry address fields.
+
- __streetAddress__: Supported. Returns a concatenation of BlackBerry __address1__ and __address2__ address fields.
+
- __locality__: Supported. Stored in BlackBerry __city__ address field.
+
- __region__: Supported. Stored in BlackBerry __stateProvince__ address field.
+
- __postalCode__: Supported. Stored in BlackBerry __zipPostal__ address field.
+
- __country__: Supported.
iOS Quirks
----------
+
- __pref__: Not supported on iOS devices, returning `false`.
+
- __formatted__: Currently not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactField/contactfield.md b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
index 2bb0f38..6507146 100644
--- a/docs/en/edge/cordova/contacts/ContactField/contactfield.md
+++ b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
@@ -28,7 +28,9 @@ Properties
----------
- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)_
+
- __value__: The value of the field, such as a phone number or email address. _(DOMString)_
+
- __pref__: Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
Details
@@ -150,10 +152,13 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
- __type__: Partially supported. Used for phone numbers.
+
- __value__: Supported.
+
- __pref__: Not supported, returning `false`.
iOS Quirks
-----------
+
- __pref__: Not supported, returning `false`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 5a027f5..7cd76dc 100644
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -26,6 +26,7 @@ Properties
----------
- __filter__: The search string used to find contacts. _(DOMString)_ (Default: `""`)
+
- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: false)
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactName/contactname.md b/docs/en/edge/cordova/contacts/ContactName/contactname.md
index 85751d9..9dc6c70 100644
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/edge/cordova/contacts/ContactName/contactname.md
@@ -26,10 +26,15 @@ Properties
----------
- __formatted__: The complete name of the contact. _(DOMString)_
+
- __familyName__: The contact's family name. _(DOMString)_
+
- __givenName__: The contact's given name. _(DOMString)_
+
- __middleName__: The contact's middle name. _(DOMString)_
+
- __honorificPrefix__: The contact's prefix (example _Mr._ or _Dr._) _(DOMString)_
+
- __honorificSuffix__: The contact's suffix (example _Esq._). _(DOMString)_
Details
@@ -129,10 +134,15 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
- __formatted__: Partially supported. Returns a concatenation of BlackBerry __firstName__ and __lastName__ fields.
+
- __familyName__: Supported. Stored in BlackBerry __lastName__ field.
+
- __givenName__: Supported. Stored in BlackBerry __firstName__ field.
+
- __middleName__: Not supported, returning `null`.
+
- __honorificPrefix__: Not supported, returning `null`.
+
- __honorificSuffix__: Not supported, returning `null`.
iOS Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
index 0e2dba7..76f7b86 100644
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
@@ -26,9 +26,13 @@ Properties
----------
- __pref__: Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
+
- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)
+
- __name__: The name of the organization. _(DOMString)_
+
- __department__: The department the contract works for. _(DOMString)_
+
- __title__: The contact's title at the organization. _(DOMString)_
Details
@@ -123,7 +127,6 @@ Full Example
</body>
</html>
-
Android 2.X Quirks
------------------
@@ -131,17 +134,27 @@ Android 2.X Quirks
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
+
- __pref__: Not supported by BlackBerry devices, returning `false`.
+
- __type__: Not supported by BlackBerry devices, returning `null`.
+
- __name__: Partially supported. The first organization name is stored in the BlackBerry __company__ field.
+
- __department__: Not supported, returning `null`.
+
- __title__: Partially supported. The first organization title is stored in the BlackBerry __jobTitle__ field.
iOS Quirks
-----------
+
- __pref__: Not supported on iOS devices, returning `false`.
+
- __type__: Not supported on iOS devices, returning `null`.
+
- __name__: Partially supported. The first organization name is stored in the iOS __kABPersonOrganizationProperty__ field.
+
- __department__: Partially supported. The first department name is stored in the iOS __kABPersonDepartmentProperty__ field.
+
- __title__: Partially supported. The first title is stored in the iOS __kABPersonJobTitleProperty__ field.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.create.md b/docs/en/edge/cordova/contacts/contacts.create.md
index 93be1aa..aab67d3 100644
--- a/docs/en/edge/cordova/contacts/contacts.create.md
+++ b/docs/en/edge/cordova/contacts/contacts.create.md
@@ -68,7 +68,6 @@ Full Example
console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
}
-
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.find.md b/docs/en/edge/cordova/contacts/contacts.find.md
index 9976f46..ed0129e 100644
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ b/docs/en/edge/cordova/contacts/contacts.find.md
@@ -50,8 +50,11 @@ Parameters
----------
- __contactFields__: Contact fields to use as a search qualifier. The resulting `Contact` object only features values for these fields. _(DOMString[])_ [Required]
+
- __contactSuccess__: Success callback function invoked with the contacts returned from the database. [Required]
+
- __contactError__: Error callback function, invoked when an error occurs. [Optional]
+
- __contactFindOptions__: Search options to filter contacts. [Optional]
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
index 758531c..65ef9d7 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
@@ -32,4 +32,5 @@ Options
-------
- __filter__: The search string used to filter contacts. _(DOMString)_ (Default: `""`)
+
- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.model.md b/docs/en/edge/cordova/device/device.model.md
index 9ebd1d9..6073fa4 100644
--- a/docs/en/edge/cordova/device/device.model.md
+++ b/docs/en/edge/cordova/device/device.model.md
@@ -92,6 +92,7 @@ Android Quirks
Tizen Quirks
-----------
+
- Returns the device model assigned by the vendor, for example, `TIZEN`
Windows Phone 7 and 8 Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.name.md b/docs/en/edge/cordova/device/device.name.md
index 1f75f27..73a9fe4 100644
--- a/docs/en/edge/cordova/device/device.name.md
+++ b/docs/en/edge/cordova/device/device.name.md
@@ -97,7 +97,7 @@ Windows Phone 7 and 8 Quirks
- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
-
Tizen Quirks
-----------
+
- Returns the device model assigned by the vendor, for example, `TIZEN`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.backbutton.md b/docs/en/edge/cordova/events/events.backbutton.md
index ce99243..346ef95 100644
--- a/docs/en/edge/cordova/events/events.backbutton.md
+++ b/docs/en/edge/cordova/events/events.backbutton.md
@@ -60,7 +60,6 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
-
// Wait for device API libraries to load
//
function onLoad() {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterycritical.md b/docs/en/edge/cordova/events/events.batterycritical.md
index ff79908..c229ec0 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -35,6 +35,7 @@ The `batterycritical` handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
+
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
Applications typically should use `window.addEventListener` to attach
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterylow.md b/docs/en/edge/cordova/events/events.batterylow.md
index 5147e05..24af3b6 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -34,6 +34,7 @@ The `batterylow` handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
+
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
Applications typically should use `document.addEventListener` to
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterystatus.md b/docs/en/edge/cordova/events/events.batterystatus.md
index 7904f2e..2d38a20 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -34,6 +34,7 @@ The battery status handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
+
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
Applications typically should use `window.addEventListener` to
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.pause.md b/docs/en/edge/cordova/events/events.pause.md
index 2559e89..6c35ba8 100644
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@ -27,7 +27,6 @@ The event fires when an application is put into the background.
Details
-------
-
The `pause` event fires when the native platform puts the application
into the background, typically when the user switches to a different
application.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index e21aa5f..0c1b34b 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -28,8 +28,11 @@ Properties
----------
- __isFile__: Always false. _(boolean)_
+
- __isDirectory__: Always true. _(boolean)_
+
- __name__: The name of the `DirectoryEntry`, excluding the path leading to it. _(DOMString)_
+
- __fullPath__: The full absolute path from the root to the `DirectoryEntry`. _(DOMString)_
__NOTE:__ The following attribute is defined by the W3C specification,
@@ -43,15 +46,25 @@ Methods
The following methods can be invoked on a `DirectoryEntry` object:
- __getMetadata__: Look up metadata about a directory.
+
- __setMetadata__: Set metadata on a directory.
+
- __moveTo__: Move a directory to a different location on the file system.
+
- __copyTo__: Copy a directory to a different location on the file system.
+
- __toURL__: Return a URL to help locate a directory.
+
- __remove__: Delete a directory. The directory must be empty.
+
- __getParent__: Look up the parent directory.
+
- __createReader__: Create a new `DirectoryReader` that can read entries from a directory.
+
- __getDirectory__: Create or look up a directory.
+
- __getFile__: Create or look up a file.
+
- __removeRecursively__: Delete a directory and all of its contents.
Supported Platforms
@@ -71,6 +84,7 @@ Look up metadata about a directory.
__Parameters:__
- __successCallback__: A callback function to execute with a `Metadata` object. _(Function)_
+
- __errorCallback__: A callback function to execute if an error occurs when retrieving the `Metadata`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -95,7 +109,9 @@ __Currently works only on iOS.__ - this will set the extended attributes of a di
__Parameters:__
- __successCallback__: A callback that executes when the metadata is successfully set. _(Function)_
+
- __errorCallback__: A callback that executes when the metadata fails to be set. _(Function)_
+
- __metadataObject__: An object that contains the metadata's keys and values. _(Object)_
__Quick Example__
@@ -154,8 +170,11 @@ moveTo
Move a directory to a different location on the file system. An error results if the app attempts to:
- move a directory inside itself or to any child at any depth.
+
- move a directory into its parent if a name different from its current directory is not provided.
+
- move a directory to a path occupied by a file.
+
- move a directory to a path occupied by a directory that is not empty.
Moving a directory on top of an existing empty directory attempts to
@@ -164,8 +183,11 @@ delete and replace that directory.
__Parameters:__
- __parent__: The parent directory to which to move the directory. _(DirectoryEntry)_
+
- __newName__: The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
+
- __successCallback__: A callback that executes with the `DirectoryEntry` object for the new directory. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to move the directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -194,6 +216,7 @@ copyTo
Copy a directory to a different location on the file system. An error results if the app attempts to:
- copy a directory inside itself at any depth.
+
- copy a directory into its parent if a name different from its current directory is not provided.
Directory copies are always recursive, and copy all contents of the directory.
@@ -201,8 +224,11 @@ Directory copies are always recursive, and copy all contents of the directory.
__Parameters:__
- __parent__: The parent directory to which to copy the directory. _(DirectoryEntry)_
+
- __newName__: The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
+
- __successCallback__: A callback that executes with the `DirectoryEntry` object for the new directory. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to copy the underlying directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -242,11 +268,13 @@ remove
Deletes a directory. An error results if the app attempts to:
- delete a directory that is not empty.
+
- delete the root directory of a filesystem.
__Parameters:__
- __successCallback__: A callback that executes after the directory is deleted. Invoked with no parameters. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to delete the directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -270,6 +298,7 @@ Look up the parent `DirectoryEntry` containing the directory.
__Parameters:__
- __successCallback__: A callback that is passed the directory's parent `DirectoryEntry`. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -305,8 +334,11 @@ Creates or looks up an existing directory. An error results if the app attempts
__Parameters:__
- __path__: The path to the directory to be looked up or created. Either an absolute path, or a relative path from this `DirectoryEntry`. _(DOMString)_
+
- __options__: Options to specify whether the directory is to be created if it doesn't exist. _(Flags)_
+
- __successCallback__: A callback that executes with a `DirectoryEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when creating or looking up the directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -332,8 +364,11 @@ Creates or looks up a file. An error results if the app attempts to:
__Parameters:__
- __path__: The path to the file to be looked up or created. Either an absolute path, or a relative path from this `DirectoryEntry`. _(DOMString)_
+
- __options__: Options to specify whether the file is created if it doesn't exist. _(Flags)_
+
- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when creating or looking up the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -361,6 +396,7 @@ be deleted. An error results if the app attempts to:
__Parameters:__
- __successCallback__: A callback that executes after the `DirectoryEntry` has been deleted. Invoked with no parameters. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to delete the `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryreader/directoryreader.md b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
index b37edb9..8146726 100644
--- a/docs/en/edge/cordova/file/directoryreader/directoryreader.md
+++ b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
@@ -47,6 +47,7 @@ Read the entries in this directory.
__Parameters:__
- __successCallback__: A callback that is passed an array of `FileEntry` and `DirectoryEntry` objects. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when retrieving the directory listing. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index f362833..2a7b747 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -28,8 +28,11 @@ Properties
----------
- __isFile__: Always true. _(boolean)_
+
- __isDirectory__: Always false. _(boolean)_
+
- __name__: The name of the `FileEntry`, excluding the path leading to it. _(DOMString)_
+
- __fullPath__: The full absolute path from the root to the `FileEntry`. _(DOMString)_
__NOTE:__ The following attribute is defined by the W3C specification,
@@ -41,13 +44,21 @@ Methods
-------
- __getMetadata__: Look up metadata about a file.
+
- __setMetadata__: Set metadata on a file.
+
- __moveTo__: Move a file to a different location on the file system.
+
- __copyTo__: Copy a file to a different location on the file system.
+
- __toURL__: Return a URL that can be used to locate a file.
+
- __remove__: Delete a file.
+
- __getParent__: Look up the parent directory.
+
- __createWriter__: Creates a `FileWriter` object that can be used to write to a file.
+
- __file__: Creates a `File` object containing file properties.
Supported Platforms
@@ -67,6 +78,7 @@ Look up metadata about a file.
__Parameters:__
- __successCallback__: A callback that is passed a `Metadata` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when retrieving the `Metadata`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -88,12 +100,15 @@ setMetadata
Set metadata on a file.
__Currently works only on iOS.__
+
- this will set the extended attributes of a file.
__Parameters:__
- __successCallback__: A callback that executes when the metadata is set. _(Function)_
+
- __errorCallback__: A callback that executes when the metadata is not successfully set. _(Function)_
+
- __metadataObject__: An object that contains the metadata's keys and values. _(Object)_
__Quick Example__
@@ -153,6 +168,7 @@ Move a file to a different location on the file system. An error
results if the app attempts to:
- move a file into its parent if a name different from its current one isn't provided;
+
- move a file to a path occupied by a directory;
In addition, moving a file on top of an existing file attempts to
@@ -161,8 +177,11 @@ delete and replace that file.
__Parameters:__
- __parent__: The parent directory to which to move the file. _(DirectoryEntry)_
+
- __newName__: The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
+
- __successCallback__: A callback that is passed the new files `FileEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to move the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -195,8 +214,11 @@ the app attempts to:
__Parameters:__
- __parent__: The parent directory to which to copy the file. _(DirectoryEntry)_
+
- __newName__: The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
+
- __successCallback__: A callback that is passed the new file's `FileEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to copy the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -237,6 +259,7 @@ Deletes a file.
__Parameters:__
- __successCallback__: A callback that executes after the file has been deleted. Invoked with no parameters. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to delete the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -260,6 +283,7 @@ Look up the parent `DirectoryEntry` containing the file.
__Parameters:__
- __successCallback__: A callback that is passed the file's parent `DirectoryEntry`. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -283,6 +307,7 @@ Create a `FileWriter` object associated with the file represented by the `FileEn
__Parameters:__
- __successCallback__: A callback that is passed a `FileWriter` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs while attempting to create the FileWriter. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -307,6 +332,7 @@ that this `FileEntry` represents.
__Parameters:__
- __successCallback__: A callback that is passed a `File` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when creating the `File` object, such as when the file no longer exists. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileobj/fileobj.md b/docs/en/edge/cordova/file/fileobj/fileobj.md
index 0825889..e1216c4 100644
--- a/docs/en/edge/cordova/file/fileobj/fileobj.md
+++ b/docs/en/edge/cordova/file/fileobj/fileobj.md
@@ -26,9 +26,13 @@ Properties
----------
- __name__: The name of the file. _(DOMString)_
+
- __fullPath__: The full path of the file including the file name. _(DOMString)_
+
- __type__: The mime type of the file. _(DOMString)_
+
- __lastModifiedDate__: The last time the file was modified. _(Date)_
+
- __size__: The size of the file in bytes. _(long)_
Methods
@@ -63,6 +67,7 @@ relative to the current slice. (See the full example below.)
__Parameters:__
- __start__: The index of the first byte to read, inclusive.
+
- __end__: The index of the byte after the last one to read.
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filereader/filereader.md b/docs/en/edge/cordova/file/filereader/filereader.md
index ceb559a..412e935 100644
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@ -26,12 +26,19 @@ Properties
----------
- __readyState__: One of the reader's three possible states, either `EMPTY`, `LOADING` or `DONE`.
+
- __result__: The contents of the file that have been read. _(DOMString)_
+
- __error__: An object containing errors. _(FileError)_
+
- __onloadstart__: Called when the read starts. _(Function)_
+
- __onload__: Called when the read has successfully completed. _(Function)_
+
- __onabort__: Called when the read has been aborted. For instance, by invoking the `abort()` method. _(Function)_
+
- __onerror__: Called when the read has failed. _(Function)_
+
- __onloadend__: Called when the request has completed (either in success or failure). _(Function)_
__NOTE:__ The following porperty is not supported:
@@ -42,9 +49,13 @@ Methods
-------
- __abort__: Aborts reading file.
+
- __readAsDataURL__: Read file and return data as a base64-encoded data URL.
+
- __readAsText__: Reads text file.
+
- __readAsBinaryString__: Reads file as binary and returns a binary string.
+
- __readAsArrayBuffer__: Reads file as an `ArrayBuffer`.
Details
@@ -95,6 +106,7 @@ Read As Text
__Parameters:__
- __file__: the file object to read.
+
- __encoding__: the encoding to use to encode the file's content. Default is UTF8.
Quick Example
@@ -200,6 +212,7 @@ Full Example
iOS Quirks
----------
+
- The __encoding__ parameter is not supported, and UTF8 encoding is always in effect.
Read As Binary String
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filesystem/filesystem.md b/docs/en/edge/cordova/file/filesystem/filesystem.md
index 04a5f53..2367d2d 100644
--- a/docs/en/edge/cordova/file/filesystem/filesystem.md
+++ b/docs/en/edge/cordova/file/filesystem/filesystem.md
@@ -26,6 +26,7 @@ Properties
----------
- __name__: The name of the file system. _(DOMString)_
+
- __root__: The root directory of the file system. _(DirectoryEntry)_
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index 37a2dd5..28ecdd6 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -32,7 +32,9 @@ Methods
-------
- __upload__: sends a file to a server.
+
- __download__: downloads a file from server.
+
- __abort__: Aborts an in-progress transfer.
Details
@@ -63,10 +65,15 @@ upload
__Parameters:__
- __filePath__: Full path of the file on the device.
+
- __server__: URL of the server to receive the file, as encoded by `encodeURI()`.
+
- __successCallback__: A callback that is passed a `Metadata` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
+
- __options__: Optional parameters such as file name and mimetype.
+
- __trustAllHosts__: Optional parameter, defaults to `false`. If set to true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
__Quick Example__
@@ -205,10 +212,15 @@ download
__Parameters:__
- __source__: URL of the server to download the file, as encoded by `encodeURI()`.
+
- __target__: Full path of the file on the device.
+
- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
+
- __trustAllHosts__: Optional parameter, defaults to `false`. If set to `true` then it will accept all security certificates. This is useful as Android rejects self signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
+
- __options__: Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
index abb135f..a3cba30 100644
--- a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
+++ b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
@@ -26,8 +26,11 @@ Properties
----------
- __code__: One of the predefined error codes listed below. (Number)
+
- __source__: URI to the source. (String)
+
- __target__: URI to the target. (String)
+
- __http_status__: HTTP status code. This attribute is only available when a response code is received from the HTTP connection. (Number)
Constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
index e0e6fe2..0aea57e 100644
--- a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -28,10 +28,15 @@ Properties
----------
- __fileKey__: The name of the form element. Defaults to `file`. (DOMString)
+
- __fileName__: The file name to use when saving the file on the server. Defaults to `image.jpg`. (DOMString)
+
- __mimeType__: The mime type of the data to upload. Defaults to `image/jpeg`. (DOMString)
+
- __params__: A set of optional key/value pairs to pass in the HTTP request. (Object)
+
- __chunkedMode__: Whether to upload the data in chunked streaming mode. Defaults to `true`. (Boolean)
+
- __headers__: A map of header name/header values. Use an array to specify more than one value. (Object)
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
index 4d9305a..f24d9c5 100644
--- a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
@@ -27,7 +27,9 @@ Properties
----------
- __bytesSent__: The number of bytes sent to the server as part of the upload. (long)
+
- __responseCode__: The HTTP response code returned by the server. (long)
+
- __response__: The HTTP response returned by the server. (DOMString)
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index 8ac5b18..4af7f7d 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -26,14 +26,23 @@ Properties
----------
- __readyState__: One of the three possible states, either `INIT`, `WRITING`, or `DONE`.
+
- __fileName__: The name of the file to be written. _(DOMString)_
+
- __length__: The length of the file to be written. _(long)_
+
- __position__: The current position of the file pointer. _(long)_
+
- __error__: An object containing errors. _(FileError)_
+
- __onwritestart__: Called when the write starts. _(Function)_
+
- __onwrite__: Called when the request has completed successfully. _(Function)_
+
- __onabort__: Called when the write has been aborted. For instance, by invoking the abort() method. _(Function)_
+
- __onerror__: Called when the write has failed. _(Function)_
+
- __onwriteend__: Called when the request has completed (either in success or failure). _(Function)_
The following property is _not_ supported:
@@ -43,8 +52,11 @@ Methods
-------
- __abort__: Aborts writing the file.
+
- __seek__: Moves the file pointer to the specified byte.
+
- __truncate__: Shortens the file to the specified length.
+
- __write__: Writes data to the file.
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/flags/flags.md b/docs/en/edge/cordova/file/flags/flags.md
index 504f323..9303dd6 100644
--- a/docs/en/edge/cordova/file/flags/flags.md
+++ b/docs/en/edge/cordova/file/flags/flags.md
@@ -28,6 +28,7 @@ Properties
----------
- __create__: Indicates that the file or directory should be created if it does not already exist. _(boolean)_
+
- __exclusive__: Has has no effect by itself, but when used with `create` causes the file or directory creation to fail if the target path already exists. _(boolean)_
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
index ea271e2..67bcee2 100644
--- a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
@@ -26,12 +26,14 @@ Methods
----------
- __requestFileSystem__: Requests a filesystem. _(Function)_
+
- __resolveLocalFileSystemURI__: Retrieve a `DirectoryEntry` or `FileEntry` using local URI. _(Function)_
Constants
---------
- `LocalFileSystem.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission.
+
- `LocalFileSystem.TEMPORARY`: Used for storage with no guarantee of persistence.
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
index 2ebbcd5..4b39428 100644
--- a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
@@ -26,11 +26,17 @@ Properties
----------
* __latitude__: Latitude in decimal degrees. _(Number)_
+
* __longitude__: Longitude in decimal degrees. _(Number)_
+
* __altitude__: Height of the position in meters above the ellipsoid. _(Number)_
+
* __accuracy__: Accuracy level of the latitude and longitude coordinates in meters. _(Number)_
+
* __altitudeAccuracy__: Accuracy level of the altitude coordinate in meters. _(Number)_
+
* __heading__: Direction of travel, specified in degrees counting clockwise relative to the true north. _(Number)_
+
* __speed__: Current ground speed of the device, specified in meters per second. _(Number)_
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Position/position.md b/docs/en/edge/cordova/geolocation/Position/position.md
index 13eb8f4..61178e2 100644
--- a/docs/en/edge/cordova/geolocation/Position/position.md
+++ b/docs/en/edge/cordova/geolocation/Position/position.md
@@ -26,6 +26,7 @@ Properties
----------
- __coords__: A set of geographic coordinates. _(Coordinates)_
+
- __timestamp__: Creation timestamp for `coords`. _(Date)_
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/PositionError/positionError.md b/docs/en/edge/cordova/geolocation/PositionError/positionError.md
index 07200d5..9ba183e 100755
--- a/docs/en/edge/cordova/geolocation/PositionError/positionError.md
+++ b/docs/en/edge/cordova/geolocation/PositionError/positionError.md
@@ -26,6 +26,7 @@ Properties
----------
- __code__: One of the predefined error codes listed below.
+
- __message__: Error message describing the details of the error encountered.
Constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index 9bd09f1..e5a5ed8 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -30,7 +30,9 @@ Parameters
----------
- __geolocationSuccess__: The callback that is passed the current position.
+
- __geolocationError__: _(Optional)_ The callback that executes if an error occurs.
+
- __geolocationOptions__: _(Optional)_ The geolocation options.
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
index 280976f..c1e4119 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
@@ -30,7 +30,9 @@ Parameters
----------
- __geolocationSuccess__: The callback that is passed the current position.
+
- __geolocationError__: (Optional) The callback that executes if an error occurs.
+
- __geolocationOptions__: (Optional) The geolocation options.
Returns
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
index 74353f4..107009d 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
@@ -29,7 +29,9 @@ Options
-------
- __enableHighAccuracy__: Provides a hint that the application needs the best possible results. By default, the device attempts to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
+
- __timeout__: The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback executes. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is passed a `PositionError.TIMEOUT` error code. (Note that when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds!) _(Number)_
+
- __maximumAge__: Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
Android Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 0df7fcd..cad69c5 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -32,10 +32,15 @@ Returns the pattern to the `successCallback` with a `properties` object
as a parameter. That object should contain the following properties:
- __pattern__: The currency pattern to format and parse currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+
- __code__: The ISO 4217 currency code for the pattern. _(String)_
+
- __fraction__: The number of fractional digits to use when parsing and formatting currency. _(Number)_
+
- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_
+
- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_
+
- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_
The inbound `currencyCode` parameter should be a `String` of one of
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
index 044b014..b7c6dde 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -32,8 +32,11 @@ Returns the pattern to the `successCallback`. The object passed in as
a parameter contains the following properties:
- __pattern__: The date and time pattern to format and parse dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+
- __timezone__: The abbreviated name of the time zone on the client. _(String)_
+
- __utc\_offset__: The current difference in seconds between the client's time zone and coordinated universal time. _(Number)_
+
- __dst\_offset__: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone. _(Number)_
If there is an error obtaining the pattern, the `errorCallback`
@@ -99,7 +102,10 @@ Windows Phone 8 Quirks
--------------
- The `formatLength` supports only `short` and `full` values.
+
- The `pattern` for `date and time` pattern returns only full datetime format.
+
- The `timezone` returns the full time zone name.
+
- The `dst_offset` property is not supported, and always returns zero.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index d9a8ba4..276e38d 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -24,7 +24,6 @@ Get the string identifier for the client's current locale setting.
navigator.globalization.getLocaleName(successCallback, errorCallback);
-
Description
-----------
@@ -80,4 +79,5 @@ Full Example
Windows Phone 8 Quirks
---------------------
+
- Returns the two-letter code defined in ISO 3166 for the current country/region.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index dc22d3f..54777ed 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -31,12 +31,19 @@ Returns the pattern to the `successCallback` with a `properties` object
as a parameter. That object contains the following properties:
- __pattern__: The number pattern to format and parse numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+
- __symbol__: The symbol to use when formatting and parsing, such as a percent or currency symbol. _(String)_
+
- __fraction__: The number of fractional digits to use when parsing and formatting numbers. _(Number)_
+
- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_
+
- __positive__: The symbol to use for positive numbers when parsing and formatting. _(String)_
+
- __negative__: The symbol to use for negative numbers when parsing and formatting. _(String)_
+
- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_
+
- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_
If there is an error obtaining the pattern, then the `errorCallback`
@@ -121,5 +128,7 @@ Full Example
Windows Phone 8 Quirks
----------------
+
- The `pattern` property is not supported, and retuens an empty string.
+
- The `fraction` property is not supported, and returns zero.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index 0c29506..60fb856 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -24,7 +24,6 @@ Get the string identifier for the client's current language.
navigator.globalization.getPreferredLanguage(successCallback, errorCallback);
-
Description
-----------
@@ -80,4 +79,5 @@ Full Example
Windows Phone 8 Quirks
-------
+
- Returns the ISO 639-1 two-letter code for the current language.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index 0dc4d63..797cf18 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -33,11 +33,17 @@ Returns the date to the success callback with a `properties` object as
a parameter. That object should have the following properties:
- __year__: The four digit year. _(Number)_
+
- __month__: The month from (0 - 11). _(Number)_
+
- __day__: The day from (1 - 31). _(Number)_
+
- __hour__: The hour from (0 - 23). _(Number)_
+
- __minute__: The minute from (0 - 59). _(Number)_
+
- __second__: The second from (0 - 59). _(Number)_
+
- __millisecond__: The milliseconds (from 0 - 999), not available on all platforms. _(Number)_
The inbound `dateString` parameter should be of type `String`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/inappbrowser.md b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
index 02754cb..ab46919 100644
--- a/docs/en/edge/cordova/inappbrowser/inappbrowser.md
+++ b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
@@ -78,6 +78,7 @@ addEventListener
ref.addEventListener(eventname, callback);
- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
+
- __eventname__: the event to listen for _(String)_
- __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
@@ -139,6 +140,7 @@ removeEventListener
ref.removeEventListener(eventname, callback);
- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
+
- __eventname__: the event to stop listening for. _(String)_
- __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
@@ -327,7 +329,6 @@ Full Example
</body>
</html>
-
executeScript
=============
@@ -336,9 +337,11 @@ executeScript
ref.executeScript(details, callback);
- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
+
- __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_
- __file__: URL of the script to inject.
- __code__: Text of the script to inject.
+
- __callback__: the function that executes after the JavaScript code is injected.
- If the injected script is of type `code`, the callback executes
with a single parameter, which is the return value of the
@@ -415,9 +418,11 @@ insertCSS
ref.insertCSS(details, callback);
- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
+
- __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_
- __file__: URL of the stylesheet to inject.
- __code__: Text of the stylesheet to inject.
+
- __callback__: the function that executes after the CSS is injected.
Supported Platforms
@@ -491,6 +496,9 @@ Properties
----------
- __type__: the eventname, either `loadstart`, `loadstop`, `loaderror`, or `exit`. _(String)_
+
- __url__: the URL that was loaded. _(String)_
+
- __code__: the error code, only in the case of `loaderror`. _(Number)_
+
- __message__: the error message, only in the case of `loaderror`. _(String)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/window.open.md b/docs/en/edge/cordova/inappbrowser/window.open.md
index 71e75b9..70521e1 100644
--- a/docs/en/edge/cordova/inappbrowser/window.open.md
+++ b/docs/en/edge/cordova/inappbrowser/window.open.md
@@ -26,7 +26,9 @@ instance, or the system browser.
var ref = window.open(url, target, options);
- __ref__: Reference to the `InAppBrowser` window. _(InAppBrowser)_
+
- __url__: The URL to load _(String)_. Call `encodeURI()` on this if the URL contains Unicode characters.
+
- __target__: The target in which to load the URL, an optional parameter that defaults to `_self`. _(String)_
- `_self`: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in the `InAppBrowser`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/MediaError/mediaError.md b/docs/en/edge/cordova/media/MediaError/mediaError.md
index 5652a27..fd5e3c5 100644
--- a/docs/en/edge/cordova/media/MediaError/mediaError.md
+++ b/docs/en/edge/cordova/media/MediaError/mediaError.md
@@ -27,6 +27,7 @@ Properties
----------
- __code__: One of the predefined error codes listed below.
+
- __message__: An error message describing the details of the error.
Constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureError.md b/docs/en/edge/cordova/media/capture/CaptureError.md
index 0268f06..a532ab9 100644
--- a/docs/en/edge/cordova/media/capture/CaptureError.md
+++ b/docs/en/edge/cordova/media/capture/CaptureError.md
@@ -31,7 +31,11 @@ Constants
---------
- `CaptureError.CAPTURE_INTERNAL_ERR`: The camera or microphone failed to capture image or sound.
+
- `CaptureError.CAPTURE_APPLICATION_BUSY`: The camera or audio capture application is currently serving another capture request.
+
- `CaptureError.CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. the value of `limit` is less than one).
+
- `CaptureError.CAPTURE_NO_MEDIA_FILES`: The user exits the camera or audio capture application before capturing anything.
+
- `CaptureError.CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/ConfigurationData.md b/docs/en/edge/cordova/media/capture/ConfigurationData.md
index 361f45a..619e8a6 100644
--- a/docs/en/edge/cordova/media/capture/ConfigurationData.md
+++ b/docs/en/edge/cordova/media/capture/ConfigurationData.md
@@ -41,7 +41,9 @@ Properties
----------
- __type__: The ASCII-encoded lowercase string representing the media type. (DOMString)
+
- __height__: The height of the image or video in pixels. The value is zero for sound clips. (Number)
+
- __width__: The width of the image or video in pixels. The value is zero for sound clips. (Number)
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.md b/docs/en/edge/cordova/media/capture/MediaFile.md
index 3bca7aa..072e90f 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.md
@@ -26,9 +26,13 @@ Properties
----------
- __name__: The name of the file, without path information. (DOMString)
+
- __fullPath__: The full path of the file, including the name. (DOMString)
+
- __type__: The file's mime type (DOMString)
+
- __lastModifiedDate__: The date and time when the file was last modified. (Date)
+
- __size__: The size of the file, in bytes. (Number)
Methods
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFileData.md b/docs/en/edge/cordova/media/capture/MediaFileData.md
index 545b549..35ef16a 100644
--- a/docs/en/edge/cordova/media/capture/MediaFileData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFileData.md
@@ -26,9 +26,13 @@ Properties
----------
- __codecs__: The actual format of the audio and video content. (DOMString)
+
- __bitrate__: The average bitrate of the content. The value is zero for images. (Number)
+
- __height__: The height of the image or video in pixels. The value is zero for audio clips. (Number)
+
- __width__: The width of the image or video in pixels. The value is zero for audio clips. (Number)
+
- __duration__: The length of the video or sound clip in seconds. The value is zero for images. (Number)
BlackBerry WebWorks Quirks
@@ -39,9 +43,13 @@ No API provides format information for media files, so the
the following default values:
- __codecs__: Not supported, and returns `null`.
+
- __bitrate__: Not supported, and returns zero.
+
- __height__: Not supported, and returns zero.
+
- __width__: Not supported, and returns zero.
+
- __duration__: Not supported, and returns zero.
Android Quirks
@@ -49,9 +57,13 @@ Android Quirks
Supports the following `MediaFileData` properties:
- __codecs__: Not supported, and returns `null`.
+
- __bitrate__: Not supported, and returns zero.
+
- __height__: Supported: image and video files only.
+
- __width__: Supported: image and video files only.
+
- __duration__: Supported: audio and video files only.
iOS Quirks
@@ -59,7 +71,11 @@ iOS Quirks
Supports the following `MediaFileData` properties:
- __codecs__: Not supported, and returns null.
+
- __bitrate__: Supported on iOS4 devices for audio only. Returns zero for images and videos.
+
- __height__: Supported: image and video files only.
+
- __width__: Supported: image and video files only.
+
- __duration__: Supported: audio and video files only.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
index bf8a395..775ef57 100644
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@ -58,14 +58,18 @@ Properties
----------
- __supportedAudioModes__: The audio recording formats supported by the device. (ConfigurationData[])
+
- __supportedImageModes__: The recording image sizes and formats supported by the device. (ConfigurationData[])
+
- __supportedVideoModes__: The recording video resolutions and formats supported by the device. (ConfigurationData[])
Methods
-------
- `capture.captureAudio`: Launch the device's audio recording application to record audio clips.
+
- `capture.captureImage`: Launch the device's camera application to take photos.
+
- `capture.captureVideo`: Launch the device's video recorder application to record videos.
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudioOptions.md b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
index c7d7ac2..75e2c83 100644
--- a/docs/en/edge/cordova/media/capture/captureAudioOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
@@ -26,6 +26,7 @@ Properties
----------
- __limit__: The maximum number of audio clips the device user can record in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+
- __duration__: The maximum duration of an audio sound clip, in seconds.
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideoOptions.md b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
index 769e2ac..41c472b 100644
--- a/docs/en/edge/cordova/media/capture/captureVideoOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
@@ -26,6 +26,7 @@ Properties
----------
- __limit__: The maximum number of video clips the device's user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+
- __duration__: The maximum duration of a video clip, in seconds.
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getCurrentPosition.md b/docs/en/edge/cordova/media/media.getCurrentPosition.md
index 43c2018..66509f6 100644
--- a/docs/en/edge/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/edge/cordova/media/media.getCurrentPosition.md
@@ -28,6 +28,7 @@ Parameters
----------
- __mediaSuccess__: The callback that is passed the current position in seconds.
+
- __mediaError__: (Optional) The callback to execute if an error occurs.
Description
@@ -41,10 +42,15 @@ Supported Platforms
-------------------
- Android
+
- BlackBerry WebWorks (OS 5.0 and higher)
+
- iOS
+
- Windows Phone 7 and 8
+
- Tizen
+
- Windows 8
Quick Example