You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/12/17 21:31:37 UTC
svn commit: r1551686 [13/19] - in /cordova/site/public/docs/en: 3.3.0/ edge/
Modified: cordova/site/public/docs/en/edge/cordova_file_file.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_file_file.md.html?rev=1551686&r1=1551685&r2=1551686&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_file_file.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_file_file.md.html Tue Dec 17 20:31:35 2013
@@ -17,16 +17,18 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
-<meta name="generator" content="joDoc">
-<title>Apache Cordova API Documentation</title>
-<link rel="stylesheet" type="text/css" href="index.css">
-<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
-<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
-</head>
-<body>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+ <meta name="generator" content="joDoc">
+
+ <title>Apache Cordova API Documentation</title>
+
+ <link rel="stylesheet" type="text/css" href="index.css">
+ <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+ <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+ </head>
+ <body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -92,7 +94,8 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select></small>
+</optgroup></select>
+ </small>
</div>
<div id="subheader">
<h1>File</h1>
@@ -264,9 +267,7 @@ File System Quick Example</option>
<p>An API to read, write and navigate file system hierarchies, based on the <a class="external" href="http://www.w3.org/TR/FileAPI">w3c file api</a>.</p>
</blockquote>
-<h2>
-<a name="File_objects">Objects</a>
-</h2>
+<h2><a name="File_objects">Objects</a></h2>
<ul>
<li><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></li>
@@ -285,9 +286,8 @@ File System Quick Example</option>
<li><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a></li>
<li><a href="cordova_file_file.md.html#Metadata">Metadata</a></li>
</ul>
-<h2>
-<a name="File_accessing_the_feature">Accessing the Feature</a>
-</h2>
+
+<h2><a name="File_accessing_the_feature">Accessing the Feature</a></h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -383,17 +383,17 @@ platform-specific configuration settings
</code></pre>
</li>
</ul>
+
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
+
<h1><a name="File">File</a></h1>
<p>This object contains attributes of a single file.</p>
-<h2>
-<a name="File_properties">Properties</a>
-</h2>
+<h2><a name="File_properties">Properties</a></h2>
<ul>
<li><p><strong>name</strong>: The name of the file. <em>(DOMString)</em></p></li>
@@ -402,25 +402,21 @@ configuration. See <a href="guide_suppo
<li><p><strong>lastModifiedDate</strong>: The last time the file was modified. <em>(Date)</em></p></li>
<li><p><strong>size</strong>: The size of the file in bytes. <em>(long)</em></p></li>
</ul>
-<h2>
-<a name="File_methods">Methods</a>
-</h2>
+
+<h2><a name="File_methods">Methods</a></h2>
<ul>
<li>
<strong>slice</strong>: Select only a portion of the file to be read.</li>
</ul>
-<h2>
-<a name="File_details">Details</a>
-</h2>
+
+<h2><a name="File_details">Details</a></h2>
<p>The <code><a href="cordova_file_file.md.html#File">File</a></code> object contains attributes of a single file. You can get
an instance of a <code><a href="cordova_file_file.md.html#File">File</a></code> object by calling a <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> object's
<code>file()</code> method.</p>
-<h2>
-<a name="File_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="File_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -430,9 +426,8 @@ an instance of a <code><a href="cordova_
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="File_slice">slice</a>
-</h2>
+
+<h2><a name="File_slice">slice</a></h2>
<p>Return a new <code><a href="cordova_file_file.md.html#File">File</a></code> object, for which <code><a href="cordova_file_file.md.html#FileReader">FileReader</a></code> returns only the
specified portion of the file. Negative values for <code>start</code> or <code>end</code>
@@ -445,6 +440,7 @@ relative to the current slice. (See the
<li><p><strong>start</strong>: The index of the first byte to read, inclusive.</p></li>
<li><p><strong>end</strong>: The index of the byte after the last one to read.</p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>var slicedFile = file.slice(10, 30);
@@ -465,14 +461,14 @@ var slice3 = file.slice(120, 135);
<li>Android</li>
<li>iOS</li>
</ul>
+
<hr>
+
<h1><a name="FileReader">FileReader</a></h1>
<p>The <code><a href="cordova_file_file.md.html#FileReader">FileReader</a></code> allows basic access to a file.</p>
-<h2>
-<a name="FileReader_properties">Properties</a>
-</h2>
+<h2><a name="FileReader_properties">Properties</a></h2>
<ul>
<li><p><strong>readyState</strong>: One of the reader's three possible states, either <code>EMPTY</code>, <code>LOADING</code> or <code>DONE</code>.</p></li>
@@ -484,6 +480,7 @@ var slice3 = file.slice(120, 135);
<li><p><strong>onerror</strong>: Called when the read has failed. <em>(Function)</em></p></li>
<li><p><strong>onloadend</strong>: Called when the request has completed (either in success or failure). <em>(Function)</em></p></li>
</ul>
+
<p><strong>NOTE</strong>: The following porperty is not supported:</p>
<ul>
@@ -491,9 +488,8 @@ var slice3 = file.slice(120, 135);
<strong>onprogress</strong>: Called while reading the file, reporting progress in terms of <code>progress.loaded</code>/<code>progress.total</code>. <em>(Function)</em>
</li>
</ul>
-<h2>
-<a name="FileReader_methods">Methods</a>
-</h2>
+
+<h2><a name="FileReader_methods">Methods</a></h2>
<ul>
<li><p><strong>abort</strong>: Aborts reading file.</p></li>
@@ -502,18 +498,15 @@ var slice3 = file.slice(120, 135);
<li><p><strong>readAsBinaryString</strong>: Reads file as binary and returns a binary string.</p></li>
<li><p><strong>readAsArrayBuffer</strong>: Reads file as an <code>ArrayBuffer</code>.</p></li>
</ul>
-<h2>
-<a name="FileReader_details">Details</a>
-</h2>
+
+<h2><a name="FileReader_details">Details</a></h2>
<p>The <code><a href="cordova_file_file.md.html#FileReader">FileReader</a></code> object offers a way to read files from the device's
file system. Files can be read as text or as a base64 data-encoded
string. Event listeners receive the <code>loadstart</code>, <code>progress</code>, <code>load</code>,
<code>loadend</code>, <code>error</code>, and <code>abort</code> events.</p>
-<h2>
-<a name="FileReader_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="FileReader_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -523,9 +516,8 @@ string. Event listeners receive the <co
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="FileReader_readasdataurl">readAsDataURL</a>
-</h2>
+
+<h2><a name="FileReader_readasdataurl">readAsDataURL</a></h2>
<p><strong>Parameters</strong>:</p>
@@ -533,9 +525,8 @@ string. Event listeners receive the <co
<li>
<strong>file</strong>: the file object to read.</li>
</ul>
-<h2>
-<a name="FileReader_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="FileReader_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function win(file) {
var reader = new <a href="cordova_file_file.md.html#FileReader">FileReader</a>();
@@ -553,9 +544,7 @@ var fail = function (error) {
entry.file(win, fail);
</code></pre>
-<h2>
-<a name="FileReader_readastext">readAsText</a>
-</h2>
+<h2><a name="FileReader_readastext">readAsText</a></h2>
<p><strong>Parameters</strong>:</p>
@@ -563,9 +552,8 @@ entry.file(win, fail);
<li><p><strong>file</strong>: the file object to read.</p></li>
<li><p><strong>encoding</strong>: the encoding to use to encode the file's content. Default is UTF8.</p></li>
</ul>
-<h2>
-<a name="FileReader_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="FileReader_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function win(file) {
var reader = new <a href="cordova_file_file.md.html#FileReader">FileReader</a>();
@@ -583,9 +571,7 @@ var fail = function (error) {
entry.file(win, fail);
</code></pre>
-<h2>
-<a name="FileReader_abort">abort</a>
-</h2>
+<h2><a name="FileReader_abort">abort</a></h2>
<pre class="prettyprint"><code>function win(file) {
var reader = new <a href="cordova_file_file.md.html#FileReader">FileReader</a>();
@@ -604,9 +590,7 @@ function fail(error) {
entry.file(win, fail);
</code></pre>
-<h2>
-<a name="FileReader_full_example">Full Example</a>
-</h2>
+<h2><a name="FileReader_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -670,16 +654,13 @@ entry.file(win, fail);
</html>
</code></pre>
-<h2>
-<a name="FileReader_ios_quirks">iOS Quirks</a>
-</h2>
+<h2><a name="FileReader_ios_quirks">iOS Quirks</a></h2>
<ul>
<li>The <strong>encoding</strong> parameter is not supported, and UTF8 encoding is always in effect.</li>
</ul>
-<h2>
-<a name="FileReader_readasbinarystring">readAsBinaryString</a>
-</h2>
+
+<h2><a name="FileReader_readasbinarystring">readAsBinaryString</a></h2>
<p>Currently supported on iOS and Android only.</p>
@@ -689,9 +670,8 @@ entry.file(win, fail);
<li>
<strong>file</strong>: the file object to read.</li>
</ul>
-<h2>
-<a name="FileReader_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="FileReader_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function win(file) {
var reader = new <a href="cordova_file_file.md.html#FileReader">FileReader</a>();
@@ -709,9 +689,7 @@ var fail = function (error) {
entry.file(win, fail);
</code></pre>
-<h2>
-<a name="FileReader_readasarraybuffer">readAsArrayBuffer</a>
-</h2>
+<h2><a name="FileReader_readasarraybuffer">readAsArrayBuffer</a></h2>
<p>Currently supported on iOS and Android only.</p>
@@ -721,9 +699,8 @@ entry.file(win, fail);
<li>
<strong>file</strong>: the file object to read.</li>
</ul>
-<h2>
-<a name="FileReader_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="FileReader_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function win(file) {
var reader = new <a href="cordova_file_file.md.html#FileReader">FileReader</a>();
@@ -742,13 +719,12 @@ entry.file(win, fail);
</code></pre>
<hr>
+
<h1><a name="FileWriter">FileWriter</a></h1>
<p>As object that allows you to create and write data to a file.</p>
-<h2>
-<a name="FileWriter_properties">Properties</a>
-</h2>
+<h2><a name="FileWriter_properties">Properties</a></h2>
<ul>
<li><p><strong>readyState</strong>: One of the three possible states, either <code>INIT</code>, <code>WRITING</code>, or <code>DONE</code>.</p></li>
@@ -762,6 +738,7 @@ entry.file(win, fail);
<li><p><strong>onerror</strong>: Called when the write has failed. <em>(Function)</em></p></li>
<li><p><strong>onwriteend</strong>: Called when the request has completed (either in success or failure). <em>(Function)</em></p></li>
</ul>
+
<p>The following property is <em>not</em> supported:</p>
<ul>
@@ -775,9 +752,8 @@ entry.file(win, fail);
<li><p><strong>truncate</strong>: Shortens the file to the specified length.</p></li>
<li><p><strong>write</strong>: Writes data to the file.</p></li>
</ul>
-<h2>
-<a name="FileWriter_details">Details</a>
-</h2>
+
+<h2><a name="FileWriter_details">Details</a></h2>
<p>The <code><a href="cordova_file_file.md.html#FileWriter">FileWriter</a></code> object offers a way to write UTF-8 encoded files to
the device file system. Applications respond to <code>writestart</code>,
@@ -793,9 +769,7 @@ write to the end of the file.</p>
<p>Text data is supported by all platforms listed below. Text is encoded as UTF-8 before being written to the filesystem. Some platforms also support binary data, which can be passed in as either an ArrayBuffer or a Blob.</p>
-<h2>
-<a name="FileWriter_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="FileWriter_supported_platforms">Supported Platforms</a></h2>
<p>Text and Binary Support:</p>
@@ -804,6 +778,7 @@ write to the end of the file.</p>
<li>Android</li>
<li>iOS</li>
</ul>
+
<p>Text-only Support:</p>
<ul>
@@ -811,9 +786,8 @@ write to the end of the file.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="FileWriter_seek_quick_example">Seek Quick Example</a>
-</h2>
+
+<h2><a name="FileWriter_seek_quick_example">Seek Quick Example</a></h2>
<pre class="prettyprint"><code>function win(writer) {
// fast forwards file pointer to end of file
@@ -827,9 +801,7 @@ var fail = function(evt) {
entry.createWriter(win, fail);
</code></pre>
-<h2>
-<a name="FileWriter_truncate_quick_example">Truncate Quick Example</a>
-</h2>
+<h2><a name="FileWriter_truncate_quick_example">Truncate Quick Example</a></h2>
<pre class="prettyprint"><code>function win(writer) {
writer.truncate(10);
@@ -842,9 +814,7 @@ var fail = function(evt) {
entry.createWriter(win, fail);
</code></pre>
-<h2>
-<a name="FileWriter_write_quick_example">Write Quick Example</a>
-</h2>
+<h2><a name="FileWriter_write_quick_example">Write Quick Example</a></h2>
<pre class="prettyprint"><code>function win(writer) {
writer.onwrite = function(evt) {
@@ -860,9 +830,7 @@ var fail = function(evt) {
entry.createWriter(win, fail);
</code></pre>
-<h2>
-<a name="FileWriter_binary_write_quick_example">Binary Write Quick Example</a>
-</h2>
+<h2><a name="FileWriter_binary_write_quick_example">Binary Write Quick Example</a></h2>
<pre class="prettyprint"><code>function win(writer) {
var data = new ArrayBuffer(5),
@@ -883,9 +851,7 @@ var fail = function(evt) {
entry.createWriter(win, fail);
</code></pre>
-<h2>
-<a name="FileWriter_append_quick_example">Append Quick Example</a>
-</h2>
+<h2><a name="FileWriter_append_quick_example">Append Quick Example</a></h2>
<pre class="prettyprint"><code>function win(writer) {
writer.onwrite = function(evt) {
@@ -902,9 +868,7 @@ var fail = function(evt) {
entry.createWriter(win, fail);
</code></pre>
-<h2>
-<a name="FileWriter_abort_quick_example">Abort Quick Example</a>
-</h2>
+<h2><a name="FileWriter_abort_quick_example">Abort Quick Example</a></h2>
<pre class="prettyprint"><code>function win(writer) {
writer.onwrite = function(evt) {
@@ -921,9 +885,7 @@ var fail = function(evt) {
entry.createWriter(win, fail);
</code></pre>
-<h2>
-<a name="FileWriter_full_example">Full Example</a>
-</h2>
+<h2><a name="FileWriter_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -981,30 +943,26 @@ entry.createWriter(win, fail);
</code></pre>
<hr>
+
<h1><a name="FileSystem">FileSystem</a></h1>
<p>This object represents a file system.</p>
-<h2>
-<a name="FileSystem_properties">Properties</a>
-</h2>
+<h2><a name="FileSystem_properties">Properties</a></h2>
<ul>
<li><p><strong>name</strong>: The name of the file system. <em>(DOMString)</em></p></li>
<li><p><strong>root</strong>: The root directory of the file system. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em></p></li>
</ul>
-<h2>
-<a name="FileSystem_details">Details</a>
-</h2>
+
+<h2><a name="FileSystem_details">Details</a></h2>
<p>The <code><a href="cordova_file_file.md.html#FileSystem">FileSystem</a></code> object represents information about the file system.
The name of the file system is unique across the list of exposed
file systems. The root property contains a <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> object
that represents the file system's root directory.</p>
-<h2>
-<a name="FileSystem_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="FileSystem_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1014,10 +972,9 @@ that represents the file system's root d
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="FileSystem_file_system_quick_example">
-File System Quick Example</a>
-</h2>
+
+<h2><a name="FileSystem_file_system_quick_example">
+File System Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(fileSystem) {
console.log(fileSystem.name);
@@ -1028,9 +985,7 @@ File System Quick Example</a>
window.<a href="cordova_file_file.md.html#requestFileSystem">requestFileSystem</a>(<a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.PERSISTENT, 0, onSuccess, null);
</code></pre>
-<h2>
-<a name="FileSystem_full_example">Full Example</a>
-</h2>
+<h2><a name="FileSystem_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -1069,15 +1024,14 @@ window.<a href="cordova_file_file.md.htm
</code></pre>
<hr>
+
<h1><a name="FileEntry">FileEntry</a></h1>
<p>Represents a file on a file system, as defined in the
<a class="external" href="http://www.w3.org/TR/file-system-api/">W3C Directories and Systems</a>
specification.</p>
-<h2>
-<a name="FileEntry_properties">Properties</a>
-</h2>
+<h2><a name="FileEntry_properties">Properties</a></h2>
<ul>
<li><p><strong>isFile</strong>: Always <code>true</code>. <em>(boolean)</em></p></li>
@@ -1085,6 +1039,7 @@ specification.</p>
<li><p><strong>name</strong>: The name of the <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code>, excluding the path leading to it. <em>(DOMString)</em></p></li>
<li><p><strong>fullPath</strong>: The full absolute path from the root to the <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code>. <em>(DOMString)</em></p></li>
</ul>
+
<p><strong>NOTE</strong>: The following attribute is defined by the W3C specification,
but is <em>not</em> supported:</p>
@@ -1093,9 +1048,8 @@ but is <em>not</em> supported:</p>
<strong>filesystem</strong>: The file system on which the <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> resides. <em>(<a href="cordova_file_file.md.html#FileSystem">FileSystem</a>)</em>
</li>
</ul>
-<h2>
-<a name="FileEntry_methods">Methods</a>
-</h2>
+
+<h2><a name="FileEntry_methods">Methods</a></h2>
<ul>
<li><p><strong>getMetadata</strong>: Look up metadata about a file.</p></li>
@@ -1108,9 +1062,8 @@ but is <em>not</em> supported:</p>
<li><p><strong>createWriter</strong>: Creates a <code><a href="cordova_file_file.md.html#FileWriter">FileWriter</a></code> object that can be used to write to a file.</p></li>
<li><p><strong>file</strong>: Creates a <code><a href="cordova_file_file.md.html#File">File</a></code> object containing file properties.</p></li>
</ul>
-<h2>
-<a name="FileEntry_supported_platforms">Supported Platforms</a>
-</h2>
+
+<h2><a name="FileEntry_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1120,9 +1073,8 @@ but is <em>not</em> supported:</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="FileEntry_getmetadata">getMetadata</a>
-</h2>
+
+<h2><a name="FileEntry_getmetadata">getMetadata</a></h2>
<p>Look up metadata about a file.</p>
@@ -1132,6 +1084,7 @@ but is <em>not</em> supported:</p>
<li><p><strong>successCallback</strong>: A callback that is passed a <code><a href="cordova_file_file.md.html#Metadata">Metadata</a></code> object. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when retrieving the <code><a href="cordova_file_file.md.html#Metadata">Metadata</a></code>. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(metadata) {
@@ -1146,9 +1099,7 @@ function fail(error) {
entry.getMetadata(success, fail);
</code></pre>
-<h2>
-<a name="FileEntry_setmetadata">setMetadata</a>
-</h2>
+<h2><a name="FileEntry_setmetadata">setMetadata</a></h2>
<p>Set metadata on a file.</p>
@@ -1157,6 +1108,7 @@ entry.getMetadata(success, fail);
<ul>
<li>This sets the extended attributes of a file.</li>
</ul>
+
<p><strong>Parameters</strong>:</p>
<ul>
@@ -1164,6 +1116,7 @@ entry.getMetadata(success, fail);
<li><p><strong>errorCallback</strong>: A callback that executes when the metadata is not successfully set. <em>(Function)</em></p></li>
<li><p><strong>metadataObject</strong>: An object that contains the metadata's keys and values. <em>(Object)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success() {
@@ -1183,6 +1136,7 @@ entry.setMetadata(success, fail, { "com.
<ul>
<li>Only the <code>com.apple.MobileBackup</code> extended attribute is supported. Set the value to <code>1</code> to prevent the file from being backed up to iCloud. Set the value to <code>0</code> to re-enable the file to be backed up to iCloud.</li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function setFileMetadata(localFileSystem, filePath, metadataKey, metadataValue)
@@ -1217,9 +1171,7 @@ entry.setMetadata(success, fail, { "com.
setFileMetadata(<a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
</code></pre>
-<h2>
-<a name="FileEntry_moveto">moveTo</a>
-</h2>
+<h2><a name="FileEntry_moveto">moveTo</a></h2>
<p>Move a file to a different location on the file system. An error
results if the app attempts to:</p>
@@ -1228,6 +1180,7 @@ results if the app attempts to:</p>
<li><p>move a file into its parent if a name different from its current one isn't provided;</p></li>
<li><p>move a file to a path occupied by a directory;</p></li>
</ul>
+
<p>In addition, moving a file on top of an existing file attempts to
delete and replace that file.</p>
@@ -1239,6 +1192,7 @@ delete and replace that file.</p>
<li><p><strong>successCallback</strong>: A callback that is passed the new file's <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> object. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to move the file. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(entry) {
@@ -1259,9 +1213,7 @@ function moveFile(entry) {
}
</code></pre>
-<h2>
-<a name="FileEntry_copyto">copyTo</a>
-</h2>
+<h2><a name="FileEntry_copyto">copyTo</a></h2>
<p>Copy a file to a new location on the file system. An error results if
the app attempts to:</p>
@@ -1269,6 +1221,7 @@ the app attempts to:</p>
<ul>
<li>copy a file into its parent if a name different from its current one is not provided.</li>
</ul>
+
<p><strong>Parameters</strong>:</p>
<ul>
@@ -1277,6 +1230,7 @@ the app attempts to:</p>
<li><p><strong>successCallback</strong>: A callback that is passed the new file's <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> object. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to copy the file. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function win(entry) {
@@ -1297,9 +1251,7 @@ function copyFile(entry) {
}
</code></pre>
-<h2>
-<a name="FileEntry_tourl">toURL</a>
-</h2>
+<h2><a name="FileEntry_tourl">toURL</a></h2>
<p>Returns a URL that can be used to locate the file.</p>
@@ -1310,9 +1262,7 @@ var fileURL = entry.toURL();
console.log(fileURL);
</code></pre>
-<h2>
-<a name="FileEntry_remove">remove</a>
-</h2>
+<h2><a name="FileEntry_remove">remove</a></h2>
<p>Deletes a file.</p>
@@ -1322,6 +1272,7 @@ console.log(fileURL);
<li><p><strong>successCallback</strong>: A callback that executes after the file has been deleted. Invoked with no parameters. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to delete the file. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(entry) {
@@ -1336,9 +1287,7 @@ function fail(error) {
entry.remove(success, fail);
</code></pre>
-<h2>
-<a name="FileEntry_getparent">getParent</a>
-</h2>
+<h2><a name="FileEntry_getparent">getParent</a></h2>
<p>Look up the parent <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> containing the file.</p>
@@ -1348,6 +1297,7 @@ entry.remove(success, fail);
<li><p><strong>successCallback</strong>: A callback that is passed the file's parent <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to retrieve the parent <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(parent) {
@@ -1362,9 +1312,7 @@ function fail(error) {
entry.getParent(success, fail);
</code></pre>
-<h2>
-<a name="FileEntry_createwriter">createWriter</a>
-</h2>
+<h2><a name="FileEntry_createwriter">createWriter</a></h2>
<p>Create a <code><a href="cordova_file_file.md.html#FileWriter">FileWriter</a></code> object associated with the file represented by the <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code>.</p>
@@ -1374,6 +1322,7 @@ entry.getParent(success, fail);
<li><p><strong>successCallback</strong>: A callback that is passed a <code><a href="cordova_file_file.md.html#FileWriter">FileWriter</a></code> object. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs while attempting to create the <a href="cordova_file_file.md.html#FileWriter">FileWriter</a>. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(writer) {
@@ -1388,9 +1337,7 @@ function fail(error) {
entry.createWriter(success, fail);
</code></pre>
-<h2>
-<a name="FileEntry_file">file</a>
-</h2>
+<h2><a name="FileEntry_file">file</a></h2>
<p>Return a <code><a href="cordova_file_file.md.html#File">File</a></code> object that represents the current state of the file
that this <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> represents.</p>
@@ -1401,6 +1348,7 @@ that this <code><a href="cordova_file_fi
<li><p><strong>successCallback</strong>: A callback that is passed a <code><a href="cordova_file_file.md.html#File">File</a></code> object. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when creating the <code><a href="cordova_file_file.md.html#File">File</a></code> object, such as when the file no longer exists. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(file) {
@@ -1416,15 +1364,14 @@ entry.file(success, fail);
</code></pre>
<hr>
+
<h1><a name="DirectoryEntry">DirectoryEntry</a></h1>
<p>This object represents a directory on a file system, as defined by the
<a class="external" href="http://www.w3.org/TR/file-system-api/">W3C Directories and Systems</a>
specification.</p>
-<h2>
-<a name="DirectoryEntry_properties">Properties</a>
-</h2>
+<h2><a name="DirectoryEntry_properties">Properties</a></h2>
<ul>
<li><p><strong>isFile</strong>: Always <code>false</code>. <em>(boolean)</em></p></li>
@@ -1432,6 +1379,7 @@ specification.</p>
<li><p><strong>name</strong>: The name of the <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>, excluding the path leading to it. <em>(DOMString)</em></p></li>
<li><p><strong>fullPath</strong>: The full absolute path from the root to the <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. <em>(DOMString)</em></p></li>
</ul>
+
<p><strong>NOTE</strong>: The following attribute is defined by the W3C specification,
but is <em>not</em> supported:</p>
@@ -1440,9 +1388,8 @@ but is <em>not</em> supported:</p>
<strong>filesystem</strong>: The file system on which the <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> resides. <em>(<a href="cordova_file_file.md.html#FileSystem">FileSystem</a>)</em>
</li>
</ul>
-<h2>
-<a name="DirectoryEntry_methods">Methods</a>
-</h2>
+
+<h2><a name="DirectoryEntry_methods">Methods</a></h2>
<p>The following methods can be invoked on a <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> object:</p>
@@ -1459,9 +1406,8 @@ but is <em>not</em> supported:</p>
<li><p><strong>getFile</strong>: Create or look up a file.</p></li>
<li><p><strong>removeRecursively</strong>: Delete a directory and all of its contents.</p></li>
</ul>
-<h2>
-<a name="DirectoryEntry_supported_platforms">Supported Platforms</a>
-</h2>
+
+<h2><a name="DirectoryEntry_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1471,9 +1417,8 @@ but is <em>not</em> supported:</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="DirectoryEntry_getmetadata">getMetadata</a>
-</h2>
+
+<h2><a name="DirectoryEntry_getmetadata">getMetadata</a></h2>
<p>Look up metadata about a directory.</p>
@@ -1483,6 +1428,7 @@ but is <em>not</em> supported:</p>
<li><p><strong>successCallback</strong>: A callback function to execute with a <code><a href="cordova_file_file.md.html#Metadata">Metadata</a></code> object. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback function to execute if an error occurs when retrieving the <code><a href="cordova_file_file.md.html#Metadata">Metadata</a></code>. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(metadata) {
@@ -1497,9 +1443,7 @@ function fail(error) {
entry.getMetadata(success, fail);
</code></pre>
-<h2>
-<a name="DirectoryEntry_setmetadata">setMetadata</a>
-</h2>
+<h2><a name="DirectoryEntry_setmetadata">setMetadata</a></h2>
<p>Sets a directory's extended attributes, or metadata. <em>Currently works
only on iOS.</em></p>
@@ -1511,6 +1455,7 @@ only on iOS.</em></p>
<li><p><strong>errorCallback</strong>: A callback that executes when the metadata fails to be set. <em>(Function)</em></p></li>
<li><p><strong>metadataObject</strong>: An object that contains the metadata's keys and values. <em>(Object)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success() {
@@ -1530,6 +1475,7 @@ entry.setMetadata(success, fail, { "com.
<ul>
<li>Only the <code>com.apple.MobileBackup</code> extended attribute is supported. Set the value to <code>1</code> to prevent the directory from being backed up to iCloud. Set the value to <code>0</code> to re-enable the directory to be backed up to iCloud.</li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function setFolderMetadata(localFileSystem, subFolder, metadataKey, metadataValue)
@@ -1564,9 +1510,7 @@ entry.setMetadata(success, fail, { "com.
setFolderMetadata(<a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
</code></pre>
-<h2>
-<a name="DirectoryEntry_moveto">moveTo</a>
-</h2>
+<h2><a name="DirectoryEntry_moveto">moveTo</a></h2>
<p>Move a directory to a different location on the file system. An error results if the app attempts to:</p>
@@ -1576,6 +1520,7 @@ entry.setMetadata(success, fail, { "com.
<li><p>move a directory to a path occupied by a file.</p></li>
<li><p>move a directory to a path occupied by a directory that is not empty.</p></li>
</ul>
+
<p>Moving a directory on top of an existing empty directory attempts to
delete and replace that directory.</p>
@@ -1587,6 +1532,7 @@ delete and replace that directory.</p>
<li><p><strong>successCallback</strong>: A callback that executes with the <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> object for the new directory. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to move the directory. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(entry) {
@@ -1608,9 +1554,7 @@ function moveDir(entry) {
}
</code></pre>
-<h2>
-<a name="DirectoryEntry_copyto">copyTo</a>
-</h2>
+<h2><a name="DirectoryEntry_copyto">copyTo</a></h2>
<p>Copy a directory to a different location on the file system. An error results if the app attempts to:</p>
@@ -1618,6 +1562,7 @@ function moveDir(entry) {
<li><p>copy a directory inside itself at any depth.</p></li>
<li><p>copy a directory into its parent if a name different from its current directory is not provided.</p></li>
</ul>
+
<p>Directory copies are always recursive, and copy all contents of the directory.</p>
<p><strong>Parameters</strong>:</p>
@@ -1628,6 +1573,7 @@ function moveDir(entry) {
<li><p><strong>successCallback</strong>: A callback that executes with the <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> object for the new directory. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to copy the underlying directory. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function win(entry) {
@@ -1649,9 +1595,7 @@ function copyDir(entry) {
}
</code></pre>
-<h2>
-<a name="DirectoryEntry_tourl">toURL</a>
-</h2>
+<h2><a name="DirectoryEntry_tourl">toURL</a></h2>
<p>Returns a URL that can be used to locate the directory.</p>
@@ -1662,9 +1606,7 @@ var dirURL = entry.toURL();
console.log(dirURL);
</code></pre>
-<h2>
-<a name="DirectoryEntry_remove">remove</a>
-</h2>
+<h2><a name="DirectoryEntry_remove">remove</a></h2>
<p>Deletes a directory. An error results if the app attempts to:</p>
@@ -1672,12 +1614,14 @@ console.log(dirURL);
<li><p>delete a directory that is not empty.</p></li>
<li><p>delete the root directory of a filesystem.</p></li>
</ul>
+
<p><strong>Parameters</strong>:</p>
<ul>
<li><p><strong>successCallback</strong>: A callback that executes after the directory is deleted. Invoked with no parameters. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to delete the directory. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(entry) {
@@ -1692,9 +1636,7 @@ function fail(error) {
entry.remove(success, fail);
</code></pre>
-<h2>
-<a name="DirectoryEntry_getparent">getParent</a>
-</h2>
+<h2><a name="DirectoryEntry_getparent">getParent</a></h2>
<p>Look up the parent <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> containing the directory.</p>
@@ -1704,6 +1646,7 @@ entry.remove(success, fail);
<li><p><strong>successCallback</strong>: A callback that is passed the directory's parent <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to retrieve the parent <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(parent) {
@@ -1718,9 +1661,7 @@ function fail(error) {
entry.getParent(success, fail);
</code></pre>
-<h2>
-<a name="DirectoryEntry_createreader">createReader</a>
-</h2>
+<h2><a name="DirectoryEntry_createreader">createReader</a></h2>
<p>Creates a new <a href="cordova_file_file.md.html#DirectoryReader">DirectoryReader</a> to read entries in a directory.</p>
@@ -1730,15 +1671,14 @@ entry.getParent(success, fail);
var directoryReader = entry.createReader();
</code></pre>
-<h2>
-<a name="DirectoryEntry_getdirectory">getDirectory</a>
-</h2>
+<h2><a name="DirectoryEntry_getdirectory">getDirectory</a></h2>
<p>Creates or looks up an existing directory. An error results if the app attempts to:</p>
<ul>
<li>create a directory whose immediate parent does not yet exist.</li>
</ul>
+
<p><strong>Parameters</strong>:</p>
<ul>
@@ -1747,6 +1687,7 @@ var directoryReader = entry.createReader
<li><p><strong>successCallback</strong>: A callback that executes with a <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> object. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when creating or looking up the directory. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(dirEntry) {
@@ -1761,15 +1702,14 @@ function fail(error) {
entry.getDirectory("newDir", {create: true, exclusive: false}, success, fail);
</code></pre>
-<h2>
-<a name="DirectoryEntry_getfile">getFile</a>
-</h2>
+<h2><a name="DirectoryEntry_getfile">getFile</a></h2>
<p>Creates or looks up a file. An error results if the app attempts to:</p>
<ul>
<li>create a file whose immediate parent does not yet exist.</li>
</ul>
+
<p><strong>Parameters</strong>:</p>
<ul>
@@ -1778,6 +1718,7 @@ entry.getDirectory("newDir", {create: tr
<li><p><strong>successCallback</strong>: A callback that is passed a <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> object. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when creating or looking up the file. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(fileEntry) {
@@ -1792,9 +1733,7 @@ function fail(error) {
entry.getFile("newFile.txt", {create: true, exclusive: false}, success, fail);
</code></pre>
-<h2>
-<a name="DirectoryEntry_removerecursively">removeRecursively</a>
-</h2>
+<h2><a name="DirectoryEntry_removerecursively">removeRecursively</a></h2>
<p>Deletes a directory and all of its contents. In the event of an error (such as trying to delete
a directory containing a file that can't be removed), some of the contents of the directory may
@@ -1803,12 +1742,14 @@ be deleted. An error results if the ap
<ul>
<li>delete the root directory of a filesystem.</li>
</ul>
+
<p><strong>Parameters</strong>:</p>
<ul>
<li><p><strong>successCallback</strong>: A callback that executes after the <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> has been deleted. Invoked with no parameters. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when attempting to delete the <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(parent) {
@@ -1823,15 +1764,14 @@ function fail(error) {
entry.removeRecursively(success, fail);
</code></pre>
-<h2>
-<a name="DirectoryEntry_blackberry_quirks">BlackBerry Quirks</a>
-</h2>
+<h2><a name="DirectoryEntry_blackberry_quirks">BlackBerry Quirks</a></h2>
<p>May fail with a <code>ControlledAccessException</code> in the following cases:</p>
<ul>
<li>An app attempts to access a directory created by a previous installation of the app.</li>
</ul>
+
<blockquote>
<p>Solution: ensure temporary directories are cleaned manually, or by the application prior to reinstallation.</p>
</blockquote>
@@ -1839,11 +1779,13 @@ entry.removeRecursively(success, fail);
<ul>
<li>If the device is connected by USB.</li>
</ul>
+
<blockquote>
<p>Solution: disconnect the USB cable from the device and run again.</p>
</blockquote>
<hr>
+
<h1><a name="DirectoryReader">DirectoryReader</a></h1>
<p>An object that lists files and directories within a directory, as
@@ -1851,17 +1793,14 @@ defined in the
<a class="external" href="http://www.w3.org/TR/file-system-api/">W3C Directories and Systems</a>
specification.</p>
-<h2>
-<a name="DirectoryReader_methods">Methods</a>
-</h2>
+<h2><a name="DirectoryReader_methods">Methods</a></h2>
<ul>
<li>
<strong>readEntries</strong>: Read the entries in a directory.</li>
</ul>
-<h2>
-<a name="DirectoryReader_supported_platforms">Supported Platforms</a>
-</h2>
+
+<h2><a name="DirectoryReader_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1871,9 +1810,8 @@ specification.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="DirectoryReader_readentries">readEntries</a>
-</h2>
+
+<h2><a name="DirectoryReader_readentries">readEntries</a></h2>
<p>Read the entries in this directory.</p>
@@ -1883,6 +1821,7 @@ specification.</p>
<li><p><strong>successCallback</strong>: A callback that is passed an array of <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> and <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> objects. <em>(Function)</em></p></li>
<li><p><strong>errorCallback</strong>: A callback that executes if an error occurs when retrieving the directory listing. Invoked with a <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object. <em>(Function)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>function success(entries) {
@@ -1904,32 +1843,29 @@ directoryReader.readEntries(success,fail
</code></pre>
<hr>
+
<h1><a name="FileTransfer">FileTransfer</a></h1>
<p>The <code><a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a></code> object allows you to upload or download files to
and from a server.</p>
-<h2>
-<a name="FileTransfer_properties">Properties</a>
-</h2>
+<h2><a name="FileTransfer_properties">Properties</a></h2>
<ul>
<li>
<strong>onprogress</strong>: Called with a <code>ProgressEvent</code> whenever a new chunk of data is transferred. <em>(Function)</em>
</li>
</ul>
-<h2>
-<a name="FileTransfer_methods">Methods</a>
-</h2>
+
+<h2><a name="FileTransfer_methods">Methods</a></h2>
<ul>
<li><p><strong>upload</strong>: sends a file to a server.</p></li>
<li><p><strong>download</strong>: downloads a file from server.</p></li>
<li><p><strong>abort</strong>: Aborts an in-progress transfer.</p></li>
</ul>
-<h2>
-<a name="FileTransfer_details">Details</a>
-</h2>
+
+<h2><a name="FileTransfer_details">Details</a></h2>
<p>The <code><a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a></code> object provides a way to upload files to a remote
server using an HTTP multi-part POST request. Both HTTP and HTTPS
@@ -1941,9 +1877,7 @@ passed to the error callback. It is als
Android) to download a file from a remote server and save it on the
device.</p>
-<h2>
-<a name="FileTransfer_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="FileTransfer_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1953,9 +1887,8 @@ device.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="FileTransfer_upload">upload</a>
-</h2>
+
+<h2><a name="FileTransfer_upload">upload</a></h2>
<p><strong>Parameters</strong>:</p>
@@ -1967,6 +1900,7 @@ device.</p>
<li><p><strong>options</strong>: Optional parameters such as file name and mimetype.</p></li>
<li><p><strong>trustAllHosts</strong>: Optional parameter, defaults to <code>false</code>. If set to <code>true</code>, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. <em>(boolean)</em></p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>// !! Assumes variable fileURI contains a valid URI to a text file on the device
@@ -2100,9 +2034,7 @@ ft.upload(fileURI, uri, win, fail, optio
<p>Set the <code>chunkedMode</code> option to <code>false</code> to prevent problems uploading
to a Nginx server.</p>
-<h2>
-<a name="FileTransfer_download">download</a>
-</h2>
+<h2><a name="FileTransfer_download">download</a></h2>
<p><strong>Parameters</strong>:</p>
@@ -2114,6 +2046,7 @@ to a Nginx server.</p>
<li><p><strong>trustAllHosts</strong>: Optional parameter, defaults to <code>false</code>. If set to <code>true</code>, it accepts all security certificates. This is useful because Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. <em>(boolean)</em></p></li>
<li><p><strong>options</strong>: Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).</p></li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>// !! Assumes filePath is a valid path on the device
@@ -2141,9 +2074,7 @@ fileTransfer.download(
);
</code></pre>
-<h2>
-<a name="FileTransfer_abort">abort</a>
-</h2>
+<h2><a name="FileTransfer_abort">abort</a></h2>
<p>Aborts an in-progress transfer. The onerror callback is passed a <a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a> object which has an error code of <a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a>.ABORT_ERR.</p>
@@ -2154,6 +2085,7 @@ fileTransfer.download(
<li>Android</li>
<li>iOS</li>
</ul>
+
<p><strong>Quick Example</strong></p>
<pre class="prettyprint"><code>// !! Assumes variable fileURI contains a valid URI to a text file on the device
@@ -2179,9 +2111,7 @@ ft.upload(fileURI, encodeURI("http://som
ft.abort();
</code></pre>
-<h2>
-<a name="FileTransfer_onprogress">onprogress</a>
-</h2>
+<h2><a name="FileTransfer_onprogress">onprogress</a></h2>
<p>Called with a ProgressEvent whenever a new chunk of data is transferred.</p>
@@ -2192,6 +2122,7 @@ ft.abort();
<li>Android</li>
<li>iOS</li>
</ul>
+
<p><strong>Example</strong></p>
<pre class="prettyprint"><code>fileTransfer.onprogress = function(progressEvent) {
@@ -2208,15 +2139,14 @@ fileTransfer.download(...); // or fileTr
- On both Android an iOS, lengthComputable is <code>false</code> for downloads that use gzip encoding.</p>
<hr>
+
<h1><a name="FileUploadOptions">FileUploadOptions</a></h1>
<p>A <code><a href="cordova_file_file.md.html#FileUploadOptions">FileUploadOptions</a></code> object can be passed to the <code><a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a></code>
object's <code>upload()</code> method to specify additional parameters to the
upload script.</p>
-<h2>
-<a name="FileUploadOptions_properties">Properties</a>
-</h2>
+<h2><a name="FileUploadOptions_properties">Properties</a></h2>
<ul>
<li><p><strong>fileKey</strong>: The name of the form element. Defaults to <code>file</code>. (DOMString)</p></li>
@@ -2226,69 +2156,62 @@ upload script.</p>
<li><p><strong>chunkedMode</strong>: Whether to upload the data in chunked streaming mode. Defaults to <code>true</code>. (Boolean)</p></li>
<li><p><strong>headers</strong>: A map of header name/header values. Use an array to specify more than one value. (Object)</p></li>
</ul>
-<h2>
-<a name="FileUploadOptions_description">Description</a>
-</h2>
+
+<h2><a name="FileUploadOptions_description">Description</a></h2>
<p>A <code><a href="cordova_file_file.md.html#FileUploadOptions">FileUploadOptions</a></code> object can be passed to the <code><a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a></code>
object's <code>upload()</code> method to specify additional parameters to the
upload script.</p>
-<h2>
-<a name="FileUploadOptions_wp7_quirk">WP7 Quirk</a>
-</h2>
+<h2><a name="FileUploadOptions_wp7_quirk">WP7 Quirk</a></h2>
<ul>
<li>
<strong>chunkedMode</strong>: Ignored on WP7.</li>
</ul>
+
<hr>
+
<h1><a name="FileUploadResult">FileUploadResult</a></h1>
<p>A <code><a href="cordova_file_file.md.html#FileUploadResult">FileUploadResult</a></code> object is passed to the success callback of the
<code><a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a></code> object's <code>upload()</code> method.</p>
-<h2>
-<a name="FileUploadResult_properties">Properties</a>
-</h2>
+<h2><a name="FileUploadResult_properties">Properties</a></h2>
<ul>
<li><p><strong>bytesSent</strong>: The number of bytes sent to the server as part of the upload. (long)</p></li>
<li><p><strong>responseCode</strong>: The HTTP response code returned by the server. (long)</p></li>
<li><p><strong>response</strong>: The HTTP response returned by the server. (DOMString)</p></li>
</ul>
-<h2>
-<a name="FileUploadResult_description">Description</a>
-</h2>
+
+<h2><a name="FileUploadResult_description">Description</a></h2>
<p>The <code><a href="cordova_file_file.md.html#FileUploadResult">FileUploadResult</a></code> object is returned via the success callback of
the <code><a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a></code> object's <code>upload()</code> method.</p>
-<h2>
-<a name="FileUploadResult_ios_quirks">iOS Quirks</a>
-</h2>
+<h2><a name="FileUploadResult_ios_quirks">iOS Quirks</a></h2>
<ul>
<li>Does not support <code>responseCode</code> or <code>bytesSent</code>.</li>
</ul>
+
<hr>
+
<h1><a name="Flags">Flags</a></h1>
<p>Supplies arguments to the <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> object's <code>getFile()</code> and
<code>getDirectory()</code> methods, which look up or create files and
directories, respectively.</p>
-<h2>
-<a name="Flags_properties">Properties</a>
-</h2>
+<h2><a name="Flags_properties">Properties</a></h2>
<ul>
<li><p><strong>create</strong>: Indicates that the file or directory should be created if it does not already exist. <em>(boolean)</em></p></li>
<li><p><strong>exclusive</strong>: Has has no effect by itself, but when used with <code>create</code> causes the file or directory creation to fail if the target path already exists. <em>(boolean)</em></p></li>
</ul>
-<h2>
-<a name="Flags_supported_platforms">Supported Platforms</a>
-</h2>
+
+<h2><a name="Flags_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -2298,9 +2221,8 @@ directories, respectively.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="Flags_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="Flags_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>// Get the data directory, creating it if it doesn't exist.
dataDir = fileSystem.root.getDirectory("data", {create: true});
@@ -2310,35 +2232,30 @@ lockFile = dataDir.getFile("lockfile.txt
</code></pre>
<hr>
+
<h1><a name="LocalFileSystem">LocalFileSystem</a></h1>
<p>This object provides a way to obtain root file systems.</p>
-<h2>
-<a name="LocalFileSystem_methods">Methods</a>
-</h2>
+<h2><a name="LocalFileSystem_methods">Methods</a></h2>
<ul>
<li><p><strong><a href="cordova_file_file.md.html#requestFileSystem">requestFileSystem</a></strong>: Requests a filesystem. <em>(Function)</em></p></li>
<li><p><strong>resolveLocalFileSystemURI</strong>: Retrieve a <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> or <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> using local URI. <em>(Function)</em></p></li>
</ul>
-<h2>
-<a name="LocalFileSystem_constants">Constants</a>
-</h2>
+
+<h2><a name="LocalFileSystem_constants">Constants</a></h2>
<ul>
<li><p><code><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.PERSISTENT</code>: Used for storage that should not be removed by the user agent without application or user permission.</p></li>
<li><p><code><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.TEMPORARY</code>: Used for storage with no guarantee of persistence.</p></li>
</ul>
-<h2>
-<a name="LocalFileSystem_details">Details</a>
-</h2>
+
+<h2><a name="LocalFileSystem_details">Details</a></h2>
<p>The <code><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a></code> object methods are defined on the <code>window</code> object.</p>
-<h2>
-<a name="LocalFileSystem_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="LocalFileSystem_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -2348,9 +2265,8 @@ lockFile = dataDir.getFile("lockfile.txt
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="LocalFileSystem_request_file_system_quick_example">Request File System Quick Example</a>
-</h2>
+
+<h2><a name="LocalFileSystem_request_file_system_quick_example">Request File System Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(fileSystem) {
console.log(fileSystem.name);
@@ -2360,9 +2276,7 @@ lockFile = dataDir.getFile("lockfile.txt
window.<a href="cordova_file_file.md.html#requestFileSystem">requestFileSystem</a>(<a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.PERSISTENT, 0, onSuccess, onError);
</code></pre>
-<h2>
-<a name="LocalFileSystem_resolve_local_file_system_uri_quick_example">Resolve Local File System URI Quick Example</a>
-</h2>
+<h2><a name="LocalFileSystem_resolve_local_file_system_uri_quick_example">Resolve Local File System URI Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(fileEntry) {
console.log(fileEntry.name);
@@ -2371,9 +2285,7 @@ window.<a href="cordova_file_file.md.htm
window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
</code></pre>
-<h2>
-<a name="LocalFileSystem_full_example">Full Example</a>
-</h2>
+<h2><a name="LocalFileSystem_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -2436,9 +2348,8 @@ window.resolveLocalFileSystemURI("file:/
<li>
<strong>errorCallback</strong>: invoked if error occurs retrieving file system</li>
</ul>
-<h2>
-<a name="requestFileSystem_request_file_system_quick_example">Request File System Quick Example</a>
-</h2>
+
+<h2><a name="requestFileSystem_request_file_system_quick_example">Request File System Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(fileSystem) {
console.log(fileSystem.name);
@@ -2449,30 +2360,26 @@ window.<a href="cordova_file_file.md.htm
</code></pre>
<hr>
+
<h1><a name="Metadata">Metadata</a></h1>
<p>An interface that supplies information about the state of a file or directory.</p>
-<h2>
-<a name="Metadata_properties">Properties</a>
-</h2>
+<h2><a name="Metadata_properties">Properties</a></h2>
<ul>
<li>
<strong>modificationTime</strong>: The time when the file or directory was last modified. <em>(Date)</em>
</li>
</ul>
-<h2>
-<a name="Metadata_details">Details</a>
-</h2>
+
+<h2><a name="Metadata_details">Details</a></h2>
<p>The <code><a href="cordova_file_file.md.html#Metadata">Metadata</a></code> object represents information about the state of a file
or directory. Calling a <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> or <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> object's
<code>getMetadata()</code> method results in a <code><a href="cordova_file_file.md.html#Metadata">Metadata</a></code> instance.</p>
-<h2>
-<a name="Metadata_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="Metadata_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -2482,9 +2389,8 @@ or directory. Calling a <code><a href="
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="Metadata_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="Metadata_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function win(metadata) {
console.log("Last Modified: " + metadata.modificationTime);
@@ -2495,21 +2401,19 @@ entry.getMetadata(win, null);
</code></pre>
<hr>
+
<h1><a name="FileError">FileError</a></h1>
<p>A <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object is set when an error occurs in any of the <a href="cordova_file_file.md.html#File">File</a> API methods.</p>
-<h2>
-<a name="FileError_properties">Properties</a>
-</h2>
+<h2><a name="FileError_properties">Properties</a></h2>
<ul>
<li>
<strong>code</strong>: One of the predefined error codes listed below.</li>
</ul>
-<h2>
-<a name="FileError_constants">Constants</a>
-</h2>
+
+<h2><a name="FileError_constants">Constants</a></h2>
<ul>
<li><code><a href="cordova_file_file.md.html#FileError">FileError</a>.NOT_FOUND_ERR</code></li>
@@ -2525,22 +2429,20 @@ entry.getMetadata(win, null);
<li><code><a href="cordova_file_file.md.html#FileError">FileError</a>.TYPE_MISMATCH_ERR</code></li>
<li><code><a href="cordova_file_file.md.html#FileError">FileError</a>.PATH_EXISTS_ERR</code></li>
</ul>
-<h2>
-<a name="FileError_description">Description</a>
-</h2>
+
+<h2><a name="FileError_description">Description</a></h2>
<p>The <code><a href="cordova_file_file.md.html#FileError">FileError</a></code> object is the only parameter provided to any of the
<a href="cordova_file_file.md.html#File">File</a> API's error callbacks. To determine the type of error, compare
its <code>code</code> property to any of the listings above.</p>
<hr>
+
<h1><a name="FileTransferError">FileTransferError</a></h1>
<p>A <code><a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a></code> object is passed to an error callback when an error occurs.</p>
-<h2>
-<a name="FileTransferError_properties">Properties</a>
-</h2>
+<h2><a name="FileTransferError_properties">Properties</a></h2>
<ul>
<li><p><strong>code</strong>: One of the predefined error codes listed below. (Number)</p></li>
@@ -2548,9 +2450,8 @@ its <code>code</code> property to any of
<li><p><strong>target</strong>: URI to the target. (String)</p></li>
<li><p><strong>http_status</strong>: HTTP status code. This attribute is only available when a response code is received from the HTTP connection. (Number)</p></li>
</ul>
-<h2>
-<a name="FileTransferError_constants">Constants</a>
-</h2>
+
+<h2><a name="FileTransferError_constants">Constants</a></h2>
<ul>
<li><code><a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a>.FILE_NOT_FOUND_ERR</code></li>
@@ -2558,9 +2459,8 @@ its <code>code</code> property to any of
<li><code><a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a>.CONNECTION_ERR</code></li>
<li><code><a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a>.ABORT_ERR</code></li>
</ul>
-<h2>
-<a name="FileTransferError_description">Description</a>
-</h2>
+
+<h2><a name="FileTransferError_description">Description</a></h2>
<p>The <code><a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a></code> object is passed to the error callback when an
error occurs when uploading or downloading a file.</p>
@@ -2569,6 +2469,7 @@ error occurs when uploading or downloadi
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
-</body>
+ <script type="text/javascript" src="index.js"></script>
+ <script type="text/javascript" src="prettify/prettify.js"></script>
+ </body>
</html>
Modified: cordova/site/public/docs/en/edge/cordova_geolocation_geolocation.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_geolocation_geolocation.md.html?rev=1551686&r1=1551685&r2=1551686&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_geolocation_geolocation.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_geolocation_geolocation.md.html Tue Dec 17 20:31:35 2013
@@ -17,16 +17,18 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
-<meta name="generator" content="joDoc">
-<title>Apache Cordova API Documentation</title>
-<link rel="stylesheet" type="text/css" href="index.css">
-<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
-<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
-</head>
-<body>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+ <meta name="generator" content="joDoc">
+
+ <title>Apache Cordova API Documentation</title>
+
+ <link rel="stylesheet" type="text/css" href="index.css">
+ <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+ <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+ </head>
+ <body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -92,7 +94,8 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select></small>
+</optgroup></select>
+ </small>
</div>
<div id="subheader">
<h1>Geolocation</h1>
@@ -220,36 +223,31 @@ above, as well as obtaining the user's p
choices for <strong>OK</strong> and <strong>No Thanks</strong>). For more information, please
see the <a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a>.</p>
-<h2>
-<a name="Geolocation_methods">Methods</a>
-</h2>
+<h2><a name="Geolocation_methods">Methods</a></h2>
<ul>
<li><a href="cordova_geolocation_geolocation.md.html#geolocation.getCurrentPosition">geolocation.getCurrentPosition</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#geolocation.watchPosition">geolocation.watchPosition</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#geolocation.clearWatch">geolocation.clearWatch</a></li>
</ul>
-<h2>
-<a name="Geolocation_arguments">Arguments</a>
-</h2>
+
+<h2><a name="Geolocation_arguments">Arguments</a></h2>
<ul>
<li><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a></li>
</ul>
-<h2>
-<a name="Geolocation_objects_read_only">Objects (Read-Only)</a>
-</h2>
+
+<h2><a name="Geolocation_objects_read_only">Objects (Read-Only)</a></h2>
<ul>
<li><a href="cordova_geolocation_geolocation.md.html#Position">Position</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#Coordinates">Coordinates</a></li>
</ul>
-<h2>
-<a name="Geolocation_accessing_the_feature">Accessing the Feature</a>
-</h2>
+
+<h2><a name="Geolocation_accessing_the_feature">Accessing the Feature</a></h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -330,10 +328,12 @@ platform-specific configuration settings
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
</li>
</ul>
+
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
+
<h1><a name="geolocation.getCurrentPosition">geolocation.getCurrentPosition</a></h1>
<p>Returns the device's current position as a <code><a href="cordova_geolocation_geolocation.md.html#Position">Position</a></code> object.</p>
@@ -343,18 +343,15 @@ configuration. See <a href="guide_suppo
[<a href="cordova_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a>]);
</code></pre>
-<h2>
-<a name="geolocation.getCurrentPosition_parameters">Parameters</a>
-</h2>
+<h2><a name="geolocation.getCurrentPosition_parameters">Parameters</a></h2>
<ul>
<li><p><strong><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></strong>: The callback that is passed the current position.</p></li>
<li><p><strong><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></strong>: <em>(Optional)</em> The callback that executes if an error occurs.</p></li>
<li><p><strong><a href="cordova_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a></strong>: <em>(Optional)</em> The geolocation options.</p></li>
</ul>
-<h2>
-<a name="geolocation.getCurrentPosition_description">Description</a>
-</h2>
+
+<h2><a name="geolocation.getCurrentPosition_description">Description</a></h2>
<p><code><a href="cordova_geolocation_geolocation.md.html#geolocation.getCurrentPosition">geolocation.getCurrentPosition</a></code> is an asynchronous function. It
returns the device's current position to the <code><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></code>
@@ -362,9 +359,7 @@ callback with a <code><a href="cordova_g
error, the <code><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></code> callback is passed a
<code><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a></code> object.</p>
-<h2>
-<a name="geolocation.getCurrentPosition_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="geolocation.getCurrentPosition_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -375,9 +370,8 @@ error, the <code><a href="cordova_geoloc
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="geolocation.getCurrentPosition_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="geolocation.getCurrentPosition_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>// onSuccess Callback
// This method accepts a <a href="cordova_geolocation_geolocation.md.html#Position">Position</a> object, which contains the
@@ -404,9 +398,7 @@ function onError(error) {
navigator.<a href="cordova_geolocation_geolocation.md.html#geolocation.getCurrentPosition">geolocation.getCurrentPosition</a>(onSuccess, onError);
</code></pre>
-<h2>
-<a name="geolocation.getCurrentPosition_full_example">Full Example</a>
-</h2>
+<h2><a name="geolocation.getCurrentPosition_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -456,6 +448,7 @@ navigator.<a href="cordova_geolocation_g
</code></pre>
<hr>
+
<h1><a name="geolocation.watchPosition">geolocation.watchPosition</a></h1>
<p>Watches for changes to the device's current position.</p>
@@ -465,26 +458,22 @@ navigator.<a href="cordova_geolocation_g
[<a href="cordova_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a>]);
</code></pre>
-<h2>
-<a name="geolocation.watchPosition_parameters">Parameters</a>
-</h2>
+<h2><a name="geolocation.watchPosition_parameters">Parameters</a></h2>
<ul>
<li><p><strong><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></strong>: The callback that is passed the current position.</p></li>
<li><p><strong><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></strong>: (Optional) The callback that executes if an error occurs.</p></li>
<li><p><strong><a href="cordova_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a></strong>: (Optional) The geolocation options.</p></li>
</ul>
-<h2>
-<a name="geolocation.watchPosition_returns">Returns</a>
-</h2>
+
+<h2><a name="geolocation.watchPosition_returns">Returns</a></h2>
<ul>
<li>
<strong>String</strong>: returns a watch id that references the watch position interval. The watch id should be used with <code><a href="cordova_geolocation_geolocation.md.html#geolocation.clearWatch">geolocation.clearWatch</a></code> to stop watching for changes in position.</li>
</ul>
-<h2>
-<a name="geolocation.watchPosition_description">Description</a>
-</h2>
+
+<h2><a name="geolocation.watchPosition_description">Description</a></h2>
<p><code><a href="cordova_geolocation_geolocation.md.html#geolocation.watchPosition">geolocation.watchPosition</a></code> is an asynchronous function. It returns
the device's current position when a change in position is detected.
@@ -493,9 +482,7 @@ callback executes with a <code><a href="
there is an error, the <code><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></code> callback executes with a
<code><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a></code> object as the parameter.</p>
-<h2>
-<a name="geolocation.watchPosition_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="geolocation.watchPosition_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -506,9 +493,8 @@ there is an error, the <code><a href="co
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="geolocation.watchPosition_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="geolocation.watchPosition_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>// onSuccess Callback
// This method accepts a `<a href="cordova_geolocation_geolocation.md.html#Position">Position</a>` object, which contains
@@ -533,9 +519,7 @@ function onError(error) {
var watchID = navigator.<a href="cordova_geolocation_geolocation.md.html#geolocation.watchPosition">geolocation.watchPosition</a>(onSuccess, onError, { timeout: 30000 });
</code></pre>
-<h2>
-<a name="geolocation.watchPosition_full_example">Full Example</a>
-</h2>
+<h2><a name="geolocation.watchPosition_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -584,6 +568,7 @@ var watchID = navigator.<a href="cordova
</code></pre>
<hr>
+
<h1><a name="geolocation.clearWatch">geolocation.clearWatch</a></h1>
<p>Stop watching for changes to the device's location referenced by the
@@ -592,25 +577,20 @@ var watchID = navigator.<a href="cordova
<pre class="prettyprint"><code>navigator.<a href="cordova_geolocation_geolocation.md.html#geolocation.clearWatch">geolocation.clearWatch</a>(watchID);
</code></pre>
-<h2>
-<a name="geolocation.clearWatch_parameters">Parameters</a>
-</h2>
+<h2><a name="geolocation.clearWatch_parameters">Parameters</a></h2>
<ul>
<li>
<strong>watchID</strong>: The id of the <code>watchPosition</code> interval to clear. (String)</li>
</ul>
-<h2>
-<a name="geolocation.clearWatch_description">Description</a>
-</h2>
+
+<h2><a name="geolocation.clearWatch_description">Description</a></h2>
<p>The <code><a href="cordova_geolocation_geolocation.md.html#geolocation.clearWatch">geolocation.clearWatch</a></code> stops watching changes to the device's
location by clearing the <code><a href="cordova_geolocation_geolocation.md.html#geolocation.watchPosition">geolocation.watchPosition</a></code> referenced by
<code>watchID</code>.</p>
-<h2>
-<a name="geolocation.clearWatch_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="geolocation.clearWatch_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -621,9 +601,8 @@ location by clearing the <code><a href="
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="geolocation.clearWatch_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="geolocation.clearWatch_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>// Options: watch for changes in position, and use the most
// accurate position acquisition method available.
@@ -635,9 +614,7 @@ var watchID = navigator.<a href="cordova
navigator.<a href="cordova_geolocation_geolocation.md.html#geolocation.clearWatch">geolocation.clearWatch</a>(watchID);
</code></pre>
-<h2>
-<a name="geolocation.clearWatch_full_example">Full Example</a>
-</h2>
+<h2><a name="geolocation.clearWatch_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -697,13 +674,12 @@ navigator.<a href="cordova_geolocation_g
</code></pre>
<hr>
+
<h1><a name="Coordinates">Coordinates</a></h1>
<p>A set of properties that describe the geographic coordinates of a position.</p>
-<h2>
-<a name="Coordinates_properties">Properties</a>
-</h2>
+<h2><a name="Coordinates_properties">Properties</a></h2>
<ul>
<li><p><strong>latitude</strong>: Latitude in decimal degrees. <em>(Number)</em></p></li>
@@ -714,16 +690,13 @@ navigator.<a href="cordova_geolocation_g
<li><p><strong>heading</strong>: Direction of travel, specified in degrees counting clockwise relative to the true north. <em>(Number)</em></p></li>
<li><p><strong>speed</strong>: Current ground speed of the device, specified in meters per second. <em>(Number)</em></p></li>
</ul>
-<h2>
-<a name="Coordinates_description">Description</a>
-</h2>
+
+<h2><a name="Coordinates_description">Description</a></h2>
<p>The <code><a href="cordova_geolocation_geolocation.md.html#Coordinates">Coordinates</a></code> object is attached to the <code><a href="cordova_geolocation_geolocation.md.html#Position">Position</a></code> object that is
available to callback functions in requests for the current position.</p>
-<h2>
-<a name="Coordinates_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="Coordinates_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -734,9 +707,8 @@ available to callback functions in reque
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="Coordinates_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="Coordinates_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>// onSuccess Callback
//
@@ -760,9 +732,7 @@ var onError = function() {
navigator.<a href="cordova_geolocation_geolocation.md.html#geolocation.getCurrentPosition">geolocation.getCurrentPosition</a>(onSuccess, onError);
</code></pre>
-<h2>
-<a name="Coordinates_full_example">Full Example</a>
-</h2>
+<h2><a name="Coordinates_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -809,40 +779,32 @@ navigator.<a href="cordova_geolocation_g
</html>
</code></pre>
-<h2>
-<a name="Coordinates_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
-</h2>
+<h2><a name="Coordinates_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
<p><strong>altitudeAccuracy</strong>: Not supported by Android devices, returning <code>null</code>.</p>
-<h2>
-<a name="Coordinates_android_quirks">Android Quirks</a>
-</h2>
+<h2><a name="Coordinates_android_quirks">Android Quirks</a></h2>
<p><strong>altitudeAccuracy</strong>: Not supported by Android devices, returning <code>null</code>.</p>
<hr>
+
<h1><a name="Position">Position</a></h1>
<p>Contains <code><a href="cordova_geolocation_geolocation.md.html#Position">Position</a></code> coordinates and timestamp, created by the geolocation API.</p>
-<h2>
-<a name="Position_properties">Properties</a>
-</h2>
+<h2><a name="Position_properties">Properties</a></h2>
<ul>
<li><p><strong>coords</strong>: A set of geographic coordinates. <em>(<a href="cordova_geolocation_geolocation.md.html#Coordinates">Coordinates</a>)</em></p></li>
<li><p><strong>timestamp</strong>: Creation timestamp for <code>coords</code>. <em>(Date)</em></p></li>
</ul>
-<h2>
-<a name="Position_description">Description</a>
-</h2>
+
+<h2><a name="Position_description">Description</a></h2>
<p>The <code><a href="cordova_geolocation_geolocation.md.html#Position">Position</a></code> object is created and populated by Cordova, and returned to the user through a callback function.</p>
-<h2>
-<a name="Position_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="Position_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -853,9 +815,8 @@ navigator.<a href="cordova_geolocation_g
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="Position_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="Position_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>// onSuccess Callback
//
@@ -880,9 +841,7 @@ function onError(error) {
navigator.<a href="cordova_geolocation_geolocation.md.html#geolocation.getCurrentPosition">geolocation.getCurrentPosition</a>(onSuccess, onError);
</code></pre>
-<h2>
-<a name="Position_full_example">Full Example</a>
-</h2>
+<h2><a name="Position_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -932,30 +891,27 @@ navigator.<a href="cordova_geolocation_g
</code></pre>
<hr>
+
<h1><a name="PositionError">PositionError</a></h1>
<p>A <code><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a></code> object is passed to the <code><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></code> callback when an error occurs.</p>
-<h2>
-<a name="PositionError_properties">Properties</a>
-</h2>
+<h2><a name="PositionError_properties">Properties</a></h2>
<ul>
<li><p><strong>code</strong>: One of the predefined error codes listed below.</p></li>
<li><p><strong>message</strong>: Error message describing the details of the error encountered.</p></li>
</ul>
-<h2>
-<a name="PositionError_constants">Constants</a>
-</h2>
+
+<h2><a name="PositionError_constants">Constants</a></h2>
<ul>
<li><code><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a>.PERMISSION_DENIED</code></li>
<li><code><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a>.POSITION_UNAVAILABLE</code></li>
<li><code><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a>.TIMEOUT</code></li>
</ul>
-<h2>
-<a name="PositionError_description">Description</a>
-</h2>
+
+<h2><a name="PositionError_description">Description</a></h2>
<p>The <code><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a></code> object is passed to the <code><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></code>
callback function when an error occurs with geolocation. It features
@@ -974,7 +930,9 @@ included in <code><a href="cordova_geolo
<code><a href="cordova_geolocation_geolocation.md.html#geolocation.watchPosition">geolocation.watchPosition</a></code>, this error could be repeatedly passed
to the <code><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></code> callback every <code>timeout</code> milliseconds.</p></li>
</ul>
+
<hr>
+
<h1><a name="geolocationSuccess">geolocationSuccess</a></h1>
<p>The user's callback function that executes when a geolocation position
@@ -987,18 +945,15 @@ or when the position changes (when calle
}
</code></pre>
-<h2>
-<a name="geolocationSuccess_parameters">Parameters</a>
-</h2>
+<h2><a name="geolocationSuccess_parameters">Parameters</a></h2>
<ul>
<li>
<strong>position</strong>: The geolocation position returned by the device. <em>(<a href="cordova_geolocation_geolocation.md.html#Position">Position</a>)</em>
</li>
</ul>
-<h2>
-<a name="geolocationSuccess_example">Example</a>
-</h2>
+
+<h2><a name="geolocationSuccess_example">Example</a></h2>
<pre class="prettyprint"><code>function <a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a>(position) {
alert('Latitude: ' + position.coords.latitude + '\n' +
@@ -1013,6 +968,7 @@ or when the position changes (when calle
</code></pre>
<hr>
+
<h1><a name="geolocationError">geolocationError</a></h1>
<p>The user's callback function that executes when there is an error for
@@ -1023,16 +979,16 @@ geolocation functions.</p>
}
</code></pre>
-<h2>
-<a name="geolocationError_parameters">Parameters</a>
-</h2>
+<h2><a name="geolocationError_parameters">Parameters</a></h2>
<ul>
<li>
<strong>error</strong>: The error returned by the device. <em>(<a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a>)</em>
</li>
</ul>
+
<hr>
+
<h1><a name="geolocationOptions">geolocationOptions</a></h1>
<p>Optional parameters to customize the retrieval of the geolocation
@@ -1041,18 +997,15 @@ geolocation functions.</p>
<pre class="prettyprint"><code>{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
</code></pre>
-<h2>
-<a name="geolocationOptions_options">Options</a>
-</h2>
+<h2><a name="geolocationOptions_options">Options</a></h2>
<ul>
<li><p><strong>enableHighAccuracy</strong>: Provides a hint that the application needs the best possible results. By default, the device attempts to retrieve a <code><a href="cordova_geolocation_geolocation.md.html#Position">Position</a></code> using network-based methods. Setting this property to <code>true</code> tells the framework to use more accurate methods, such as satellite positioning. <em>(Boolean)</em></p></li>
<li><p><strong>timeout</strong>: The maximum length of time (milliseconds) that is allowed to pass from the call to <code><a href="cordova_geolocation_geolocation.md.html#geolocation.getCurrentPosition">geolocation.getCurrentPosition</a></code> or <code><a href="cordova_geolocation_geolocation.md.html#geolocation.watchPosition">geolocation.watchPosition</a></code> until the corresponding <code><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></code> callback executes. If the <code><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></code> callback is not invoked within this time, the <code><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></code> callback is passed a <code><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a>.TIMEOUT</code> error code. (Note that when used in conjunction with <code><a href="cordova_geolocation_geolocation
.md.html#geolocation.watchPosition">geolocation.watchPosition</a></code>, the <code><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></code> callback could be called on an interval every <code>timeout</code> milliseconds!) <em>(Number)</em></p></li>
<li><p><strong>maximumAge</strong>: Accept a cached position whose age is no greater than the specified time in milliseconds. <em>(Number)</em></p></li>
</ul>
-<h2>
-<a name="geolocationOptions_android_quirks">Android Quirks</a>
-</h2>
+
+<h2><a name="geolocationOptions_android_quirks">Android Quirks</a></h2>
<p>Android 2.x emulators do not return a geolocation result unless the <code>enableHighAccuracy</code> option is set to <code>true</code>.</p>
@@ -1060,6 +1013,7 @@ geolocation functions.</p>
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
-</body>
+ <script type="text/javascript" src="index.js"></script>
+ <script type="text/javascript" src="prettify/prettify.js"></script>
+ </body>
</html>