You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/11 06:41:15 UTC
[31/51] [partial] docs commit: Reverting autolinking change because
of inconsistencies.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md b/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md
index 1bafcc3..f73e7d9 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md
+++ b/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md
@@ -30,14 +30,14 @@ Details
If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '<a href="events.deviceready.html">deviceready</a>' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
Supported Platforms
-------------------
- Android
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
document.addEventListener("searchbutton", onSearchKeyDown, false);
@@ -46,31 +46,31 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// Handle the search button
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>PhoneGap Search Button <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>PhoneGap Search Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call on<a href="../device/device.html">Device</a>Ready when PhoneGap is loaded.
+ // Call onDeviceReady when PhoneGap is loaded.
//
// At this point, the document has loaded but cordova-1.5.0.js has not.
// When PhoneGap is loaded and talking with the native device,
- // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
+ // it will call the event `deviceready`.
//
function onLoad() {
- document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
}
// PhoneGap is loaded and it is now safe to make calls PhoneGap methods
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Register the event listener
document.addEventListener("searchbutton", onSearchKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md b/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
index 9b6912d..c9b9a34 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
+++ b/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
@@ -30,14 +30,14 @@ Details
If you need to override the default start call behaviour you can register an event listener for the 'startcallbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '<a href="events.deviceready.html">deviceready</a>' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
document.addEventListener("startcallbutton", onStartCallKeyDown, false);
@@ -46,31 +46,31 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// Handle the start call button
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>PhoneGap Start Call Button <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>PhoneGap Start Call Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call on<a href="../device/device.html">Device</a>Ready when PhoneGap is loaded.
+ // Call onDeviceReady when PhoneGap is loaded.
//
// At this point, the document has loaded but cordova-1.5.0.js has not.
// When PhoneGap is loaded and talking with the native device,
- // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
+ // it will call the event `deviceready`.
//
function onLoad() {
- document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
}
// PhoneGap is loaded and it is now safe to make calls PhoneGap methods
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Register the event listener
document.addEventListener("startcallbutton", onStartCallKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md b/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
index c4b52c0..00923f8 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
+++ b/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
@@ -30,14 +30,14 @@ Details
If you need to override the default volume down behaviour you can register an event listener for the 'volumedownbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '<a href="events.deviceready.html">deviceready</a>' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
@@ -46,31 +46,31 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// Handle the volume down button
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>PhoneGap Volume Down Button <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>PhoneGap Volume Down Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call on<a href="../device/device.html">Device</a>Ready when PhoneGap is loaded.
+ // Call onDeviceReady when PhoneGap is loaded.
//
// At this point, the document has loaded but cordova-1.5.0.js has not.
// When PhoneGap is loaded and talking with the native device,
- // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
+ // it will call the event `deviceready`.
//
function onLoad() {
- document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
}
// PhoneGap is loaded and it is now safe to make calls PhoneGap methods
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Register the event listener
document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md b/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
index 8502e9a..6247b93 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
+++ b/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
@@ -30,14 +30,14 @@ Details
If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '<a href="events.deviceready.html">deviceready</a>' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
@@ -46,31 +46,31 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// Handle the volume up button
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>PhoneGap Volume Up Button <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>PhoneGap Volume Up Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call on<a href="../device/device.html">Device</a>Ready when PhoneGap is loaded.
+ // Call onDeviceReady when PhoneGap is loaded.
//
// At this point, the document has loaded but cordova-1.5.0.js has not.
// When PhoneGap is loaded and talking with the native device,
- // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
+ // it will call the event `deviceready`.
//
function onLoad() {
- document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
}
// PhoneGap is loaded and it is now safe to make calls PhoneGap methods
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Register the event listener
document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md b/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md
index e8766a6..bcc7784 100644
--- a/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md
+++ b/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md
@@ -26,29 +26,29 @@ This object represents a directory on a file system. It is defined in the [W3C
Properties
----------
-- __is<a href="../fileobj/fileobj.html">File</a>:__ Always false. _(boolean)_
+- __isFile:__ Always false. _(boolean)_
- __isDirectory:__ Always true. _(boolean)_
-- __<a href="../../storage/parameters/name.html">name</a>:__ The <a href="../../storage/parameters/name.html">name</a> of the DirectoryEntry, excluding the path leading to it. _(DOMString)_
+- __name:__ The name of the DirectoryEntry, excluding the path leading to it. _(DOMString)_
- __fullPath:__ The full absolute path from the root to the DirectoryEntry. _(DOMString)_
NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by PhoneGap:
-- __filesystem:__ The file system on which the DirectoryEntry resides. _(<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>)_
+- __filesystem:__ The file system on which the DirectoryEntry resides. _(FileSystem)_
Methods
-------
The following methods can be invoked on a DirectoryEntry object:
-- __get<a href="../metadata/metadata.html">Metadata</a>__: Look up metadata about a directory.
+- __getMetadata__: Look up metadata about a directory.
- __moveTo__: Move a directory to a different location on the file system.
- __copyTo__: Copy a directory to a different location on the file system.
- __toURI__: Return a URI that can be used to locate a directory.
- __remove__: Delete a directory. The directory must be empty.
- __getParent__: Look up the parent directory.
-- __createReader__: Create a new <a href="../directoryreader/directoryreader.html">DirectoryReader</a> that can read entries from a directory.
+- __createReader__: Create a new DirectoryReader that can read entries from a directory.
- __getDirectory__: Create or look up a directory.
-- __get<a href="../fileobj/fileobj.html">File</a>__: Create or look up a file.
+- __getFile__: Create or look up a file.
- __removeRecursively__: Delete a directory and all of its contents.
@@ -60,18 +60,18 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-get<a href="../metadata/metadata.html">Metadata</a>
+getMetadata
-----------
Look up metadata about a directory.
__Parameters:__
-- __successCallback__ - A callback that is called with a <a href="../metadata/metadata.html">Metadata</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the <a href="../metadata/metadata.html">Metadata</a>. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(metadata) {
console.log("Last Modified: " + metadata.modificationTime);
@@ -82,7 +82,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
}
// Request the metadata object for this entry
- entry.get<a href="../metadata/metadata.html">Metadata</a>(success, fail);
+ entry.getMetadata(success, fail);
moveTo
@@ -91,7 +91,7 @@ moveTo
Move a directory to a different location on the file system. It is an error to attempt to:
- move a directory inside itself or to any child at any depth;
-- move a directory into its parent if a <a href="../../storage/parameters/name.html">name</a> different from its current one is not provided;
+- move a directory into its parent if a name different from its current one is not provided;
- move a directory to a path occupied by a file;
- move a directory to a path occupied by a directory which is not empty.
@@ -100,12 +100,12 @@ In addition, an attempt to move a directory on top of an existing empty director
__Parameters:__
- __parent__ - The parent directory to which to move the directory. _(DirectoryEntry)_
-- __newName__ - The new <a href="../../storage/parameters/name.html">name</a> of the directory. Defaults to the current <a href="../../storage/parameters/name.html">name</a> if unspecified. _(DOMString)_
+- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(entry) {
console.log("New Path: " + entry.fullPath);
@@ -120,7 +120,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
newName = document.getElementById('newName').value,
parentEntry = new DirectoryEntry({fullPath: parent});
- // move the directory to a new directory and re<a href="../../storage/parameters/name.html">name</a> it
+ // move the directory to a new directory and rename it
entry.moveTo(parentEntry, newName, success, fail);
}
@@ -130,19 +130,19 @@ copyTo
Copy a directory to a different location on the file system. It is an error to attempt to:
- copy a directory inside itself at any depth;
-- copy a directory into its parent if a <a href="../../storage/parameters/name.html">name</a> different from its current one is not provided.
+- copy a directory into its parent if a name different from its current one is not provided.
Directory copies are always recursive - that is, they copy all contents of the directory.
__Parameters:__
- __parent__ - The parent directory to which to copy the directory. _(DirectoryEntry)_
-- __newName__ - The new <a href="../../storage/parameters/name.html">name</a> of the directory. Defaults to the current <a href="../../storage/parameters/name.html">name</a> if unspecified. _(DOMString)_
+- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function win(entry) {
console.log("New Path: " + entry.fullPath);
@@ -157,7 +157,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
newName = document.getElementById('newName').value,
parentEntry = new DirectoryEntry({fullPath: parent});
- // copy the directory to a new directory and re<a href="../../storage/parameters/name.html">name</a> it
+ // copy the directory to a new directory and rename it
entry.copyTo(parentEntry, newName, success, fail);
}
@@ -167,7 +167,7 @@ toURI
Returns a URI that can be used to locate the directory.
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
// Get the URI for this directory
var uri = entry.toURI();
@@ -185,9 +185,9 @@ Deletes a directory. It is an error to attempt to:
__Parameters:__
- __successCallback__ - A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(entry) {
console.log("Removal succeeded");
@@ -209,12 +209,12 @@ Look up the parent DirectoryEntry containing the directory.
__Parameters:__
- __successCallback__ - A callback that is called with the directory's parent DirectoryEntry. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(parent) {
- console.log("Parent Name: " + parent.<a href="../../storage/parameters/name.html">name</a>);
+ console.log("Parent Name: " + parent.name);
}
function fail(error) {
@@ -228,9 +228,9 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
createReader
------------
-Creates a new <a href="../directoryreader/directoryreader.html">DirectoryReader</a> to read entries in a directory.
+Creates a new DirectoryReader to read entries in a directory.
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
// create a directory reader
var directoryReader = entry.createReader();
@@ -246,14 +246,14 @@ Creates or looks up an existing directory. It is an error to attempt to:
__Parameters:__
- __path__ - The path to the directory to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_
-- __options__ - Options to specify whether the directory is created if it doesn't exist. _(<a href="../flags/flags.html">Flags</a>)_
+- __options__ - Options to specify whether the directory is created if it doesn't exist. _(Flags)_
- __successCallback__ - A callback that is invoked with a DirectoryEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(parent) {
- console.log("Parent Name: " + parent.<a href="../../storage/parameters/name.html">name</a>);
+ console.log("Parent Name: " + parent.name);
}
function fail(error) {
@@ -264,7 +264,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
entry.getDirectory("newDir", {create: true, exclusive: false}, success, fail);
-get<a href="../fileobj/fileobj.html">File</a>
+getFile
-------
Creates or looks up a file. It is an error to attempt to:
@@ -274,14 +274,14 @@ Creates or looks up a file. It is an error to attempt to:
__Parameters:__
- __path__ - The path to the file to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_
-- __options__ - Options to specify whether the file is created if it doesn't exist. _(<a href="../flags/flags.html">Flags</a>)_
-- __successCallback__ - A callback that is invoked with a <a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __options__ - Options to specify whether the file is created if it doesn't exist. _(Flags)_
+- __successCallback__ - A callback that is invoked with a FileEntry object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(parent) {
- console.log("Parent Name: " + parent.<a href="../../storage/parameters/name.html">name</a>);
+ console.log("Parent Name: " + parent.name);
}
function fail(error) {
@@ -289,7 +289,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
}
// Retrieve an existing file, or create it if it does not exist
- entry.get<a href="../fileobj/fileobj.html">File</a>("new<a href="../fileobj/fileobj.html">File</a>.txt", {create: true, exclusive: false}, success, fail);
+ entry.getFile("newFile.txt", {create: true, exclusive: false}, success, fail);
removeRecursively
@@ -304,9 +304,9 @@ be deleted. It is an error to attempt to:
__Parameters:__
- __successCallback__ - A callback that is called after the DirectoryEntry has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(parent) {
console.log("Remove Recursively Succeeded");
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md b/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md
index 233df7e..da55cc2 100644
--- a/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md
+++ b/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md
@@ -44,15 +44,15 @@ Read the entries in this directory.
__Parameters:__
-- __successCallback__ - A callback that is passed an array of <a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a> and <a href="../directoryentry/directoryentry.html">DirectoryEntry</a> objects. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the directory listing. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is passed an array of FileEntry and DirectoryEntry objects. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the directory listing. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(entries) {
var i;
for (i=0; i<entries.length; i++) {
- console.log(entries[i].<a href="../../storage/parameters/name.html">name</a>);
+ console.log(entries[i].name);
}
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/file.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/file.md b/www/docs/en/1.5.0/phonegap/file/file.md
index c88f97c..9c6027e 100644
--- a/www/docs/en/1.5.0/phonegap/file/file.md
+++ b/www/docs/en/1.5.0/phonegap/file/file.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="fileobj/fileobj.html">File</a>
+File
==========
> An API to read, write and navigate file system hierarchies.
@@ -26,18 +26,18 @@ license: >
Objects
-------
-- <a href="directoryentry/directoryentry.html">DirectoryEntry</a>
-- <a href="directoryreader/directoryreader.html">DirectoryReader</a>
-- <a href="fileobj/fileobj.html">File</a>
-- <a href="fileentry/fileentry.html"><a href="fileobj/fileobj.html">File</a>Entry</a>
-- <a href="fileerror/fileerror.html"><a href="fileobj/fileobj.html">File</a>Error</a>
-- <a href="filereader/filereader.html"><a href="fileobj/fileobj.html">File</a>Reader</a>
-- <a href="filesystem/filesystem.html"><a href="fileobj/fileobj.html">File</a>System</a>
-- <a href="filetransfer/filetransfer.html"><a href="fileobj/fileobj.html">File</a>Transfer</a>
-- <a href="filetransfererror/filetransfererror.html"><a href="filetransfer/filetransfer.html"><a href="fileobj/fileobj.html">File</a>Transfer</a>Error</a>
-- <a href="fileuploadoptions/fileuploadoptions.html"><a href="fileobj/fileobj.html">File</a>UploadOptions</a>
-- <a href="fileuploadresult/fileuploadresult.html"><a href="fileobj/fileobj.html">File</a>UploadResult</a>
-- <a href="filewriter/filewriter.html"><a href="fileobj/fileobj.html">File</a>Writer</a>
-- <a href="flags/flags.html">Flags</a>
-- Local<a href="filesystem/filesystem.html"><a href="fileobj/fileobj.html">File</a>System</a>
-- <a href="metadata/metadata.html">Metadata</a>
\ No newline at end of file
+- DirectoryEntry
+- DirectoryReader
+- File
+- FileEntry
+- FileError
+- FileReader
+- FileSystem
+- FileTransfer
+- FileTransferError
+- FileUploadOptions
+- FileUploadResult
+- FileWriter
+- Flags
+- LocalFileSystem
+- Metadata
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md b/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md
index c44a551..7a7d521 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md
+++ b/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Entry
+FileEntry
==========
This object represents a file on a file system. It is defined in the [W3C Directories and Systems](http://www.w3.org/TR/file-system-api/) specification.
@@ -26,27 +26,27 @@ This object represents a file on a file system. It is defined in the [W3C Direc
Properties
----------
-- __is<a href="../fileobj/fileobj.html">File</a>:__ Always true. _(boolean)_
+- __isFile:__ Always true. _(boolean)_
- __isDirectory:__ Always false. _(boolean)_
-- __<a href="../../storage/parameters/name.html">name</a>:__ The <a href="../../storage/parameters/name.html">name</a> of the <a href="../fileobj/fileobj.html">File</a>Entry, excluding the path leading to it. _(DOMString)_
-- __fullPath:__ The full absolute path from the root to the <a href="../fileobj/fileobj.html">File</a>Entry. _(DOMString)_
+- __name:__ The name of the FileEntry, excluding the path leading to it. _(DOMString)_
+- __fullPath:__ The full absolute path from the root to the FileEntry. _(DOMString)_
NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by PhoneGap:
-- __filesystem:__ The file system on which the <a href="../fileobj/fileobj.html">File</a>Entry resides. _(<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>)_
+- __filesystem:__ The file system on which the FileEntry resides. _(FileSystem)_
Methods
-------
-- __get<a href="../metadata/metadata.html">Metadata</a>__: Look up metadata about a file.
+- __getMetadata__: Look up metadata about a file.
- __moveTo__: Move a file to a different location on the file system.
- __copyTo__: Copy a file to a different location on the file system.
- __toURI__: Return a URI that can be used to locate a file.
- __remove__: Delete a file.
- __getParent__: Look up the parent directory.
-- __createWriter__: Creates a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> object that can be used to write to a file.
-- __file__: Creates a <a href="../fileobj/fileobj.html">File</a> object containing file properties.
+- __createWriter__: Creates a FileWriter object that can be used to write to a file.
+- __file__: Creates a File object containing file properties.
Supported Platforms
@@ -58,18 +58,18 @@ Supported Platforms
- Windows Phone 7 ( Mango )
-get<a href="../metadata/metadata.html">Metadata</a>
+getMetadata
----------------
Look up metadata about a file.
__Parameters:__
-- __successCallback__ - A callback that is called with a <a href="../metadata/metadata.html">Metadata</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the <a href="../metadata/metadata.html">Metadata</a>. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(metadata) {
console.log("Last Modified: " + metadata.modificationTime);
@@ -80,7 +80,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
}
// Request the metadata object for this entry
- entry.get<a href="../metadata/metadata.html">Metadata</a>(success, fail);
+ entry.getMetadata(success, fail);
moveTo
@@ -88,20 +88,20 @@ moveTo
Move a file to a different location on the file system. It is an error to attempt to:
-- move a file into its parent if a <a href="../../storage/parameters/name.html">name</a> different from its current one isn't provided;
+- move a file into its parent if a name different from its current one isn't provided;
- move a file to a path occupied by a directory;
In addition, an attempt to move a file on top of an existing file must attempt to delete and replace that file.
__Parameters:__
-- __parent__ - The parent directory to which to move the file. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
-- __newName__ - The new <a href="../../storage/parameters/name.html">name</a> of the file. Defaults to the current <a href="../../storage/parameters/name.html">name</a> if unspecified. _(DOMString)_
-- __successCallback__ - A callback that is called with the <a href="../fileobj/fileobj.html">File</a>Entry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __parent__ - The parent directory to which to move the file. _(DirectoryEntry)_
+- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
+- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(entry) {
console.log("New Path: " + entry.fullPath);
@@ -111,12 +111,12 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
alert(error.code);
}
- function move<a href="../fileobj/fileobj.html">File</a>(entry) {
+ function moveFile(entry) {
var parent = document.getElementById('parent').value,
- parentEntry = new <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>({fullPath: parent});
+ parentEntry = new DirectoryEntry({fullPath: parent});
- // move the file to a new directory and re<a href="../../storage/parameters/name.html">name</a> it
- entry.moveTo(parentEntry, "new<a href="../fileobj/fileobj.html">File</a>.txt", success, fail);
+ // move the file to a new directory and rename it
+ entry.moveTo(parentEntry, "newFile.txt", success, fail);
}
@@ -125,17 +125,17 @@ copyTo
Copy a file to a new location on the file system. It is an error to attempt to:
-- copy a file into its parent if a <a href="../../storage/parameters/name.html">name</a> different from its current one is not provided.
+- copy a file into its parent if a name different from its current one is not provided.
__Parameters:__
-- __parent__ - The parent directory to which to copy the file. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
-- __newName__ - The new <a href="../../storage/parameters/name.html">name</a> of the file. Defaults to the current <a href="../../storage/parameters/name.html">name</a> if unspecified. _(DOMString)_
-- __successCallback__ - A callback that is called with the <a href="../fileobj/fileobj.html">File</a>Entry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __parent__ - The parent directory to which to copy the file. _(DirectoryEntry)_
+- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
+- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function win(entry) {
console.log("New Path: " + entry.fullPath);
@@ -145,11 +145,11 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
alert(error.code);
}
- function copy<a href="../fileobj/fileobj.html">File</a>(entry) {
+ function copyFile(entry) {
var parent = document.getElementById('parent').value,
- parentEntry = new <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>({fullPath: parent});
+ parentEntry = new DirectoryEntry({fullPath: parent});
- // copy the file to a new directory and re<a href="../../storage/parameters/name.html">name</a> it
+ // copy the file to a new directory and rename it
entry.copyTo(parentEntry, "file.copy", success, fail);
}
@@ -159,7 +159,7 @@ toURI
Returns a URI that can be used to locate the file.
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
// Request the URI for this entry
var uri = entry.toURI();
@@ -174,9 +174,9 @@ Deletes a file.
__Parameters:__
- __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(entry) {
console.log("Removal succeeded");
@@ -193,38 +193,38 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
getParent
---------
-Look up the parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a> containing the file.
+Look up the parent DirectoryEntry containing the file.
__Parameters:__
-- __successCallback__ - A callback that is called with the file's parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with the file's parent DirectoryEntry. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(parent) {
- console.log("Parent Name: " + parent.<a href="../../storage/parameters/name.html">name</a>);
+ console.log("Parent Name: " + parent.name);
}
function fail(error) {
alert(error.code);
}
- // Get the parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>
+ // Get the parent DirectoryEntry
entry.getParent(success, fail);
createWriter
------------
-Create a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> object associated with the file that the <a href="../fileobj/fileobj.html">File</a>Entry represents.
+Create a FileWriter object associated with the file that the FileEntry represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs while attempting to create the <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a>. Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a FileWriter object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs while attempting to create the FileWriter. Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(writer) {
writer.write("Some text to the file");
@@ -234,24 +234,24 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
alert(error.code);
}
- // create a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> to write to the file
+ // create a FileWriter to write to the file
entry.createWriter(success, fail);
file
----
-Return a <a href="../fileobj/fileobj.html">File</a> object that represents the current state of the file that this <a href="../fileobj/fileobj.html">File</a>Entry represents.
+Return a File object that represents the current state of the file that this FileEntry represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a <a href="../fileobj/fileobj.html">File</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when creating the <a href="../fileobj/fileobj.html">File</a> object (e.g. the underlying file no longer exists). Invoked with a <a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a File object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when creating the File object (e.g. the underlying file no longer exists). Invoked with a FileError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
function success(file) {
- console.log("<a href="../fileobj/fileobj.html">File</a> <a href="../../storage/parameters/size.html">size</a>: " + file.<a href="../../storage/parameters/size.html">size</a>);
+ console.log("File size: " + file.size);
}
function fail(error) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md b/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md
index 5bdd794..fa54c1f 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md
+++ b/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Error
+FileError
========
-A '<a href="../fileobj/fileobj.html">File</a>Error' object is set when an error occurs in any of the <a href="../fileobj/fileobj.html">File</a> API methods.
+A 'FileError' object is set when an error occurs in any of the File API methods.
Properties
----------
@@ -31,20 +31,20 @@ Properties
Constants
---------
-- `<a href="../fileobj/fileobj.html">File</a>Error.NOT_FOUND_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.SECURITY_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.ABORT_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.NOT_READABLE_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.ENCODING_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.NO_MODIFICATION_ALLOWED_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.INVALID_STATE_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.SYNTAX_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.INVALID_MODIFICATION_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.QUOTA_EXCEEDED_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.TYPE_MISMATCH_ERR`
-- `<a href="../fileobj/fileobj.html">File</a>Error.PATH_EXISTS_ERR`
+- `FileError.NOT_FOUND_ERR`
+- `FileError.SECURITY_ERR`
+- `FileError.ABORT_ERR`
+- `FileError.NOT_READABLE_ERR`
+- `FileError.ENCODING_ERR`
+- `FileError.NO_MODIFICATION_ALLOWED_ERR`
+- `FileError.INVALID_STATE_ERR`
+- `FileError.SYNTAX_ERR`
+- `FileError.INVALID_MODIFICATION_ERR`
+- `FileError.QUOTA_EXCEEDED_ERR`
+- `FileError.TYPE_MISMATCH_ERR`
+- `FileError.PATH_EXISTS_ERR`
Description
-----------
-The `<a href="../fileobj/fileobj.html">File</a>Error` object is the only parameter of any of the <a href="../fileobj/fileobj.html">File</a> API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
+The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md b/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md
index 42f9589..9920be9 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md
+++ b/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md
@@ -26,16 +26,16 @@ This object contains attributes of a single file.
Properties
----------
-- __<a href="../../storage/parameters/name.html">name</a>:__ The <a href="../../storage/parameters/name.html">name</a> of the file. _(DOMString)_
-- __fullPath:__ The full path of the file including the file <a href="../../storage/parameters/name.html">name</a>. _(DOMString)_
+- __name:__ The name of the file. _(DOMString)_
+- __fullPath:__ The full path of the file including the file name. _(DOMString)_
- __type:__ The mime type of the file. _(DOMString)_
- __lastModifiedDate:__ The last time the file was modified. _(Date)_
-- __<a href="../../storage/parameters/size.html">size</a>:__ The <a href="../../storage/parameters/size.html">size</a> of the file in bytes. _(long)_
+- __size:__ The size of the file in bytes. _(long)_
Details
-------
-The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `<a href="../fileentry/fileentry.html">FileEntry</a>` object.
+The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md b/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md
index 72431a0..f482844 100644
--- a/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md
+++ b/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md
@@ -18,17 +18,17 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Reader
+FileReader
==========
-<a href="../fileobj/fileobj.html">File</a>Reader is an object that allows one to read a file.
+FileReader is an object that allows one to read a file.
Properties
----------
- __readyState:__ One of the three states the reader can be in EMPTY, LOADING or DONE.
- __result:__ The contents of the file that has been read. _(DOMString)_
-- __error:__ An object containing errors. _(<a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a>)_
+- __error:__ An object containing errors. _(FileError)_
- __onloadstart:__ Called when the read starts. . _(Function)_
- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -NOT SUPPORTED
- __onload:__ Called when the read has successfully completed. _(Function)_
@@ -46,7 +46,7 @@ Methods
Details
-------
-The `<a href="../fileobj/fileobj.html">File</a>Reader` object is a way to read files from the devices file system. <a href="../fileobj/fileobj.html">File</a>s can be read as text or as a base64 data encoded string. Users register their own event listeners to receive the loadstart, progress, load, loadend, error and abort events.
+The `FileReader` object is a way to read files from the devices file system. Files can be read as text or as a base64 data encoded string. Users register their own event listeners to receive the loadstart, progress, load, loadend, error and abort events.
Supported Platforms
-------------------
@@ -63,11 +63,11 @@ __Parameters:__
- file - the file object to read
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function win(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("read success");
console.log(evt.target.result);
@@ -89,11 +89,11 @@ __Parameters:__
- file - the file object to read
- encoding - the encoding to use to encode the file's content. Default is UTF8.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function win(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("read success");
console.log(evt.target.result);
@@ -107,11 +107,11 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.file(win, fail);
-Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Abort Quick Example
-------------------
function win(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("read success");
console.log(evt.target.result);
@@ -126,13 +126,13 @@ Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.file(win, fail);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../fileobj/fileobj.html">File</a>Reader <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>FileReader Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -140,30 +140,30 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// Wait for PhoneGap to load
//
function onLoad() {
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
}
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- window.request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>(Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, gotFS, fail);
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
}
function gotFS(fileSystem) {
- fileSystem.root.get<a href="../fileobj/fileobj.html">File</a>("readme.txt", null, got<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>, fail);
+ fileSystem.root.getFile("readme.txt", null, gotFileEntry, fail);
}
- function got<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>(fileEntry) {
- fileEntry.file(got<a href="../fileobj/fileobj.html">File</a>, fail);
+ function gotFileEntry(fileEntry) {
+ fileEntry.file(gotFile, fail);
}
- function got<a href="../fileobj/fileobj.html">File</a>(file){
+ function gotFile(file){
readDataUrl(file);
readAsText(file);
}
function readDataUrl(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("Read as data URL");
console.log(evt.target.result);
@@ -172,7 +172,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
}
function readAsText(file) {
- var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
+ var reader = new FileReader();
reader.onloadend = function(evt) {
console.log("Read as text");
console.log(evt.target.result);
@@ -187,8 +187,8 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Read <a href="../fileobj/fileobj.html">File</a></p>
+ <h1>Example</h1>
+ <p>Read File</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md b/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md
index 5633f7d..0ac34ba 100644
--- a/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md
+++ b/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>System
+FileSystem
==========
This object represents a file system.
@@ -26,13 +26,13 @@ This object represents a file system.
Properties
----------
-- __<a href="../../storage/parameters/name.html">name</a>:__ The <a href="../../storage/parameters/name.html">name</a> of the file system. _(DOMString)_
-- __root:__ The root directory of the file system. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
+- __name:__ The name of the file system. _(DOMString)_
+- __root:__ The root directory of the file system. _(DirectoryEntry)_
Details
-------
-The `<a href="../fileobj/fileobj.html">File</a>System` object represents information about the file system. The <a href="../../storage/parameters/name.html">name</a> of the file system will be unique across the list of exposed file systems. The root property contains a `<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>` object which represents the root directory of the file system.
+The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `DirectoryEntry` object which represents the root directory of the file system.
Supported Platforms
-------------------
@@ -42,41 +42,41 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-<a href="../fileobj/fileobj.html">File</a> System Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+File System Quick Example
-------------------------
function onSuccess(fileSystem) {
- console.log(fileSystem.<a href="../../storage/parameters/name.html">name</a>);
- console.log(fileSystem.root.<a href="../../storage/parameters/name.html">name</a>);
+ console.log(fileSystem.name);
+ console.log(fileSystem.root.name);
}
// request the persistent file system
- window.request<a href="../fileobj/fileobj.html">File</a>System(<a href="../localfilesystem/localfilesystem.html">Local<a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, onSuccess, null);
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../fileobj/fileobj.html">File</a> System <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>File System Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- window.request<a href="../fileobj/fileobj.html">File</a>System(<a href="../localfilesystem/localfilesystem.html">Local<a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, on<a href="../fileobj/fileobj.html">File</a>SystemSuccess, fail);
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
}
- function on<a href="../fileobj/fileobj.html">File</a>SystemSuccess(fileSystem) {
- console.log(fileSystem.<a href="../../storage/parameters/name.html">name</a>);
- console.log(fileSystem.root.<a href="../../storage/parameters/name.html">name</a>);
+ function onFileSystemSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ console.log(fileSystem.root.name);
}
function fail(evt) {
@@ -86,7 +86,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p><a href="../fileobj/fileobj.html">File</a> System</p>
+ <h1>Example</h1>
+ <p>File System</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md b/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md
index fe5296f..e51176c 100644
--- a/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md
+++ b/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Transfer
+FileTransfer
==========
-<a href="../fileobj/fileobj.html">File</a>Transfer is an object that allows you to upload files to a server or download files from a server.
+FileTransfer is an object that allows you to upload files to a server or download files from a server.
Properties
----------
@@ -37,7 +37,7 @@ Methods
Details
-------
-The `<a href="../fileobj/fileobj.html">File</a>Transfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a <a href="../fileuploadoptions/fileuploadoptions.html"><a href="../fileobj/fileobj.html">File</a>UploadOptions</a> object to the upload method. On successful upload, the success callback will be called with a <a href="../fileuploadresult/fileuploadresult.html"><a href="../fileobj/fileobj.html">File</a>UploadResult</a> object. If an error occurs, the error callback will be invoked with a <a href="../filetransfererror/filetransfererror.html"><a href="../fileobj/fileobj.html">File</a>TransferError</a> object.
+The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
It is also possible to download a file from remote and save it on the device (only iOS and Android).
Supported Platforms
@@ -55,11 +55,11 @@ __Parameters:__
- __filePath__ - Full path of the file on the device
- __server__ - URL of the server to receive the file
-- __successCallback__ - A callback that is called with a <a href="../metadata/metadata.html">Metadata</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the <a href="../metadata/metadata.html">Metadata</a>. Invoked with a <a href="../filetransfererror/filetransfererror.html"><a href="../fileobj/fileobj.html">File</a>TransferError</a> object. _(Function)_
-- __options__ - Optional parameters such as file <a href="../../storage/parameters/name.html">name</a> and mimetype
+- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
+- __options__ - Optional parameters such as file name and mimetype
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
// !! Assumes variable fileURI contains a valid URI to a text file on the device
@@ -75,7 +75,7 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
console.log("upload error target " + error.target);
}
- var options = new <a href="../fileuploadoptions/fileuploadoptions.html"><a href="../fileobj/fileobj.html">File</a>UploadOptions</a>();
+ var options = new FileUploadOptions();
options.fileKey="file";
options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
options.mimeType="text/plain";
@@ -86,29 +86,29 @@ __Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
options.params = params;
- var ft = new <a href="../fileobj/fileobj.html">File</a>Transfer();
+ var ft = new FileTransfer();
ft.upload(fileURI, "http://some.server.com/upload.php", win, fail, options);
-__Full <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Full Example__
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title><a href="../fileobj/fileobj.html">File</a> Transfer <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>File Transfer Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Retrieve image file location from specified source
- navigator.<a href="../../camera/camera.getPicture.html">camera.getPicture</a>(uploadPhoto,
+ navigator.camera.getPicture(uploadPhoto,
function(message) { alert('get picture failed'); },
{ quality: 50,
destinationType: navigator.camera.DestinationType.FILE_URI,
@@ -118,7 +118,7 @@ __Full <a href="../../storage/storage.opendatabase.html">Example</a>__
}
function uploadPhoto(imageURI) {
- var options = new <a href="../fileuploadoptions/fileuploadoptions.html"><a href="../fileobj/fileobj.html">File</a>UploadOptions</a>();
+ var options = new FileUploadOptions();
options.fileKey="file";
options.fileName=imageURI.substr(imageURI.lastIndexOf('/')+1);
options.mimeType="image/jpeg";
@@ -129,7 +129,7 @@ __Full <a href="../../storage/storage.opendatabase.html">Example</a>__
options.params = params;
- var ft = new <a href="../fileobj/fileobj.html">File</a>Transfer();
+ var ft = new FileTransfer();
ft.upload(imageURI, "http://some.server.com/upload.php", win, fail, options);
}
@@ -148,8 +148,8 @@ __Full <a href="../../storage/storage.opendatabase.html">Example</a>__
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Upload <a href="../fileobj/fileobj.html">File</a></p>
+ <h1>Example</h1>
+ <p>Upload File</p>
</body>
</html>
@@ -160,14 +160,14 @@ __Parameters:__
- __source__ - URL of the server to receive the file
- __target__ - Full path of the file on the device
-- __successCallback__ - A callback that is called with a <a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a> object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the <a href="../metadata/metadata.html">Metadata</a>. Invoked with a <a href="../filetransfererror/filetransfererror.html"><a href="../fileobj/fileobj.html">File</a>TransferError</a> object. _(Function)_
+- __successCallback__ - A callback that is called with a FileEntry object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
-__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
+__Quick Example__
// !! Assumes variable url contains a valid URI to a file on a server and filePath is a valid path on the device
- var fileTransfer = new <a href="../fileobj/fileobj.html">File</a>Transfer();
+ var fileTransfer = new FileTransfer();
fileTransfer.download(
url,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filetransfererror/filetransfererror.md b/www/docs/en/1.5.0/phonegap/file/filetransfererror/filetransfererror.md
index 1ef9e88..b243292 100644
--- a/www/docs/en/1.5.0/phonegap/file/filetransfererror/filetransfererror.md
+++ b/www/docs/en/1.5.0/phonegap/file/filetransfererror/filetransfererror.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error
+FileTransferError
========
-A `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error` object is returned via the error callback when an error occurs.
+A `FileTransferError` object is returned via the error callback when an error occurs.
Properties
----------
@@ -33,11 +33,11 @@ Properties
Constants
---------
-- `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error.FILE_NOT_FOUND_ERR`
-- `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error.INVALID_URL_ERR`
-- `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error.CONNECTION_ERR`
+- `FileTransferError.FILE_NOT_FOUND_ERR`
+- `FileTransferError.INVALID_URL_ERR`
+- `FileTransferError.CONNECTION_ERR`
Description
-----------
-The `<a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a>Error` object is returned via the error callback when an error occurs when uploading a file.
+The `FileTransferError` object is returned via the error callback when an error occurs when uploading a file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md
index 3221aea..46b2e47 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md
+++ b/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md
@@ -18,16 +18,16 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>UploadOptions
+FileUploadOptions
========
-A `<a href="../fileobj/fileobj.html">File</a>UploadOptions` object can be passed to the <a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a> objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
Properties
----------
-- __fileKey:__ The <a href="../../storage/parameters/name.html">name</a> of the form element. If not set defaults to "file". (DOMString)
-- __fileName:__ The file <a href="../../storage/parameters/name.html">name</a> you want the file to be saved as on the server. If not set defaults to "image.jpg". (DOMString)
+- __fileKey:__ The name of the form element. If not set defaults to "file". (DOMString)
+- __fileName:__ The file name you want the file to be saved as on the server. If not set defaults to "image.jpg". (DOMString)
- __mimeType:__ The mime type of the data you are uploading. If not set defaults to "image/jpeg". (DOMString)
- __params:__ A set of optional key/value pairs to be passed along in the HTTP request. (Object)
- __chunkedMode:__ Should the data be uploaded in chunked streaming mode. If not set defaults to "true". (Boolean)
@@ -36,4 +36,4 @@ Properties
Description
-----------
-A `<a href="../fileobj/fileobj.html">File</a>UploadOptions` object can be passed to the <a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a> objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md b/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md
index a910ccb..d82cde1 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md
+++ b/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>UploadResult
+FileUploadResult
========
-A `<a href="../fileobj/fileobj.html">File</a>UploadResult` object is returned via the success callback of the <a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a> upload method.
+A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
Properties
----------
@@ -33,9 +33,9 @@ Properties
Description
-----------
-The `<a href="../fileobj/fileobj.html">File</a>UploadResult` object is returned via the success callback of the <a href="../filetransfer/filetransfer.html"><a href="../fileobj/fileobj.html">File</a>Transfer</a> upload method.
+The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
iOS Quirks
----------
-- iOS does not include values for responseCode nor bytesSent in the success callback <a href="../fileobj/fileobj.html">File</a>UploadResult object.
+- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md b/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md
index 6b3eb60..3c3bd1b 100644
--- a/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md
+++ b/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md
@@ -18,19 +18,19 @@ license: >
under the License.
---
-<a href="../fileobj/fileobj.html">File</a>Writer
+FileWriter
==========
-<a href="../fileobj/fileobj.html">File</a>Writer is an object that allows one to write a file.
+FileWriter is an object that allows one to write a file.
Properties
----------
- __readyState:__ One of the three states the reader can be in INIT, WRITING or DONE.
-- __fileName:__ The <a href="../../storage/parameters/name.html">name</a> of the file to be written. _(DOMString)_
+- __fileName:__ The name of the file to be written. _(DOMString)_
- __length:__ The length of the file to be written. _(long)_
- __position:__ The current position of the file pointer. _(long)_
-- __error:__ An object containing errors. _(<a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a>)_
+- __error:__ An object containing errors. _(FileError)_
- __onwritestart:__ Called when the write starts. . _(Function)_
- __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -NOT SUPPORTED
- __onwrite:__ Called when the request has completed successfully. _(Function)_
@@ -49,9 +49,9 @@ Methods
Details
-------
-The `<a href="../fileobj/fileobj.html">File</a>Writer` object is a way to write files from the devices file system. Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events.
+The `FileWriter` object is a way to write files from the devices file system. Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events.
-A <a href="../fileobj/fileobj.html">File</a>Writer is created for a single file. You can use it to write to a file multiple times. The <a href="../fileobj/fileobj.html">File</a>Writer maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the <a href="../fileobj/fileobj.html">File</a>Writer writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the <a href="../fileobj/fileobj.html">File</a>Writer's constructor to begin writing to the end of the file.
+A FileWriter is created for a single file. You can use it to write to a file multiple times. The FileWriter maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the FileWriter writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor to begin writing to the end of the file.
Supported Platforms
-------------------
@@ -61,7 +61,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Seek Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Seek Quick Example
------------------------------
function win(writer) {
@@ -75,7 +75,7 @@ Seek Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Truncate Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Truncate Quick Example
--------------------------
function win(writer) {
@@ -88,7 +88,7 @@ Truncate Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Write Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Write Quick Example
-------------------
function win(writer) {
@@ -104,7 +104,7 @@ Write Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Append Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Append Quick Example
--------------------
function win(writer) {
@@ -121,7 +121,7 @@ Append Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Abort Quick Example
-------------------
function win(writer) {
@@ -138,35 +138,35 @@ Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
entry.createWriter(win, fail);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../fileobj/fileobj.html">File</a>Writer <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>FileWriter Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- window.request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>(Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, gotFS, fail);
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
}
function gotFS(fileSystem) {
- fileSystem.root.get<a href="../fileobj/fileobj.html">File</a>("readme.txt", {create: true, exclusive: false}, got<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>, fail);
+ fileSystem.root.getFile("readme.txt", {create: true, exclusive: false}, gotFileEntry, fail);
}
- function got<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>(fileEntry) {
- fileEntry.createWriter(got<a href="../fileobj/fileobj.html">File</a>Writer, fail);
+ function gotFileEntry(fileEntry) {
+ fileEntry.createWriter(gotFileWriter, fail);
}
- function got<a href="../fileobj/fileobj.html">File</a>Writer(writer) {
+ function gotFileWriter(writer) {
writer.onwriteend = function(evt) {
console.log("contents of file now 'some sample text'");
writer.truncate(11);
@@ -189,7 +189,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Write <a href="../fileobj/fileobj.html">File</a></p>
+ <h1>Example</h1>
+ <p>Write File</p>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/flags/flags.md b/www/docs/en/1.5.0/phonegap/file/flags/flags.md
index c5e9c8d..dedd8d4 100644
--- a/www/docs/en/1.5.0/phonegap/file/flags/flags.md
+++ b/www/docs/en/1.5.0/phonegap/file/flags/flags.md
@@ -21,7 +21,7 @@ license: >
Flags
=====
-This object is used to supply arguments to the `<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>` __get<a href="../fileobj/fileobj.html">File</a>__ and __getDirectory__ methods, which look up or create files and directories, respectively.
+This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively.
Properties
----------
@@ -37,11 +37,11 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Get the data directory, creating it if it doesn't exist.
dataDir = fileSystem.root.getDirectory("data", {create: true});
// Create the lock file, if and only if it doesn't exist.
- lock<a href="../fileobj/fileobj.html">File</a> = dataDir.get<a href="../fileobj/fileobj.html">File</a>("lockfile.txt", {create: true, exclusive: true});
+ lockFile = dataDir.getFile("lockfile.txt", {create: true, exclusive: true});
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org