You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/11 06:40:59 UTC
[15/51] [partial] docs commit: Reverting autolinking change because
of inconsistencies.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/filesystem/filesystem.md b/www/docs/en/1.7.0/cordova/file/filesystem/filesystem.md
index 0973c31..8aeb641 100644
--- a/www/docs/en/1.7.0/cordova/file/filesystem/filesystem.md
+++ b/www/docs/en/1.7.0/cordova/file/filesystem/filesystem.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>System
+FileSystem
==========
This object represents a file system.
@@ -27,12 +27,12 @@ Properties
----------
- __name:__ The name of the file system. _(DOMString)_
-- __root:__ The root directory of the file system. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
+- __root:__ The root directory of the file system. _(DirectoryEntry)_
Details
-------
-The `<a href="../fileobj/fileobj.html">File</a>System` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>` object which represents the root directory of the file system.
+The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `DirectoryEntry` object which represents the root directory of the file system.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-<a href="../fileobj/fileobj.html">File</a> System Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+File System Quick Example
-------------------------
function onSuccess(fileSystem) {
@@ -51,30 +51,30 @@ Supported Platforms
}
// request the persistent file system
- window.request<a href="../fileobj/fileobj.html">File</a>System(<a href="../localfilesystem/localfilesystem.html">Local<a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, onSuccess, null);
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../fileobj/fileobj.html">File</a> System <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>File System Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- window.request<a href="../fileobj/fileobj.html">File</a>System(<a href="../localfilesystem/localfilesystem.html">Local<a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, on<a href="../fileobj/fileobj.html">File</a>SystemSuccess, fail);
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
}
- function on<a href="../fileobj/fileobj.html">File</a>SystemSuccess(fileSystem) {
+ function onFileSystemSuccess(fileSystem) {
console.log(fileSystem.name);
console.log(fileSystem.root.name);
}
@@ -86,7 +86,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p><a href="../fileobj/fileobj.html">File</a> System</p>
+ <h1>Example</h1>
+ <p>File System</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/filetransfer/filetransfer.md b/www/docs/en/1.7.0/cordova/file/filetransfer/filetransfer.md
index c8e6b1f..aeab830 100644
--- a/www/docs/en/1.7.0/cordova/file/filetransfer/filetransfer.md
+++ b/www/docs/en/1.7.0/cordova/file/filetransfer/filetransfer.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Transfer
+FileTransfer
==========
-<a href="../fileobj/fileobj.html">File</a>Transfer is an object that allows you to upload files to a server or download files from a server.
+FileTransfer is an object that allows you to upload files to a server or download files from a server.
Properties
----------
@@ -37,7 +37,7 @@ Methods
Details
-------
-The `<a href="../fileobj/fileobj.html">File</a>Transfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a <a href="../fileuploadoptions/fileuploadoptions.html"><a href="../fileobj/fileobj.html">File</a>UploadOptions</a> object to the upload method. On successful upload, the success callback will be called with a <a href="../fileuploadresult/fileuploadresult.html"><a href="../fileobj/fileobj.html">File</a>UploadResult</a> object. If an error occurs, the error callback will be invoked with a <a href="../filetransfererror/filetransfererror.html"><a href="../fileobj/fileobj.html">File</a>TransferError</a> object.
+The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
It is also possible to download a file from remote and save it on the device (only iOS and Android).
Supported Platforms
@@ -55,11 +55,11 @@ __Parameters:__
- __filePath__ - Full path of the file on the device
- __server__ - URL of the server to receive the file
-- __successCallback__ - A callback that is called with a <a href="../metadata/metadata.html">Metadata</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the <a href="../metadata/metadata.html">Metadata</a>. Invoked with a <a href="../filetransfererror/filetransfererror.html"><a href="../fileobj/fileobj.html">File</a>TransferError</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
- __options__ - Optional parameters such as file name and mimetype
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
// !! Assumes variable fileURI contains a valid URI to a text file on the device
@@ -75,7 +75,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
console.log("upload error target " + error.target);
}
- var options = new <a href="../fileuploadoptions/fileuploadoptions.html"><a href="../fileobj/fileobj.html">File</a>UploadOptions</a>();
+ var options = new FileUploadOptions();
options.fileKey="file";
options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
options.mimeType="text/plain";
@@ -86,29 +86,29 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
options.params = params;
- var ft = new <a href="../fileobj/fileobj.html">File</a>Transfer();
+ var ft = new FileTransfer();
ft.upload(fileURI, "http://some.server.com/upload.php", win, fail, options);
-__Full <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Full Example__
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title><a href="../fileobj/fileobj.html">File</a> Transfer <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>File Transfer Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Retrieve image file location from specified source
- navigator.<a href="../../camera/camera.getPicture.html">camera.getPicture</a>(uploadPhoto,
+ navigator.camera.getPicture(uploadPhoto,
function(message) { alert('get picture failed'); },
{ quality: 50,
destinationType: navigator.camera.DestinationType.FILE_URI,
@@ -118,7 +118,7 @@ __Full <a href="../../storage/storage.opendatabase.html">Example</a>__
}
function uploadPhoto(imageURI) {
- var options = new <a href="../fileuploadoptions/fileuploadoptions.html"><a href="../fileobj/fileobj.html">File</a>UploadOptions</a>();
+ var options = new FileUploadOptions();
options.fileKey="file";
options.fileName=imageURI.substr(imageURI.lastIndexOf('/')+1);
options.mimeType="image/jpeg";
@@ -129,7 +129,7 @@ __Full <a href="../../storage/storage.opendatabase.html">Example</a>__
options.params = params;
- var ft = new <a href="../fileobj/fileobj.html">File</a>Transfer();
+ var ft = new FileTransfer();
ft.upload(imageURI, "http://some.server.com/upload.php", win, fail, options);
}
@@ -148,8 +148,8 @@ __Full <a href="../../storage/storage.opendatabase.html">Example</a>__
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Upload <a href="../fileobj/fileobj.html">File</a></p>
+ <h1>Example</h1>
+ <p>Upload File</p>
</body>
</html>
@@ -160,14 +160,14 @@ __Parameters:__
- __source__ - URL of the server to receive the file
- __target__ - Full path of the file on the device
-- __successCallback__ - A callback that is called with a <a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the <a href="../metadata/metadata.html">Metadata</a>. Invoked with a <a href="../filetransfererror/filetransfererror.html"><a href="../fileobj/fileobj.html">File</a>TransferError</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a FileEntry object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
// !! Assumes variable url contains a valid URI to a file on a server and filePath is a valid path on the device
- var fileTransfer = new <a href="../fileobj/fileobj.html">File</a>Transfer();
+ var fileTransfer = new FileTransfer();
fileTransfer.download(
url,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/filetransfererror/filetransfererror.md b/www/docs/en/1.7.0/cordova/file/filetransfererror/filetransfererror.md
index 1ef9e88..b243292 100644
--- a/www/docs/en/1.7.0/cordova/file/filetransfererror/filetransfererror.md
+++ b/www/docs/en/1.7.0/cordova/file/filetransfererror/filetransfererror.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error
+FileTransferError
========
-A `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error` object is returned via the error callback when an error occurs.
+A `FileTransferError` object is returned via the error callback when an error occurs.
Properties
----------
@@ -33,11 +33,11 @@ Properties
Constants
---------
-- `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error.FILE_NOT_FOUND_ERR`
-- `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error.INVALID_URL_ERR`
-- `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error.CONNECTION_ERR`
+- `FileTransferError.FILE_NOT_FOUND_ERR`
+- `FileTransferError.INVALID_URL_ERR`
+- `FileTransferError.CONNECTION_ERR`
Description
-----------
-The `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error` object is returned via the error callback when an error occurs when uploading a file.
+The `FileTransferError` object is returned via the error callback when an error occurs when uploading a file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/1.7.0/cordova/file/fileuploadoptions/fileuploadoptions.md
index afd3e1a..2b02358 100644
--- a/www/docs/en/1.7.0/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/www/docs/en/1.7.0/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>UploadOptions
+FileUploadOptions
========
-A `<a href="../fileobj/fileobj.html">File</a>UploadOptions` object can be passed to the <a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a> objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
Properties
----------
@@ -36,7 +36,7 @@ Properties
Description
-----------
-A `<a href="../fileobj/fileobj.html">File</a>UploadOptions` object can be passed to the <a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a> objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
iOS Quirk
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/fileuploadresult/fileuploadresult.md b/www/docs/en/1.7.0/cordova/file/fileuploadresult/fileuploadresult.md
index a910ccb..d82cde1 100644
--- a/www/docs/en/1.7.0/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/www/docs/en/1.7.0/cordova/file/fileuploadresult/fileuploadresult.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>UploadResult
+FileUploadResult
========
-A `<a href="../fileobj/fileobj.html">File</a>UploadResult` object is returned via the success callback of the <a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a> upload method.
+A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
Properties
----------
@@ -33,9 +33,9 @@ Properties
Description
-----------
-The `<a href="../fileobj/fileobj.html">File</a>UploadResult` object is returned via the success callback of the <a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a> upload method.
+The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
iOS Quirks
----------
-- iOS does not include values for responseCode nor bytesSent in the success callback <a href="../fileobj/fileobj.html">File</a>UploadResult object.
+- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/filewriter/filewriter.md b/www/docs/en/1.7.0/cordova/file/filewriter/filewriter.md
index 90c7e5c..c85fb99 100644
--- a/www/docs/en/1.7.0/cordova/file/filewriter/filewriter.md
+++ b/www/docs/en/1.7.0/cordova/file/filewriter/filewriter.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Writer
+FileWriter
==========
-<a href="../fileobj/fileobj.html">File</a>Writer is an object that allows one to write a file.
+FileWriter is an object that allows one to write a file.
Properties
----------
@@ -30,7 +30,7 @@ Properties
- __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. _(<a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a>)_
+- __error:__ An object containing errors. _(FileError)_
- __onwritestart:__ Called when the write starts. . _(Function)_
- __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -NOT SUPPORTED
- __onwrite:__ Called when the request has completed successfully. _(Function)_
@@ -49,9 +49,9 @@ Methods
Details
-------
-The `<a href="../fileobj/fileobj.html">File</a>Writer` object is a way to write files to the device file system (UTF-8 encoded). Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events.
+The `FileWriter` object is a way to write files to the device file system (UTF-8 encoded). Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events.
-A <a href="../fileobj/fileobj.html">File</a>Writer is created for a single file. You can use it to write to a file multiple times. The <a href="../fileobj/fileobj.html">File</a>Writer maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the <a href="../fileobj/fileobj.html">File</a>Writer writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the <a href="../fileobj/fileobj.html">File</a>Writer's constructor to begin writing to the end of the file.
+A FileWriter is created for a single file. You can use it to write to a file multiple times. The FileWriter maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the FileWriter writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor to begin writing to the end of the file.
Supported Platforms
-------------------
@@ -61,7 +61,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Seek Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Seek Quick Example
------------------------------
function win(writer) {
@@ -75,7 +75,7 @@ Seek Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Truncate Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Truncate Quick Example
--------------------------
function win(writer) {
@@ -88,7 +88,7 @@ Truncate Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Write Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Write Quick Example
-------------------
function win(writer) {
@@ -104,7 +104,7 @@ Write Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Append Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Append Quick Example
--------------------
function win(writer) {
@@ -121,7 +121,7 @@ Append Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Abort Quick Example
-------------------
function win(writer) {
@@ -138,35 +138,35 @@ Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../fileobj/fileobj.html">File</a>Writer <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>FileWriter Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- window.request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>(Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, gotFS, fail);
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
}
function gotFS(fileSystem) {
- fileSystem.root.get<a href="../fileobj/fileobj.html">File</a>("readme.txt", {create: true, exclusive: false}, got<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>, fail);
+ fileSystem.root.getFile("readme.txt", {create: true, exclusive: false}, gotFileEntry, fail);
}
- function got<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>(fileEntry) {
- fileEntry.createWriter(got<a href="../fileobj/fileobj.html">File</a>Writer, fail);
+ function gotFileEntry(fileEntry) {
+ fileEntry.createWriter(gotFileWriter, fail);
}
- function got<a href="../fileobj/fileobj.html">File</a>Writer(writer) {
+ function gotFileWriter(writer) {
writer.onwriteend = function(evt) {
console.log("contents of file now 'some sample text'");
writer.truncate(11);
@@ -189,7 +189,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Write <a href="../fileobj/fileobj.html">File</a></p>
+ <h1>Example</h1>
+ <p>Write File</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/flags/flags.md b/www/docs/en/1.7.0/cordova/file/flags/flags.md
index c5e9c8d..dedd8d4 100644
--- a/www/docs/en/1.7.0/cordova/file/flags/flags.md
+++ b/www/docs/en/1.7.0/cordova/file/flags/flags.md
@@ -21,7 +21,7 @@ license: >
Flags
=====
-This object is used to supply arguments to the `<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>` __get<a href="../fileobj/fileobj.html">File</a>__ and __getDirectory__ methods, which look up or create files and directories, respectively.
+This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively.
Properties
----------
@@ -37,11 +37,11 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Get the data directory, creating it if it doesn't exist.
dataDir = fileSystem.root.getDirectory("data", {create: true});
// Create the lock file, if and only if it doesn't exist.
- lock<a href="../fileobj/fileobj.html">File</a> = dataDir.get<a href="../fileobj/fileobj.html">File</a>("lockfile.txt", {create: true, exclusive: true});
+ lockFile = dataDir.getFile("lockfile.txt", {create: true, exclusive: true});
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/localfilesystem/localfilesystem.md b/www/docs/en/1.7.0/cordova/file/localfilesystem/localfilesystem.md
index 4ba94e9..ff9d1e4 100644
--- a/www/docs/en/1.7.0/cordova/file/localfilesystem/localfilesystem.md
+++ b/www/docs/en/1.7.0/cordova/file/localfilesystem/localfilesystem.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>
+LocalFileSystem
===============
This object provides a way to obtain root file systems.
@@ -26,19 +26,19 @@ This object provides a way to obtain root file systems.
Methods
----------
-- __request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>:__ Requests a filesystem. _(Function)_
-- __resolveLocal<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>URI:__ Retrieve a <a href="../directoryentry/directoryentry.html">DirectoryEntry</a> or <a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a> using local URI. _(Function)_
+- __requestFileSystem:__ Requests a filesystem. _(Function)_
+- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_
Constants
---------
-- `Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission.
-- `Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.TEMPORARY`: Used for storage with no guarantee of persistence.
+- `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
-------
-The `Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>` object methods are defined on the __window__ object.
+The `LocalFileSystem` object methods are defined on the __window__ object.
Supported Platforms
-------------------
@@ -48,7 +48,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Request <a href="../fileobj/fileobj.html">File</a> System Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Request File System Quick Example
---------------------------------
function onSuccess(fileSystem) {
@@ -56,41 +56,41 @@ Request <a href="../fileobj/fileobj.html">File</a> System Quick <a href="../../s
}
// request the persistent file system
- window.request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>(Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, onSuccess, onError);
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
-Resolve Local <a href="../fileobj/fileobj.html">File</a> System URI Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Resolve Local File System URI Quick Example
-------------------------------------------
function onSuccess(fileEntry) {
console.log(fileEntry.name);
}
- window.resolveLocal<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>URI("file:///example.txt", onSuccess, onError);
+ window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>Local <a href="../fileobj/fileobj.html">File</a> System <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Local File System Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- window.request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>(Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, on<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>Success, fail);
- window.resolveLocal<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>URI("file:///example.txt", onResolveSuccess, fail);
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ window.resolveLocalFileSystemURI("file:///example.txt", onResolveSuccess, fail);
}
- function on<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>Success(fileSystem) {
+ function onFileSystemSuccess(fileSystem) {
console.log(fileSystem.name);
}
@@ -105,7 +105,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Local <a href="../fileobj/fileobj.html">File</a> System</p>
+ <h1>Example</h1>
+ <p>Local File System</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/file/metadata/metadata.md b/www/docs/en/1.7.0/cordova/file/metadata/metadata.md
index e4c5194..487d07c 100644
--- a/www/docs/en/1.7.0/cordova/file/metadata/metadata.md
+++ b/www/docs/en/1.7.0/cordova/file/metadata/metadata.md
@@ -31,7 +31,7 @@ Properties
Details
-------
-The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>` or `<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>` object.
+The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `DirectoryEntry` or `FileEntry` object.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function win(metadata) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/Coordinates/coordinates.md b/www/docs/en/1.7.0/cordova/geolocation/Coordinates/coordinates.md
index 451635d..ad2baf0 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/Coordinates/coordinates.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/Coordinates/coordinates.md
@@ -37,7 +37,7 @@ Properties
Description
-----------
-The `Coordinates` object is created and populated by Cordova, and attached to the `<a href="../Position/position.html">Position</a>` object. The `<a href="../Position/position.html">Position</a>` object is then returned to the user through a callback function.
+The `Coordinates` object is created and populated by Cordova, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function.
Supported Platforms
-------------------
@@ -48,7 +48,7 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
@@ -70,29 +70,29 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
alert('onError!');
};
- navigator.geolocation.getCurrent<a href="../Position/position.html">Position</a>(onSuccess, onError);
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../geolocation.html">Geolocation</a> <a href="../Position/position.html">Position</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Geolocation Position Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Set an event to wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is loaded and Ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- navigator.geolocation.getCurrent<a href="../Position/position.html">Position</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
- // Display `<a href="../Position/position.html">Position</a>` properties from the geolocation
+ // Display `Position` properties from the geolocation
//
function onSuccess(position) {
var div = document.getElementById('myDiv');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/Position/position.md b/www/docs/en/1.7.0/cordova/geolocation/Position/position.md
index 82f0d57..2f23043 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/Position/position.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/Position/position.md
@@ -26,7 +26,7 @@ Contains `Position` coordinates that are created by the geolocation API.
Properties
----------
-- __coords:__ A set of geographic coordinates. _(<a href="../Coordinates/coordinates.html">Coordinates</a>)_
+- __coords:__ A set of geographic coordinates. _(Coordinates)_
- __timestamp:__ Creation timestamp for `coords` in milliseconds. _(DOMTimeStamp)_
Description
@@ -43,7 +43,7 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
@@ -59,37 +59,37 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + new Date(position.timestamp) + '\n');
};
- // onError Callback receives a <a href="../PositionError/positionError.html">PositionError</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
- navigator.<a href="../geolocation.getCurrentPosition.html">geolocation.getCurrentPosition</a>(onSuccess, onError);
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../../device/device.html">Device</a> Properties <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- navigator.<a href="../geolocation.getCurrentPosition.html">geolocation.getCurrentPosition</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
- // onSuccess <a href="../geolocation.html">Geolocation</a>
+ // onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -103,7 +103,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + new Date(position.timestamp) + '<br />';
}
- // onError Callback receives a <a href="../PositionError/positionError.html">PositionError</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/PositionError/positionError.md b/www/docs/en/1.7.0/cordova/geolocation/PositionError/positionError.md
index 4450441..45bef69 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/PositionError/positionError.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/PositionError/positionError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../Position/position.html">Position</a>Error
+PositionError
========
-A `<a href="../Position/position.html">Position</a>Error` object is returned to the <a href="../parameters/geolocationError.html">geolocationError</a> callback when an error occurs.
+A `PositionError` object is returned to the geolocationError callback when an error occurs.
Properties
----------
@@ -32,12 +32,12 @@ Properties
Constants
---------
-- `<a href="../Position/position.html">Position</a>Error.PERMISSION_DENIED`
-- `<a href="../Position/position.html">Position</a>Error.POSITION_UNAVAILABLE`
-- `<a href="../Position/position.html">Position</a>Error.TIMEOUT`
+- `PositionError.PERMISSION_DENIED`
+- `PositionError.POSITION_UNAVAILABLE`
+- `PositionError.TIMEOUT`
Description
-----------
-The `<a href="../Position/position.html">Position</a>Error` object is returned to the user through the `<a href="../parameters/geolocationError.html">geolocationError</a>` callback function when an error occurs with geolocation.
+The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/geolocation.clearWatch.md b/www/docs/en/1.7.0/cordova/geolocation/geolocation.clearWatch.md
index 798b75c..154ec6f 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/geolocation.clearWatch.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/geolocation.clearWatch.md
@@ -28,12 +28,12 @@ Stop watching for changes to the device's location referenced by the `watchID` p
Parameters
----------
-- __watchID:__ The id of the `watch<a href="Position/position.html">Position</a>` interval to clear. (String)
+- __watchID:__ The id of the `watchPosition` interval to clear. (String)
Description
-----------
-Function `geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watch<a href="Position/position.html">Position</a>` referenced by `watchID`.
+Function `geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
Supported Platforms
-------------------
@@ -44,44 +44,44 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Options: retrieve the location every 3 seconds
//
- var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { frequency: 3000 });
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { frequency: 3000 });
// ...later on...
navigator.geolocation.clearWatch(watchID);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
var watchID = null;
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Update every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, options);
+ watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
}
- // onSuccess <a href="geolocation.html">Geolocation</a>
+ // onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -99,7 +99,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
}
}
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/geolocation.getCurrentPosition.md b/www/docs/en/1.7.0/cordova/geolocation/geolocation.getCurrentPosition.md
index 6d9617d..343d429 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -18,26 +18,26 @@ license: >
under the License.
---
-geolocation.getCurrent<a href="Position/position.html">Position</a>
+geolocation.getCurrentPosition
==============================
-Returns the device's current position as a `<a href="Position/position.html">Position</a>` object.
+Returns the device's current position as a `Position` object.
- navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>,
- [<a href="parameters/geolocationError.html">geolocationError</a>],
- [<a href="parameters/geolocation.options.html">geolocationOptions</a>]);
+ navigator.geolocation.getCurrentPosition(geolocationSuccess,
+ [geolocationError],
+ [geolocationOptions]);
Parameters
----------
-- __<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>__: The callback that is called with the current position.
-- __<a href="parameters/geolocationError.html">geolocationError</a>__: (Optional) The callback that is called if there was an error.
-- __<a href="parameters/geolocation.options.html">geolocationOptions</a>__: (Optional) The geolocation options.
+- __geolocationSuccess__: The callback that is called with the current position.
+- __geolocationError__: (Optional) The callback that is called if there was an error.
+- __geolocationOptions__: (Optional) The geolocation options.
Description
-----------
-Function `geolocation.getCurrent<a href="Position/position.html">Position</a>` is an asynchronous function. It returns the device's current position to the `<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>` callback with a `<a href="Position/position.html">Position</a>` object as the parameter. If there is an error, the `<a href="parameters/geolocationError.html">geolocationError</a>` callback is invoked with a `<a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>` object.
+Function `geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
Supported Platforms
@@ -49,11 +49,11 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
- // This method accepts a `<a href="Position/position.html">Position</a>` object, which contains
+ // This method accepts a `Position` object, which contains
// the current GPS coordinates
//
var onSuccess = function(position) {
@@ -67,37 +67,37 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + new Date(position.timestamp) + '\n');
};
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
- navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(onSuccess, onError);
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
- navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
- // onSuccess <a href="geolocation.html">Geolocation</a>
+ // onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -111,7 +111,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + new Date(position.timestamp) + '<br />';
}
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/geolocation.md b/www/docs/en/1.7.0/cordova/geolocation/geolocation.md
index dcb6b3b..3f43a14 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/geolocation.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/geolocation.md
@@ -23,28 +23,28 @@ Geolocation
> The `geolocation` object provides access to the device's GPS sensor.
-Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global <a href="Position/position.html">Position</a>ing System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
+Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
This API is based on the [W3C Geo location API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have geolocation support, Cordova's implementation should be compatible with the W3C specification.
Methods
-------
-- geolocation.getCurrent<a href="Position/position.html">Position</a>
-- geolocation.watch<a href="Position/position.html">Position</a>
-- <a href="geolocation.clearWatch.html">geolocation.clearWatch</a>
+- geolocation.getCurrentPosition
+- geolocation.watchPosition
+- geolocation.clearWatch
Arguments
---------
-- <a href="parameters/geolocationSuccess.html">geolocationSuccess</a>
-- <a href="parameters/geolocationError.html">geolocationError</a>
-- <a href="parameters/geolocation.options.html">geolocationOptions</a>
+- geolocationSuccess
+- geolocationError
+- geolocationOptions
Objects (Read-Only)
-------------------
-- <a href="Position/position.html">Position</a>
-- <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>
-- <a href="Coordinates/coordinates.html">Coordinates</a>
+- Position
+- PositionError
+- Coordinates
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/geolocation.watchPosition.md b/www/docs/en/1.7.0/cordova/geolocation/geolocation.watchPosition.md
index becf9f7..9382866 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/geolocation.watchPosition.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/geolocation.watchPosition.md
@@ -18,31 +18,31 @@ license: >
under the License.
---
-geolocation.watch<a href="Position/position.html">Position</a>
+geolocation.watchPosition
=========================
Watches for changes to the device's current position.
- var watchId = navigator.geolocation.watch<a href="Position/position.html">Position</a>(<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>,
- [<a href="parameters/geolocationError.html">geolocationError</a>],
- [<a href="parameters/geolocation.options.html">geolocationOptions</a>]);
+ var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
+ [geolocationError],
+ [geolocationOptions]);
Parameters
----------
-- __<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>__: The callback that is called with the current position.
-- __<a href="parameters/geolocationError.html">geolocationError</a>__: (Optional) The callback that is called if there was an error.
-- __<a href="parameters/geolocation.options.html">geolocationOptions</a>__: (Optional) The geolocation options.
+- __geolocationSuccess__: The callback that is called with the current position.
+- __geolocationError__: (Optional) The callback that is called if there was an error.
+- __geolocationOptions__: (Optional) The geolocation options.
Returns
-------
-- __String__: returns a watch id that references the watch position interval. The watch id can be used with `<a href="geolocation.clearWatch.html">geolocation.clearWatch</a>` to stop watching for changes in position.
+- __String__: returns a watch id that references the watch position interval. The watch id can be used with `geolocation.clearWatch` to stop watching for changes in position.
Description
-----------
-Function `geolocation.watch<a href="Position/position.html">Position</a>` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>` callback is invoked with a `<a href="Position/position.html">Position</a>` object as the parameter. If there is an error, the `<a href="parameters/geolocationError.html">geolocationError</a>` callback is invoked with a `<a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>` object.
+Function `geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
Supported Platforms
-------------------
@@ -53,11 +53,11 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
- // This method accepts a `<a href="Position/position.html">Position</a>` object, which contains
+ // This method accepts a `Position` object, which contains
// the current GPS coordinates
//
function onSuccess(position) {
@@ -67,7 +67,7 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
'<hr />' + element.innerHTML;
}
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
@@ -76,35 +76,35 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// Options: retrieve the location every 3 seconds
//
- var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { frequency: 3000 });
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { frequency: 3000 });
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
var watchID = null;
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Update every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, options);
+ watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
}
- // onSuccess <a href="geolocation.html">Geolocation</a>
+ // onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -113,7 +113,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
'<hr />' + element.innerHTML;
}
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocation.options.md b/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocation.options.md
index 9b14493..c6ab066 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocation.options.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocation.options.md
@@ -30,7 +30,7 @@ Options
- __frequency:__ How often to retrieve the position in milliseconds. This option is not part of the W3C spec and will be removed in the future. maximumAge should be used instead. _(Number)_ (Default: 10000)
- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. _(Boolean)_
-- __timeout:__ The maximum length of time (msec) that is allowed to pass from the call to `geolocation.getCurrent<a href="../Position/position.html">Position</a>` or `geolocation.watch<a href="../Position/position.html">Position</a>` until the corresponding `<a href="geolocationSuccess.html">geolocationSuccess</a>` callback is invoked. _(Number)_
+- __timeout:__ The maximum length of time (msec) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. _(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/af6a5545/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationError.md b/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationError.md
index afe00ea..3408969 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationError.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationError.md
@@ -30,4 +30,4 @@ The user's callback function that is called when there is an error for geolocati
Parameters
----------
-- __error:__ The error returned by the device. (`<a href="../<a href="../Position/position.html">Position</a>Error/positionError.html"><a href="../Position/position.html">Position</a>Error</a>`)
+- __error:__ The error returned by the device. (`PositionError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationSuccess.md b/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationSuccess.md
index e26929c..95d3455 100644
--- a/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/www/docs/en/1.7.0/cordova/geolocation/parameters/geolocationSuccess.md
@@ -30,9 +30,9 @@ The user's callback function that is called when a geolocation position is avail
Parameters
----------
-- __position:__ The geolocation position returned by the device. (`<a href="../Position/position.html">Position</a>`)
+- __position:__ The geolocation position returned by the device. (`Position`)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function geolocationSuccess(position) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/MediaError/mediaError.md b/www/docs/en/1.7.0/cordova/media/MediaError/mediaError.md
index 8d8a960..ad11ca5 100644
--- a/www/docs/en/1.7.0/cordova/media/MediaError/mediaError.md
+++ b/www/docs/en/1.7.0/cordova/media/MediaError/mediaError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../media.html">Media</a>Error
+MediaError
==========
-A `<a href="../media.html">Media</a>Error` object is returned to the `<a href="../Parameters/mediaError.html">mediaError</a>` callback function when an error occurs.
+A `MediaError` object is returned to the `mediaError` callback function when an error occurs.
Properties
----------
@@ -32,14 +32,14 @@ Properties
Constants
---------
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_ABORTED`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_NETWORK`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_DECODE`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_NONE_SUPPORTED`
+- `MediaError.MEDIA_ERR_ABORTED`
+- `MediaError.MEDIA_ERR_NETWORK`
+- `MediaError.MEDIA_ERR_DECODE`
+- `MediaError.MEDIA_ERR_NONE_SUPPORTED`
Description
-----------
-The `<a href="../media.html">Media</a>Error` object is returned to the user through the `<a href="../Parameters/mediaError.html">mediaError</a>` callback function when an error occurs.
+The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/Parameters/mediaError.md b/www/docs/en/1.7.0/cordova/media/Parameters/mediaError.md
index 1881d31..1e0e3a8 100644
--- a/www/docs/en/1.7.0/cordova/media/Parameters/mediaError.md
+++ b/www/docs/en/1.7.0/cordova/media/Parameters/mediaError.md
@@ -30,4 +30,4 @@ A user specified callback function that is invoked when there is an error in med
Parameters
----------
-- __error:__ The error returned by the device. (`<a href="../<a href="../media.html">Media</a>Error/mediaError.html"><a href="../media.html">Media</a>Error</a>`)
+- __error:__ The error returned by the device. (`MediaError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/capture/CaptureCB.md b/www/docs/en/1.7.0/cordova/media/capture/CaptureCB.md
index 81cad0a..a897c8b 100644
--- a/www/docs/en/1.7.0/cordova/media/capture/CaptureCB.md
+++ b/www/docs/en/1.7.0/cordova/media/capture/CaptureCB.md
@@ -18,28 +18,28 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>CB
+CaptureCB
=========
> Invoked upon a successful media capture operation.
- function captureSuccess( <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>[] media<a href="../../file/fileobj/fileobj.html">File</a>s ) { ... };
+ function captureSuccess( MediaFile[] mediaFiles ) { ... };
Description
-----------
This function is invoked after a successful capture operation has completed. This means a media file has been captured, and either the user has exited the media capture application, or the capture limit has been reached.
-Each <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a> object describes a captured media file.
+Each MediaFile object describes a captured media file.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture callback
- function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ function captureSuccess(mediaFiles) {
var i, path, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- path = media<a href="../../file/fileobj/fileobj.html">File</a>s[i].fullPath;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
// do something interesting with the file
}
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/capture/CaptureError.md b/www/docs/en/1.7.0/cordova/media/capture/CaptureError.md
index a4f135c..f387287 100644
--- a/www/docs/en/1.7.0/cordova/media/capture/CaptureError.md
+++ b/www/docs/en/1.7.0/cordova/media/capture/CaptureError.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>Error
+CaptureError
============
> Encapsulates the error code resulting from a failed media capture operation.
@@ -31,8 +31,8 @@ Properties
Constants
---------
-- <a href="capture.html">Capture</a>Error.`CAPTURE_INTERNAL_ERR`: <a href="../../camera/camera.html">Camera</a> or microphone failed to capture image or sound.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_APPLICATION_BUSY`: <a href="../../camera/camera.html">Camera</a> application or audio capture application is currently serving other capture request.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
-- <a href="capture.html">Capture</a>Error.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
+- CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound.
+- CaptureError.`CAPTURE_APPLICATION_BUSY`: Camera application or audio capture application is currently serving other capture request.
+- CaptureError.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
+- CaptureError.`CAPTURE_NO_MEDIA_FILES`: User exited camera application 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/af6a5545/www/docs/en/1.7.0/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/capture/CaptureErrorCB.md b/www/docs/en/1.7.0/cordova/media/capture/CaptureErrorCB.md
index 02e9f62..7d24861 100644
--- a/www/docs/en/1.7.0/cordova/media/capture/CaptureErrorCB.md
+++ b/www/docs/en/1.7.0/cordova/media/capture/CaptureErrorCB.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>ErrorCB
+CaptureErrorCB
==============
> Invoked if an error occurs during a media capture operation.
- function captureError( <a href="capture.html">Capture</a>Error error ) { ... };
+ function captureError( CaptureError error ) { ... };
Description
-----------
This function is invoked if an error occurs when trying to launch a media capture operation and the capture application is busy, if an error occurs while the capture operation is taking place, or if the capture operation has been canceled by the user before any media files have been captured.
-This function is invoked with a <a href="capture.html">Capture</a>Error object containing an appropriate error code.
+This function is invoked with a CaptureError object containing an appropriate error code.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture error callback
var captureError = function(error) {
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/capture/ConfigurationData.md b/www/docs/en/1.7.0/cordova/media/capture/ConfigurationData.md
index 797d9da..2b32dfe 100644
--- a/www/docs/en/1.7.0/cordova/media/capture/ConfigurationData.md
+++ b/www/docs/en/1.7.0/cordova/media/capture/ConfigurationData.md
@@ -28,7 +28,7 @@ Description
This object is used to describe media capture modes supported by the device. The configuration data includes the MIME type, and capture dimensions (for video or image capture).
-The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). <a href="../../storage/storage.opendatabase.html">Example</a>s:
+The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples:
- video/3gpp
- video/quicktime
@@ -43,7 +43,7 @@ Properties
- __height:__ The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
- __width:__ The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// retrieve supported image modes
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/capture/MediaFile.getFormatData.md b/www/docs/en/1.7.0/cordova/media/capture/MediaFile.getFormatData.md
index afb3f3e..83b2fe8 100644
--- a/www/docs/en/1.7.0/cordova/media/capture/MediaFile.getFormatData.md
+++ b/www/docs/en/1.7.0/cordova/media/capture/MediaFile.getFormatData.md
@@ -18,20 +18,20 @@ license: >
under the License.
---
-<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData
+MediaFile.getFormatData
=======================
> Retrieves format information about the media capture file.
- media<a href="../../file/fileobj/fileobj.html">File</a>.getFormatData(
- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataSuccessCB successCallback,
- [<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataErrorCB errorCallback]
+ mediaFile.getFormatData(
+ MediaFileDataSuccessCB successCallback,
+ [MediaFileDataErrorCB errorCallback]
);
Description
-----------
-This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataSuccessCB callback with a <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data object. If the attempt fails, this function will invoke the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataErrorCB callback.
+This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the MediaFileDataSuccessCB callback with a MediaFileData object. If the attempt fails, this function will invoke the MediaFileDataErrorCB callback.
Supported Platforms
-------------------
@@ -43,12 +43,12 @@ Supported Platforms
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. Therefore, all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data objects will be returned with default values. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
+There is no API that provides format information of media files. Therefore, all MediaFileData objects will be returned with default values. See MediaFileData documentation.
Android Quirks
--------------
-The API for retrieving media file format information is limited. Therefore, not all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties are supported. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
+The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
iOS Quirks
----------
-The API for retrieving media file format information is limited. Therefore, not all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties are supported. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
\ No newline at end of file
+The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/capture/MediaFile.md b/www/docs/en/1.7.0/cordova/media/capture/MediaFile.md
index 0a10254..869b0ef 100644
--- a/www/docs/en/1.7.0/cordova/media/capture/MediaFile.md
+++ b/www/docs/en/1.7.0/cordova/media/capture/MediaFile.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>
+MediaFile
=========
> Encapsulates properties of a media capture file.
@@ -35,4 +35,4 @@ Properties
Methods
-------
-- __<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.getFormatData.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.getFormatData</a>:__ Retrieves the format information of the media file.
\ No newline at end of file
+- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/capture/MediaFileData.md b/www/docs/en/1.7.0/cordova/media/capture/MediaFileData.md
index ebac2e3..cc7de58 100644
--- a/www/docs/en/1.7.0/cordova/media/capture/MediaFileData.md
+++ b/www/docs/en/1.7.0/cordova/media/capture/MediaFileData.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data
+MediaFileData
=============
> Encapsulates format information about a media file.
@@ -34,7 +34,7 @@ Properties
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. So the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data object returned by the <a href="<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData.html"><a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData</a> function will have the following default values:
+There is no API that provides format information of media files. So the MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Not supported. The attribute will always be 0.
@@ -44,7 +44,7 @@ There is no API that provides format information of media files. So the <a href
Android Quirks
--------------
-Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties is as follows:
+Support for the MediaFileData properties is as follows:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Not supported. The attribute will always be 0.
@@ -54,7 +54,7 @@ Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fi
iOS Quirks
----------
-Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties is as follows:
+Support for the MediaFileData properties is as follows:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/media/capture/capture.md b/www/docs/en/1.7.0/cordova/media/capture/capture.md
index 1989c03..24cf551 100644
--- a/www/docs/en/1.7.0/cordova/media/capture/capture.md
+++ b/www/docs/en/1.7.0/cordova/media/capture/capture.md
@@ -27,22 +27,22 @@ Objects
-------
- Capture
-- <a href="captureAudioOptions.html">CaptureAudioOptions</a>
-- <a href="captureImageOptions.html">CaptureImageOptions</a>
-- <a href="captureVideoOptions.html">CaptureVideoOptions</a>
-- <a href="CaptureCB.html">CaptureCB</a>
-- <a href="<a href="CaptureError.html">CaptureError</a>CB.html"><a href="CaptureError.html">CaptureError</a>CB</a>
-- <a href="ConfigurationData.html">ConfigurationData</a>
-- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>
-- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data
+- CaptureAudioOptions
+- CaptureImageOptions
+- CaptureVideoOptions
+- CaptureCB
+- CaptureErrorCB
+- ConfigurationData
+- MediaFile
+- MediaFileData
Methods
-------
-- <a href="captureAudio.html">capture.captureAudio</a>
-- <a href="captureImage.html">capture.captureImage</a>
-- <a href="captureVideo.html">capture.captureVideo</a>
-- <a href="<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData.html"><a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData</a>
+- capture.captureAudio
+- capture.captureImage
+- capture.captureVideo
+- MediaFile.getFormatData
Scope
-----
@@ -55,16 +55,16 @@ The __capture__ object is assigned to the __navigator.device__ object, and there
Properties
----------
-- __supportedAudioModes:__ The audio recording formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
-- __supportedImageModes:__ The recording image sizes and formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
-- __supportedVideoModes:__ The recording video resolutions and formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
+- __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
-------
-- <a href="captureAudio.html">capture.captureAudio</a>: Launch the device audio recording application for recording audio clip(s).
-- <a href="captureImage.html">capture.captureImage</a>: Launch the device camera application for taking image(s).
-- <a href="captureVideo.html">capture.captureVideo</a>: Launch the device video recorder application for recording video(s).
+- capture.captureAudio: Launch the device audio recording application for recording audio clip(s).
+- capture.captureImage: Launch the device camera application for taking image(s).
+- capture.captureVideo: Launch the device video recorder application for recording video(s).
Supported Platforms
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org