You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/08/02 00:17:47 UTC
svn commit: r1509456 [13/21] - in /cordova/site/public/docs: en/1.5.0/
en/1.5.0rc1/ en/1.6.0/ en/1.6.0rc1/ en/1.6.1/ en/1.7.0/ en/1.7.0rc1/
en/1.8.0/ en/1.8.0rc1/ en/1.8.1/ en/1.9.0/ en/1.9.0rc1/ en/2.0.0/
en/2.0.0rc1/ en/2.1.0/ en/2.1.0rc1/ en/2.1.0rc...
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=1509456&r1=1509455&r2=1509456&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 Thu Aug 1 22:17:43 2013
@@ -83,7 +83,7 @@
<h1>File</h1>
<small><select><option value="File">File</option>
<option value="File_objects">Â Â Â Â Â Â - Objects</option>
-<option value="File_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="File_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="File">File</option>
<option value="File_properties">Â Â Â Â Â Â - Properties</option>
<option value="File_methods">Â Â Â Â Â Â - Methods</option>
@@ -208,7 +208,6 @@ File System Quick Example</option>
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -267,52 +266,72 @@ File System Quick Example</option>
<li><a href="cordova_file_file.md.html#Metadata">Metadata</a></li>
</ul>
<h2>
-<a name="File_permissions">Permissions</a>
+<a name="File_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<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
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_file_file.md.html#File">File</a>" value="org.apache.cordova.FileUtils" />
-<plugin name="<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>" value="org.apache.cordova.<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>" />
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
+ $ cordova plugin rm org.apache.cordova.core.file
</code></pre>
-<h4>app/AndroidManifest.xml</h4>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<pre class="prettyprint"><code><uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-</code></pre>
+<ul>
+<li>
+<p>Android</p>
-<h3>BlackBerry WebWorks</h3>
+<pre class="prettyprint"><code>(in app/res/xml/config.xml)
+<feature name="<a href="cordova_file_file.md.html#File">File</a>">
+ <param name="android-package" value="org.apache.cordova.FileUtils" />
+</feature>
+<feature name="<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>">
+ <param name="android-package" value="org.apache.cordova.<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>" />
+</feature>
-<h4>www/plugins.xml</h4>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_file_file.md.html#File">File</a>" value="org.apache.cordova.file.FileManager" />
-<plugin name="<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>" value="org.apache.cordova.http.<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>" />
+(in app/AndroidManifest.xml)
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks</p>
+
+<pre class="prettyprint"><code>(in www/plugins.xml)
+<feature name="<a href="cordova_file_file.md.html#File">File</a>">
+ <param name="blackberry-package" value="org.apache.cordova.file.FileManager" />
+</feature>
+<feature name="<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>">
+ <param name="blackberry-package" value="org.apache.cordova.http.<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>" />
+</feature>
-<h4>www/config.xml</h4>
-<pre class="prettyprint"><code><feature id="blackberry.io.file" required="true" version="1.0.0.0" />
+(in www/config.xml)
+<feature id="blackberry.io.file" required="true" version="1.0.0.0" />
<feature id="blackberry.utils" required="true" version="1.0.0.0" />
<feature id="blackberry.io.dir" required="true" version="1.0.0.0" />
<rim:permissions>
<rim:permit>access_shared</rim:permit>
</rim:permissions>
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_file_file.md.html#File">File</a>" value="CDVFile" />
-<plugin name="<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>" value="CDVFileTransfer" />
-</code></pre>
-
-<h3>Windows Phone</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
+<pre class="prettyprint"><code><feature name="<a href="cordova_file_file.md.html#File">File</a>">
+ <param name="ios-package" value="CDVFile" />
+</feature>
+<feature name="<a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>">
+ <param name="ios-package" value="CDVFileTransfer" />
+</feature>
</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="File">File</a></h1>
@@ -324,21 +343,11 @@ File System Quick Example</option>
</h2>
<ul>
-<li>
-<strong>name</strong>: The name of the file. <em>(DOMString)</em>
-</li>
-<li>
-<strong>fullPath</strong>: The full path of the file including the file name. <em>(DOMString)</em>
-</li>
-<li>
-<strong>type</strong>: The mime type of the file. <em>(DOMString)</em>
-</li>
-<li>
-<strong>lastModifiedDate</strong>: The last time the file was modified. <em>(Date)</em>
-</li>
-<li>
-<strong>size</strong>: The size of the file in bytes. <em>(long)</em>
-</li>
+<li><p><strong>name</strong>: The name of the file. <em>(DOMString)</em></p></li>
+<li><p><strong>fullPath</strong>: The full path of the file including the file name. <em>(DOMString)</em></p></li>
+<li><p><strong>type</strong>: The mime type of the file. <em>(DOMString)</em></p></li>
+<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>
@@ -379,10 +388,8 @@ relative to the current slice. (See the
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>start</strong>: The index of the first byte to read, inclusive.</li>
-<li>
-<strong>end</strong>: The index of the byte after the last one to read.</li>
+<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>
@@ -414,29 +421,14 @@ var slice3 = file.slice(120, 135);
</h2>
<ul>
-<li>
-<strong>readyState</strong>: One of the reader's three possible states, either <code>EMPTY</code>, <code>LOADING</code> or <code>DONE</code>.</li>
-<li>
-<strong>result</strong>: The contents of the file that have been read. <em>(DOMString)</em>
-</li>
-<li>
-<strong>error</strong>: An object containing errors. <em>(<a href="cordova_file_file.md.html#FileError">FileError</a>)</em>
-</li>
-<li>
-<strong>onloadstart</strong>: Called when the read starts. <em>(Function)</em>
-</li>
-<li>
-<strong>onload</strong>: Called when the read has successfully completed. <em>(Function)</em>
-</li>
-<li>
-<strong>onabort</strong>: Called when the read has been aborted. For instance, by invoking the <code>abort()</code> method. <em>(Function)</em>
-</li>
-<li>
-<strong>onerror</strong>: Called when the read has failed. <em>(Function)</em>
-</li>
-<li>
-<strong>onloadend</strong>: Called when the request has completed (either in success or failure). <em>(Function)</em>
-</li>
+<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>
+<li><p><strong>result</strong>: The contents of the file that have been read. <em>(DOMString)</em></p></li>
+<li><p><strong>error</strong>: An object containing errors. <em>(<a href="cordova_file_file.md.html#FileError">FileError</a>)</em></p></li>
+<li><p><strong>onloadstart</strong>: Called when the read starts. <em>(Function)</em></p></li>
+<li><p><strong>onload</strong>: Called when the read has successfully completed. <em>(Function)</em></p></li>
+<li><p><strong>onabort</strong>: Called when the read has been aborted. For instance, by invoking the <code>abort()</code> method. <em>(Function)</em></p></li>
+<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>
@@ -450,16 +442,11 @@ var slice3 = file.slice(120, 135);
</h2>
<ul>
-<li>
-<strong>abort</strong>: Aborts reading file.</li>
-<li>
-<strong>readAsDataURL</strong>: Read file and return data as a base64-encoded data URL.</li>
-<li>
-<strong>readAsText</strong>: Reads text file.</li>
-<li>
-<strong>readAsBinaryString</strong>: Reads file as binary and returns a binary string.</li>
-<li>
-<strong>readAsArrayBuffer</strong>: Reads file as an <code>ArrayBuffer</code>.</li>
+<li><p><strong>abort</strong>: Aborts reading file.</p></li>
+<li><p><strong>readAsDataURL</strong>: Read file and return data as a base64-encoded data URL.</p></li>
+<li><p><strong>readAsText</strong>: Reads text file.</p></li>
+<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>
@@ -518,10 +505,8 @@ entry.file(win, fail);
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>file</strong>: the file object to read.</li>
-<li>
-<strong>encoding</strong>: the encoding to use to encode the file's content. Default is UTF8.</li>
+<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>
@@ -573,14 +558,12 @@ entry.file(win, fail);
<head>
<title><a href="cordova_file_file.md.html#FileReader">FileReader</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
//
- function onLoad() {
- document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
- }
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// device APIs are available
//
@@ -713,35 +696,16 @@ entry.file(win, fail);
</h2>
<ul>
-<li>
-<strong>readyState</strong>: One of the three possible states, either <code>INIT</code>, <code>WRITING</code>, or <code>DONE</code>.</li>
-<li>
-<strong>fileName</strong>: The name of the file to be written. <em>(DOMString)</em>
-</li>
-<li>
-<strong>length</strong>: The length of the file to be written. <em>(long)</em>
-</li>
-<li>
-<strong>position</strong>: The current position of the file pointer. <em>(long)</em>
-</li>
-<li>
-<strong>error</strong>: An object containing errors. <em>(<a href="cordova_file_file.md.html#FileError">FileError</a>)</em>
-</li>
-<li>
-<strong>onwritestart</strong>: Called when the write starts. <em>(Function)</em>
-</li>
-<li>
-<strong>onwrite</strong>: Called when the request has completed successfully. <em>(Function)</em>
-</li>
-<li>
-<strong>onabort</strong>: Called when the write has been aborted. For instance, by invoking the abort() method. <em>(Function)</em>
-</li>
-<li>
-<strong>onerror</strong>: Called when the write has failed. <em>(Function)</em>
-</li>
-<li>
-<strong>onwriteend</strong>: Called when the request has completed (either in success or failure). <em>(Function)</em>
-</li>
+<li><p><strong>readyState</strong>: One of the three possible states, either <code>INIT</code>, <code>WRITING</code>, or <code>DONE</code>.</p></li>
+<li><p><strong>fileName</strong>: The name of the file to be written. <em>(DOMString)</em></p></li>
+<li><p><strong>length</strong>: The length of the file to be written. <em>(long)</em></p></li>
+<li><p><strong>position</strong>: The current position of the file pointer. <em>(long)</em></p></li>
+<li><p><strong>error</strong>: An object containing errors. <em>(<a href="cordova_file_file.md.html#FileError">FileError</a>)</em></p></li>
+<li><p><strong>onwritestart</strong>: Called when the write starts. <em>(Function)</em></p></li>
+<li><p><strong>onwrite</strong>: Called when the request has completed successfully. <em>(Function)</em></p></li>
+<li><p><strong>onabort</strong>: Called when the write has been aborted. For instance, by invoking the abort() method. <em>(Function)</em></p></li>
+<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>
@@ -752,12 +716,9 @@ entry.file(win, fail);
<h2>Methods</h2>
</li>
<li><p><strong>abort</strong>: Aborts writing the file.</p></li>
-<li>
-<strong>seek</strong>: Moves the file pointer to the specified byte.</li>
-<li>
-<strong>truncate</strong>: Shortens the file to the specified length.</li>
-<li>
-<strong>write</strong>: Writes data to the file.</li>
+<li><p><strong>seek</strong>: Moves the file pointer to the specified byte.</p></li>
+<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>
@@ -913,7 +874,7 @@ entry.createWriter(win, fail);
<head>
<title><a href="cordova_file_file.md.html#FileWriter">FileWriter</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -973,12 +934,8 @@ entry.createWriter(win, fail);
</h2>
<ul>
-<li>
-<strong>name</strong>: The name of the file system. <em>(DOMString)</em>
-</li>
-<li>
-<strong>root</strong>: The root directory of the file system. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em>
-</li>
+<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>
@@ -1023,7 +980,7 @@ window.requestFileSystem(<a href="cordov
<head>
<title><a href="cordova_file_file.md.html#File">File</a> System Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -1066,18 +1023,10 @@ specification.</p>
</h2>
<ul>
-<li>
-<strong>isFile</strong>: Always true. <em>(boolean)</em>
-</li>
-<li>
-<strong>isDirectory</strong>: Always false. <em>(boolean)</em>
-</li>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>isFile</strong>: Always true. <em>(boolean)</em></p></li>
+<li><p><strong>isDirectory</strong>: Always false. <em>(boolean)</em></p></li>
+<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>
@@ -1092,24 +1041,15 @@ but is <em>not</em> supported:</p>
</h2>
<ul>
-<li>
-<strong>getMetadata</strong>: Look up metadata about a file.</li>
-<li>
-<strong>setMetadata</strong>: Set metadata on a file.</li>
-<li>
-<strong>moveTo</strong>: Move a file to a different location on the file system.</li>
-<li>
-<strong>copyTo</strong>: Copy a file to a different location on the file system.</li>
-<li>
-<strong>toURL</strong>: Return a URL that can be used to locate a file.</li>
-<li>
-<strong>remove</strong>: Delete a file.</li>
-<li>
-<strong>getParent</strong>: Look up the parent directory.</li>
-<li>
-<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.</li>
-<li>
-<strong>file</strong>: Creates a <code><a href="cordova_file_file.md.html#File">File</a></code> object containing file properties.</li>
+<li><p><strong>getMetadata</strong>: Look up metadata about a file.</p></li>
+<li><p><strong>setMetadata</strong>: Set metadata on a file.</p></li>
+<li><p><strong>moveTo</strong>: Move a file to a different location on the file system.</p></li>
+<li><p><strong>copyTo</strong>: Copy a file to a different location on the file system.</p></li>
+<li><p><strong>toURL</strong>: Return a URL that can be used to locate a file.</p></li>
+<li><p><strong>remove</strong>: Delete a file.</p></li>
+<li><p><strong>getParent</strong>: Look up the parent directory.</p></li>
+<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>
@@ -1131,12 +1071,8 @@ but is <em>not</em> supported:</p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1158,21 +1094,17 @@ entry.getMetadata(success, fail);
<p>Set metadata on a file.</p>
-<p><strong>Currently works only on iOS.</strong>
-- this will set the extended attributes of a file.</p>
+<p><strong>Currently works only on iOS.</strong></p>
+<ul>
+<li>this will set the extended attributes of a file.</li>
+</ul>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>successCallback</strong>: A callback that executes when the metadata is set. <em>(Function)</em>
-</li>
-<li>
-<strong>errorCallback</strong>: A callback that executes when the metadata is not successfully set. <em>(Function)</em>
-</li>
-<li>
-<strong>metadataObject</strong>: An object that contains the metadata's keys and values. <em>(Object)</em>
-</li>
+<li><p><strong>successCallback</strong>: A callback that executes when the metadata is set. <em>(Function)</em></p></li>
+<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>
@@ -1197,31 +1129,31 @@ entry.setMetadata(success, fail, { "com.
<pre class="prettyprint"><code>function setFileMetadata(localFileSystem, filePath, metadataKey, metadataValue)
{
- var onSetMetadataWin = function() {
- console.log("success setting metadata")
- }
+ var onSetMetadataWin = function() {
+ console.log("success setting metadata")
+ }
var onSetMetadataFail = function() {
- console.log("error setting metadata")
+ console.log("error setting metadata")
}
- var onGetFileWin = function(parent) {
- var data = {};
- data[metadataKey] = metadataValue;
- parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
- }
- var onGetFileFail = function() {
- console.log("error getting file")
- }
+ var onGetFileWin = function(parent) {
+ var data = {};
+ data[metadataKey] = metadataValue;
+ parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
+ }
+ var onGetFileFail = function() {
+ console.log("error getting file")
+ }
- var onFSWin = function(fileSystem) {
- fileSystem.root.getFile(filePath, {create: true, exclusive: false}, onGetFileWin, onGetFileFail);
- }
+ var onFSWin = function(fileSystem) {
+ fileSystem.root.getFile(filePath, {create: true, exclusive: false}, onGetFileWin, onGetFileFail);
+ }
- var onFSFail = function(evt) {
- console.log(evt.target.error.code);
- }
+ var onFSFail = function(evt) {
+ console.log(evt.target.error.code);
+ }
- window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
+ window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
}
setFileMetadata(<a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
@@ -1235,8 +1167,8 @@ entry.setMetadata(success, fail, { "com.
results if the app attempts to:</p>
<ul>
-<li>move a file into its parent if a name different from its current one isn't provided;</li>
-<li>move a file to a path occupied by a directory;</li>
+<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>
@@ -1244,18 +1176,10 @@ delete and replace that file.</p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>parent</strong>: The parent directory to which to move the file. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em>
-</li>
-<li>
-<strong>newName</strong>: The new name of the file. Defaults to the current name if unspecified. <em>(DOMString)</em>
-</li>
-<li>
-<strong>successCallback</strong>: A callback that is passed the new files <code><a href="cordova_file_file.md.html#FileEntry">FileEntry</a></code> object. <em>(Function)</em>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>parent</strong>: The parent directory to which to move the file. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em></p></li>
+<li><p><strong>newName</strong>: The new name of the file. Defaults to the current name if unspecified. <em>(DOMString)</em></p></li>
+<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>
@@ -1290,18 +1214,10 @@ the app attempts to:</p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>parent</strong>: The parent directory to which to copy the file. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em>
-</li>
-<li>
-<strong>newName</strong>: The new name of the file. Defaults to the current name if unspecified. <em>(DOMString)</em>
-</li>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>parent</strong>: The parent directory to which to copy the file. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em></p></li>
+<li><p><strong>newName</strong>: The new name of the file. Defaults to the current name if unspecified. <em>(DOMString)</em></p></li>
+<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>
@@ -1345,12 +1261,8 @@ console.log(fileURL);
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>successCallback</strong>: A callback that executes after the file has been deleted. Invoked with no parameters. <em>(Function)</em>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1375,12 +1287,8 @@ entry.remove(success, fail);
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1405,12 +1313,8 @@ entry.getParent(success, fail);
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1436,12 +1340,8 @@ that this <code><a href="cordova_file_fi
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1469,18 +1369,10 @@ specification.</p>
</h2>
<ul>
-<li>
-<strong>isFile</strong>: Always false. <em>(boolean)</em>
-</li>
-<li>
-<strong>isDirectory</strong>: Always true. <em>(boolean)</em>
-</li>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>isFile</strong>: Always false. <em>(boolean)</em></p></li>
+<li><p><strong>isDirectory</strong>: Always true. <em>(boolean)</em></p></li>
+<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>
@@ -1497,28 +1389,17 @@ but is <em>not</em> supported:</p>
<p>The following methods can be invoked on a <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code> object:</p>
<ul>
-<li>
-<strong>getMetadata</strong>: Look up metadata about a directory.</li>
-<li>
-<strong>setMetadata</strong>: Set metadata on a directory.</li>
-<li>
-<strong>moveTo</strong>: Move a directory to a different location on the file system.</li>
-<li>
-<strong>copyTo</strong>: Copy a directory to a different location on the file system.</li>
-<li>
-<strong>toURL</strong>: Return a URL to help locate a directory.</li>
-<li>
-<strong>remove</strong>: Delete a directory. The directory must be empty.</li>
-<li>
-<strong>getParent</strong>: Look up the parent directory.</li>
-<li>
-<strong>createReader</strong>: Create a new <code><a href="cordova_file_file.md.html#DirectoryReader">DirectoryReader</a></code> that can read entries from a directory.</li>
-<li>
-<strong>getDirectory</strong>: Create or look up a directory.</li>
-<li>
-<strong>getFile</strong>: Create or look up a file.</li>
-<li>
-<strong>removeRecursively</strong>: Delete a directory and all of its contents.</li>
+<li><p><strong>getMetadata</strong>: Look up metadata about a directory.</p></li>
+<li><p><strong>setMetadata</strong>: Set metadata on a directory.</p></li>
+<li><p><strong>moveTo</strong>: Move a directory to a different location on the file system.</p></li>
+<li><p><strong>copyTo</strong>: Copy a directory to a different location on the file system.</p></li>
+<li><p><strong>toURL</strong>: Return a URL to help locate a directory.</p></li>
+<li><p><strong>remove</strong>: Delete a directory. The directory must be empty.</p></li>
+<li><p><strong>getParent</strong>: Look up the parent directory.</p></li>
+<li><p><strong>createReader</strong>: Create a new <code><a href="cordova_file_file.md.html#DirectoryReader">DirectoryReader</a></code> that can read entries from a directory.</p></li>
+<li><p><strong>getDirectory</strong>: Create or look up a directory.</p></li>
+<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>
@@ -1540,12 +1421,8 @@ but is <em>not</em> supported:</p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1565,21 +1442,15 @@ entry.getMetadata(success, fail);
<a name="DirectoryEntry_setmetadata">setMetadata</a>
</h2>
-<p>Set metadata on a directory.
-<strong>Currently works only on iOS.</strong> - this will set the extended attributes of a directory.</p>
+<p>Sets a directory's extended attributes, or metadata. <em>Currently works
+only on iOS.</em></p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>successCallback</strong>: A callback that executes when the metadata is successfully set. <em>(Function)</em>
-</li>
-<li>
-<strong>errorCallback</strong>: A callback that executes when the metadata fails to be set. <em>(Function)</em>
-</li>
-<li>
-<strong>metadataObject</strong>: An object that contains the metadata's keys and values. <em>(Object)</em>
-</li>
+<li><p><strong>successCallback</strong>: A callback that executes when the metadata is successfully set. <em>(Function)</em></p></li>
+<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>
@@ -1604,31 +1475,31 @@ entry.setMetadata(success, fail, { "com.
<pre class="prettyprint"><code>function setFolderMetadata(localFileSystem, subFolder, metadataKey, metadataValue)
{
- var onSetMetadataWin = function() {
- console.log("success setting metadata")
- }
+ var onSetMetadataWin = function() {
+ console.log("success setting metadata")
+ }
var onSetMetadataFail = function() {
- console.log("error setting metadata")
+ console.log("error setting metadata")
}
- var onGetDirectoryWin = function(parent) {
- var data = {};
- data[metadataKey] = metadataValue;
- parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
- }
- var onGetDirectoryFail = function() {
- console.log("error getting dir")
- }
+ var onGetDirectoryWin = function(parent) {
+ var data = {};
+ data[metadataKey] = metadataValue;
+ parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
+ }
+ var onGetDirectoryFail = function() {
+ console.log("error getting dir")
+ }
- var onFSWin = function(fileSystem) {
- fileSystem.root.getDirectory(subFolder, {create: true, exclusive: false}, onGetDirectoryWin, onGetDirectoryFail);
- }
+ var onFSWin = function(fileSystem) {
+ fileSystem.root.getDirectory(subFolder, {create: true, exclusive: false}, onGetDirectoryWin, onGetDirectoryFail);
+ }
- var onFSFail = function(evt) {
- console.log(evt.target.error.code);
- }
+ var onFSFail = function(evt) {
+ console.log(evt.target.error.code);
+ }
- window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
+ window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
}
setFolderMetadata(<a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
@@ -1641,10 +1512,10 @@ entry.setMetadata(success, fail, { "com.
<p>Move a directory to a different location on the file system. An error results if the app attempts to:</p>
<ul>
-<li>move a directory inside itself or to any child at any depth.</li>
-<li>move a directory into its parent if a name different from its current directory is not provided.</li>
-<li>move a directory to a path occupied by a file.</li>
-<li>move a directory to a path occupied by a directory that is not empty.</li>
+<li><p>move a directory inside itself or to any child at any depth.</p></li>
+<li><p>move a directory into its parent if a name different from its current directory is not provided.</p></li>
+<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>
@@ -1652,18 +1523,10 @@ delete and replace that directory.</p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>parent</strong>: The parent directory to which to move the directory. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em>
-</li>
-<li>
-<strong>newName</strong>: The new name of the directory. Defaults to the current name if unspecified. <em>(DOMString)</em>
-</li>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>parent</strong>: The parent directory to which to move the directory. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em></p></li>
+<li><p><strong>newName</strong>: The new name of the directory. Defaults to the current name if unspecified. <em>(DOMString)</em></p></li>
+<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>
@@ -1675,7 +1538,7 @@ function fail(error) {
alert(error.code);
}
- function moveDir(entry) {
+function moveDir(entry) {
var parent = document.getElementById('parent').value,
parentName = parent.substring(parent.lastIndexOf('/')+1),
newName = document.getElementById('newName').value,
@@ -1693,38 +1556,30 @@ function fail(error) {
<p>Copy a directory to a different location on the file system. An error results if the app attempts to:</p>
<ul>
-<li>copy a directory inside itself at any depth.</li>
-<li>copy a directory into its parent if a name different from its current directory is not provided.</li>
+<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>
<ul>
-<li>
-<strong>parent</strong>: The parent directory to which to copy the directory. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em>
-</li>
-<li>
-<strong>newName</strong>: The new name of the directory. Defaults to the current name if unspecified. <em>(DOMString)</em>
-</li>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>parent</strong>: The parent directory to which to copy the directory. <em>(<a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a>)</em></p></li>
+<li><p><strong>newName</strong>: The new name of the directory. Defaults to the current name if unspecified. <em>(DOMString)</em></p></li>
+<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) {
- console.log("New Path: " + entry.fullPath);
- }
+<pre class="prettyprint"><code>function win(entry) {
+ console.log("New Path: " + entry.fullPath);
+}
- function fail(error) {
- alert(error.code);
- }
+function fail(error) {
+ alert(error.code);
+}
- function copyDir(entry) {
+function copyDir(entry) {
var parent = document.getElementById('parent').value,
parentName = parent.substring(parent.lastIndexOf('/')+1),
newName = document.getElementById('newName').value,
@@ -1755,18 +1610,14 @@ console.log(dirURL);
<p>Deletes a directory. An error results if the app attempts to:</p>
<ul>
-<li>delete a directory that is not empty.</li>
-<li>delete the root directory of a filesystem.</li>
+<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>
-<strong>successCallback</strong>: A callback that executes after the directory is deleted. Invoked with no parameters. <em>(Function)</em>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1791,12 +1642,8 @@ entry.remove(success, fail);
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1836,18 +1683,10 @@ var directoryReader = entry.createReader
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>path</strong>: The path to the directory to be looked up or created. Either an absolute path, or a relative path from this <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. <em>(DOMString)</em>
-</li>
-<li>
-<strong>options</strong>: Options to specify whether the directory is to be created if it doesn't exist. <em>(<a href="cordova_file_file.md.html#Flags">Flags</a>)</em>
-</li>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>path</strong>: The path to the directory to be looked up or created. Either an absolute path, or a relative path from this <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. <em>(DOMString)</em></p></li>
+<li><p><strong>options</strong>: Options to specify whether the directory is to be created if it doesn't exist. <em>(<a href="cordova_file_file.md.html#Flags">Flags</a>)</em></p></li>
+<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>
@@ -1875,18 +1714,10 @@ entry.getDirectory("newDir", {create: tr
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>path</strong>: The path to the file to be looked up or created. Either an absolute path, or a relative path from this <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. <em>(DOMString)</em>
-</li>
-<li>
-<strong>options</strong>: Options to specify whether the file is created if it doesn't exist. <em>(<a href="cordova_file_file.md.html#Flags">Flags</a>)</em>
-</li>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>path</strong>: The path to the file to be looked up or created. Either an absolute path, or a relative path from this <code><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></code>. <em>(DOMString)</em></p></li>
+<li><p><strong>options</strong>: Options to specify whether the file is created if it doesn't exist. <em>(<a href="cordova_file_file.md.html#Flags">Flags</a>)</em></p></li>
+<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>
@@ -1916,12 +1747,8 @@ be deleted. An error results if the ap
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -1993,12 +1820,8 @@ specification.</p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -2040,12 +1863,9 @@ and from a server.</p>
</h2>
<ul>
-<li>
-<strong>upload</strong>: sends a file to a server.</li>
-<li>
-<strong>download</strong>: downloads a file from server.</li>
-<li>
-<strong>abort</strong>: Aborts an in-progress transfer.</li>
+<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>
@@ -2079,21 +1899,12 @@ device.</p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>filePath</strong>: Full path of the file on the device.</li>
-<li>
-<strong>server</strong>: URL of the server to receive the file, as encoded by <code>encodeURI()</code>.</li>
-<li>
-<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>
-</li>
-<li>
-<strong>errorCallback</strong>: A callback that executes if an error occurs 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#FileTransferError">FileTransferError</a></code> object. <em>(Function)</em>
-</li>
-<li>
-<strong>options</strong>: Optional parameters such as file name and mimetype.</li>
-<li>
-<strong>trustAllHosts</strong>: Optional parameter, defaults to <code>false</code>. If set to true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. <em>(boolean)</em>
-</li>
+<li><p><strong>filePath</strong>: Full path of the file on the device.</p></li>
+<li><p><strong>server</strong>: URL of the server to receive the file, as encoded by <code>encodeURI()</code>.</p></li>
+<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 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#FileTransferError">FileTransferError</a></code> object. <em>(Function)</em></p></li>
+<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 true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. <em>(boolean)</em></p></li>
</ul>
<p><strong>Quick Example</strong></p>
@@ -2133,7 +1944,7 @@ ft.upload(fileURI, encodeURI("http://som
<head>
<title><a href="cordova_file_file.md.html#File">File</a> Transfer Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -2235,21 +2046,12 @@ to a Nginx server.</p>
<p><strong>Parameters:</strong></p>
<ul>
-<li>
-<strong>source</strong>: URL of the server to download the file, as encoded by <code>encodeURI()</code>.</li>
-<li>
-<strong>target</strong>: Full path of the file on the device.</li>
-<li>
-<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>
-</li>
-<li>
-<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#FileTransferError">FileTransferError</a></code> object. <em>(Function)</em>
-</li>
-<li>
-<strong>trustAllHosts</strong>: Optional parameter, defaults to <code>false</code>. If set to <code>true</code> then it will accept all security certificates. This is useful as Android rejects self signed security certificates. Not recommended for production use. Supported on Android and iOS. <em>(boolean)</em>
-</li>
-<li>
-<strong>options</strong>: Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).</li>
+<li><p><strong>source</strong>: URL of the server to download the file, as encoded by <code>encodeURI()</code>.</p></li>
+<li><p><strong>target</strong>: Full path of the file on the device.</p></li>
+<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 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#FileTransferError">FileTransferError</a></code> object. <em>(Function)</em></p></li>
+<li><p><strong>trustAllHosts</strong>: Optional parameter, defaults to <code>false</code>. If set to <code>true</code> then it will accept all security certificates. This is useful as Android rejects self signed security certificates. Not recommended for production use. Supported on Android and iOS. <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>
@@ -2294,32 +2096,25 @@ fileTransfer.download(
<pre class="prettyprint"><code>// !! Assumes variable fileURI contains a valid URI to a text file on the device
- var win = function(r) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
- }
+var win = function(r) {
+ console.log("Should not be called.");
+}
var fail = function(error) {
+ // error.code == <a href="cordova_file_file.md.html#FileTransferError">FileTransferError</a>.ABORT_ERR
alert("An error has occurred: Code = " + error.code);
console.log("upload error source " + error.source);
console.log("upload error target " + error.target);
}
- var options = new <a href="cordova_file_file.md.html#FileUploadOptions">FileUploadOptions</a>();
- options.fileKey="file";
- options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
- options.mimeType="text/plain";
-
-var params = {};
- params.value1 = "test";
- params.value2 = "param";
-
- options.params = params;
+var options = new <a href="cordova_file_file.md.html#FileUploadOptions">FileUploadOptions</a>();
+options.fileKey="file";
+options.fileName="myphoto.jpg";
+options.mimeType="image/jpeg";
- var ft = new <a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>();
+var ft = new <a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>();
ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
-ft.abort(win, fail);
+ft.abort();
</code></pre>
<h2>
@@ -2361,18 +2156,12 @@ upload script.</p>
</h2>
<ul>
-<li>
-<strong>fileKey</strong>: The name of the form element. Defaults to <code>file</code>. (DOMString)</li>
-<li>
-<strong>fileName</strong>: The file name to use when saving the file on the server. Defaults to <code>image.jpg</code>. (DOMString)</li>
-<li>
-<strong>mimeType</strong>: The mime type of the data to upload. Defaults to <code>image/jpeg</code>. (DOMString)</li>
-<li>
-<strong>params</strong>: A set of optional key/value pairs to pass in the HTTP request. (Object)</li>
-<li>
-<strong>chunkedMode</strong>: Whether to upload the data in chunked streaming mode. Defaults to <code>true</code>. (Boolean)</li>
-<li>
-<strong>headers</strong>: A map of header name/header values. Use an array to specify more than one value. (Object)</li>
+<li><p><strong>fileKey</strong>: The name of the form element. Defaults to <code>file</code>. (DOMString)</p></li>
+<li><p><strong>fileName</strong>: The file name to use when saving the file on the server. Defaults to <code>image.jpg</code>. (DOMString)</p></li>
+<li><p><strong>mimeType</strong>: The mime type of the data to upload. Defaults to <code>image/jpeg</code>. (DOMString)</p></li>
+<li><p><strong>params</strong>: A set of optional key/value pairs to pass in the HTTP request. (Object)</p></li>
+<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>
@@ -2401,12 +2190,9 @@ upload script.</p>
</h2>
<ul>
-<li>
-<strong>bytesSent</strong>: The number of bytes sent to the server as part of the upload. (long)</li>
-<li>
-<strong>responseCode</strong>: The HTTP response code returned by the server. (long)</li>
-<li>
-<strong>response</strong>: The HTTP response returned by the server. (DOMString)</li>
+<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>
@@ -2434,12 +2220,8 @@ directories, respectively.</p>
</h2>
<ul>
-<li>
-<strong>create</strong>: Indicates that the file or directory should be created if it does not already exist. <em>(boolean)</em>
-</li>
-<li>
-<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>
-</li>
+<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>
@@ -2473,22 +2255,16 @@ lockFile = dataDir.getFile("lockfile.txt
</h2>
<ul>
-<li>
-<strong>requestFileSystem</strong>: Requests a filesystem. <em>(Function)</em>
-</li>
-<li>
-<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>
-</li>
+<li><p><strong>requestFileSystem</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>
<ul>
-<li>
-<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.</li>
-<li>
-<code><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.TEMPORARY</code>: Used for storage with no guarantee of persistence.</li>
+<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>
@@ -2539,7 +2315,7 @@ window.resolveLocalFileSystemURI("file:/
<head>
<title>Local <a href="cordova_file_file.md.html#File">File</a> System Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -2668,14 +2444,10 @@ its <code>code</code> property to any of
</h2>
<ul>
-<li>
-<strong>code</strong>: One of the predefined error codes listed below. (Number)</li>
-<li>
-<strong>source</strong>: URI to the source. (String)</li>
-<li>
-<strong>target</strong>: URI to the target. (String)</li>
-<li>
-<strong>http_status</strong>: HTTP status code. This attribute is only available when a response code is received from the HTTP connection. (Number)</li>
+<li><p><strong>code</strong>: One of the predefined error codes listed below. (Number)</p></li>
+<li><p><strong>source</strong>: URI to the source. (String)</p></li>
+<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>
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=1509456&r1=1509455&r2=1509456&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 Thu Aug 1 22:17:43 2013
@@ -85,7 +85,7 @@
<option value="Geolocation_methods">Â Â Â Â Â Â - Methods</option>
<option value="Geolocation_arguments">Â Â Â Â Â Â - Arguments</option>
<option value="Geolocation_objects_read_only">Â Â Â Â Â Â - Objects (Read-Only)</option>
-<option value="Geolocation_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Geolocation_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="geolocation.getCurrentPosition">geolocation.getCurrentPosition</option>
<option value="geolocation.getCurrentPosition_parameters">Â Â Â Â Â Â - Parameters</option>
<option value="geolocation.getCurrentPosition_description">Â Â Â Â Â Â - Description</option>
@@ -139,7 +139,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -217,47 +216,61 @@ and only executes on devices that don't
<li><a href="cordova_geolocation_geolocation.md.html#Coordinates">Coordinates</a></li>
</ul>
<h2>
-<a name="Geolocation_permissions">Permissions</a>
+<a name="Geolocation_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<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
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>" value="org.apache.cordova.GeoBroker" />
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
+ $ cordova plugin rm org.apache.cordova.core.geolocation
</code></pre>
-<h4>app/AndroidManifest.xml</h4>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<pre class="prettyprint"><code><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
-<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
-<uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
-</code></pre>
+<ul>
+<li>
+<p>Android</p>
-<h3>BlackBerry WebWorks</h3>
+<pre class="prettyprint"><code>(in app/res/xml/config.xml)
+<feature name="<a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>">
+ <param name="android-package" value="org.apache.cordova.GeoBroker" />
+</feature>
-<h4>www/plugins.xml</h4>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>" value="org.apache.cordova.geolocation.<a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>" />
+(in app/AndroidManifest.xml)
+<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+<uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks</p>
+
+<pre class="prettyprint"><code>(in www/plugins.xml)
+<feature name="<a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>">
+ <param name="blackberry-package" value="org.apache.cordova.geolocation.<a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>" />
+</feature>
-<h4>www/config.xml</h4>
-<pre class="prettyprint"><code><rim:permissions>
+(in www/config.xml)
+<rim:permissions>
<rim:permit>read_geolocation</rim:permit>
</rim:permissions>
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>" value="CDVLocation" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>">
+ <param name="ios-package" value="CDVLocation" />
+</feature>
</code></pre>
-
-<h3>Windows Phone</h3>
-
-<h4>Properties/WPAppManifest.xml</h4>
+</li>
+<li>
+<p>Windows Phone (in <code>Properties/WPAppManifest.xml</code>)</p>
<pre class="prettyprint"><code><Capabilities>
<Capability Name="ID_CAP_LOCATION" />
@@ -265,11 +278,10 @@ and only executes on devices that don't
</code></pre>
<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>
-
-<h3>Tizen</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
-</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="geolocation.getCurrentPosition">geolocation.getCurrentPosition</a></h1>
@@ -286,12 +298,9 @@ and only executes on devices that don't
</h2>
<ul>
-<li>
-<strong><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></strong>: The callback that is passed the current position.</li>
-<li>
-<strong><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></strong>: <em>(Optional)</em> The callback that executes if an error occurs.</li>
-<li>
-<strong><a href="cordova_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a></strong>: <em>(Optional)</em> The geolocation options.</li>
+<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>
@@ -353,7 +362,7 @@ navigator.<a href="cordova_geolocation_g
<head>
<title><a href="cordova_device_device.md.html#Device">Device</a> Properties Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -410,12 +419,9 @@ navigator.<a href="cordova_geolocation_g
</h2>
<ul>
-<li>
-<strong><a href="cordova_geolocation_geolocation.md.html#geolocationSuccess">geolocationSuccess</a></strong>: The callback that is passed the current position.</li>
-<li>
-<strong><a href="cordova_geolocation_geolocation.md.html#geolocationError">geolocationError</a></strong>: (Optional) The callback that executes if an error occurs.</li>
-<li>
-<strong><a href="cordova_geolocation_geolocation.md.html#geolocationOptions">geolocationOptions</a></strong>: (Optional) The geolocation options.</li>
+<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>
@@ -484,7 +490,7 @@ var watchID = navigator.<a href="cordova
<head>
<title><a href="cordova_device_device.md.html#Device">Device</a> Properties Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -585,7 +591,7 @@ navigator.<a href="cordova_geolocation_g
<head>
<title><a href="cordova_device_device.md.html#Device">Device</a> Properties Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -647,27 +653,13 @@ navigator.<a href="cordova_geolocation_g
</h2>
<ul>
-<li>
-<strong>latitude</strong>: Latitude in decimal degrees. <em>(Number)</em>
-</li>
-<li>
-<strong>longitude</strong>: Longitude in decimal degrees. <em>(Number)</em>
-</li>
-<li>
-<strong>altitude</strong>: Height of the position in meters above the ellipsoid. <em>(Number)</em>
-</li>
-<li>
-<strong>accuracy</strong>: Accuracy level of the latitude and longitude coordinates in meters. <em>(Number)</em>
-</li>
-<li>
-<strong>altitudeAccuracy</strong>: Accuracy level of the altitude coordinate in meters. <em>(Number)</em>
-</li>
-<li>
-<strong>heading</strong>: Direction of travel, specified in degrees counting clockwise relative to the true north. <em>(Number)</em>
-</li>
-<li>
-<strong>speed</strong>: Current ground speed of the device, specified in meters per second. <em>(Number)</em>
-</li>
+<li><p><strong>latitude</strong>: Latitude in decimal degrees. <em>(Number)</em></p></li>
+<li><p><strong>longitude</strong>: Longitude in decimal degrees. <em>(Number)</em></p></li>
+<li><p><strong>altitude</strong>: Height of the position in meters above the ellipsoid. <em>(Number)</em></p></li>
+<li><p><strong>accuracy</strong>: Accuracy level of the latitude and longitude coordinates in meters. <em>(Number)</em></p></li>
+<li><p><strong>altitudeAccuracy</strong>: Accuracy level of the altitude coordinate in meters. <em>(Number)</em></p></li>
+<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>
@@ -722,7 +714,7 @@ navigator.<a href="cordova_geolocation_g
<html>
<head>
<title><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a> <a href="cordova_geolocation_geolocation.md.html#Position">Position</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// wait for device API libraries to load
@@ -779,12 +771,8 @@ navigator.<a href="cordova_geolocation_g
</h2>
<ul>
-<li>
-<strong>coords</strong>: A set of geographic coordinates. <em>(<a href="cordova_geolocation_geolocation.md.html#Coordinates">Coordinates</a>)</em>
-</li>
-<li>
-<strong>timestamp</strong>: Creation timestamp for <code>coords</code>. <em>(Date)</em>
-</li>
+<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>
@@ -840,7 +828,7 @@ navigator.<a href="cordova_geolocation_g
<head>
<title><a href="cordova_device_device.md.html#Device">Device</a> Properties Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -892,10 +880,8 @@ navigator.<a href="cordova_geolocation_g
</h2>
<ul>
-<li>
-<strong>code</strong>: One of the predefined error codes listed below.</li>
-<li>
-<strong>message</strong>: Error message describing the details of the error encountered.</li>
+<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>
@@ -1003,15 +989,9 @@ geolocation functions.</p>
</h2>
<ul>
-<li>
-<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>
-</li>
-<li>
-<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.htm
l#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>
-</li>
-<li>
-<strong>maximumAge</strong>: Accept a cached position whose age is no greater than the specified time in milliseconds. <em>(Number)</em>
-</li>
+<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>