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:54 UTC
[10/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.8.0/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md b/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md
index 4334cb3..ea0ad2c 100644
--- a/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md
+++ b/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Entry
+FileEntry
==========
This object represents a file on a file system. It is defined in the [W3C Directories and Systems](http://www.w3.org/TR/file-system-api/) specification.
@@ -26,28 +26,28 @@ This object represents a file on a file system. It is defined in the [W3C Direc
Properties
----------
-- __is<a href="../fileobj/fileobj.html">File</a>:__ Always true. _(boolean)_
+- __isFile:__ Always true. _(boolean)_
- __isDirectory:__ Always false. _(boolean)_
-- __name:__ The name of the <a href="../fileobj/fileobj.html">File</a>Entry, excluding the path leading to it. _(DOMString)_
-- __fullPath:__ The full absolute path from the root to the <a href="../fileobj/fileobj.html">File</a>Entry. _(DOMString)_
+- __name:__ The name of the FileEntry, excluding the path leading to it. _(DOMString)_
+- __fullPath:__ The full absolute path from the root to the FileEntry. _(DOMString)_
NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by Cordova:
-- __filesystem:__ The file system on which the <a href="../fileobj/fileobj.html">File</a>Entry resides. _(<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>)_
+- __filesystem:__ The file system on which the FileEntry resides. _(FileSystem)_
Methods
-------
-- __get<a href="../metadata/metadata.html">Metadata</a>__: Look up metadata about a file.
-- __set<a href="../metadata/metadata.html">Metadata</a>__: Set metadata on a file.
+- __getMetadata__: Look up metadata about a file.
+- __setMetadata__: Set metadata on a file.
- __moveTo__: Move a file to a different location on the file system.
- __copyTo__: Copy a file to a different location on the file system.
- __toURL__: Return a URL that can be used to locate a file.
- __remove__: Delete a file.
- __getParent__: Look up the parent directory.
-- __createWriter__: Creates a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> object that can be used to write to a file.
-- __file__: Creates a <a href="../fileobj/fileobj.html">File</a> object containing file properties.
+- __createWriter__: Creates a FileWriter object that can be used to write to a file.
+- __file__: Creates a File object containing file properties.
Supported Platforms
@@ -59,18 +59,18 @@ Supported Platforms
- Windows Phone 7 ( Mango )
-get<a href="../metadata/metadata.html">Metadata</a>
+getMetadata
----------------
Look up metadata about a file.
__Parameters:__
-- __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="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</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 FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(metadata) {
console.log("Last Modified: " + metadata.modificationTime);
@@ -81,10 +81,10 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
}
// Request the metadata object for this entry
- entry.get<a href="../metadata/metadata.html">Metadata</a>(success, fail);
+ entry.getMetadata(success, fail);
-set<a href="../metadata/metadata.html">Metadata</a>
+setMetadata
----------------
Set metadata on a file.
@@ -97,7 +97,7 @@ __Parameters:__
- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success() {
console.log("The metadata was successfully set.");
@@ -108,7 +108,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
}
// Set the metadata
- entry.set<a href="../metadata/metadata.html">Metadata</a>(success, fail, { "com.apple.MobileBackup": 1});
+ entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
__iOS Quirk__
- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the file to be backed up by iCloud. Set the value to **0** to re-enable the file to be backed up by iCloud.
@@ -126,13 +126,13 @@ In addition, an attempt to move a file on top of an existing file must attempt t
__Parameters:__
-- __parent__ - The parent directory to which to move the file. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
+- __parent__ - The parent directory to which to move the file. _(DirectoryEntry)_
- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
-- __successCallback__ - A callback that is called with the <a href="../fileobj/fileobj.html">File</a>Entry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(entry) {
console.log("New Path: " + entry.fullPath);
@@ -142,13 +142,13 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
alert(error.code);
}
- function move<a href="../fileobj/fileobj.html">File</a>(entry) {
+ function moveFile(entry) {
var parent = document.getElementById('parent').value,
parentName = parent.substring(parent.lastIndexOf('/')+1),
- parentEntry = new <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>(parentName, parent);
+ parentEntry = new DirectoryEntry(parentName, parent);
// move the file to a new directory and rename it
- entry.moveTo(parentEntry, "new<a href="../fileobj/fileobj.html">File</a>.txt", success, fail);
+ entry.moveTo(parentEntry, "newFile.txt", success, fail);
}
@@ -161,13 +161,13 @@ Copy a file to a new location on the file system. It is an error to attempt to:
__Parameters:__
-- __parent__ - The parent directory to which to copy the file. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
+- __parent__ - The parent directory to which to copy the file. _(DirectoryEntry)_
- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
-- __successCallback__ - A callback that is called with the <a href="../fileobj/fileobj.html">File</a>Entry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function win(entry) {
console.log("New Path: " + entry.fullPath);
@@ -177,10 +177,10 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
alert(error.code);
}
- function copy<a href="../fileobj/fileobj.html">File</a>(entry) {
+ function copyFile(entry) {
var parent = document.getElementById('parent').value,
parentName = parent.substring(parent.lastIndexOf('/')+1),
- parentEntry = new <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>(parentName, parent);
+ parentEntry = new DirectoryEntry(parentName, parent);
// copy the file to a new directory and rename it
entry.copyTo(parentEntry, "file.copy", success, fail);
@@ -192,7 +192,7 @@ toURL
Returns a URL that can be used to locate the file.
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
// Request the URL for this entry
var fileURL = entry.toURL();
@@ -207,9 +207,9 @@ Deletes a file.
__Parameters:__
- __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(entry) {
console.log("Removal succeeded");
@@ -226,14 +226,14 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
getParent
---------
-Look up the parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a> containing the file.
+Look up the parent DirectoryEntry containing the file.
__Parameters:__
-- __successCallback__ - A callback that is called with the file's parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with the file's parent DirectoryEntry. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(parent) {
console.log("Parent Name: " + parent.name);
@@ -243,21 +243,21 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
alert(error.code);
}
- // Get the parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>
+ // Get the parent DirectoryEntry
entry.getParent(success, fail);
createWriter
------------
-Create a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> object associated with the file that the <a href="../fileobj/fileobj.html">File</a>Entry represents.
+Create a FileWriter object associated with the file that the FileEntry represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs while attempting to create the <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a>. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a FileWriter object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs while attempting to create the FileWriter. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(writer) {
writer.write("Some text to the file");
@@ -267,24 +267,24 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
alert(error.code);
}
- // create a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> to write to the file
+ // create a FileWriter to write to the file
entry.createWriter(success, fail);
file
----
-Return a <a href="../fileobj/fileobj.html">File</a> object that represents the current state of the file that this <a href="../fileobj/fileobj.html">File</a>Entry represents.
+Return a File object that represents the current state of the file that this FileEntry represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a <a href="../fileobj/fileobj.html">File</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when creating the <a href="../fileobj/fileobj.html">File</a> object (e.g. the underlying file no longer exists). Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a File object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when creating the File object (e.g. the underlying file no longer exists). Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(file) {
- console.log("<a href="../fileobj/fileobj.html">File</a> size: " + file.size);
+ console.log("File size: " + file.size);
}
function fail(error) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md b/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md
index 5bdd794..fa54c1f 100644
--- a/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md
+++ b/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Error
+FileError
========
-A '<a href="../fileobj/fileobj.html">File</a>Error' object is set when an error occurs in any of the <a href="../fileobj/fileobj.html">File</a> API methods.
+A 'FileError' object is set when an error occurs in any of the File API methods.
Properties
----------
@@ -31,20 +31,20 @@ Properties
Constants
---------
-- `<a href="../fileobj/fileobj.html">File</a>Error.NOT_FOUND_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.SECURITY_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.ABORT_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.NOT_READABLE_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.ENCODING_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.NO_MODIFICATION_ALLOWED_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.INVALID_STATE_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.SYNTAX_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.INVALID_MODIFICATION_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.QUOTA_EXCEEDED_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.TYPE_MISMATCH_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.PATH_EXISTS_ERR`
+- `FileError.NOT_FOUND_ERR`
+- `FileError.SECURITY_ERR`
+- `FileError.ABORT_ERR`
+- `FileError.NOT_READABLE_ERR`
+- `FileError.ENCODING_ERR`
+- `FileError.NO_MODIFICATION_ALLOWED_ERR`
+- `FileError.INVALID_STATE_ERR`
+- `FileError.SYNTAX_ERR`
+- `FileError.INVALID_MODIFICATION_ERR`
+- `FileError.QUOTA_EXCEEDED_ERR`
+- `FileError.TYPE_MISMATCH_ERR`
+- `FileError.PATH_EXISTS_ERR`
Description
-----------
-The `<a href="../fileobj/fileobj.html">File</a>Error` object is the only parameter of any of the <a href="../fileobj/fileobj.html">File</a> API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
+The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md b/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md
index 5910a3c..9920be9 100644
--- a/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md
+++ b/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md
@@ -35,7 +35,7 @@ Properties
Details
-------
-The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `<a href="../fileentry/fileentry.html">FileEntry</a>` object.
+The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filereader/filereader.md b/www/docs/en/1.8.0/cordova/file/filereader/filereader.md
index b529be1..f199c91 100644
--- a/www/docs/en/1.8.0/cordova/file/filereader/filereader.md
+++ b/www/docs/en/1.8.0/cordova/file/filereader/filereader.md
@@ -18,17 +18,17 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Reader
+FileReader
==========
-<a href="../fileobj/fileobj.html">File</a>Reader is an object that allows one to read a file.
+FileReader is an object that allows one to read a file.
Properties
----------
- __readyState:__ One of the three states the reader can be in EMPTY, LOADING or DONE.
- __result:__ The contents of the file that has been read. _(DOMString)_
-- __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)_
- __onloadstart:__ Called when the read starts. . _(Function)_
- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -NOT SUPPORTED
- __onload:__ Called when the read has successfully completed. _(Function)_
@@ -46,7 +46,7 @@ Methods
Details
-------
-The `<a href="../fileobj/fileobj.html">File</a>Reader` object is a way to read files from the devices file system. <a href="../fileobj/fileobj.html">File</a>s can be read as text or as a base64 data encoded string. Users register their own event listeners to receive the loadstart, progress, load, loadend, error and abort events.
+The `FileReader` object is a way to read files from the devices file system. Files can be read as text or as a base64 data encoded string. Users register their own event listeners to receive the loadstart, progress, load, loadend, error and abort events.
Supported Platforms
-------------------
@@ -63,11 +63,11 @@ __Parameters:__
- file - the file object to read
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function win(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("read success");
console.log(evt.target.result);
@@ -89,11 +89,11 @@ __Parameters:__
- file - the file object to read
- encoding - the encoding to use to encode the file's content. Default is UTF8.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function win(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("read success");
console.log(evt.target.result);
@@ -107,11 +107,11 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.file(win, fail);
-Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Abort Quick Example
-------------------
function win(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("read success");
console.log(evt.target.result);
@@ -126,13 +126,13 @@ Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.file(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>Reader <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>FileReader Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -140,30 +140,30 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// Wait for Cordova to load
//
function onLoad() {
- 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", null, got<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>, fail);
+ fileSystem.root.getFile("readme.txt", null, gotFileEntry, fail);
}
- function got<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>(fileEntry) {
- fileEntry.file(got<a href="../fileobj/fileobj.html">File</a>, fail);
+ function gotFileEntry(fileEntry) {
+ fileEntry.file(gotFile, fail);
}
- function got<a href="../fileobj/fileobj.html">File</a>(file){
+ function gotFile(file){
readDataUrl(file);
readAsText(file);
}
function readDataUrl(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("Read as data URL");
console.log(evt.target.result);
@@ -172,7 +172,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
}
function readAsText(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("Read as text");
console.log(evt.target.result);
@@ -187,8 +187,8 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Read <a href="../fileobj/fileobj.html">File</a></p>
+ <h1>Example</h1>
+ <p>Read File</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md b/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md
index 91bfa29..5dd8d7c 100644
--- a/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md
+++ b/www/docs/en/1.8.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.8.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.8.0/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filetransfer/filetransfer.md b/www/docs/en/1.8.0/cordova/file/filetransfer/filetransfer.md
index 7503c4b..b390dd2 100644
--- a/www/docs/en/1.8.0/cordova/file/filetransfer/filetransfer.md
+++ b/www/docs/en/1.8.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.8.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.8.0/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filetransfererror/filetransfererror.md b/www/docs/en/1.8.0/cordova/file/filetransfererror/filetransfererror.md
index c843777..f5fd9db 100644
--- a/www/docs/en/1.8.0/cordova/file/filetransfererror/filetransfererror.md
+++ b/www/docs/en/1.8.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
----------
@@ -34,11 +34,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.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/1.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md
index afd3e1a..2b02358 100644
--- a/www/docs/en/1.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/www/docs/en/1.8.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.8.0/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileuploadresult/fileuploadresult.md b/www/docs/en/1.8.0/cordova/file/fileuploadresult/fileuploadresult.md
index a910ccb..d82cde1 100644
--- a/www/docs/en/1.8.0/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/www/docs/en/1.8.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.8.0/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filewriter/filewriter.md b/www/docs/en/1.8.0/cordova/file/filewriter/filewriter.md
index 80650a9..f5b6a8b 100644
--- a/www/docs/en/1.8.0/cordova/file/filewriter/filewriter.md
+++ b/www/docs/en/1.8.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.8.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.8.0/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/flags/flags.md b/www/docs/en/1.8.0/cordova/file/flags/flags.md
index c5e9c8d..dedd8d4 100644
--- a/www/docs/en/1.8.0/cordova/file/flags/flags.md
+++ b/www/docs/en/1.8.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.8.0/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/localfilesystem/localfilesystem.md b/www/docs/en/1.8.0/cordova/file/localfilesystem/localfilesystem.md
index 86e296d..01cf09b 100644
--- a/www/docs/en/1.8.0/cordova/file/localfilesystem/localfilesystem.md
+++ b/www/docs/en/1.8.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.8.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.8.0/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/metadata/metadata.md b/www/docs/en/1.8.0/cordova/file/metadata/metadata.md
index e4c5194..487d07c 100644
--- a/www/docs/en/1.8.0/cordova/file/metadata/metadata.md
+++ b/www/docs/en/1.8.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.8.0/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/Coordinates/coordinates.md b/www/docs/en/1.8.0/cordova/geolocation/Coordinates/coordinates.md
index 4d59516..5a6e61b 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/Coordinates/coordinates.md
+++ b/www/docs/en/1.8.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
-------------------
@@ -49,7 +49,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
@@ -71,29 +71,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.8.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.8.0/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/Position/position.md b/www/docs/en/1.8.0/cordova/geolocation/Position/position.md
index 8fb4053..be03e0f 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/Position/position.md
+++ b/www/docs/en/1.8.0/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. _(<a href="../Coordinates/coordinates.html">Coordinates</a>)_
+- __coords:__ A set of geographic coordinates. _(Coordinates)_
- __timestamp:__ Creation timestamp for `coords`. _(Date)_
Description
@@ -44,7 +44,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
@@ -60,37 +60,37 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + 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.8.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');
@@ -105,7 +105,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
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.8.0/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/PositionError/positionError.md b/www/docs/en/1.8.0/cordova/geolocation/PositionError/positionError.md
index 1b5b042..3b38add 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/PositionError/positionError.md
+++ b/www/docs/en/1.8.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,29 +32,29 @@ 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.
-### `<a href="../Position/position.html">Position</a>Error.PERMISSION_DENIED`
+### `PositionError.PERMISSION_DENIED`
Returned when the user does not allow your application to retrieve
position information. This is dependent on the platform.
-### `<a href="../Position/position.html">Position</a>Error.POSITION_UNAVAILABLE`
+### `PositionError.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.
-### `<a href="../Position/position.html">Position</a>Error.TIMEOUT`
+### `PositionError.TIMEOUT`
Returned when the device was unable to retrieve a position within the
-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.
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md b/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md
index bf31e19..b8227bb 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md
+++ b/www/docs/en/1.8.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
-----------
-`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`.
+`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
Supported Platforms
-------------------
@@ -45,46 +45,46 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Options: watch for changes in position, and use the most
// accurate position acquisition method available.
//
- var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { enableHighAccuracy: true });
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });
// ...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.8.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() {
// Get the most accurate position updates available on the
// device.
var options = { enableHighAccuracy: true };
- 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');
@@ -102,7 +102,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.8.0/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/geolocation.getCurrentPosition.md b/www/docs/en/1.8.0/cordova/geolocation/geolocation.getCurrentPosition.md
index 1c6d02c..0f63538 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/www/docs/en/1.8.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
-----------
-`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.
+`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
@@ -50,11 +50,11 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-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) {
@@ -68,37 +68,37 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + 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.8.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');
@@ -112,7 +112,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + 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.8.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/geolocation.md b/www/docs/en/1.8.0/cordova/geolocation/geolocation.md
index 9d03a19..63659cf 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/geolocation.md
+++ b/www/docs/en/1.8.0/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 <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 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.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
Permissions
-----------
@@ -82,7 +82,7 @@ Permissions
### iOS
-#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md b/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md
index a3615ee..d4b8607 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md
+++ b/www/docs/en/1.8.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 should 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 should be used with `geolocation.clearWatch` to stop watching for changes in position.
Description
-----------
-`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.
+`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
-------------------
@@ -54,11 +54,11 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-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) {
@@ -68,7 +68,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' +
@@ -77,35 +77,35 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// Options: throw an error if no update is received every 30 seconds.
//
- var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { timeout: 30000 });
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-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.8.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() {
// Throw an error if no update is received every 30 seconds
var options = { timeout: 30000 };
- 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');
@@ -114,7 +114,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' +
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org