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/08/02 00:11:39 UTC
[5/6] Update 3.0.0 from edge directory.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileentry/fileentry.md b/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
index f362833..357ec46 100644
--- a/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
+++ b/docs/en/3.0.0/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__
@@ -117,31 +132,31 @@ __Quick Example__
function setFileMetadata(localFileSystem, filePath, metadataKey, metadataValue)
{
- var onSetMetadataWin = function() {
- console.log("success setting metadata")
- }
+ var onSetMetadataWin = function() {
+ console.log("success setting metadata")
+ }
var onSetMetadataFail = function() {
- console.log("error setting metadata")
+ console.log("error setting metadata")
}
- var onGetFileWin = function(parent) {
- var data = {};
- data[metadataKey] = metadataValue;
- parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
- }
- var onGetFileFail = function() {
- console.log("error getting file")
- }
+ var onGetFileWin = function(parent) {
+ var data = {};
+ data[metadataKey] = metadataValue;
+ parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
+ }
+ var onGetFileFail = function() {
+ console.log("error getting file")
+ }
- var onFSWin = function(fileSystem) {
- fileSystem.root.getFile(filePath, {create: true, exclusive: false}, onGetFileWin, onGetFileFail);
- }
+ var onFSWin = function(fileSystem) {
+ fileSystem.root.getFile(filePath, {create: true, exclusive: false}, onGetFileWin, onGetFileFail);
+ }
- var onFSFail = function(evt) {
- console.log(evt.target.error.code);
- }
+ var onFSFail = function(evt) {
+ console.log(evt.target.error.code);
+ }
- window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
+ window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
}
setFileMetadata(LocalFileSystem.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
@@ -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)_
+
+- __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 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/3fb6feae/docs/en/3.0.0/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileobj/fileobj.md b/docs/en/3.0.0/cordova/file/fileobj/fileobj.md
index 0825889..e1216c4 100644
--- a/docs/en/3.0.0/cordova/file/fileobj/fileobj.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filereader/filereader.md b/docs/en/3.0.0/cordova/file/filereader/filereader.md
index 0664242..412e935 100644
--- a/docs/en/3.0.0/cordova/file/filereader/filereader.md
+++ b/docs/en/3.0.0/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
@@ -147,9 +159,7 @@ Full Example
// Wait for device API libraries to load
//
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
+ document.addEventListener("deviceready", onDeviceReady, false);
// device APIs are available
//
@@ -202,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/3fb6feae/docs/en/3.0.0/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filesystem/filesystem.md b/docs/en/3.0.0/cordova/file/filesystem/filesystem.md
index 04a5f53..2367d2d 100644
--- a/docs/en/3.0.0/cordova/file/filesystem/filesystem.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md b/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
index 37a2dd5..7db3932 100644
--- a/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/3.0.0/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__
@@ -251,32 +263,25 @@ __Quick Example__
// !! Assumes variable fileURI contains a valid URI to a text file on the device
- var win = function(r) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
- }
+ var win = function(r) {
+ console.log("Should not be called.");
+ }
var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
alert("An error has occurred: Code = " + error.code);
console.log("upload error source " + error.source);
console.log("upload error target " + error.target);
}
- var options = new FileUploadOptions();
- options.fileKey="file";
- options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
- options.mimeType="text/plain";
-
- var params = {};
- params.value1 = "test";
- params.value2 = "param";
-
- options.params = params;
+ var options = new FileUploadOptions();
+ options.fileKey="file";
+ options.fileName="myphoto.jpg";
+ options.mimeType="image/jpeg";
- var ft = new FileTransfer();
+ var ft = new FileTransfer();
ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
- ft.abort(win, fail);
+ ft.abort();
onprogress
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md b/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md
index abb135f..a3cba30 100644
--- a/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
index e0e6fe2..0aea57e 100644
--- a/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md
index 4d9305a..f24d9c5 100644
--- a/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filewriter/filewriter.md b/docs/en/3.0.0/cordova/file/filewriter/filewriter.md
index 8ac5b18..4af7f7d 100644
--- a/docs/en/3.0.0/cordova/file/filewriter/filewriter.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/flags/flags.md b/docs/en/3.0.0/cordova/file/flags/flags.md
index 504f323..9303dd6 100644
--- a/docs/en/3.0.0/cordova/file/flags/flags.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md b/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md
index ea271e2..67bcee2 100644
--- a/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md b/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md
index 2ebbcd5..4b39428 100644
--- a/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/Position/position.md b/docs/en/3.0.0/cordova/geolocation/Position/position.md
index 13eb8f4..61178e2 100644
--- a/docs/en/3.0.0/cordova/geolocation/Position/position.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md b/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md
index 07200d5..9ba183e 100755
--- a/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
index 9bd09f1..e5a5ed8 100644
--- a/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/geolocation.md b/docs/en/3.0.0/cordova/geolocation/geolocation.md
index f2444c5..4b657c7 100644
--- a/docs/en/3.0.0/cordova/geolocation/geolocation.md
+++ b/docs/en/3.0.0/cordova/geolocation/geolocation.md
@@ -56,49 +56,55 @@ Objects (Read-Only)
- PositionError
- Coordinates
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
+ $ cordova plugin rm org.apache.cordova.core.geolocation
- <plugin name="Geolocation" value="org.apache.cordova.GeoBroker" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
- <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
- <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
+ (in app/res/xml/config.xml)
+ <feature name="Geolocation">
+ <param name="android-package" value="org.apache.cordova.GeoBroker" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+ <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+ <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Geolocation" value="org.apache.cordova.geolocation.Geolocation" />
+ (in www/plugins.xml)
+ <feature name="Geolocation">
+ <param name="blackberry-package" value="org.apache.cordova.geolocation.Geolocation" />
+ </feature>
-#### www/config.xml
+ (in www/config.xml)
+ <rim:permissions>
+ <rim:permit>read_geolocation</rim:permit>
+ </rim:permissions>
- <rim:permissions>
- <rim:permit>read_geolocation</rim:permit>
- </rim:permissions>
+* iOS (in `config.xml`)
-### iOS
+ <feature name="Geolocation">
+ <param name="ios-package" value="CDVLocation" />
+ </feature>
-#### config.xml
+* Windows Phone (in `Properties/WPAppManifest.xml`)
- <plugin name="Geolocation" value="CDVLocation" />
+ <Capabilities>
+ <Capability Name="ID_CAP_LOCATION" />
+ </Capabilities>
-### Windows Phone
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-#### Properties/WPAppManifest.xml
-
- <Capabilities>
- <Capability Name="ID_CAP_LOCATION" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-
-### Tizen
-
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md b/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md
index 280976f..c1e4119 100644
--- a/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md b/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md
index 74353f4..107009d 100644
--- a/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md
index 0df7fcd..cad69c5 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md b/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md
index 044b014..b7c6dde 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md b/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md
index d9a8ba4..276e38d 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md b/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md
index dc22d3f..54777ed 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md
index 0c29506..60fb856 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.md b/docs/en/3.0.0/cordova/globalization/globalization.md
index b473ec9..7d7309c 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.md
@@ -53,11 +53,23 @@ therefore has global scope.
// The global globalization object
var globalization = navigator.globalization;
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
+ $ cordova plugin rm org.apache.cordova.core.globalization
- <plugin name="Globalization" value="org.apache.cordova.Globalization" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
+
+* Android (in `app/res/xml/config.xml`)
+
+ <feature name="Globalization">
+ <param name="android-package" value="org.apache.cordova.Globalization" />
+ </feature>
+
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md b/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md
index 0dc4d63..cff0e4e 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md
@@ -33,12 +33,18 @@ 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)_
+
+- __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/3fb6feae/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md b/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md
index 3c6b5f8..86ee72f 100644
--- a/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md
+++ b/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md
@@ -39,26 +39,36 @@ Methods
- executeScript
- insertCSS
-Permissions
------------
+## Accessing the Feature
+
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-### Android
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+ $ cordova plugin rm org.apache.cordova.core.inappbrowser
-#### app/res/xml/config.xml
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
- <plugin name="InAppBrowser" value="org.apache.cordova.InAppBrowser" />
+* Android (in `app/res/xml/config.xml`)
-### iOS
+ <feature name="InAppBrowser">
+ <param name="android-package" value="org.apache.cordova.InAppBrowser" />
+ </feature>
-#### config.xml
+* iOS (in `config.xml`)
- <plugin name="InAppBrowser" value="CDVInAppBrowser" />
+ <feature name="InAppBrowser">
+ <param name="ios-package" value="CDVInAppBrowser" />
+ </feature>
-### Windows Phone 7 + 8
+* Windows Phone 7 and 8 (in `config.xml`)
-#### config.xml
+ <feature name="InAppBrowser" />
- <plugin name="InAppBrowser" />
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
addEventListener
================
@@ -68,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.
@@ -81,8 +92,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
-- Windows Phone 7 + 8
+- Windows Phone 7 and 8
Quick Example
-------------
@@ -129,6 +141,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.
@@ -143,8 +156,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
-- Windows Phone 7 + 8
+- Windows Phone 7 and 8
Quick Example
-------------
@@ -221,9 +235,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
-- Windows Phone 7 + 8
-- BlackBerry 10
+- Windows Phone 7 and 8
Quick Example
-------------
@@ -275,6 +289,7 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
Quick Example
@@ -317,7 +332,6 @@ Full Example
</body>
</html>
-
executeScript
=============
@@ -326,9 +340,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
@@ -340,6 +356,7 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
Quick Example
@@ -405,15 +422,18 @@ 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
-------------------
- Android
+- BlackBerry
- iOS
Quick Example
@@ -481,6 +501,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/3fb6feae/docs/en/3.0.0/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/inappbrowser/window.open.md b/docs/en/3.0.0/cordova/inappbrowser/window.open.md
index 71e75b9..c5e15b7 100644
--- a/docs/en/3.0.0/cordova/inappbrowser/window.open.md
+++ b/docs/en/3.0.0/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`.
@@ -61,9 +63,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
-- BlackBerry 10
-- Windows Phone 7 + 8
+- Windows Phone 7 and 8
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/MediaError/mediaError.md b/docs/en/3.0.0/cordova/media/MediaError/mediaError.md
index 5652a27..fd5e3c5 100644
--- a/docs/en/3.0.0/cordova/media/MediaError/mediaError.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/CaptureError.md b/docs/en/3.0.0/cordova/media/capture/CaptureError.md
index 0268f06..a532ab9 100644
--- a/docs/en/3.0.0/cordova/media/capture/CaptureError.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md b/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md
index 361f45a..619e8a6 100644
--- a/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/MediaFile.md b/docs/en/3.0.0/cordova/media/capture/MediaFile.md
index 3bca7aa..072e90f 100644
--- a/docs/en/3.0.0/cordova/media/capture/MediaFile.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/MediaFileData.md b/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
index 545b549..35ef16a 100644
--- a/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/capture.md b/docs/en/3.0.0/cordova/media/capture/capture.md
index ca184bb..d645063 100644
--- a/docs/en/3.0.0/cordova/media/capture/capture.md
+++ b/docs/en/3.0.0/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
@@ -77,45 +81,55 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Permissions
------------
-
-### Android
-
-#### app/res/xml/plugins.xml
+## Accessing the Feature
- <plugin name="Capture" value="org.apache.cordova.Capture"/>
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/AndroidManifest.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
+ $ cordova plugin rm org.apache.cordova.core.media-capture
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-### BlackBerry WebWorks
+* Android
-#### www/plugins.xml
+ (in app/res/xml/plugins.xml)
+ <feature name="Capture">
+ <param name="android-package" value="org.apache.cordova.Capture" />
+ </feature>
- <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" />
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.RECORD_AUDIO" />
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-#### www/config.xml
+* BlackBerry WebWorks
- <feature id="blackberry.system" required="true" version="1.0.0.0" />
- <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
+ (in www/plugins.xml)
+ <feature name="Capture">
+ <param name="blackberry-package" value="org.apache.cordova.capture.MediaCapture" />
+ </feature>
-### iOS
+ (in www/config.xml)
+ <feature id="blackberry.system" required="true" version="1.0.0.0" />
+ <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
-#### config.xml
+* iOS (in `config.xml`)
- <plugin name="Capture" value="CDVCapture" />
+ <feature name="Capture">
+ <param name="ios-package" value="CDVCapture" />
+ </feature>
-### Windows Phone
+* Windows Phone (in `Properties/WPAppManifest.xml`)
-#### Properties/WPAppManifest.xml
+ <Capabilities>
+ <Capability Name="ID_CAP_MEDIALIB" />
+ <Capability Name="ID_CAP_MICROPHONE" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_CAP_CAMERA" />
+ </Capabilities>
- <Capabilities>
- <Capability Name="ID_CAP_MEDIALIB" />
- <Capability Name="ID_CAP_MICROPHONE" />
- <Capability Name="ID_HW_FRONTCAMERA" />
- <Capability Name="ID_CAP_ISV_CAMERA" />
- <Capability Name="ID_CAP_CAMERA" />
- </Capabilities>
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureAudio.md b/docs/en/3.0.0/cordova/media/capture/captureAudio.md
index edf05e3..ba0fc36 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureAudio.md
+++ b/docs/en/3.0.0/cordova/media/capture/captureAudio.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
capture.captureAudio
====================
-> Start the audio recorder application and return information about the captured audio clip file(s).
+> Start the audio recorder application and return information about captured audio clip files.
navigator.device.capture.captureAudio(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md b/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md
index c7d7ac2..75e2c83 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureImage.md b/docs/en/3.0.0/cordova/media/capture/captureImage.md
index 4b02b0b..9153a47 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureImage.md
+++ b/docs/en/3.0.0/cordova/media/capture/captureImage.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
capture.captureImage
====================
-> Start the camera application and return information about captured image file(s).
+> Start the camera application and return information about captured image files.
navigator.device.capture.captureImage(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureVideo.md b/docs/en/3.0.0/cordova/media/capture/captureVideo.md
index e893b54..997a3b1 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureVideo.md
+++ b/docs/en/3.0.0/cordova/media/capture/captureVideo.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
capture.captureVideo
====================
-> Start the video recorder application and return information about captured video clip file(s).
+> Start the video recorder application and return information about captured video clip files.
navigator.device.capture.captureVideo(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md b/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md
index 769e2ac..41c472b 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md
+++ b/docs/en/3.0.0/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/3fb6feae/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md b/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md
index 43c2018..66509f6 100644
--- a/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/3.0.0/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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/media.md b/docs/en/3.0.0/cordova/media/media.md
index 2f9e49e..1c0edeb 100644
--- a/docs/en/3.0.0/cordova/media/media.md
+++ b/docs/en/3.0.0/cordova/media/media.md
@@ -33,8 +33,11 @@ Parameters
----------
- __src__: A URI containing the audio content. _(DOMString)_
+
- __mediaSuccess__: (Optional) The callback that executes after a `Media` object has completed the current play, record, or stop action. _(Function)_
+
- __mediaError__: (Optional) The callback that executes if an error occurs. _(Function)_
+
- __mediaStatus__: (Optional) The callback that executes to indicate status changes. _(Function)_
Constants
@@ -53,14 +56,23 @@ Methods
-------
- `media.getCurrentPosition`: Returns the current position within an audio file.
+
- `media.getDuration`: Returns the duration of an audio file.
+
- `media.play`: Start or resume playing an audio file.
+
- `media.pause`: Pause playback of an audio file.
+
- `media.release`: Releases the underlying operating system's audio resources.
+
- `media.seekTo`: Moves the position within the audio file.
+
- `media.setVolume`: Set the volume for audio playback.
+
- `media.startRecord`: Start recording an audio file.
+
- `media.stopRecord`: Stop recording an audio file.
+
- `media.stop`: Stop playing an audio file.
Additional ReadOnly Parameters
@@ -68,6 +80,7 @@ Additional ReadOnly Parameters
- __position__: The position within the audio playback, in seconds.
- Not automatically updated during play; call `getCurrentPosition` to update.
+
- __duration__: The duration of the media, in seconds.
Supported Platforms
@@ -80,54 +93,61 @@ Supported Platforms
- Tizen
- Windows 8
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
- <plugin name="Media" value="org.apache.cordova.AudioHandler" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+ (in app/res/xml/config.xml)
+ <feature name="Media">
+ <param name="android-package" value="org.apache.cordova.AudioHandler" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.RECORD_AUDIO" />
+ <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Capture" value="org.apache.cordova.media.MediaCapture" />
+ (in www/plugins.xml)
+ <feature name="Capture">
+ <param name="blackberry-package" value="org.apache.cordova.media.MediaCapture" />
+ </feature>
-### iOS
+* iOS (in `config.xml`)
-#### config.xml
+ <feature name="Media">
+ <param name="ios-package" value="CDVSound" />
+ </feature>
- <plugin name="Media" value="CDVSound" />
+* Windows Phone (in `Properties/WPAppManifest.xml`)
-### Windows Phone
+ <Capabilities>
+ <Capability Name="ID_CAP_MEDIALIB" />
+ <Capability Name="ID_CAP_MICROPHONE" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_CAP_CAMERA" />
+ </Capabilities>
-#### Properties/WPAppManifest.xml
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
- <Capabilities>
- <Capability Name="ID_CAP_MEDIALIB" />
- <Capability Name="ID_CAP_MICROPHONE" />
- <Capability Name="ID_HW_FRONTCAMERA" />
- <Capability Name="ID_CAP_ISV_CAMERA" />
- <Capability Name="ID_CAP_CAMERA" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-
-### Tizen
-
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
### Windows Phone Quirks
- Only one media file can be played back at a time.
+
- There are strict restrictions on how your application interacts with other media. See the [Microsoft documentation for details][url].
[url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/media.setVolume.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/media.setVolume.md b/docs/en/3.0.0/cordova/media/media.setVolume.md
index dc7ef9e..f960457 100644
--- a/docs/en/3.0.0/cordova/media/media.setVolume.md
+++ b/docs/en/3.0.0/cordova/media/media.setVolume.md
@@ -71,7 +71,6 @@ Quick Example
}, 5000);
}
-
Full Example
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/media.startRecord.md b/docs/en/3.0.0/cordova/media/media.startRecord.md
index d33d777..50f9ef9 100644
--- a/docs/en/3.0.0/cordova/media/media.startRecord.md
+++ b/docs/en/3.0.0/cordova/media/media.startRecord.md
@@ -144,7 +144,9 @@ iOS Quirks
----------
- iOS only records to files of type _.wav_ and returns an error if the file name extension is not correct.
+
- If a full path is not provided, the recording is placed in the application's `documents/tmp` directory. This can be accessed via the `File` API using `LocalFileSystem.TEMPORARY`. Any subdirectory specified at record time must already exist.
+
- Files can be recorded and played back using the documents URI:
var myMedia = new Media("documents://beer.mp3")
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.alert.md b/docs/en/3.0.0/cordova/notification/notification.alert.md
index ab73d58..99f1c0d 100644
--- a/docs/en/3.0.0/cordova/notification/notification.alert.md
+++ b/docs/en/3.0.0/cordova/notification/notification.alert.md
@@ -25,8 +25,11 @@ Shows a custom alert or dialog box.
navigator.notification.alert(message, alertCallback, [title], [buttonName])
- __message__: Dialog message. _(String)_
+
- __alertCallback__: Callback to invoke when alert dialog is dismissed. _(Function)_
+
- __title__: Dialog title. _(String)_ (Optional, defaults to `Alert`)
+
- __buttonName__: Button name. _(String)_ (Optional, defaults to `OK`)
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.beep.md b/docs/en/3.0.0/cordova/notification/notification.beep.md
index a254e96..104208e 100644
--- a/docs/en/3.0.0/cordova/notification/notification.beep.md
+++ b/docs/en/3.0.0/cordova/notification/notification.beep.md
@@ -107,5 +107,6 @@ Tizen Quirks
-------------
- Tizen implements beeps by playing an audio file via the media API.
-- The beep file must be short, must be located in a `sounds` sub-directory of the application's root directory, and must be named `beep.wav`.
+
+- The beep file must be short, must be located in a `sounds` subdirectory of the application's root directory, and must be named `beep.wav`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.confirm.md b/docs/en/3.0.0/cordova/notification/notification.confirm.md
index 48567da..072a603 100755
--- a/docs/en/3.0.0/cordova/notification/notification.confirm.md
+++ b/docs/en/3.0.0/cordova/notification/notification.confirm.md
@@ -25,8 +25,11 @@ Displays a customizable confirmation dialog box.
navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
- __message__: Dialog message. _(String)_
+
- __confirmCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when the dialog is dismissed without a button press (0). _(Function)_
+
- __title__: Dialog title. _(String)_ (Optional, defaults to `Confirm`)
+
- __buttonLabels__: Comma-separated string specifying button labels. _(String)_ (Optional, defaults to `OK,Cancel`)
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.md b/docs/en/3.0.0/cordova/notification/notification.md
index d72d51b..2f09a63 100644
--- a/docs/en/3.0.0/cordova/notification/notification.md
+++ b/docs/en/3.0.0/cordova/notification/notification.md
@@ -31,39 +31,45 @@ Methods
- `notification.beep`
- `notification.vibrate`
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
+ $ cordova plugin rm org.apache.cordova.core.dialogs
+ $ cordova plugin rm org.apache.cordova.core.vibration
- <plugin name="Notification" value="org.apache.cordova.Notification"/>
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.VIBRATE" />
+ (in app/res/xml/config.xml)
+ <feature name="Notification">
+ <param name="android-package" value="org.apache.cordova.Notification" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.VIBRATE" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Notification" value="org.apache.cordova.notification.Notification" />
+ (in www/plugins.xml)
+ <feature name="Notification">
+ <param name="blackberry-package" value="org.apache.cordova.notification.Notification" />
+ </feature>
-#### www/config.xml
+ (in www/config.xml)
+ <feature id="blackberry.ui.dialog" />
- <feature id="blackberry.ui.dialog" />
+* iOS (in `config.xml`)
-### iOS
+ <feature name="Notification">
+ <param name="ios-package" value="CDVNotification" />
+ </feature>
-#### config.xml
-
- <plugin name="Notification" value="CDVNotification" />
-
-### Windows Phone
-
- No permissions are required.
-
-### Tizen
-
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.prompt.md b/docs/en/3.0.0/cordova/notification/notification.prompt.md
index 434df6b..fe704c3 100644
--- a/docs/en/3.0.0/cordova/notification/notification.prompt.md
+++ b/docs/en/3.0.0/cordova/notification/notification.prompt.md
@@ -25,10 +25,14 @@ Shows a customizable prompt dialog box.
navigator.notification.prompt(message, promptCallback, [title], [buttonLabels], [defaultText])
- __message__: Dialog message. _(String)_
+
- __promptCallback__: Callback to invoke when a button is pressed. _(Function)_
+
- __title__: Dialog title _(String)_ (Optional, defaults to `Prompt`)
+
- __buttonLabels__: Array of strings specifying button labels _(Array)_ (Optional, defaults to `["OK","Cancel"]`)
-- __defaultText__: Default textbox input value (`String`) (Optional, Default: "Default text")
+
+- __defaultText__: Default textbox input value (`String`) (Optional, Default: empty string)
Description
-----------
@@ -44,6 +48,7 @@ in the prompt dialog box. The `results` object passed to the callback
contains the following properties:
- __buttonIndex__: The index of the pressed button. _(Number)_ Note that the index uses one-based indexing, so the value is `1`, `2`, `3`, etc.
+
- __input1__: The text entered in the prompt dialog box. _(String)_
Supported Platforms
@@ -121,4 +126,5 @@ Android Quirks
----------------------
- Android supports a maximum of three buttons, and ignores any more than that.
+
- On Android 3.0 and later, buttons are displayed in reverse order for devices that use the Holo theme.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md b/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md
index 70ad003..f7d932a 100644
--- a/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md
+++ b/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md
@@ -33,7 +33,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry 10
- iOS
+- Windows Phone 7 and 8
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/splashscreen/splashscreen.md b/docs/en/3.0.0/cordova/splashscreen/splashscreen.md
index c2cc060..2c86114 100644
--- a/docs/en/3.0.0/cordova/splashscreen/splashscreen.md
+++ b/docs/en/3.0.0/cordova/splashscreen/splashscreen.md
@@ -28,20 +28,32 @@ Methods
- splashscreen.show
- splashscreen.hide
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
+ $ cordova plugin rm org.apache.cordova.core.splashscreen
- <plugin name="SplashScreen" value="org.apache.cordova.SplashScreen"/>
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-### iOS
+* Android (in `app/res/xml/config.xml`)
+
+ <feature name="SplashScreen">
+ <param name="android-package" value="org.apache.cordova.SplashScreen" />
+ </feature>
+
+* iOS (in `config.xml`)
-#### config.xml
+ <feature name="SplashScreen">
+ <param name="ios-package" value="CDVSplashScreen" />
+ </feature>
- <plugin name="SplashScreen" value="CDVSplashScreen" />
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
Setup
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md b/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md
index 8aeffc7..806f30a 100644
--- a/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md
+++ b/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md
@@ -33,7 +33,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry 10
- iOS
+- Windows Phone 7 and 8
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/database/database.md b/docs/en/3.0.0/cordova/storage/database/database.md
index 5ac6444..7d2ec41 100644
--- a/docs/en/3.0.0/cordova/storage/database/database.md
+++ b/docs/en/3.0.0/cordova/storage/database/database.md
@@ -26,6 +26,7 @@ Methods
-------
- __transaction__: Runs a database transaction.
+
- __changeVersion__: Allows scripts to automatically verify the version number and change it when updating a schema.
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md b/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md
index 614584c..66b3562 100644
--- a/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md
@@ -20,26 +20,34 @@ license: Licensed to the Apache Software Foundation (ASF) under one
localStorage
===============
-Provides access to a [W3C Storage interface](http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
+Provides access to the W3C's
+[Web Storage interface](http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
- var storage = window.localStorage;
+ var permanentStorage = window.localStorage;
+ var tempStorage = window.sessionStorage;
Methods
-------
- __key__: Returns the name of the key at the specified position.
+
- __getItem__: Returns the item identified by the specified key.
+
- __setItem__: Assigns a keyed item's value.
+
- __removeItem__: Removes the item identified by the specified key.
+
- __clear__: Removes all of the key/value pairs.
Details
-----------
-The `window.localStorage` interface is based on the W3C Web Storage
-interface. An app can use it to save persistent data using key-value
-pairs. The `window.sessionStorage` interface works the same way, but
-all data is cleared each time the app closes.
+The `window.localStorage` interface implements the W3C's [Web Storage
+interface](http://dev.w3.org/html5/webstorage/). An app can use it to
+save persistent data using key-value pairs. The
+`window.sessionStorage` interface works the same way in every respect,
+except that all data is cleared each time the app closes. Each
+database provides a separate namespace.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md b/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md
index 5515103..1f33944 100644
--- a/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md
+++ b/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md
@@ -26,6 +26,7 @@ Properties
----------
- __code__: One of the predefined error codes listed below.
+
- __message__: A description of the error.
Constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md
index 89a0704..e29c0d0 100644
--- a/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md
@@ -27,7 +27,9 @@ Properties
-------
- __insertId__: The row ID of the row that the `SQLResultSet` object's SQL statement inserted into the database.
+
- __rowsAffected__: The number of rows changed by the SQL statement, zero if the statement did not affect any rows.
+
- __rows__: a `SQLResultSetRowList` representing the rows returned, empty if no rows are returned.
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/storage.md b/docs/en/3.0.0/cordova/storage/storage.md
index 1f703fd..366f613 100644
--- a/docs/en/3.0.0/cordova/storage/storage.md
+++ b/docs/en/3.0.0/cordova/storage/storage.md
@@ -22,12 +22,22 @@ Storage
> Provides access to the device's storage options.
-This API is based on the [W3C Web SQL Database
-Specification](http://dev.w3.org/html5/webdatabase/) and [W3C Web
-Storage API Specification](http://dev.w3.org/html5/webstorage/). Some
-devices already provide an implementation of these specifications, in
-which case the built-in support applies. Cordova's implementation
-offers compatible support for those that don't.
+This API offers storage options based on two different W3C
+specifications:
+
+* The
+ [Web Storage API Specification](http://dev.w3.org/html5/webstorage/)
+ allows you to access data via simple key/value pairs. See the
+ section on localStorage for complete details on this interface.
+
+* The
+ [Web SQL Database Specification](http://dev.w3.org/html5/webdatabase/)
+ offers more full-featured database tables accessed via SQL queries.
+ A summary of this interface appears immediately below.
+
+Cordova provides access to both interfaces for the minority of devices
+that don't already support them. Otherwise the built-in
+implementations apply.
Methods
-------
@@ -50,31 +60,26 @@ Objects
- SQLResultSet
- SQLResultSetRowList
- SQLError
-- localStorage
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/config.xml
-
- <plugin name="Storage" value="org.apache.cordova.Storage" />
-
-### BlackBerry WebWorks
-#### www/config.xml
+## Accessing the Feature
- <feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
+As of version 3.0, access to Storage APIs is built into Cordova, and
+does not require using the CLI to add plugins as described in The
+Command-line Interface.
-### iOS
+If you are using the older set of Cordova tools that precede the CLI,
+the following platform-specific configuration settings are still
+required:
- No permissions are required.
+* Android (in `app/res/xml/config.xml`)
-### Windows Phone
+ <feature name="Storage">
+ <param name="android-package" value="org.apache.cordova.Storage" />
+ </feature>
- No permissions are required.
+* BlackBerry WebWorks (in `www/config.xml`)
-### Tizen
+ <feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.