You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/11 06:40:48 UTC
[04/51] [partial] docs commit: Reverting autolinking change because
of inconsistencies.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md b/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md
index 4b2da96..d00b3a7 100644
--- a/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md
+++ b/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>
+LocalFileSystem
===============
This object provides a way to obtain root file systems.
@@ -26,19 +26,19 @@ This object provides a way to obtain root file systems.
Methods
----------
-- __request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>:__ Requests a filesystem. _(Function)_
-- __resolveLocal<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>URI:__ Retrieve a <a href="../directoryentry/directoryentry.html">DirectoryEntry</a> or <a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a> using local URI. _(Function)_
+- __requestFileSystem:__ Requests a filesystem. _(Function)_
+- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_
Constants
---------
-- `Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission.
-- `Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.TEMPORARY`: Used for storage with no guarantee of persistence.
+- `LocalFileSystem.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission.
+- `LocalFileSystem.TEMPORARY`: Used for storage with no guarantee of persistence.
Details
-------
-The `Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>` object methods are defined on the __window__ object.
+The `LocalFileSystem` object methods are defined on the __window__ object.
Supported Platforms
-------------------
@@ -48,7 +48,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Request <a href="../fileobj/fileobj.html">File</a> System Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Request File System Quick Example
---------------------------------
function onSuccess(fileSystem) {
@@ -56,41 +56,41 @@ Request <a href="../fileobj/fileobj.html">File</a> System Quick <a href="../../s
}
// request the persistent file system
- window.request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>(Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, onSuccess, onError);
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
-Resolve Local <a href="../fileobj/fileobj.html">File</a> System URI Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Resolve Local File System URI Quick Example
-------------------------------------------
function onSuccess(fileEntry) {
console.log(fileEntry.name);
}
- window.resolveLocal<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>URI("file:///example.txt", onSuccess, onError);
+ window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>Local <a href="../fileobj/fileobj.html">File</a> System <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Local File System Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- window.request<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>(Local<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>.PERSISTENT, 0, on<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>Success, fail);
- window.resolveLocal<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>URI("file:///example.txt", onResolveSuccess, fail);
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ window.resolveLocalFileSystemURI("file:///example.txt", onResolveSuccess, fail);
}
- function on<a href="../filesystem/filesystem.html"><a href="../fileobj/fileobj.html">File</a>System</a>Success(fileSystem) {
+ function onFileSystemSuccess(fileSystem) {
console.log(fileSystem.name);
}
@@ -105,7 +105,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Local <a href="../fileobj/fileobj.html">File</a> System</p>
+ <h1>Example</h1>
+ <p>Local File System</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/file/metadata/metadata.md b/www/docs/en/1.8.1/cordova/file/metadata/metadata.md
index e4c5194..487d07c 100644
--- a/www/docs/en/1.8.1/cordova/file/metadata/metadata.md
+++ b/www/docs/en/1.8.1/cordova/file/metadata/metadata.md
@@ -31,7 +31,7 @@ Properties
Details
-------
-The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `<a href="../directoryentry/directoryentry.html">DirectoryEntry</a>` or `<a href="../fileentry/fileentry.html"><a href="../fileobj/fileobj.html">File</a>Entry</a>` object.
+The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `DirectoryEntry` or `FileEntry` object.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function win(metadata) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md b/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md
index f877c14..005aa49 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md
@@ -37,7 +37,7 @@ Properties
Description
-----------
-The `Coordinates` object is created and populated by Cordova, and attached to the `<a href="../Position/position.html">Position</a>` object. The `<a href="../Position/position.html">Position</a>` object is then returned to the user through a callback function.
+The `Coordinates` object is created and populated by Cordova, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function.
Supported Platforms
-------------------
@@ -49,7 +49,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
@@ -71,29 +71,29 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
alert('onError!');
};
- navigator.geolocation.getCurrent<a href="../Position/position.html">Position</a>(onSuccess, onError);
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../geolocation.html">Geolocation</a> <a href="../Position/position.html">Position</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Geolocation Position Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Set an event to wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is loaded and Ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- navigator.geolocation.getCurrent<a href="../Position/position.html">Position</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
- // Display `<a href="../Position/position.html">Position</a>` properties from the geolocation
+ // Display `Position` properties from the geolocation
//
function onSuccess(position) {
var div = document.getElementById('myDiv');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/Position/position.md b/www/docs/en/1.8.1/cordova/geolocation/Position/position.md
index 74a5486..33be823 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/Position/position.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/Position/position.md
@@ -26,7 +26,7 @@ Contains `Position` coordinates and timestamp, created by the geolocation API.
Properties
----------
-- __coords:__ A set of geographic coordinates. _(<a href="../Coordinates/coordinates.html">Coordinates</a>)_
+- __coords:__ A set of geographic coordinates. _(Coordinates)_
- __timestamp:__ Creation timestamp for `coords`. _(Date)_
Description
@@ -44,7 +44,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
@@ -60,37 +60,37 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + position.timestamp + '\n');
};
- // onError Callback receives a <a href="../PositionError/positionError.html">PositionError</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
- navigator.<a href="../geolocation.getCurrentPosition.html">geolocation.getCurrentPosition</a>(onSuccess, onError);
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../../device/device.html">Device</a> Properties <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- navigator.<a href="../geolocation.getCurrentPosition.html">geolocation.getCurrentPosition</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
- // onSuccess <a href="../geolocation.html">Geolocation</a>
+ // onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -105,7 +105,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
position.timestamp + '<br />';
}
- // onError Callback receives a <a href="../PositionError/positionError.html">PositionError</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md b/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md
index 1b5b042..3b38add 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/PositionError/positionError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../Position/position.html">Position</a>Error
+PositionError
========
-A `<a href="../Position/position.html">Position</a>Error` object is returned to the `<a href="../parameters/geolocationError.html">geolocationError</a>` callback when an error occurs.
+A `PositionError` object is returned to the `geolocationError` callback when an error occurs.
Properties
----------
@@ -32,29 +32,29 @@ Properties
Constants
---------
-- `<a href="../Position/position.html">Position</a>Error.PERMISSION_DENIED`
-- `<a href="../Position/position.html">Position</a>Error.POSITION_UNAVAILABLE`
-- `<a href="../Position/position.html">Position</a>Error.TIMEOUT`
+- `PositionError.PERMISSION_DENIED`
+- `PositionError.POSITION_UNAVAILABLE`
+- `PositionError.TIMEOUT`
Description
-----------
-The `<a href="../Position/position.html">Position</a>Error` object is returned to the user through the `<a href="../parameters/geolocationError.html">geolocationError</a>` callback function when an error occurs with geolocation.
+The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
-### `<a href="../Position/position.html">Position</a>Error.PERMISSION_DENIED`
+### `PositionError.PERMISSION_DENIED`
Returned when the user does not allow your application to retrieve
position information. This is dependent on the platform.
-### `<a href="../Position/position.html">Position</a>Error.POSITION_UNAVAILABLE`
+### `PositionError.POSITION_UNAVAILABLE`
Returned when the device was unable to retrieve a position. In general
this means the device has no network connectivity and/or cannot get a
satellite fix.
-### `<a href="../Position/position.html">Position</a>Error.TIMEOUT`
+### `PositionError.TIMEOUT`
Returned when the device was unable to retrieve a position within the
-time specified in the `<a href="../parameters/geolocation.options.html">geolocationOptions</a>`' `timeout` property. When using
-in conjunction with `geolocation.watch<a href="../Position/position.html">Position</a>`, this error could be
-called into the `<a href="../parameters/geolocationError.html">geolocationError</a>` callback every `timeout` milliseconds.
+time specified in the `geolocationOptions`' `timeout` property. When using
+in conjunction with `geolocation.watchPosition`, this error could be
+called into the `geolocationError` callback every `timeout` milliseconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md b/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md
index 652f946..ac474ee 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/geolocation.clearWatch.md
@@ -28,12 +28,12 @@ Stop watching for changes to the device's location referenced by the `watchID` p
Parameters
----------
-- __watchID:__ The id of the `watch<a href="Position/position.html">Position</a>` interval to clear. (String)
+- __watchID:__ The id of the `watchPosition` interval to clear. (String)
Description
-----------
-`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watch<a href="Position/position.html">Position</a>` referenced by `watchID`.
+`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
Supported Platforms
-------------------
@@ -45,46 +45,46 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Options: watch for changes in position, and use the most
// accurate position acquisition method available.
//
- var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { enableHighAccuracy: true });
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });
// ...later on...
navigator.geolocation.clearWatch(watchID);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
var watchID = null;
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Get the most accurate position updates available on the
// device.
var options = { enableHighAccuracy: true };
- watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, options);
+ watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
}
- // onSuccess <a href="geolocation.html">Geolocation</a>
+ // onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -102,7 +102,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
}
}
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md b/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md
index 4d78804..672d3ef 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -18,26 +18,26 @@ license: >
under the License.
---
-geolocation.getCurrent<a href="Position/position.html">Position</a>
+geolocation.getCurrentPosition
==============================
-Returns the device's current position as a `<a href="Position/position.html">Position</a>` object.
+Returns the device's current position as a `Position` object.
- navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>,
- [<a href="parameters/geolocationError.html">geolocationError</a>],
- [<a href="parameters/geolocation.options.html">geolocationOptions</a>]);
+ navigator.geolocation.getCurrentPosition(geolocationSuccess,
+ [geolocationError],
+ [geolocationOptions]);
Parameters
----------
-- __<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>__: The callback that is called with the current position.
-- __<a href="parameters/geolocationError.html">geolocationError</a>__: (Optional) The callback that is called if there was an error.
-- __<a href="parameters/geolocation.options.html">geolocationOptions</a>__: (Optional) The geolocation options.
+- __geolocationSuccess__: The callback that is called with the current position.
+- __geolocationError__: (Optional) The callback that is called if there was an error.
+- __geolocationOptions__: (Optional) The geolocation options.
Description
-----------
-`geolocation.getCurrent<a href="Position/position.html">Position</a>` is an asynchronous function. It returns the device's current position to the `<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>` callback with a `<a href="Position/position.html">Position</a>` object as the parameter. If there is an error, the `<a href="parameters/geolocationError.html">geolocationError</a>` callback is invoked with a `<a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>` object.
+`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
Supported Platforms
@@ -50,11 +50,11 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
- // This method accepts a `<a href="Position/position.html">Position</a>` object, which contains
+ // This method accepts a `Position` object, which contains
// the current GPS coordinates
//
var onSuccess = function(position) {
@@ -68,37 +68,37 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + position.timestamp + '\n');
};
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
- navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(onSuccess, onError);
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
- navigator.geolocation.getCurrent<a href="Position/position.html">Position</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
- // onSuccess <a href="geolocation.html">Geolocation</a>
+ // onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -112,7 +112,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
'Timestamp: ' + position.timestamp + '<br />';
}
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/geolocation.md b/www/docs/en/1.8.1/cordova/geolocation/geolocation.md
index 9d03a19..63659cf 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/geolocation.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/geolocation.md
@@ -23,31 +23,31 @@ Geolocation
> The `geolocation` object provides access to the device's GPS sensor.
-Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global <a href="Position/position.html">Position</a>ing System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
+Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices (Android, BlackBerry, Bada, Windows Phone 7 and webOS, to be specific) already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have geolocation support, the Cordova implementation adheres to the W3C specification.
Methods
-------
-- geolocation.getCurrent<a href="Position/position.html">Position</a>
-- geolocation.watch<a href="Position/position.html">Position</a>
-- <a href="geolocation.clearWatch.html">geolocation.clearWatch</a>
+- geolocation.getCurrentPosition
+- geolocation.watchPosition
+- geolocation.clearWatch
Arguments
---------
-- <a href="parameters/geolocationSuccess.html">geolocationSuccess</a>
-- <a href="parameters/geolocationError.html">geolocationError</a>
-- <a href="parameters/geolocation.options.html">geolocationOptions</a>
+- geolocationSuccess
+- geolocationError
+- geolocationOptions
Objects (Read-Only)
-------------------
-- <a href="Position/position.html">Position</a>
-- <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>
-- <a href="Coordinates/coordinates.html">Coordinates</a>
+- Position
+- PositionError
+- Coordinates
Permissions
-----------
@@ -82,7 +82,7 @@ Permissions
### iOS
-#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md b/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md
index 1dc81db..335cbf2 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/geolocation.watchPosition.md
@@ -18,31 +18,31 @@ license: >
under the License.
---
-geolocation.watch<a href="Position/position.html">Position</a>
+geolocation.watchPosition
=========================
Watches for changes to the device's current position.
- var watchId = navigator.geolocation.watch<a href="Position/position.html">Position</a>(<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>,
- [<a href="parameters/geolocationError.html">geolocationError</a>],
- [<a href="parameters/geolocation.options.html">geolocationOptions</a>]);
+ var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
+ [geolocationError],
+ [geolocationOptions]);
Parameters
----------
-- __<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>__: The callback that is called with the current position.
-- __<a href="parameters/geolocationError.html">geolocationError</a>__: (Optional) The callback that is called if there was an error.
-- __<a href="parameters/geolocation.options.html">geolocationOptions</a>__: (Optional) The geolocation options.
+- __geolocationSuccess__: The callback that is called with the current position.
+- __geolocationError__: (Optional) The callback that is called if there was an error.
+- __geolocationOptions__: (Optional) The geolocation options.
Returns
-------
-- __String__: returns a watch id that references the watch position interval. The watch id should be used with `<a href="geolocation.clearWatch.html">geolocation.clearWatch</a>` to stop watching for changes in position.
+- __String__: returns a watch id that references the watch position interval. The watch id should be used with `geolocation.clearWatch` to stop watching for changes in position.
Description
-----------
-`geolocation.watch<a href="Position/position.html">Position</a>` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `<a href="parameters/geolocationSuccess.html">geolocationSuccess</a>` callback is invoked with a `<a href="Position/position.html">Position</a>` object as the parameter. If there is an error, the `<a href="parameters/geolocationError.html">geolocationError</a>` callback is invoked with a `<a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a>` object.
+`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
Supported Platforms
-------------------
@@ -54,11 +54,11 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// onSuccess Callback
- // This method accepts a `<a href="Position/position.html">Position</a>` object, which contains
+ // This method accepts a `Position` object, which contains
// the current GPS coordinates
//
function onSuccess(position) {
@@ -68,7 +68,7 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
'<hr />' + element.innerHTML;
}
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
@@ -77,35 +77,35 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// Options: throw an error if no update is received every 30 seconds.
//
- var watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, { timeout: 30000 });
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../device/device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
var watchID = null;
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// Throw an error if no update is received every 30 seconds
var options = { timeout: 30000 };
- watchID = navigator.geolocation.watch<a href="Position/position.html">Position</a>(onSuccess, onError, options);
+ watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
}
- // onSuccess <a href="geolocation.html">Geolocation</a>
+ // onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
@@ -114,7 +114,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
'<hr />' + element.innerHTML;
}
- // onError Callback receives a <a href="<a href="Position/position.html">Position</a>Error/positionError.html"><a href="Position/position.html">Position</a>Error</a> object
+ // onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md
index 6a5b3da..ff1b80d 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocation.options.md
@@ -22,15 +22,15 @@ geolocationOptions
==================
Optional parameters to customize the retrieval of the geolocation
-`<a href="../Position/position.html">Position</a>`.
+`Position`.
{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
Options
-------
-- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `<a href="../Position/position.html">Position</a>` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
-- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrent<a href="../Position/position.html">Position</a>` or `geolocation.watch<a href="../Position/position.html">Position</a>` until the corresponding `<a href="geolocationSuccess.html">geolocationSuccess</a>` callback is invoked. If the `<a href="geolocationSuccess.html">geolocationSuccess</a>` callback is not invoked within this time, the `<a href="geolocationError.html">geolocationError</a>` callback will be invoked with a `<a href="../<a href="../Position/position.html">Position</a>Error/positionError.html"><a href="../Position/position.html">Position</a>Error</a>.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watch<a href="../Position/position.html">Position</a>`, the `<a href="geolocationError.html">geolocationError</a>` callback could be called on an interval every `timeout` milliseconds! _(Number)_
+- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
+- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback will be invoked with a `PositionError.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds! _(Number)_
- __maximumAge:__ Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
Android Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md
index afe00ea..3408969 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationError.md
@@ -30,4 +30,4 @@ The user's callback function that is called when there is an error for geolocati
Parameters
----------
-- __error:__ The error returned by the device. (`<a href="../<a href="../Position/position.html">Position</a>Error/positionError.html"><a href="../Position/position.html">Position</a>Error</a>`)
+- __error:__ The error returned by the device. (`PositionError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md
index cac8481..bffd951 100644
--- a/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/www/docs/en/1.8.1/cordova/geolocation/parameters/geolocationSuccess.md
@@ -21,7 +21,7 @@ license: >
geolocationSuccess
==================
-The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrent<a href="../Position/position.html">Position</a>`), or when the position changes (when using with `geolocation.watch<a href="../Position/position.html">Position</a>`).
+The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrentPosition`), or when the position changes (when using with `geolocation.watchPosition`).
function(position) {
// Do something
@@ -30,9 +30,9 @@ The user's callback function that is called when a geolocation position becomes
Parameters
----------
-- __position:__ The geolocation position returned by the device. (`<a href="../Position/position.html">Position</a>`)
+- __position:__ The geolocation position returned by the device. (`Position`)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function geolocationSuccess(position) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md b/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md
index 8d8a960..ad11ca5 100644
--- a/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md
+++ b/www/docs/en/1.8.1/cordova/media/MediaError/mediaError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../media.html">Media</a>Error
+MediaError
==========
-A `<a href="../media.html">Media</a>Error` object is returned to the `<a href="../Parameters/mediaError.html">mediaError</a>` callback function when an error occurs.
+A `MediaError` object is returned to the `mediaError` callback function when an error occurs.
Properties
----------
@@ -32,14 +32,14 @@ Properties
Constants
---------
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_ABORTED`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_NETWORK`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_DECODE`
-- `<a href="../media.html">Media</a>Error.MEDIA_ERR_NONE_SUPPORTED`
+- `MediaError.MEDIA_ERR_ABORTED`
+- `MediaError.MEDIA_ERR_NETWORK`
+- `MediaError.MEDIA_ERR_DECODE`
+- `MediaError.MEDIA_ERR_NONE_SUPPORTED`
Description
-----------
-The `<a href="../media.html">Media</a>Error` object is returned to the user through the `<a href="../Parameters/mediaError.html">mediaError</a>` callback function when an error occurs.
+The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md b/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md
index 1881d31..1e0e3a8 100644
--- a/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md
+++ b/www/docs/en/1.8.1/cordova/media/Parameters/mediaError.md
@@ -30,4 +30,4 @@ A user specified callback function that is invoked when there is an error in med
Parameters
----------
-- __error:__ The error returned by the device. (`<a href="../<a href="../media.html">Media</a>Error/mediaError.html"><a href="../media.html">Media</a>Error</a>`)
+- __error:__ The error returned by the device. (`MediaError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md b/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md
index 81cad0a..a897c8b 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/CaptureCB.md
@@ -18,28 +18,28 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>CB
+CaptureCB
=========
> Invoked upon a successful media capture operation.
- function captureSuccess( <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>[] media<a href="../../file/fileobj/fileobj.html">File</a>s ) { ... };
+ function captureSuccess( MediaFile[] mediaFiles ) { ... };
Description
-----------
This function is invoked after a successful capture operation has completed. This means a media file has been captured, and either the user has exited the media capture application, or the capture limit has been reached.
-Each <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a> object describes a captured media file.
+Each MediaFile object describes a captured media file.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture callback
- function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ function captureSuccess(mediaFiles) {
var i, path, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- path = media<a href="../../file/fileobj/fileobj.html">File</a>s[i].fullPath;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
// do something interesting with the file
}
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md b/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md
index a4f135c..f387287 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/CaptureError.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>Error
+CaptureError
============
> Encapsulates the error code resulting from a failed media capture operation.
@@ -31,8 +31,8 @@ Properties
Constants
---------
-- <a href="capture.html">Capture</a>Error.`CAPTURE_INTERNAL_ERR`: <a href="../../camera/camera.html">Camera</a> or microphone failed to capture image or sound.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_APPLICATION_BUSY`: <a href="../../camera/camera.html">Camera</a> application or audio capture application is currently serving other capture request.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
-- <a href="capture.html">Capture</a>Error.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
-- <a href="capture.html">Capture</a>Error.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
+- CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound.
+- CaptureError.`CAPTURE_APPLICATION_BUSY`: Camera application or audio capture application is currently serving other capture request.
+- CaptureError.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
+- CaptureError.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
+- CaptureError.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md b/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md
index 02e9f62..7d24861 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/CaptureErrorCB.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>ErrorCB
+CaptureErrorCB
==============
> Invoked if an error occurs during a media capture operation.
- function captureError( <a href="capture.html">Capture</a>Error error ) { ... };
+ function captureError( CaptureError error ) { ... };
Description
-----------
This function is invoked if an error occurs when trying to launch a media capture operation and the capture application is busy, if an error occurs while the capture operation is taking place, or if the capture operation has been canceled by the user before any media files have been captured.
-This function is invoked with a <a href="capture.html">Capture</a>Error object containing an appropriate error code.
+This function is invoked with a CaptureError object containing an appropriate error code.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture error callback
var captureError = function(error) {
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md b/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md
index 797d9da..2b32dfe 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/ConfigurationData.md
@@ -28,7 +28,7 @@ Description
This object is used to describe media capture modes supported by the device. The configuration data includes the MIME type, and capture dimensions (for video or image capture).
-The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). <a href="../../storage/storage.opendatabase.html">Example</a>s:
+The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples:
- video/3gpp
- video/quicktime
@@ -43,7 +43,7 @@ Properties
- __height:__ The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
- __width:__ The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// retrieve supported image modes
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md b/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md
index afb3f3e..83b2fe8 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/MediaFile.getFormatData.md
@@ -18,20 +18,20 @@ license: >
under the License.
---
-<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData
+MediaFile.getFormatData
=======================
> Retrieves format information about the media capture file.
- media<a href="../../file/fileobj/fileobj.html">File</a>.getFormatData(
- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataSuccessCB successCallback,
- [<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataErrorCB errorCallback]
+ mediaFile.getFormatData(
+ MediaFileDataSuccessCB successCallback,
+ [MediaFileDataErrorCB errorCallback]
);
Description
-----------
-This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataSuccessCB callback with a <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data object. If the attempt fails, this function will invoke the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>DataErrorCB callback.
+This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the MediaFileDataSuccessCB callback with a MediaFileData object. If the attempt fails, this function will invoke the MediaFileDataErrorCB callback.
Supported Platforms
-------------------
@@ -43,12 +43,12 @@ Supported Platforms
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. Therefore, all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data objects will be returned with default values. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
+There is no API that provides format information of media files. Therefore, all MediaFileData objects will be returned with default values. See MediaFileData documentation.
Android Quirks
--------------
-The API for retrieving media file format information is limited. Therefore, not all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties are supported. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
+The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
iOS Quirks
----------
-The API for retrieving media file format information is limited. Therefore, not all <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties are supported. See <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data documentation.
\ No newline at end of file
+The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md b/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md
index 0a10254..869b0ef 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/MediaFile.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>
+MediaFile
=========
> Encapsulates properties of a media capture file.
@@ -35,4 +35,4 @@ Properties
Methods
-------
-- __<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.getFormatData.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.getFormatData</a>:__ Retrieves the format information of the media file.
\ No newline at end of file
+- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md b/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md
index ebac2e3..cc7de58 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/MediaFileData.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data
+MediaFileData
=============
> Encapsulates format information about a media file.
@@ -34,7 +34,7 @@ Properties
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. So the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data object returned by the <a href="<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData.html"><a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData</a> function will have the following default values:
+There is no API that provides format information of media files. So the MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Not supported. The attribute will always be 0.
@@ -44,7 +44,7 @@ There is no API that provides format information of media files. So the <a href
Android Quirks
--------------
-Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties is as follows:
+Support for the MediaFileData properties is as follows:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Not supported. The attribute will always be 0.
@@ -54,7 +54,7 @@ Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fi
iOS Quirks
----------
-Support for the <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data properties is as follows:
+Support for the MediaFileData properties is as follows:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/capture.md b/www/docs/en/1.8.1/cordova/media/capture/capture.md
index 4d53c33..044d06f 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/capture.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/capture.md
@@ -27,22 +27,22 @@ Objects
-------
- Capture
-- <a href="captureAudioOptions.html">CaptureAudioOptions</a>
-- <a href="captureImageOptions.html">CaptureImageOptions</a>
-- <a href="captureVideoOptions.html">CaptureVideoOptions</a>
-- <a href="CaptureCB.html">CaptureCB</a>
-- <a href="<a href="CaptureError.html">CaptureError</a>CB.html"><a href="CaptureError.html">CaptureError</a>CB</a>
-- <a href="ConfigurationData.html">ConfigurationData</a>
-- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>
-- <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>Data
+- CaptureAudioOptions
+- CaptureImageOptions
+- CaptureVideoOptions
+- CaptureCB
+- CaptureErrorCB
+- ConfigurationData
+- MediaFile
+- MediaFileData
Methods
-------
-- <a href="captureAudio.html">capture.captureAudio</a>
-- <a href="captureImage.html">capture.captureImage</a>
-- <a href="captureVideo.html">capture.captureVideo</a>
-- <a href="<a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData.html"><a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a>.getFormatData</a>
+- capture.captureAudio
+- capture.captureImage
+- capture.captureVideo
+- MediaFile.getFormatData
Scope
-----
@@ -55,16 +55,16 @@ The __capture__ object is assigned to the __navigator.device__ object, and there
Properties
----------
-- __supportedAudioModes:__ The audio recording formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
-- __supportedImageModes:__ The recording image sizes and formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
-- __supportedVideoModes:__ The recording video resolutions and formats supported by the device. (<a href="ConfigurationData.html">ConfigurationData</a>[])
+- __supportedAudioModes:__ The audio recording formats supported by the device. (ConfigurationData[])
+- __supportedImageModes:__ The recording image sizes and formats supported by the device. (ConfigurationData[])
+- __supportedVideoModes:__ The recording video resolutions and formats supported by the device. (ConfigurationData[])
Methods
-------
-- <a href="captureAudio.html">capture.captureAudio</a>: Launch the device audio recording application for recording audio clip(s).
-- <a href="captureImage.html">capture.captureImage</a>: Launch the device camera application for taking image(s).
-- <a href="captureVideo.html">capture.captureVideo</a>: Launch the device video recorder application for recording video(s).
+- capture.captureAudio: Launch the device audio recording application for recording audio clip(s).
+- capture.captureImage: Launch the device camera application for taking image(s).
+- capture.captureVideo: Launch the device video recorder application for recording video(s).
Supported Platforms
@@ -101,7 +101,7 @@ Permissions
#### www/plugins.xml
- <plugin name="Capture" value="org.apache.cordova.capture.<a href="../media.html">Media</a>Capture" />
+ <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" />
#### www/config.xml
@@ -110,7 +110,7 @@ Permissions
### iOS
-#### App/Supporting <a href="../../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/captureAudio.md b/www/docs/en/1.8.1/cordova/media/capture/captureAudio.md
index 7136e7c..9ca3302 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/captureAudio.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/captureAudio.md
@@ -24,7 +24,7 @@ capture.captureAudio
> Start the audio recorder application and return information about captured audio clip file(s).
navigator.device.capture.captureAudio(
- <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> captureSuccess, <a href="capture.html">Capture</a>ErrorCB captureError, [<a href="capture.html">Capture</a>AudioOptions options]
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
);
Description
@@ -32,9 +32,9 @@ Description
This method starts an asynchronous operation to capture audio recordings using the device's default audio recording application. The operation allows the device user to capture multiple recordings in a single session.
-The capture operation ends when either the user exits the audio recording application, or the maximum number of recordings, specified by the __limit__ parameter in <a href="capture.html">Capture</a>AudioOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single audio clip.
+The capture operation ends when either the user exits the audio recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureAudioOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single audio clip.
-When the capture operation is finished, it will invoke the <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> callback with an array of <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a> objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the <a href="capture.html">Capture</a>ErrorCB callback will be invoked with a <a href="capture.html">Capture</a>Error object with the <a href="capture.html">Capture</a>Error.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -44,33 +44,33 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture callback
- var captureSuccess = function(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ var captureSuccess = function(mediaFiles) {
var i, path, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- path = media<a href="../../file/fileobj/fileobj.html">File</a>s[i].fullPath;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
// do something interesting with the file
}
};
// capture error callback
var captureError = function(error) {
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};
// start audio capture
navigator.device.capture.captureAudio(captureSuccess, captureError, {limit:2});
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="capture.html">Capture</a> Audio</title>
+ <title>Capture Audio</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
@@ -78,10 +78,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// Called when capture operation is finished
//
- function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ function captureSuccess(mediaFiles) {
var i, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>s[i]);
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ uploadFile(mediaFiles[i]);
}
}
@@ -89,7 +89,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
//
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>(msg, null, 'Uh oh!');
+ navigator.notification.alert(msg, null, 'Uh oh!');
}
// A button will call this function
@@ -101,10 +101,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
}
// Upload files to server
- function upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>) {
- var ft = new <a href="../../file/filetransfer/filetransfer.html"><a href="../../file/fileobj/fileobj.html">File</a>Transfer</a>(),
- path = media<a href="../../file/fileobj/fileobj.html">File</a>.fullPath,
- name = media<a href="../../file/fileobj/fileobj.html">File</a>.name;
+ function uploadFile(mediaFile) {
+ var ft = new FileTransfer(),
+ path = mediaFile.fullPath,
+ name = mediaFile.name;
ft.upload(path,
"http://my.domain.com/upload.php",
@@ -121,14 +121,14 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <button onclick="captureAudio();"><a href="capture.html">Capture</a> Audio</button> <br>
+ <button onclick="captureAudio();">Capture Audio</button> <br>
</body>
</html>
BlackBerry WebWorks Quirks
--------------------------
-- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture the audio recordings. The developer will receive a <a href="capture.html">Capture</a>Error.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture the audio recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
iOS Quirks
----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/captureAudioOptions.md b/www/docs/en/1.8.1/cordova/media/capture/captureAudioOptions.md
index 08a05cd..ff303f5 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/captureAudioOptions.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/captureAudioOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>AudioOptions
+CaptureAudioOptions
===================
> Encapsulates audio capture configuration options.
@@ -30,13 +30,13 @@ Properties
- __duration:__ The maximum duration of an audio sound clip, in seconds.
- __mode:__ The selected audio mode. The value must match one of the elements in `capture.supportedAudioModes`.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// limit capture operation to 3 media files, no longer than 10 seconds each
var options = { limit: 3, duration: 10 };
- navigator.device.<a href="captureAudio.html">capture.captureAudio</a>(captureSuccess, captureError, options);
+ navigator.device.capture.captureAudio(captureSuccess, captureError, options);
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/captureImage.md b/www/docs/en/1.8.1/cordova/media/capture/captureImage.md
index e7c3df6..17f1e08 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/captureImage.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/captureImage.md
@@ -24,7 +24,7 @@ capture.captureImage
> Start the camera application and return information about captured image file(s).
navigator.device.capture.captureImage(
- <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> captureSuccess, <a href="capture.html">Capture</a>ErrorCB captureError, [<a href="capture.html">Capture</a>ImageOptions options]
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
);
Description
@@ -32,9 +32,9 @@ Description
This method starts an asynchronous operation to capture images using the device camera application. The operation allows the device user to capture multiple images in a single session.
-The capture operation ends when either the user exits the camera application, or the maximum number of images, specified by the __limit__ parameter in <a href="capture.html">Capture</a>ImageOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user captures a single image.
+The capture operation ends when either the user exits the camera application, or the maximum number of images, specified by the __limit__ parameter in CaptureImageOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user captures a single image.
-When the capture operation is finished, it will invoke the <a href="<a href="capture.html">Capture</a>CB.html"><a href="capture.html">Capture</a>CB</a> callback with an array of <a href="<a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a>.html"><a href="../media.html">Media</a><a href="../../file/fileobj/fileobj.html">File</a></a> objects describing each captured image file. If the operation is terminated by the user before an image is captured, the <a href="capture.html">Capture</a>ErrorCB callback will be invoked with a <a href="capture.html">Capture</a>Error object with the <a href="capture.html">Capture</a>Error.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured image file. If the operation is terminated by the user before an image is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -50,33 +50,33 @@ Windows Phone 7 Quirks
Invoking the native camera application while your device is connected
via Zune will not work, and the error callback will be triggered.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// capture callback
- var captureSuccess = function(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ var captureSuccess = function(mediaFiles) {
var i, path, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- path = media<a href="../../file/fileobj/fileobj.html">File</a>s[i].fullPath;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
// do something interesting with the file
}
};
// capture error callback
var captureError = function(error) {
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>('Error code: ' + error.code, null, '<a href="capture.html">Capture</a> Error');
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};
// start image capture
navigator.device.capture.captureImage(captureSuccess, captureError, {limit:2});
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="capture.html">Capture</a> Image</title>
+ <title>Capture Image</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
@@ -84,10 +84,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// Called when capture operation is finished
//
- function captureSuccess(media<a href="../../file/fileobj/fileobj.html">File</a>s) {
+ function captureSuccess(mediaFiles) {
var i, len;
- for (i = 0, len = media<a href="../../file/fileobj/fileobj.html">File</a>s.length; i < len; i += 1) {
- upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>s[i]);
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ uploadFile(mediaFiles[i]);
}
}
@@ -95,7 +95,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
//
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
- navigator.<a href="../../notification/notification.alert.html">notification.alert</a>(msg, null, 'Uh oh!');
+ navigator.notification.alert(msg, null, 'Uh oh!');
}
// A button will call this function
@@ -107,10 +107,10 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
}
// Upload files to server
- function upload<a href="../../file/fileobj/fileobj.html">File</a>(media<a href="../../file/fileobj/fileobj.html">File</a>) {
- var ft = new <a href="../../file/filetransfer/filetransfer.html"><a href="../../file/fileobj/fileobj.html">File</a>Transfer</a>(),
- path = media<a href="../../file/fileobj/fileobj.html">File</a>.fullPath,
- name = media<a href="../../file/fileobj/fileobj.html">File</a>.name;
+ function uploadFile(mediaFile) {
+ var ft = new FileTransfer(),
+ path = mediaFile.fullPath,
+ name = mediaFile.name;
ft.upload(path,
"http://my.domain.com/upload.php",
@@ -127,7 +127,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <button onclick="captureImage();"><a href="capture.html">Capture</a> Image</button> <br>
+ <button onclick="captureImage();">Capture Image</button> <br>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/media/capture/captureImageOptions.md b/www/docs/en/1.8.1/cordova/media/capture/captureImageOptions.md
index a0891fe..b9f0333 100644
--- a/www/docs/en/1.8.1/cordova/media/capture/captureImageOptions.md
+++ b/www/docs/en/1.8.1/cordova/media/capture/captureImageOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="capture.html">Capture</a>ImageOptions
+CaptureImageOptions
===================
> Encapsulates image capture configuration options.
@@ -29,13 +29,13 @@ Properties
- __limit:__ The maximum number of images the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
- __mode:__ The selected image mode. The value must match one of the elements in `capture.supportedImageModes`.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// limit capture operation to 3 images
var options = { limit: 3 };
- navigator.device.<a href="captureImage.html">capture.captureImage</a>(captureSuccess, captureError, options);
+ navigator.device.capture.captureImage(captureSuccess, captureError, options);
Android Quirks
--------------
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org