You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/10 23:28:06 UTC
[06/51] [partial] docs commit: Solidifying 'automatic' links.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.batterystatus.md b/www/docs/en/1.8.1/cordova/events/events.batterystatus.md
index d0d5af4..fbd7302 100644
--- a/www/docs/en/1.8.1/cordova/events/events.batterystatus.md
+++ b/www/docs/en/1.8.1/cordova/events/events.batterystatus.md
@@ -35,7 +35,7 @@ The battery status handler will be called with an object that contains two prope
- __level:__ The percentage of battery (0-100). _(Number)_
- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -53,40 +53,40 @@ The `level` property is unavailable as Windows Phone 7 does not provide
native APIs for determining battery level. The `isPlugged` parameter
_is_ supported.
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
window.addEventListener("batterystatus", onBatteryStatus, false);
function onBatteryStatus(info) {
- // Handle the online event
+ // Handle the <a href="events.online.html">online</a> event
console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Cordova <a href="../device/device.html">Device</a> Ready <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
window.addEventListener("batterystatus", onBatteryStatus, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.deviceready.md b/www/docs/en/1.8.1/cordova/events/events.deviceready.md
index ce273c2..e4051bc 100644
--- a/www/docs/en/1.8.1/cordova/events/events.deviceready.md
+++ b/www/docs/en/1.8.1/cordova/events/events.deviceready.md
@@ -45,39 +45,39 @@ Supported Platforms
- Windows Phone 7
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("deviceready", on<a href="../device/device.html">Device</a>Ready, false);
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Now safe to use the Cordova API
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Cordova <a href="../device/device.html">Device</a> Ready <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
// it will call the event `deviceready`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("deviceready", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Now safe to use the Cordova API
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.endcallbutton.md b/www/docs/en/1.8.1/cordova/events/events.endcallbutton.md
index 9a3387d..28eaa7d 100644
--- a/www/docs/en/1.8.1/cordova/events/events.endcallbutton.md
+++ b/www/docs/en/1.8.1/cordova/events/events.endcallbutton.md
@@ -30,14 +30,14 @@ Details
If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("endcallbutton", onEndCallKeyDown, false);
@@ -46,31 +46,31 @@ Quick Example
// Handle the end call button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova End Call Button Example</title>
+ <title>Cordova End Call Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("endcallbutton", onEndCallKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.md b/www/docs/en/1.8.1/cordova/events/events.md
index 067c14c..23d0478 100644
--- a/www/docs/en/1.8.1/cordova/events/events.md
+++ b/www/docs/en/1.8.1/cordova/events/events.md
@@ -26,21 +26,21 @@ Events
Event Types
-----------
-- deviceready
-- pause
-- resume
-- online
-- offline
-- backbutton
-- batterycritical
-- batterylow
-- batterystatus
-- menubutton
-- searchbutton
-- startcallbutton
-- endcallbutton
-- volumedownbutton
-- volumeupbutton
+- <a href="events.deviceready.html">deviceready</a>
+- <a href="events.pause.html">pause</a>
+- <a href="events.resume.html">resume</a>
+- <a href="events.online.html">online</a>
+- <a href="events.offline.html">offline</a>
+- <a href="events.backbutton.html">backbutton</a>
+- <a href="events.batterycritical.html">batterycritical</a>
+- <a href="events.batterylow.html">batterylow</a>
+- <a href="events.batterystatus.html">batterystatus</a>
+- <a href="events.menubutton.html">menubutton</a>
+- <a href="events.searchbutton.html">searchbutton</a>
+- <a href="events.startcallbutton.html">startcallbutton</a>
+- <a href="events.endcallbutton.html">endcallbutton</a>
+- <a href="events.volumedownbutton.html">volumedownbutton</a>
+- <a href="events.volumeupbutton.html">volumeupbutton</a>
Permissions
-----------
@@ -77,7 +77,7 @@ Permissions
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.menubutton.md b/www/docs/en/1.8.1/cordova/events/events.menubutton.md
index 8e961b0..f8459cc 100644
--- a/www/docs/en/1.8.1/cordova/events/events.menubutton.md
+++ b/www/docs/en/1.8.1/cordova/events/events.menubutton.md
@@ -30,7 +30,7 @@ Details
If you need to override the default menu button behaviour you can register an event listener for the 'menubutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -38,7 +38,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("menubutton", onMenuKeyDown, false);
@@ -47,31 +47,31 @@ Quick Example
// Handle the back button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Menu Button Example</title>
+ <title>Cordova Menu Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("menubutton", onMenuKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.offline.md b/www/docs/en/1.8.1/cordova/events/events.offline.md
index eb7beb6..2ccf6fd 100644
--- a/www/docs/en/1.8.1/cordova/events/events.offline.md
+++ b/www/docs/en/1.8.1/cordova/events/events.offline.md
@@ -30,7 +30,7 @@ Details
When the application's network connection changes to being offline, the offline event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("offline", onOffline, false);
@@ -49,30 +49,30 @@ Quick Example
// Handle the offline event
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Offline Example</title>
+ <title>Cordova Offline <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
document.addEventListener("offline", onOffline, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.online.md b/www/docs/en/1.8.1/cordova/events/events.online.md
index b6d732d..0f710a5 100644
--- a/www/docs/en/1.8.1/cordova/events/events.online.md
+++ b/www/docs/en/1.8.1/cordova/events/events.online.md
@@ -30,7 +30,7 @@ Details
When the application's network connection changes to being online, the online event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("online", onOnline, false);
@@ -49,30 +49,30 @@ Quick Example
// Handle the online event
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Online Example</title>
+ <title>Cordova Online <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
document.addEventListener("online", onOnline, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.pause.md b/www/docs/en/1.8.1/cordova/events/events.pause.md
index 339e187..e8074f0 100644
--- a/www/docs/en/1.8.1/cordova/events/events.pause.md
+++ b/www/docs/en/1.8.1/cordova/events/events.pause.md
@@ -30,7 +30,7 @@ Details
Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("pause", onPause, false);
@@ -49,30 +49,30 @@ Quick Example
// Handle the pause event
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Pause Example</title>
+ <title>Cordova Pause <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
document.addEventListener("pause", onPause, false);
}
@@ -89,7 +89,7 @@ Full Example
iOS Quirks
--------------------------
-In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app resumes (processed on the next run-loop).
+In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app <a href="events.resume.html">resume</a>s (processed on the next run-loop).
- __resign__ event
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.resume.md b/www/docs/en/1.8.1/cordova/events/events.resume.md
index 6b7c67e..b7d55b3 100644
--- a/www/docs/en/1.8.1/cordova/events/events.resume.md
+++ b/www/docs/en/1.8.1/cordova/events/events.resume.md
@@ -30,7 +30,7 @@ Details
Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("resume", onResume, false);
@@ -49,30 +49,30 @@ Quick Example
// Handle the resume event
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Resume Example</title>
+ <title>Cordova Resume <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
document.addEventListener("resume", onResume, false);
}
@@ -89,7 +89,7 @@ Full Example
iOS Quirks
--------------------------
-Any calls to console.log during your **pause** event handler will be run now when the app resumes, see the iOS Quirks section for the **pause** event for an explanation.
+Any calls to console.log during your **<a href="events.pause.html">pause</a>** event handler will be run now when the app resumes, see the iOS Quirks section for the **<a href="events.pause.html">pause</a>** event for an explanation.
Interactive functions like `alert` when the **resume** event fires will need to be wrapped in a `setTimeout` call with a timeout value of zero, or else the app will hang. e.g.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.searchbutton.md b/www/docs/en/1.8.1/cordova/events/events.searchbutton.md
index 1549257..4d96450 100644
--- a/www/docs/en/1.8.1/cordova/events/events.searchbutton.md
+++ b/www/docs/en/1.8.1/cordova/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 Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
- Android
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("searchbutton", onSearchKeyDown, false);
@@ -46,31 +46,31 @@ Quick Example
// Handle the search button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Search Button Example</title>
+ <title>Cordova Search Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("searchbutton", onSearchKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.startcallbutton.md b/www/docs/en/1.8.1/cordova/events/events.startcallbutton.md
index 210ff91..8b5ce4f 100644
--- a/www/docs/en/1.8.1/cordova/events/events.startcallbutton.md
+++ b/www/docs/en/1.8.1/cordova/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 Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("startcallbutton", onStartCallKeyDown, false);
@@ -46,31 +46,31 @@ Quick Example
// Handle the start call button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Start Call Button Example</title>
+ <title>Cordova Start Call Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("startcallbutton", onStartCallKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.volumedownbutton.md b/www/docs/en/1.8.1/cordova/events/events.volumedownbutton.md
index a071915..350aa31 100644
--- a/www/docs/en/1.8.1/cordova/events/events.volumedownbutton.md
+++ b/www/docs/en/1.8.1/cordova/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 Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
@@ -46,31 +46,31 @@ Quick Example
// Handle the volume down button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Volume Down Button Example</title>
+ <title>Cordova Volume Down Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/events/events.volumeupbutton.md b/www/docs/en/1.8.1/cordova/events/events.volumeupbutton.md
index 342fda9..79d968f 100644
--- a/www/docs/en/1.8.1/cordova/events/events.volumeupbutton.md
+++ b/www/docs/en/1.8.1/cordova/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 Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
@@ -46,31 +46,31 @@ Quick Example
// Handle the volume up button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Volume Up Button Example</title>
+ <title>Cordova Volume Up Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.1.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/directoryentry/directoryentry.md b/www/docs/en/1.8.1/cordova/file/directoryentry/directoryentry.md
index f06bd19..406f84f 100644
--- a/www/docs/en/1.8.1/cordova/file/directoryentry/directoryentry.md
+++ b/www/docs/en/1.8.1/cordova/file/directoryentry/directoryentry.md
@@ -26,30 +26,30 @@ This object represents a directory on a file system. It is defined in the [W3C
Properties
----------
-- __isFile:__ Always false. _(boolean)_
+- __is<a href="../fileobj/fileobj.html">File</a>:__ Always false. _(boolean)_
- __isDirectory:__ Always true. _(boolean)_
- __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 Cordova:
-- __filesystem:__ The file system on which the DirectoryEntry resides. _(FileSystem)_
+- __filesystem:__ The file system on which the DirectoryEntry resides. _(<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>)_
Methods
-------
The following methods can be invoked on a DirectoryEntry object:
-- __getMetadata__: Look up metadata about a directory.
-- __setMetadata__: Set metadata on a directory.
+- __get<a href="../metadata/metadata.html">Metadata</a>__: Look up metadata about a directory.
+- __set<a href="../metadata/metadata.html">Metadata</a>__: Set metadata on 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.
- __toURL__: Return a URL 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 DirectoryReader that can read entries from a directory.
+- __createReader__: Create a new <a href="../directoryreader/directoryreader.html">DirectoryReader</a> that can read entries from a directory.
- __getDirectory__: Create or look up a directory.
-- __getFile__: Create or look up a file.
+- __get<a href="../fileobj/fileobj.html">File</a>__: Create or look up a file.
- __removeRecursively__: Delete a directory and all of its contents.
@@ -61,18 +61,18 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-getMetadata
+get<a href="../metadata/metadata.html">Metadata</a>
-----------
Look up metadata about a directory.
__Parameters:__
-- __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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(metadata) {
console.log("Last Modified: " + metadata.modificationTime);
@@ -83,9 +83,9 @@ __Quick Example__
}
// Request the metadata object for this entry
- entry.getMetadata(success, fail);
+ entry.get<a href="../metadata/metadata.html">Metadata</a>(success, fail);
-setMetadata
+set<a href="../metadata/metadata.html">Metadata</a>
----------------
Set metadata on a directory.
@@ -98,7 +98,7 @@ __Parameters:__
- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success() {
console.log("The metadata was successfully set.");
@@ -109,7 +109,7 @@ __Quick Example__
}
// Set the metadata
- entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
+ entry.set<a href="../metadata/metadata.html">Metadata</a>(success, fail, { "com.apple.MobileBackup": 1});
__iOS Quirk__
- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the directory to be backed up by iCloud. Set the value to **0** to re-enable the directory to be backed up by iCloud.
@@ -132,10 +132,10 @@ __Parameters:__
- __parent__ - The parent directory to which to move the directory. _(DirectoryEntry)_
- __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 FileError object. _(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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(entry) {
console.log("New Path: " + entry.fullPath);
@@ -170,10 +170,10 @@ __Parameters:__
- __parent__ - The parent directory to which to copy the directory. _(DirectoryEntry)_
- __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 FileError object. _(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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function win(entry) {
console.log("New Path: " + entry.fullPath);
@@ -199,7 +199,7 @@ toURL
Returns a URL that can be used to locate the directory.
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
// Get the URL for this directory
var dirURL = entry.toURL();
@@ -217,9 +217,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 FileError object. _(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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(entry) {
console.log("Removal succeeded");
@@ -241,9 +241,9 @@ 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 FileError object. _(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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(parent) {
console.log("Parent Name: " + parent.name);
@@ -260,9 +260,9 @@ __Quick Example__
createReader
------------
-Creates a new DirectoryReader to read entries in a directory.
+Creates a new <a href="../directoryreader/directoryreader.html">DirectoryReader</a> to read entries in a directory.
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
// create a directory reader
var directoryReader = entry.createReader();
@@ -278,11 +278,11 @@ 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. _(Flags)_
+- __options__ - Options to specify whether the directory is created if it doesn't exist. _(<a href="../flags/flags.html">Flags</a>)_
- __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 FileError 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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(parent) {
console.log("Parent Name: " + parent.name);
@@ -296,7 +296,7 @@ __Quick Example__
entry.getDirectory("newDir", {create: true, exclusive: false}, success, fail);
-getFile
+get<a href="../fileobj/fileobj.html">File</a>
-------
Creates or looks up a file. It is an error to attempt to:
@@ -306,11 +306,11 @@ 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. _(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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(parent) {
console.log("Parent Name: " + parent.name);
@@ -321,7 +321,7 @@ __Quick Example__
}
// Retrieve an existing file, or create it if it does not exist
- entry.getFile("newFile.txt", {create: true, exclusive: false}, success, fail);
+ entry.get<a href="../fileobj/fileobj.html">File</a>("new<a href="../fileobj/fileobj.html">File</a>.txt", {create: true, exclusive: false}, success, fail);
removeRecursively
@@ -336,9 +336,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 FileError object. _(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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(parent) {
console.log("Remove Recursively Succeeded");
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/directoryreader/directoryreader.md b/www/docs/en/1.8.1/cordova/file/directoryreader/directoryreader.md
index da55cc2..9e024f6 100644
--- a/www/docs/en/1.8.1/cordova/file/directoryreader/directoryreader.md
+++ b/www/docs/en/1.8.1/cordova/file/directoryreader/directoryreader.md
@@ -44,10 +44,10 @@ Read the entries in this directory.
__Parameters:__
-- __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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(entries) {
var i;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/file.md b/www/docs/en/1.8.1/cordova/file/file.md
index 49bd848..e4c6268 100644
--- a/www/docs/en/1.8.1/cordova/file/file.md
+++ b/www/docs/en/1.8.1/cordova/file/file.md
@@ -18,29 +18,29 @@ license: >
under the License.
---
-File
+<a href="fileobj/fileobj.html">File</a>
==========
-> This API is based on the W3C [File API](http://www.w3.org/TR/FileAPI). An API to read, write and navigate file system hierarchies.
+> This API is based on the W3C [<a href="fileobj/fileobj.html">File</a> API](http://www.w3.org/TR/<a href="fileobj/fileobj.html">File</a>API). An API to read, write and navigate file system hierarchies.
Objects
-------
-- DirectoryEntry
-- DirectoryReader
-- File
-- FileEntry
-- FileError
-- FileReader
-- FileSystem
-- FileTransfer
-- FileTransferError
-- FileUploadOptions
-- FileUploadResult
-- FileWriter
-- Flags
-- LocalFileSystem
-- Metadata
+- <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>
Permissions
-----------
@@ -49,8 +49,8 @@ Permissions
#### app/res/xml/plugins.xml
- <plugin name="File" value="org.apache.cordova.FileUtils" />
- <plugin name="FileTransfer" value="org.apache.cordova.FileTransfer" />
+ <plugin name="<a href="fileobj/fileobj.html">File</a>" value="org.apache.cordova.<a href="fileobj/fileobj.html">File</a>Utils" />
+ <plugin name="<a href="filetransfer/filetransfer.html"><a href="fileobj/fileobj.html">File</a>Transfer</a>" value="org.apache.cordova.<a href="filetransfer/filetransfer.html"><a href="fileobj/fileobj.html">File</a>Transfer</a>" />
#### app/AndroidManifest.xml
@@ -64,8 +64,8 @@ Permissions
#### www/plugins.xml
- <plugin name="File" value="org.apache.cordova.file.FileManager" />
- <plugin name="FileTransfer" value="org.apache.cordova.http.FileTransfer" />
+ <plugin name="<a href="fileobj/fileobj.html">File</a>" value="org.apache.cordova.file.<a href="fileobj/fileobj.html">File</a>Manager" />
+ <plugin name="<a href="filetransfer/filetransfer.html"><a href="fileobj/fileobj.html">File</a>Transfer</a>" value="org.apache.cordova.http.<a href="filetransfer/filetransfer.html"><a href="fileobj/fileobj.html">File</a>Transfer</a>" />
#### www/config.xml
@@ -78,18 +78,18 @@ Permissions
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
- <key>File</key>
- <string>CDVFile</string>
+ <key><a href="fileobj/fileobj.html">File</a></key>
+ <string>CDV<a href="fileobj/fileobj.html">File</a></string>
</dict>
<key>Plugins</key>
<dict>
- <key>FileTransfer</key>
- <string>CDVFileTransfer</string>
+ <key><a href="filetransfer/filetransfer.html"><a href="fileobj/fileobj.html">File</a>Transfer</a></key>
+ <string>CDV<a href="filetransfer/filetransfer.html"><a href="fileobj/fileobj.html">File</a>Transfer</a></string>
</dict>
### webOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/fileentry/fileentry.md b/www/docs/en/1.8.1/cordova/file/fileentry/fileentry.md
index ea0ad2c..4334cb3 100644
--- a/www/docs/en/1.8.1/cordova/file/fileentry/fileentry.md
+++ b/www/docs/en/1.8.1/cordova/file/fileentry/fileentry.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-FileEntry
+<a href="../fileobj/fileobj.html">File</a>Entry
==========
This object represents a file on a file system. It is defined in the [W3C Directories and Systems](http://www.w3.org/TR/file-system-api/) specification.
@@ -26,28 +26,28 @@ This object represents a file on a file system. It is defined in the [W3C Direc
Properties
----------
-- __isFile:__ Always true. _(boolean)_
+- __is<a href="../fileobj/fileobj.html">File</a>:__ Always true. _(boolean)_
- __isDirectory:__ Always false. _(boolean)_
-- __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)_
+- __name:__ The name of the <a href="../fileobj/fileobj.html">File</a>Entry, excluding the path leading to it. _(DOMString)_
+- __fullPath:__ The full absolute path from the root to the <a href="../fileobj/fileobj.html">File</a>Entry. _(DOMString)_
NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by Cordova:
-- __filesystem:__ The file system on which the FileEntry resides. _(FileSystem)_
+- __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>)_
Methods
-------
-- __getMetadata__: Look up metadata about a file.
-- __setMetadata__: Set metadata on a file.
+- __get<a href="../metadata/metadata.html">Metadata</a>__: Look up metadata about a file.
+- __set<a href="../metadata/metadata.html">Metadata</a>__: Set metadata on a file.
- __moveTo__: Move a file to a different location on the file system.
- __copyTo__: Copy a file to a different location on the file system.
- __toURL__: Return a URL that can be used to locate a file.
- __remove__: Delete a file.
- __getParent__: Look up the parent directory.
-- __createWriter__: Creates a FileWriter object that can be used to write to a file.
-- __file__: Creates a File object containing file properties.
+- __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.
Supported Platforms
@@ -59,18 +59,18 @@ Supported Platforms
- Windows Phone 7 ( Mango )
-getMetadata
+get<a href="../metadata/metadata.html">Metadata</a>
----------------
Look up metadata about a file.
__Parameters:__
-- __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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(metadata) {
console.log("Last Modified: " + metadata.modificationTime);
@@ -81,10 +81,10 @@ __Quick Example__
}
// Request the metadata object for this entry
- entry.getMetadata(success, fail);
+ entry.get<a href="../metadata/metadata.html">Metadata</a>(success, fail);
-setMetadata
+set<a href="../metadata/metadata.html">Metadata</a>
----------------
Set metadata on a file.
@@ -97,7 +97,7 @@ __Parameters:__
- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success() {
console.log("The metadata was successfully set.");
@@ -108,7 +108,7 @@ __Quick Example__
}
// Set the metadata
- entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
+ entry.set<a href="../metadata/metadata.html">Metadata</a>(success, fail, { "com.apple.MobileBackup": 1});
__iOS Quirk__
- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the file to be backed up by iCloud. Set the value to **0** to re-enable the file to be backed up by iCloud.
@@ -126,13 +126,13 @@ In addition, an attempt to move a file on top of an existing file must attempt t
__Parameters:__
-- __parent__ - The parent directory to which to move the file. _(DirectoryEntry)_
+- __parent__ - The parent directory to which to move the file. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
- __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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(entry) {
console.log("New Path: " + entry.fullPath);
@@ -142,13 +142,13 @@ __Quick Example__
alert(error.code);
}
- function moveFile(entry) {
+ function move<a href="../fileobj/fileobj.html">File</a>(entry) {
var parent = document.getElementById('parent').value,
parentName = parent.substring(parent.lastIndexOf('/')+1),
- parentEntry = new DirectoryEntry(parentName, parent);
+ parentEntry = new <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>(parentName, parent);
// move the file to a new directory and rename it
- entry.moveTo(parentEntry, "newFile.txt", success, fail);
+ entry.moveTo(parentEntry, "new<a href="../fileobj/fileobj.html">File</a>.txt", success, fail);
}
@@ -161,13 +161,13 @@ Copy a file to a new location on the file system. It is an error to attempt to:
__Parameters:__
-- __parent__ - The parent directory to which to copy the file. _(DirectoryEntry)_
+- __parent__ - The parent directory to which to copy the file. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
- __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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function win(entry) {
console.log("New Path: " + entry.fullPath);
@@ -177,10 +177,10 @@ __Quick Example__
alert(error.code);
}
- function copyFile(entry) {
+ function copy<a href="../fileobj/fileobj.html">File</a>(entry) {
var parent = document.getElementById('parent').value,
parentName = parent.substring(parent.lastIndexOf('/')+1),
- parentEntry = new DirectoryEntry(parentName, parent);
+ parentEntry = new <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>(parentName, parent);
// copy the file to a new directory and rename it
entry.copyTo(parentEntry, "file.copy", success, fail);
@@ -192,7 +192,7 @@ toURL
Returns a URL that can be used to locate the file.
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
// Request the URL for this entry
var fileURL = entry.toURL();
@@ -207,9 +207,9 @@ Deletes a file.
__Parameters:__
- __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(entry) {
console.log("Removal succeeded");
@@ -226,14 +226,14 @@ __Quick Example__
getParent
---------
-Look up the parent DirectoryEntry containing the file.
+Look up the parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a> containing the file.
__Parameters:__
-- __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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(parent) {
console.log("Parent Name: " + parent.name);
@@ -243,21 +243,21 @@ __Quick Example__
alert(error.code);
}
- // Get the parent DirectoryEntry
+ // Get the parent <a href="../directoryentry/directoryentry.html">DirectoryEntry</a>
entry.getParent(success, fail);
createWriter
------------
-Create a FileWriter object associated with the file that the FileEntry represents.
+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.
__Parameters:__
-- __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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(writer) {
writer.write("Some text to the file");
@@ -267,24 +267,24 @@ __Quick Example__
alert(error.code);
}
- // create a FileWriter to write to the file
+ // create a <a href="../filewriter/filewriter.html"><a href="../fileobj/fileobj.html">File</a>Writer</a> to write to the file
entry.createWriter(success, fail);
file
----
-Return a File object that represents the current state of the file that this FileEntry represents.
+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.
__Parameters:__
-- __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)_
+- __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)_
-__Quick Example__
+__Quick <a href="../../storage/storage.opendatabase.html">Example</a>__
function success(file) {
- console.log("File size: " + file.size);
+ console.log("<a href="../fileobj/fileobj.html">File</a> size: " + file.size);
}
function fail(error) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/fileerror/fileerror.md b/www/docs/en/1.8.1/cordova/file/fileerror/fileerror.md
index fa54c1f..5bdd794 100644
--- a/www/docs/en/1.8.1/cordova/file/fileerror/fileerror.md
+++ b/www/docs/en/1.8.1/cordova/file/fileerror/fileerror.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-FileError
+<a href="../fileobj/fileobj.html">File</a>Error
========
-A 'FileError' object is set when an error occurs in any of the File API methods.
+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.
Properties
----------
@@ -31,20 +31,20 @@ Properties
Constants
---------
-- `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`
+- `<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`
Description
-----------
-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
+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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/fileobj/fileobj.md b/www/docs/en/1.8.1/cordova/file/fileobj/fileobj.md
index 9920be9..5910a3c 100644
--- a/www/docs/en/1.8.1/cordova/file/fileobj/fileobj.md
+++ b/www/docs/en/1.8.1/cordova/file/fileobj/fileobj.md
@@ -35,7 +35,7 @@ Properties
Details
-------
-The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` 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 `<a href="../fileentry/fileentry.html">FileEntry</a>` object.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/filereader/filereader.md b/www/docs/en/1.8.1/cordova/file/filereader/filereader.md
index 57a4567..1e3651f 100644
--- a/www/docs/en/1.8.1/cordova/file/filereader/filereader.md
+++ b/www/docs/en/1.8.1/cordova/file/filereader/filereader.md
@@ -18,17 +18,17 @@ license: >
under the License.
---
-FileReader
+<a href="../fileobj/fileobj.html">File</a>Reader
==========
-FileReader is an object that allows one to read a file.
+<a href="../fileobj/fileobj.html">File</a>Reader 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. _(FileError)_
+- __error:__ An object containing errors. _(<a href="../fileerror/fileerror.html"><a href="../fileobj/fileobj.html">File</a>Error</a>)_
- __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 `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.
+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.
Supported Platforms
-------------------
@@ -63,11 +63,11 @@ __Parameters:__
- file - the file object to read
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
function win(file) {
- var reader = new FileReader();
+ var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
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 Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
function win(file) {
- var reader = new FileReader();
+ var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
reader.onloadend = function(evt) {
console.log("read success");
console.log(evt.target.result);
@@ -107,11 +107,11 @@ Quick Example
entry.file(win, fail);
-Abort Quick Example
+Abort Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------------
function win(file) {
- var reader = new FileReader();
+ var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
reader.onloadend = function(evt) {
console.log("read success");
console.log(evt.target.result);
@@ -126,13 +126,13 @@ Abort Quick Example
entry.file(win, fail);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>FileReader Example</title>
+ <title><a href="../fileobj/fileobj.html">File</a>Reader <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -140,30 +140,30 @@ Full Example
// Wait for Cordova to load
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
}
// Cordova is ready
//
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
+ function on<a href="../../device/device.html">Device</a>Ready() {
+ window.request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>(Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, gotFS, fail);
}
function gotFS(fileSystem) {
- fileSystem.root.getFile("readme.txt", null, gotFileEntry, fail);
+ 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);
}
- function gotFileEntry(fileEntry) {
- fileEntry.file(gotFile, 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 gotFile(file){
+ function got<a href="../fileobj/fileobj.html">File</a>(file){
readDataUrl(file);
readAsText(file);
}
function readDataUrl(file) {
- var reader = new FileReader();
+ var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
reader.onloadend = function(evt) {
console.log("Read as data URL");
console.log(evt.target.result);
@@ -172,7 +172,7 @@ Full Example
}
function readAsText(file) {
- var reader = new FileReader();
+ var reader = new <a href="../fileobj/fileobj.html">File</a>Reader();
reader.onloadend = function(evt) {
console.log("Read as text");
console.log(evt.target.result);
@@ -187,8 +187,8 @@ Full Example
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Read File</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Read <a href="../fileobj/fileobj.html">File</a></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/filesystem/filesystem.md b/www/docs/en/1.8.1/cordova/file/filesystem/filesystem.md
index a49d023..faf0bac 100644
--- a/www/docs/en/1.8.1/cordova/file/filesystem/filesystem.md
+++ b/www/docs/en/1.8.1/cordova/file/filesystem/filesystem.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-FileSystem
+<a href="../fileobj/fileobj.html">File</a>System
==========
This object represents a file system.
@@ -27,12 +27,12 @@ Properties
----------
- __name:__ The name of the file system. _(DOMString)_
-- __root:__ The root directory of the file system. _(DirectoryEntry)_
+- __root:__ The root directory of the file system. _(<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>)_
Details
-------
-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.
+The `<a href="../fileobj/fileobj.html">File</a>System` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>` object which represents the root directory of the file system.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-File System Quick Example
+<a href="../fileobj/fileobj.html">File</a> System Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------------------
function onSuccess(fileSystem) {
@@ -51,30 +51,30 @@ File System Quick Example
}
// request the persistent file system
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
+ 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);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>File System Example</title>
+ <title><a href="../fileobj/fileobj.html">File</a> System <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ 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 onFileSystemSuccess(fileSystem) {
+ function on<a href="../fileobj/fileobj.html">File</a>SystemSuccess(fileSystem) {
console.log(fileSystem.name);
console.log(fileSystem.root.name);
}
@@ -86,7 +86,7 @@ Full Example
</script>
</head>
<body>
- <h1>Example</h1>
- <p>File System</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p><a href="../fileobj/fileobj.html">File</a> System</p>
</body>
</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org