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/10 23:28:05 UTC
[05/51] [partial] docs commit: Solidifying 'automatic' links.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md b/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md
index 61fc5fe..ad072a2 100644
--- a/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md
+++ b/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-FileTransfer
+<a href="../fileobj/fileobj.html">File</a>Transfer
==========
-FileTransfer is an object that allows you to upload files to a server or download files from a server.
+<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.
Properties
----------
@@ -37,7 +37,7 @@ Methods
Details
-------
-The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
+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.
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 Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
+- __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)_
- __options__ - Optional parameters such as file name and mimetype
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
// !! Assumes variable fileURI contains a valid URI to a text file on the device
@@ -75,7 +75,7 @@ __Quick Example__
console.log("upload error target " + error.target);
}
- var options = new FileUploadOptions();
+ var options = new <a href="../fileuploadoptions/fileuploadoptions.html"><a href="../fileobj/fileobj.html">File</a>UploadOptions</a>();
options.fileKey="file";
options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
options.mimeType="text/plain";
@@ -86,29 +86,29 @@ __Quick Example__
options.params = params;
- var ft = new FileTransfer();
+ var ft = new <a href="../fileobj/fileobj.html">File</a>Transfer();
ft.upload(fileURI, "http://some.server.com/upload.php", win, fail, options);
-__Full Example__
+__Full <a href="../../storage/storage.opendatabase.html">Example</a>__
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>File Transfer Example</title>
+ <title><a href="../fileobj/fileobj.html">File</a> Transfer <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// Retrieve image file location from specified source
- navigator.camera.getPicture(uploadPhoto,
+ navigator.<a href="../../camera/camera.getPicture.html">camera.getPicture</a>(uploadPhoto,
function(message) { alert('get picture failed'); },
{ quality: 50,
destinationType: navigator.camera.DestinationType.FILE_URI,
@@ -118,7 +118,7 @@ __Full Example__
}
function uploadPhoto(imageURI) {
- var options = new FileUploadOptions();
+ var options = new <a href="../fileuploadoptions/fileuploadoptions.html"><a href="../fileobj/fileobj.html">File</a>UploadOptions</a>();
options.fileKey="file";
options.fileName=imageURI.substr(imageURI.lastIndexOf('/')+1);
options.mimeType="image/jpeg";
@@ -129,7 +129,7 @@ __Full Example__
options.params = params;
- var ft = new FileTransfer();
+ var ft = new <a href="../fileobj/fileobj.html">File</a>Transfer();
ft.upload(imageURI, "http://some.server.com/upload.php", win, fail, options);
}
@@ -148,8 +148,8 @@ __Full Example__
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Upload File</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Upload <a href="../fileobj/fileobj.html">File</a></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 FileEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
// !! Assumes variable url contains a valid URI to a file on a server and filePath is a valid path on the device
- var fileTransfer = new FileTransfer();
+ var fileTransfer = new <a href="../fileobj/fileobj.html">File</a>Transfer();
fileTransfer.download(
url,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md b/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md
index f5fd9db..c843777 100644
--- a/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md
+++ b/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-FileTransferError
+<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error
========
-A `FileTransferError` object is returned via the error callback when an error occurs.
+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.
Properties
----------
@@ -34,11 +34,11 @@ Properties
Constants
---------
-- `FileTransferError.FILE_NOT_FOUND_ERR`
-- `FileTransferError.INVALID_URL_ERR`
-- `FileTransferError.CONNECTION_ERR`
+- `<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`
Description
-----------
-The `FileTransferError` object is returned via the error callback when an error occurs when uploading a file.
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md
index 2b02358..afd3e1a 100644
--- a/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-FileUploadOptions
+<a href="../fileobj/fileobj.html">File</a>UploadOptions
========
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
+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.
Properties
----------
@@ -36,7 +36,7 @@ Properties
Description
-----------
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
+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.
iOS Quirk
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md b/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md
index d82cde1..a910ccb 100644
--- a/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-FileUploadResult
+<a href="../fileobj/fileobj.html">File</a>UploadResult
========
-A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
+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.
Properties
----------
@@ -33,9 +33,9 @@ Properties
Description
-----------
-The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
+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.
iOS Quirks
----------
-- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object.
+- iOS does not include values for responseCode nor bytesSent in the success callback <a href="../fileobj/fileobj.html">File</a>UploadResult object.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md b/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md
index 46d6ae9..e67e71f 100644
--- a/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md
+++ b/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-FileWriter
+<a href="../fileobj/fileobj.html">File</a>Writer
==========
-FileWriter is an object that allows one to write a file.
+<a href="../fileobj/fileobj.html">File</a>Writer 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. _(FileError)_
+- __error:__ An object containing errors. _(<a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a>)_
- __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 `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.
+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.
-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.
+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.
Supported Platforms
-------------------
@@ -61,7 +61,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Seek Quick Example
+Seek Quick <a href="../../storage/storage.opendatabase.html">Example</a>
------------------------------
function win(writer) {
@@ -75,7 +75,7 @@ Seek Quick Example
entry.createWriter(win, fail);
-Truncate Quick Example
+Truncate Quick <a href="../../storage/storage.opendatabase.html">Example</a>
--------------------------
function win(writer) {
@@ -88,7 +88,7 @@ Truncate Quick Example
entry.createWriter(win, fail);
-Write Quick Example
+Write Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------------
function win(writer) {
@@ -104,7 +104,7 @@ Write Quick Example
entry.createWriter(win, fail);
-Append Quick Example
+Append Quick <a href="../../storage/storage.opendatabase.html">Example</a>
--------------------
function win(writer) {
@@ -121,7 +121,7 @@ Append Quick Example
entry.createWriter(win, fail);
-Abort Quick Example
+Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------------
function win(writer) {
@@ -138,35 +138,35 @@ Abort Quick Example
entry.createWriter(win, fail);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>FileWriter Example</title>
+ <title><a href="../fileobj/fileobj.html">File</a>Writer <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
+ 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 gotFS(fileSystem) {
- fileSystem.root.getFile("readme.txt", {create: true, exclusive: false}, gotFileEntry, fail);
+ 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);
}
- function gotFileEntry(fileEntry) {
- fileEntry.createWriter(gotFileWriter, 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 gotFileWriter(writer) {
+ function got<a href="../fileobj/fileobj.html">File</a>Writer(writer) {
writer.onwriteend = function(evt) {
console.log("contents of file now 'some sample text'");
writer.truncate(11);
@@ -189,7 +189,7 @@ Full Example
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Write File</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Write <a href="../fileobj/fileobj.html">File</a></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/flags/flags.md b/www/docs/en/1.8.1/cordova/file/flags/flags.md
index dedd8d4..c5e9c8d 100644
--- a/www/docs/en/1.8.1/cordova/file/flags/flags.md
+++ b/www/docs/en/1.8.1/cordova/file/flags/flags.md
@@ -21,7 +21,7 @@ license: >
Flags
=====
-This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively.
+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.
Properties
----------
@@ -37,11 +37,11 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// 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.
- lockFile = dataDir.getFile("lockfile.txt", {create: true, exclusive: true});
+ lock<a href="../fileobj/fileobj.html">File</a> = dataDir.get<a href="../fileobj/fileobj.html">File</a>("lockfile.txt", {create: true, exclusive: true});
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md b/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md
index d00b3a7..4b2da96 100644
--- a/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md
+++ b/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-LocalFileSystem
+Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>
===============
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
----------
-- __requestFileSystem:__ Requests a filesystem. _(Function)_
-- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_
+- __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)_
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.
+- `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.
Details
-------
-The `LocalFileSystem` object methods are defined on the __window__ object.
+The `Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>` object methods are defined on the __window__ object.
Supported Platforms
-------------------
@@ -48,7 +48,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Request File System Quick Example
+Request <a href="../fileobj/fileobj.html">File</a> System Quick <a href="../../storage/storage.opendatabase.html">Example</a>
---------------------------------
function onSuccess(fileSystem) {
@@ -56,41 +56,41 @@ Request File System Quick Example
}
// request the persistent file system
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
+ 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);
-Resolve Local File System URI Quick Example
+Resolve Local <a href="../fileobj/fileobj.html">File</a> System URI Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------------------------------------
function onSuccess(fileEntry) {
console.log(fileEntry.name);
}
- window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
+ window.resolveLocal<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>URI("file:///example.txt", onSuccess, onError);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Local File System Example</title>
+ <title>Local <a href="../fileobj/fileobj.html">File</a> System <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
- window.resolveLocalFileSystemURI("file:///example.txt", onResolveSuccess, fail);
+ 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 onFileSystemSuccess(fileSystem) {
+ function on<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>Success(fileSystem) {
console.log(fileSystem.name);
}
@@ -105,7 +105,7 @@ Full Example
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Local File System</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Local <a href="../fileobj/fileobj.html">File</a> System</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/metadata/metadata.md b/www/docs/en/1.8.1/cordova/file/metadata/metadata.md
index 487d07c..e4c5194 100644
--- a/www/docs/en/1.8.1/cordova/file/metadata/metadata.md
+++ b/www/docs/en/1.8.1/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 `DirectoryEntry` or `FileEntry` 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 `<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>` or `<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>` object.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
function win(metadata) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md b/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md
index 005aa49..f877c14 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md
@@ -37,7 +37,7 @@ Properties
Description
-----------
-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.
+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.
Supported Platforms
-------------------
@@ -49,7 +49,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// onSuccess Callback
@@ -71,29 +71,29 @@ Quick Example
alert('onError!');
};
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ navigator.geolocation.getCurrent<a href="../Position/position.html">Position</a>(onSuccess, onError);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Geolocation Position Example</title>
+ <title><a href="../geolocation.html">Geolocation</a> <a href="../Position/position.html">Position</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Set an event to wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is loaded and Ready
//
- function onDeviceReady() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ function on<a href="../../device/device.html">Device</a>Ready() {
+ navigator.geolocation.getCurrent<a href="../Position/position.html">Position</a>(onSuccess, onError);
}
- // Display `Position` properties from the geolocation
+ // Display `<a href="../Position/position.html">Position</a>` properties from the geolocation
//
function onSuccess(position) {
var div = document.getElementById('myDiv');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/Position/position.md b/www/docs/en/1.8.1/cordova/geolocation/Position/position.md
index 33be823..74a5486 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/Position/position.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/Position/position.md
@@ -26,7 +26,7 @@ Contains `Position` coordinates and timestamp, created by the geolocation API.
Properties
----------
-- __coords:__ A set of geographic coordinates. _(Coordinates)_
+- __coords:__ A set of geographic coordinates. _(<a href="../Coordinates/coordinates.html">Coordinates</a>)_
- __timestamp:__ Creation timestamp for `coords`. _(Date)_
Description
@@ -44,7 +44,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// onSuccess Callback
@@ -60,37 +60,37 @@ Quick Example
'Timestamp: ' + position.timestamp + '\n');
};
- // onError Callback receives a PositionError object
+ // onError Callback receives a <a href="../PositionError/positionError.html">PositionError</a> object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ navigator.<a href="../geolocation.getCurrentPosition.html">geolocation.getCurrentPosition</a>(onSuccess, onError);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="../../device/device.html">Device</a> Properties <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ function on<a href="../../device/device.html">Device</a>Ready() {
+ navigator.<a href="../geolocation.getCurrentPosition.html">geolocation.getCurrentPosition</a>(onSuccess, onError);
}
- // onSuccess Geolocation
+ // onSuccess <a href="../geolocation.html">Geolocation</a>
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -105,7 +105,7 @@ Full Example
position.timestamp + '<br />';
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a <a href="../PositionError/positionError.html">PositionError</a> object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md b/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md
index 3b38add..1b5b042 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-PositionError
+<a href="../Position/position.html">Position</a>Error
========
-A `PositionError` object is returned to the `geolocationError` callback when an error occurs.
+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.
Properties
----------
@@ -32,29 +32,29 @@ Properties
Constants
---------
-- `PositionError.PERMISSION_DENIED`
-- `PositionError.POSITION_UNAVAILABLE`
-- `PositionError.TIMEOUT`
+- `<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`
Description
-----------
-The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
+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.
-### `PositionError.PERMISSION_DENIED`
+### `<a href="../Position/position.html">Position</a>Error.PERMISSION_DENIED`
Returned when the user does not allow your application to retrieve
position information. This is dependent on the platform.
-### `PositionError.POSITION_UNAVAILABLE`
+### `<a href="../Position/position.html">Position</a>Error.POSITION_UNAVAILABLE`
Returned when the device was unable to retrieve a position. In general
this means the device has no network connectivity and/or cannot get a
satellite fix.
-### `PositionError.TIMEOUT`
+### `<a href="../Position/position.html">Position</a>Error.TIMEOUT`
Returned when the device was unable to retrieve a position within the
-time specified in the `geolocationOptions`' `timeout` property. When using
-in conjunction with `geolocation.watchPosition`, this error could be
-called into the `geolocationError` callback every `timeout` milliseconds.
+time specified in the `<a href="../parameters/geolocation.options.html">geolocationOptions</a>`' `timeout` property. When using
+in conjunction with `geolocation.watch<a href="../Position/position.html">Position</a>`, this error could be
+called into the `<a href="../parameters/geolocationError.html">geolocationError</a>` callback every `timeout` milliseconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md b/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md
index ac474ee..652f946 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md
+++ b/www/docs/en/1.8.1/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 `watchPosition` interval to clear. (String)
+- __watchID:__ The id of the `watch<a href="Position/position.html">Position</a>` interval to clear. (String)
Description
-----------
-`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
+`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`.
Supported Platforms
-------------------
@@ -45,46 +45,46 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// Options: watch for changes in position, and use the most
// accurate position acquisition method available.
//
- var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });
+ var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { enableHighAccuracy: true });
// ...later on...
navigator.geolocation.clearWatch(watchID);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
var watchID = null;
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Get the most accurate position updates available on the
// device.
var options = { enableHighAccuracy: true };
- watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
+ watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, options);
}
- // onSuccess Geolocation
+ // onSuccess <a href="geolocation.html">Geolocation</a>
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -102,7 +102,7 @@ Full Example
}
}
- // onError Callback receives a PositionError object
+ // 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
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md b/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md
index 672d3ef..4d78804 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -18,26 +18,26 @@ license: >
under the License.
---
-geolocation.getCurrentPosition
+geolocation.getCurrent<a href="Position/position.html">Position</a>
==============================
-Returns the device's current position as a `Position` object.
+Returns the device's current position as a `<a href="Position/position.html">Position</a>` object.
- navigator.geolocation.getCurrentPosition(geolocationSuccess,
- [geolocationError],
- [geolocationOptions]);
+ 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>]);
Parameters
----------
-- __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.
+- __<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.
Description
-----------
-`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.
+`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.
Supported Platforms
@@ -50,11 +50,11 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// onSuccess Callback
- // This method accepts a `Position` object, which contains
+ // This method accepts a `<a href="Position/position.html">Position</a>` object, which contains
// the current GPS coordinates
//
var onSuccess = function(position) {
@@ -68,37 +68,37 @@ Quick Example
'Timestamp: ' + position.timestamp + '\n');
};
- // onError Callback receives a PositionError object
+ // 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
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(onSuccess, onError);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ function on<a href="../device/device.html">Device</a>Ready() {
+ navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(onSuccess, onError);
}
- // onSuccess Geolocation
+ // onSuccess <a href="geolocation.html">Geolocation</a>
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -112,7 +112,7 @@ Full Example
'Timestamp: ' + position.timestamp + '<br />';
}
- // onError Callback receives a PositionError object
+ // 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
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/geolocation.md b/www/docs/en/1.8.1/cordova/geolocation/geolocation.md
index 63659cf..9d03a19 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/geolocation.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/geolocation.md
@@ -23,31 +23,31 @@ 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 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.
+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.
This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices (Android, BlackBerry, Bada, Windows Phone 7 and webOS, to be specific) 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, the Cordova implementation adheres to the W3C specification.
Methods
-------
-- geolocation.getCurrentPosition
-- geolocation.watchPosition
-- geolocation.clearWatch
+- 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>
Arguments
---------
-- geolocationSuccess
-- geolocationError
-- geolocationOptions
+- <a href="parameters/geolocationSuccess.html">geolocationSuccess</a>
+- <a href="parameters/geolocationError.html">geolocationError</a>
+- <a href="parameters/geolocation.options.html">geolocationOptions</a>
Objects (Read-Only)
-------------------
-- Position
-- PositionError
-- Coordinates
+- <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>
Permissions
-----------
@@ -82,7 +82,7 @@ Permissions
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md b/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md
index 335cbf2..1dc81db 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md
@@ -18,31 +18,31 @@ license: >
under the License.
---
-geolocation.watchPosition
+geolocation.watch<a href="Position/position.html">Position</a>
=========================
Watches for changes to the device's current position.
- var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
- [geolocationError],
- [geolocationOptions]);
+ 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>]);
Parameters
----------
-- __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.
+- __<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.
Returns
-------
-- __String__: returns a watch id that references the watch position interval. The watch id should be used with `geolocation.clearWatch` to stop watching for changes in position.
+- __String__: returns a watch id that references the watch position interval. The watch id should be used with `<a href="geolocation.clearWatch.html">geolocation.clearWatch</a>` to stop watching for changes in position.
Description
-----------
-`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.
+`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.
Supported Platforms
-------------------
@@ -54,11 +54,11 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// onSuccess Callback
- // This method accepts a `Position` object, which contains
+ // This method accepts a `<a href="Position/position.html">Position</a>` object, which contains
// the current GPS coordinates
//
function onSuccess(position) {
@@ -68,7 +68,7 @@ Quick Example
'<hr />' + element.innerHTML;
}
- // onError Callback receives a PositionError object
+ // 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
//
function onError(error) {
alert('code: ' + error.code + '\n' +
@@ -77,35 +77,35 @@ Quick Example
// Options: throw an error if no update is received every 30 seconds.
//
- var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
+ var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { timeout: 30000 });
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
var watchID = null;
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Throw an error if no update is received every 30 seconds
var options = { timeout: 30000 };
- watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
+ watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, options);
}
- // onSuccess Geolocation
+ // onSuccess <a href="geolocation.html">Geolocation</a>
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -114,7 +114,7 @@ Full Example
'<hr />' + element.innerHTML;
}
- // onError Callback receives a PositionError object
+ // 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
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md
index ff1b80d..6a5b3da 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md
@@ -22,15 +22,15 @@ geolocationOptions
==================
Optional parameters to customize the retrieval of the geolocation
-`Position`.
+`<a href="../Position/position.html">Position</a>`.
{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
Options
-------
-- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt 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 is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback will be invoked with a `PositionError.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds! _(Number)_
+- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `<a href="../Position/position.html">Position</a>` 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.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. If the `<a href="geolocationSuccess.html">geolocationSuccess</a>` callback is not invoked within this time, the `<a href="geolocationError.html">geolocationError</a>` callback will be invoked with a `<a href="../<a href="../Position/position.html">Position</a>Error/positionError.html"><a href="../Position/position.html">Position</a>Error</a>.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watch<a href="../Position/position.html">Position</a>`, the `<a href="geolocationError.html">geolocationError</a>` 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/89392fa8/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md
index 3408969..afe00ea 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md
+++ b/www/docs/en/1.8.1/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. (`PositionError`)
+- __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>`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md
index bffd951..cac8481 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md
@@ -21,7 +21,7 @@ license: >
geolocationSuccess
==================
-The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrentPosition`), or when the position changes (when using with `geolocation.watchPosition`).
+The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrent<a href="../Position/position.html">Position</a>`), or when the position changes (when using with `geolocation.watch<a href="../Position/position.html">Position</a>`).
function(position) {
// Do something
@@ -30,9 +30,9 @@ The user's callback function that is called when a geolocation position becomes
Parameters
----------
-- __position:__ The geolocation position returned by the device. (`Position`)
+- __position:__ The geolocation position returned by the device. (`<a href="../Position/position.html">Position</a>`)
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
function geolocationSuccess(position) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md b/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md
index ad11ca5..8d8a960 100644
--- a/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md
+++ b/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-MediaError
+<a href="../media.html">Media</a>Error
==========
-A `MediaError` object is returned to the `mediaError` callback function when an error occurs.
+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.
Properties
----------
@@ -32,14 +32,14 @@ Properties
Constants
---------
-- `MediaError.MEDIA_ERR_ABORTED`
-- `MediaError.MEDIA_ERR_NETWORK`
-- `MediaError.MEDIA_ERR_DECODE`
-- `MediaError.MEDIA_ERR_NONE_SUPPORTED`
+- `<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`
Description
-----------
-The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs.
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md b/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md
index 1e0e3a8..1881d31 100644
--- a/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md
+++ b/www/docs/en/1.8.1/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. (`MediaError`)
+- __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>`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md b/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md
index a897c8b..81cad0a 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md
@@ -18,28 +18,28 @@ license: >
under the License.
---
-CaptureCB
+<a href="capture.html">Capture</a>CB
=========
> Invoked upon a successful media capture operation.
- function captureSuccess( MediaFile[] mediaFiles ) { ... };
+ 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 ) { ... };
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 MediaFile object describes a captured media file.
+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.
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// capture callback
- function captureSuccess(mediaFiles) {
+ function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
var i, path, len;
- for (i = 0, len = mediaFiles.length; i < len; i += 1) {
- path = mediaFiles[i].fullPath;
+ 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;
// do something interesting with the file
}
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md b/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md
index f387287..a4f135c 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-CaptureError
+<a href="capture.html">Capture</a>Error
============
> Encapsulates the error code resulting from a failed media capture operation.
@@ -31,8 +31,8 @@ Properties
Constants
---------
-- 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.
+- <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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md b/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md
index 7d24861..02e9f62 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-CaptureErrorCB
+<a href="capture.html">Capture</a>ErrorCB
==============
> Invoked if an error occurs during a media capture operation.
- function captureError( CaptureError error ) { ... };
+ function captureError( <a href="capture.html">Capture</a>Error 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 CaptureError object containing an appropriate error code.
+This function is invoked with a <a href="capture.html">Capture</a>Error object containing an appropriate error code.
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// capture error callback
var captureError = function(error) {
- navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md b/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md
index 2b32dfe..797d9da 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md
+++ b/www/docs/en/1.8.1/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). Examples:
+The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). <a href="../../storage/storage.opendatabase.html">Example</a>s:
- 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 Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// retrieve supported image modes
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md b/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md
index 83b2fe8..afb3f3e 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md
@@ -18,20 +18,20 @@ license: >
under the License.
---
-MediaFile.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>.getFormatData
=======================
> Retrieves format information about the media capture file.
- mediaFile.getFormatData(
- MediaFileDataSuccessCB successCallback,
- [MediaFileDataErrorCB errorCallback]
+ 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]
);
Description
-----------
-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.
+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.
Supported Platforms
-------------------
@@ -43,12 +43,12 @@ Supported Platforms
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. Therefore, all MediaFileData objects will be returned with default values. See MediaFileData documentation.
+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.
Android Quirks
--------------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
+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.
iOS Quirks
----------
-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
+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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md b/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md
index 869b0ef..0a10254 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-MediaFile
+<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>
=========
> Encapsulates properties of a media capture file.
@@ -35,4 +35,4 @@ Properties
Methods
-------
-- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
\ No newline at end of file
+- __<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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md b/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md
index cc7de58..ebac2e3 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-MediaFileData
+<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
=============
> 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 MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
+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:
- __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 MediaFi
Android Quirks
--------------
-Support for the MediaFileData properties is as follows:
+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:
- __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 MediaFileData properties is as follows:
iOS Quirks
----------
-Support for the MediaFileData properties is as follows:
+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:
- __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/89392fa8/www/docs/en/1.8.1/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/capture.md b/www/docs/en/1.8.1/cordova/media/capture/capture.md
index 044d06f..4d53c33 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/capture.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/capture.md
@@ -27,22 +27,22 @@ Objects
-------
- Capture
-- CaptureAudioOptions
-- CaptureImageOptions
-- CaptureVideoOptions
-- CaptureCB
-- CaptureErrorCB
-- ConfigurationData
-- MediaFile
-- MediaFileData
+- <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
Methods
-------
-- capture.captureAudio
-- capture.captureImage
-- capture.captureVideo
-- MediaFile.getFormatData
+- <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>
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. (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[])
+- __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>[])
Methods
-------
-- 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).
+- <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).
Supported Platforms
@@ -101,7 +101,7 @@ Permissions
#### www/plugins.xml
- <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" />
+ <plugin name="Capture" value="org.apache.cordova.capture.<a href="../media.html">Media</a>Capture" />
#### www/config.xml
@@ -110,7 +110,7 @@ Permissions
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org