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:02 UTC
[02/51] [partial] docs commit: Solidifying 'automatic' links.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/camera/parameter/CameraPopoverOptions.md b/www/docs/en/1.9.0/cordova/camera/parameter/CameraPopoverOptions.md
index 06bfea9..2efd55b 100644
--- a/www/docs/en/1.9.0/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/www/docs/en/1.9.0/cordova/camera/parameter/CameraPopoverOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-CameraPopoverOptions
+<a href="../camera.html">Camera</a>PopoverOptions
====================
Parameters only used by iOS to specify the anchor element location and arrow direction of popover used on iPad when selecting images from the library or album.
@@ -27,10 +27,10 @@ Parameters only used by iOS to specify the anchor element location and arrow dir
y : 32,
width : 320,
height : 480,
- arrowDir : Camera.PopoverArrowDirection.ARROW_ANY
+ arrowDir : <a href="../camera.html">Camera</a>.PopoverArrowDirection.ARROW_ANY
};
-CameraPopoverOptions
+<a href="../camera.html">Camera</a>PopoverOptions
--------------------
- __x:__ x pixel coordinate of element on the screen to anchor popover onto. (`Number`)
@@ -41,9 +41,9 @@ CameraPopoverOptions
- __height:__ height, in pixels, of the element on the screen to anchor popover onto. (`Number`)
-- __arrowDir:__ Direction the arrow on the popover should point. Defined in Camera.PopoverArrowDirection (`Number`)
+- __arrowDir:__ Direction the arrow on the popover should point. Defined in <a href="../camera.html">Camera</a>.PopoverArrowDirection (`Number`)
- Camera.PopoverArrowDirection = {
+ <a href="../camera.html">Camera</a>.PopoverArrowDirection = {
ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
ARROW_DOWN : 2,
ARROW_LEFT : 4,
@@ -53,13 +53,13 @@ CameraPopoverOptions
Note that the size of the popover may change to adjust to the direction of the arrow and orientation of the screen. Make sure to account for orientation changes when specifying the anchor element location.
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
- var popover = new CameraPopoverOptions(300,300,100,100,Camera.PopoverArrowDirection.ARROW_ANY);
- var options = { quality: 50, destinationType: Camera.DestinationType.DATA_URL,sourceType: Camera.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover };
+ var popover = new <a href="../camera.html">Camera</a>PopoverOptions(300,300,100,100,<a href="../camera.html">Camera</a>.PopoverArrowDirection.ARROW_ANY);
+ var options = { quality: 50, destinationType: <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,sourceType: <a href="../camera.html">Camera</a>.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover };
- navigator.camera.getPicture(onSuccess, onFail, options);
+ navigator.<a href="../camera.getPicture.html">camera.getPicture</a>(onSuccess, onFail, options);
function onSuccess(imageData) {
var image = document.getElementById('myImage');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/camera/parameter/cameraOptions.md b/www/docs/en/1.9.0/cordova/camera/parameter/cameraOptions.md
index 713f3c4..284fd77 100644
--- a/www/docs/en/1.9.0/cordova/camera/parameter/cameraOptions.md
+++ b/www/docs/en/1.9.0/cordova/camera/parameter/cameraOptions.md
@@ -24,13 +24,13 @@ cameraOptions
Optional parameters to customize the camera settings.
{ quality : 75,
- destinationType : Camera.DestinationType.DATA_URL,
- sourceType : Camera.PictureSourceType.CAMERA,
+ destinationType : <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,
+ sourceType : <a href="../camera.html">Camera</a>.PictureSourceType.CAMERA,
allowEdit : true,
- encodingType: Camera.EncodingType.JPEG,
+ encodingType: <a href="../camera.html">Camera</a>.EncodingType.JPEG,
targetWidth: 100,
targetHeight: 100,
- popoverOptions: CameraPopoverOptions,
+ popoverOptions: <a href="../camera.html">Camera</a>PopoverOptions,
saveToPhotoAlbum: false };
Options
@@ -40,14 +40,14 @@ Options
- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
- Camera.DestinationType = {
+ <a href="../camera.html">Camera</a>.DestinationType = {
DATA_URL : 0, // Return image as base64 encoded string
FILE_URI : 1 // Return image file URI
};
- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
- Camera.PictureSourceType = {
+ <a href="../camera.html">Camera</a>.PictureSourceType = {
PHOTOLIBRARY : 0,
CAMERA : 1,
SAVEDPHOTOALBUM : 2
@@ -57,7 +57,7 @@ Options
- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
- Camera.EncodingType = {
+ <a href="../camera.html">Camera</a>.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
@@ -65,9 +65,9 @@ Options
- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`)
- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`)
-- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`)
+- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.<a href="../../media/media.html">Media</a>Type (`Number`)
- Camera.MediaType = {
+ <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type = {
PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
ALLMEDIA : 2 // allow selection from all media types
@@ -75,13 +75,13 @@ Options
- __correctOrientation:__ Rotate the image to correct for the orientation of the device during capture. (`Boolean`)
- __saveToPhotoAlbum:__ Save the image to the photo album on the device after capture. (`Boolean`)
-- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in CameraPopoverOptions
+- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in <a href="../camera.html">Camera</a>PopoverOptions
Android Quirks
--------------
- Ignores the `allowEdit` parameter.
-- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
+- <a href="../camera.html">Camera</a>.PictureSourceType.PHOTOLIBRARY and <a href="../camera.html">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
BlackBerry Quirks
-----------------
@@ -89,9 +89,9 @@ BlackBerry Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native Camera application after photo is taken.
+- Application must have key injection permissions to close native <a href="../camera.html">Camera</a> application after photo is taken.
- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-- Camera.MediaType is not supported.
+- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -101,7 +101,7 @@ webOS Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Camera.MediaType is not supported.
+- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/camera/parameter/cameraSuccess.md b/www/docs/en/1.9.0/cordova/camera/parameter/cameraSuccess.md
index ec04795..6083130 100644
--- a/www/docs/en/1.9.0/cordova/camera/parameter/cameraSuccess.md
+++ b/www/docs/en/1.9.0/cordova/camera/parameter/cameraSuccess.md
@@ -30,9 +30,9 @@ onSuccess callback function that provides the image data.
Parameters
----------
-- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
+- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `<a href="cameraOptions.html">cameraOptions</a>` used. (`String`)
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
// Show image
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/compass.clearWatch.md b/www/docs/en/1.9.0/cordova/compass/compass.clearWatch.md
index bb2536a..8eff362 100644
--- a/www/docs/en/1.9.0/cordova/compass/compass.clearWatch.md
+++ b/www/docs/en/1.9.0/cordova/compass/compass.clearWatch.md
@@ -25,7 +25,7 @@ Stop watching the compass referenced by the watch ID parameter.
navigator.compass.clearWatch(watchID);
-- __watchID__: The ID returned by `compass.watchHeading`.
+- __watchID__: The ID returned by `<a href="compass.watchHeading.html">compass.watchHeading</a>`.
Supported Platforms
-------------------
@@ -36,22 +36,22 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+ var watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
// ... later on ...
navigator.compass.clearWatch(watchID);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -61,11 +61,11 @@ Full Example
// 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() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -76,7 +76,7 @@ Full Example
// Update compass every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+ watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
}
// Stop watching the compass
@@ -97,8 +97,8 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ function onError(<a href="parameters/compassError.html">compassError</a>) {
+ alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/compass.clearWatchFilter.md b/www/docs/en/1.9.0/cordova/compass/compass.clearWatchFilter.md
index 276c11f..9cf3e19 100644
--- a/www/docs/en/1.9.0/cordova/compass/compass.clearWatchFilter.md
+++ b/www/docs/en/1.9.0/cordova/compass/compass.clearWatchFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-compass.clearWatchFilter
+<a href="compass.clearWatch.html">compass.clearWatch</a>Filter
========================
-No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
+No longer supported as of 1.6. See `<a href="compass.clearWatch.html">compass.clearWatch</a>`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/compass.getCurrentHeading.md b/www/docs/en/1.9.0/cordova/compass/compass.getCurrentHeading.md
index fd4ab2e..a8ae7c7 100644
--- a/www/docs/en/1.9.0/cordova/compass/compass.getCurrentHeading.md
+++ b/www/docs/en/1.9.0/cordova/compass/compass.getCurrentHeading.md
@@ -23,14 +23,14 @@ compass.getCurrentHeading
Get the current compass heading.
- navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
+ navigator.compass.getCurrentHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, <a href="parameters/compassOptions.html">compassOptions</a>);
Description
-----------
The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
+The compass heading information is returned via a <a href="compass.html">Compass</a>Heading object using the `<a href="parameters/compassSuccess.html">compassSuccess</a>` callback function.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(heading) {
@@ -49,29 +49,29 @@ Quick Example
};
function onError(error) {
- alert('CompassError: ' + error.code);
+ alert('<a href="<a href="parameters/compassError.html">compassError</a>/<a href="parameters/compassError.html">compassError</a>.html"><a href="compass.html">Compass</a>Error</a>: ' + error.code);
};
navigator.compass.getCurrentHeading(onSuccess, onError);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
+ function on<a href="../device/device.html">Device</a>Ready() {
navigator.compass.getCurrentHeading(onSuccess, onError);
}
@@ -83,14 +83,14 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass Error: ' + compassError.code);
+ function onError(<a href="parameters/compassError.html">compassError</a>) {
+ alert('<a href="compass.html">Compass</a> Error: ' + <a href="parameters/compassError.html">compassError</a>.code);
}
</script>
</head>
<body>
- <h1>Example</h1>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
<p>getCurrentHeading</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/compass.md b/www/docs/en/1.9.0/cordova/compass/compass.md
index c560ffd..3e0651e 100644
--- a/www/docs/en/1.9.0/cordova/compass/compass.md
+++ b/www/docs/en/1.9.0/cordova/compass/compass.md
@@ -26,19 +26,19 @@ Compass
Methods
-------
-- compass.getCurrentHeading
-- compass.watchHeading
-- compass.clearWatch
-- compass.watchHeadingFilter (obsolete)
-- compass.clearWatchFilter (obsolete)
+- <a href="compass.getCurrentHeading.html">compass.getCurrentHeading</a>
+- <a href="compass.watchHeading.html">compass.watchHeading</a>
+- <a href="compass.clearWatch.html">compass.clearWatch</a>
+- <a href="<a href="compass.watchHeading.html">compass.watchHeading</a>Filter.html"><a href="compass.watchHeading.html">compass.watchHeading</a>Filter</a> (obsolete)
+- <a href="<a href="compass.clearWatch.html">compass.clearWatch</a>Filter.html"><a href="compass.clearWatch.html">compass.clearWatch</a>Filter</a> (obsolete)
Arguments
---------
-- compassSuccess
-- compassError
-- compassOptions
-- compassHeading
+- <a href="parameters/compassSuccess.html">compassSuccess</a>
+- <a href="parameters/compassError.html">compassError</a>
+- <a href="parameters/compassOptions.html">compassOptions</a>
+- <a href="parameters/compassHeading.html">compassHeading</a>
Permissions
-----------
@@ -59,7 +59,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.9.0/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/compass.watchHeading.md b/www/docs/en/1.9.0/cordova/compass/compass.watchHeading.md
index 306facc..f85b56e 100644
--- a/www/docs/en/1.9.0/cordova/compass/compass.watchHeading.md
+++ b/www/docs/en/1.9.0/cordova/compass/compass.watchHeading.md
@@ -23,16 +23,16 @@ compass.watchHeading
At a regular interval, get the compass heading in degrees.
- var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
+ var watchID = navigator.compass.watchHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, [<a href="parameters/compassOptions.html">compassOptions</a>]);
Description
-----------
The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object.
+The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `<a href="parameters/compassOptions.html">compassOptions</a>` object.
-The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
+The returned watch ID references references the compass watch interval. The watch ID can be used with `<a href="compass.clearWatch.html">compass.clearWatch</a>` to stop watching the compass.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(heading) {
@@ -52,21 +52,21 @@ Quick Example
element.innerHTML = 'Heading: ' + heading.magneticHeading;
};
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ function onError(<a href="parameters/compassError.html">compassError</a>) {
+ alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
};
var options = { frequency: 3000 }; // Update every 3 seconds
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -76,11 +76,11 @@ Full Example
// 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() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -98,7 +98,7 @@ Full Example
//
function stopWatch() {
if (watchID) {
- navigator.compass.clearWatch(watchID);
+ navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>(watchID);
watchID = null;
}
}
@@ -112,8 +112,8 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ function onError(<a href="parameters/compassError.html">compassError</a>) {
+ alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
}
</script>
@@ -128,6 +128,6 @@ Full Example
iOS Quirks
--------------
-In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
+In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `<a href="parameters/compassOptions.html">compassOptions</a>` object. Clear the watch as normal by passing the returned watch ID to `<a href="compass.clearWatch.html">compass.clearWatch</a>`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
In iOS only one watchHeading can be in effect at one time. If a watchHeading via filter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS watching heading changes via a filter is more efficient than via time.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/compass.watchHeadingFilter.md b/www/docs/en/1.9.0/cordova/compass/compass.watchHeadingFilter.md
index 991da30..f05a774 100644
--- a/www/docs/en/1.9.0/cordova/compass/compass.watchHeadingFilter.md
+++ b/www/docs/en/1.9.0/cordova/compass/compass.watchHeadingFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-compass.watchHeadingFilter
+<a href="compass.watchHeading.html">compass.watchHeading</a>Filter
==========================
-No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
+No longer supported as of 1.6, see `<a href="compass.watchHeading.html">compass.watchHeading</a>` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/compassError/compassError.md b/www/docs/en/1.9.0/cordova/compass/compassError/compassError.md
index 20d01c5..e356b45 100644
--- a/www/docs/en/1.9.0/cordova/compass/compassError/compassError.md
+++ b/www/docs/en/1.9.0/cordova/compass/compassError/compassError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-CompassError
+<a href="../compass.html">Compass</a>Error
==========
-A `CompassError` object is returned to the `compassError` callback function when an error occurs.
+A `<a href="../compass.html">Compass</a>Error` object is returned to the `<a href="../parameters/compassError.html">compassError</a>` callback function when an error occurs.
Properties
----------
@@ -30,12 +30,12 @@ Properties
Constants
---------
-- `CompassError.COMPASS_INTERNAL_ERR`
-- `CompassError.COMPASS_NOT_SUPPORTED`
+- `<a href="../compass.html">Compass</a>Error.COMPASS_INTERNAL_ERR`
+- `<a href="../compass.html">Compass</a>Error.COMPASS_NOT_SUPPORTED`
Description
-----------
-The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
+The `<a href="../compass.html">Compass</a>Error` object is returned to the user through the `<a href="../parameters/compassError.html">compassError</a>` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/parameters/compassError.md b/www/docs/en/1.9.0/cordova/compass/parameters/compassError.md
index 3d2f523..44700bc 100644
--- a/www/docs/en/1.9.0/cordova/compass/parameters/compassError.md
+++ b/www/docs/en/1.9.0/cordova/compass/parameters/compassError.md
@@ -23,9 +23,9 @@ compassError
onError callback function for compass functions.
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
-function(CompassError) {
+function(<a href="../compassError/compassError.html"><a href="../compass.html">Compass</a>Error</a>) {
// Handle the error
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/parameters/compassHeading.md b/www/docs/en/1.9.0/cordova/compass/parameters/compassHeading.md
index adae2f6..8293202 100644
--- a/www/docs/en/1.9.0/cordova/compass/parameters/compassHeading.md
+++ b/www/docs/en/1.9.0/cordova/compass/parameters/compassHeading.md
@@ -21,7 +21,7 @@ license: >
compassHeading
==========
-A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
+A `<a href="../compass.html">Compass</a>Heading` object is returned to the `<a href="compassSuccess.html">compassSuccess</a>` callback function when an error occurs.
Properties
----------
@@ -33,7 +33,7 @@ Properties
Description
-----------
-The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
+The `<a href="../compass.html">Compass</a>Heading` object is returned to the user through the `<a href="compassSuccess.html">compassSuccess</a>` callback function.
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/compass/parameters/compassSuccess.md b/www/docs/en/1.9.0/cordova/compass/parameters/compassSuccess.md
index a9bc5ff..015bb3f 100644
--- a/www/docs/en/1.9.0/cordova/compass/parameters/compassSuccess.md
+++ b/www/docs/en/1.9.0/cordova/compass/parameters/compassSuccess.md
@@ -21,7 +21,7 @@ license: >
compassSuccess
==============
-onSuccess callback function that provides the compass heading information via a compassHeading object.
+onSuccess callback function that provides the compass heading information via a <a href="compassHeading.html">compassHeading</a> object.
function(heading) {
// Do something
@@ -31,9 +31,9 @@ Parameters
----------
-- __heading:__ The heading information. _(compassHeading)_
+- __heading:__ The heading information. _(<a href="compassHeading.html">compassHeading</a>)_
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
function onSuccess(heading) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/connection/connection.md b/www/docs/en/1.9.0/cordova/connection/connection.md
index dd275b5..a39bb77 100644
--- a/www/docs/en/1.9.0/cordova/connection/connection.md
+++ b/www/docs/en/1.9.0/cordova/connection/connection.md
@@ -28,7 +28,7 @@ This object is accessed under the `navigator.network` interface.
Properties
----------
-- connection.type
+- <a href="connection.type.html">connection.type</a>
Constants
---------
@@ -70,7 +70,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.9.0/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/connection/connection.type.md b/www/docs/en/1.9.0/cordova/connection/connection.type.md
index 6d68c3d..8d1b638 100644
--- a/www/docs/en/1.9.0/cordova/connection/connection.type.md
+++ b/www/docs/en/1.9.0/cordova/connection/connection.type.md
@@ -38,60 +38,60 @@ Supported Platforms
- Bada 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- function checkConnection() {
+ function check<a href="connection.html">Connection</a>() {
var networkState = navigator.network.connection.type;
var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.NONE] = 'No network connection';
+ states[<a href="connection.html">Connection</a>.UNKNOWN] = 'Unknown connection';
+ states[<a href="connection.html">Connection</a>.ETHERNET] = 'Ethernet connection';
+ states[<a href="connection.html">Connection</a>.WIFI] = 'WiFi connection';
+ states[<a href="connection.html">Connection</a>.CELL_2G] = 'Cell 2G connection';
+ states[<a href="connection.html">Connection</a>.CELL_3G] = 'Cell 3G connection';
+ states[<a href="connection.html">Connection</a>.CELL_4G] = 'Cell 4G connection';
+ states[<a href="connection.html">Connection</a>.NONE] = 'No network connection';
- alert('Connection type: ' + states[networkState]);
+ alert('<a href="connection.html">Connection</a> type: ' + states[networkState]);
}
- checkConnection();
+ check<a href="connection.html">Connection</a>();
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>navigator.network.connection.type Example</title>
+ <title>navigator.network.connection.type <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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 loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
- checkConnection();
+ function on<a href="../device/device.html">Device</a>Ready() {
+ check<a href="connection.html">Connection</a>();
}
- function checkConnection() {
+ function check<a href="connection.html">Connection</a>() {
var networkState = navigator.network.connection.type;
var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.NONE] = 'No network connection';
-
- alert('Connection type: ' + states[networkState]);
+ states[<a href="connection.html">Connection</a>.UNKNOWN] = 'Unknown connection';
+ states[<a href="connection.html">Connection</a>.ETHERNET] = 'Ethernet connection';
+ states[<a href="connection.html">Connection</a>.WIFI] = 'WiFi connection';
+ states[<a href="connection.html">Connection</a>.CELL_2G] = 'Cell 2G connection';
+ states[<a href="connection.html">Connection</a>.CELL_3G] = 'Cell 3G connection';
+ states[<a href="connection.html">Connection</a>.CELL_4G] = 'Cell 4G connection';
+ states[<a href="connection.html">Connection</a>.NONE] = 'No network connection';
+
+ alert('<a href="connection.html">Connection</a> type: ' + states[networkState]);
}
</script>
@@ -105,13 +105,13 @@ iOS Quirks
----------
- iOS cannot detect the type of cellular network connection.
- - `navigator.network.connection.type` is set to `Connection.CELL_2G` for all cellular data.
+ - `navigator.network.connection.type` is set to `<a href="connection.html">Connection</a>.CELL_2G` for all cellular data.
Bada Quirks
-----------
- Bada can only detect a WiFi or cellular connection.
- - `navigator.network.connection.type` is set to `Connection.CELL_2G` for all cellular data.
+ - `navigator.network.connection.type` is set to `<a href="connection.html">Connection</a>.CELL_2G` for all cellular data.
webOS Quirks
------------
@@ -121,4 +121,4 @@ webOS Quirks
Windows Phone Quirks
--------------------
-- Windows Phone Emulator always detects `navigator.network.connection.type` as `Connection.UNKNOWN`.
+- Windows Phone Emulator always detects `navigator.network.connection.type` as `<a href="connection.html">Connection</a>.UNKNOWN`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/Contact/contact.md b/www/docs/en/1.9.0/cordova/contacts/Contact/contact.md
index 90bdb70..1168c47 100644
--- a/www/docs/en/1.9.0/cordova/contacts/Contact/contact.md
+++ b/www/docs/en/1.9.0/cordova/contacts/Contact/contact.md
@@ -28,31 +28,31 @@ Properties
- __id:__ A globally unique identifier. _(DOMString)_
- __displayName:__ The name of this Contact, suitable for display to end-users. _(DOMString)_
-- __name:__ An object containing all components of a persons name. _(ContactName)_
+- __name:__ An object containing all components of a persons name. _(<a href="../ContactName/contactname.html">ContactName</a>)_
- __nickname:__ A casual name to address the contact by. _(DOMString)_
-- __phoneNumbers:__ An array of all the contact's phone numbers. _(ContactField[])_
-- __emails:__ An array of all the contact's email addresses. _(ContactField[])_
-- __addresses:__ An array of all the contact's addresses. _(ContactAddress[])_
-- __ims:__ An array of all the contact's IM addresses. _(ContactField[])_
-- __organizations:__ An array of all the contact's organizations. _(ContactOrganization[])_
+- __phoneNumbers:__ An array of all the contact's phone numbers. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
+- __emails:__ An array of all the contact's email addresses. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
+- __addresses:__ An array of all the contact's addresses. _(<a href="../ContactAddress/contactaddress.html">ContactAddress</a>[])_
+- __ims:__ An array of all the contact's IM addresses. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
+- __organizations:__ An array of all the contact's organizations. _(<a href="../ContactOrganization/contactorganization.html">ContactOrganization</a>[])_
- __birthday:__ The birthday of the contact. _(Date)_
- __note:__ A note about the contact. _(DOMString)_
-- __photos:__ An array of the contact's photos. _(ContactField[])_
-- __categories:__ An array of all the contacts user defined categories. _(ContactField[])_
-- __urls:__ An array of web pages associated to the contact. _(ContactField[])_
+- __photos:__ An array of the contact's photos. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
+- __categories:__ An array of all the contacts user defined categories. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
+- __urls:__ An array of web pages associated to the contact. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
Methods
-------
- __clone__: Returns a new Contact object that is a deep copy of the calling object, with the id property set to `null`.
-- __remove__: Removes the contact from the device contacts database. An error callback is called with a `ContactError` object if the removal is unsuccessful.
+- __remove__: Removes the contact from the device contacts database. An error callback is called with a `<a href="../ContactError/<a href="../parameters/contactError.html">contactError</a>.html">ContactError</a>` object if the removal is unsuccessful.
- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
Details
-------
-The `Contact` object represents a user contact. Contacts can be created, saved to, or removed from the device contacts database. Contacts can also be retrieved (individually or in bulk) from the database by invoking the `contacts.find` method.
+The `Contact` object represents a user contact. <a href="../contacts.html">Contacts</a> can be created, saved to, or removed from the device contacts database. <a href="../contacts.html">Contacts</a> can also be retrieved (individually or in bulk) from the database by invoking the `<a href="../contacts.find.html">contacts.find</a>` method.
_Note: Not all of the above contact fields are supported on every device platform. Please check each platform's Quirks section for information about which fields are supported._
@@ -64,24 +64,24 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Save Quick Example
+Save Quick <a href="../../storage/storage.opendatabase.html">Example</a>
------------------
function onSuccess(contact) {
alert("Save Success");
};
- function onError(contactError) {
- alert("Error = " + contactError.code);
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
};
// create a new contact object
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
// populate some fields
- var name = new ContactName();
+ var name = new <a href="../ContactName/contactname.html">ContactName</a>();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
@@ -89,7 +89,7 @@ Save Quick Example
// save to device
contact.save(onSuccess,onError);
-Clone Quick Example
+Clone Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------------
// clone the contact object
@@ -98,43 +98,43 @@ Clone Quick Example
console.log("Original contact name = " + contact.name.givenName);
console.log("Cloned contact name = " + clone.name.givenName);
-Remove Quick Example
+Remove Quick <a href="../../storage/storage.opendatabase.html">Example</a>
--------------------
function onSuccess() {
alert("Removal Success");
};
- function onError(contactError) {
- alert("Error = " + contactError.code);
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
};
// remove the contact from the device
contact.remove(onSuccess,onError);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title>Contact <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// create
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
- var name = new ContactName();
+ var name = new <a href="../ContactName/contactname.html">ContactName</a>();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
@@ -160,8 +160,8 @@ Full Example
// onSaveError: Failed to get the contacts
//
- function onSaveError(contactError) {
- alert("Error = " + contactError.code);
+ function onSaveError(<a href="../parameters/contactError.html">contactError</a>) {
+ alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
}
// onRemoveSuccess: Get a snapshot of the current contacts
@@ -172,15 +172,15 @@ Full Example
// onRemoveError: Failed to get the contacts
//
- function onRemoveError(contactError) {
- alert("Error = " + contactError.code);
+ function onRemoveError(<a href="../parameters/contactError.html">contactError</a>) {
+ alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../contacts.html">Contacts</a></p>
</body>
</html>
@@ -217,9 +217,9 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
iOS Quirks
----------
-- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no ContactName specified. If there is no ContactName, then composite name, __nickname__ or "" is returned for __displayName__, respectively.
+- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no <a href="../ContactName/contactname.html">ContactName</a> specified. If there is no <a href="../ContactName/contactname.html">ContactName</a>, then composite name, __nickname__ or "" is returned for __displayName__, respectively.
- __birthday:__ For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object.
-- __photos:__ Returned Photo is stored in the application's temporary directory and a File URL to photo is returned. Contents of temporary folder is deleted when application exits.
+- __photos:__ Returned Photo is stored in the application's temporary directory and a <a href="../../file/fileobj/fileobj.html">File</a> URL to photo is returned. Contents of temporary folder is deleted when application exits.
- __categories:__ This property is not currently supported and will always be returned as `null`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/ContactAddress/contactaddress.md b/www/docs/en/1.9.0/cordova/contacts/ContactAddress/contactaddress.md
index 8123312..490d005 100644
--- a/www/docs/en/1.9.0/cordova/contacts/ContactAddress/contactaddress.md
+++ b/www/docs/en/1.9.0/cordova/contacts/ContactAddress/contactaddress.md
@@ -18,14 +18,14 @@ license: >
under the License.
---
-ContactAddress
+<a href="../Contact/contact.html">Contact</a>Address
==============
-Contains address properties for a `Contact` object.
+Contains address properties for a `<a href="../Contact/contact.html">Contact</a>` object.
Properties
----------
-- __pref:__ Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Address` contains the user's preferred value. _(boolean)_
- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
- __formatted:__ The full address formatted for display. _(DOMString)_
- __streetAddress:__ The full street address. _(DOMString)_
@@ -37,7 +37,7 @@ Properties
Details
-------
-The `ContactAddress` object stores the properties of a single address of a contact. A `Contact` object can have one or more addresses in a `ContactAddress[]` array.
+The `<a href="../Contact/contact.html">Contact</a>Address` object stores the properties of a single address of a contact. A `<a href="../Contact/contact.html">Contact</a>` object can have one or more addresses in a `<a href="../Contact/contact.html">Contact</a>Address[]` array.
Supported Platforms
-------------------
@@ -47,7 +47,7 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// display the address information for all contacts
@@ -66,39 +66,39 @@ Quick Example
}
};
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
// find all contacts
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
var filter = ["displayName","addresses"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// find all contacts
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
var filter = ["displayName","addresses"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -121,15 +121,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/ContactError/contactError.md b/www/docs/en/1.9.0/cordova/contacts/ContactError/contactError.md
index b0f07c8..ad3bc3d 100644
--- a/www/docs/en/1.9.0/cordova/contacts/ContactError/contactError.md
+++ b/www/docs/en/1.9.0/cordova/contacts/ContactError/contactError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-ContactError
+<a href="../Contact/contact.html">Contact</a>Error
========
-A `ContactError` object is returned to the `contactError` callback when an error occurs.
+A `<a href="../Contact/contact.html">Contact</a>Error` object is returned to the `<a href="../parameters/contactError.html">contactError</a>` callback when an error occurs.
Properties
----------
@@ -31,16 +31,16 @@ Properties
Constants
---------
-- `ContactError.UNKNOWN_ERROR`
-- `ContactError.INVALID_ARGUMENT_ERROR`
-- `ContactError.TIMEOUT_ERROR`
-- `ContactError.PENDING_OPERATION_ERROR`
-- `ContactError.IO_ERROR`
-- `ContactError.NOT_SUPPORTED_ERROR`
-- `ContactError.PERMISSION_DENIED_ERROR`
+- `<a href="../Contact/contact.html">Contact</a>Error.UNKNOWN_ERROR`
+- `<a href="../Contact/contact.html">Contact</a>Error.INVALID_ARGUMENT_ERROR`
+- `<a href="../Contact/contact.html">Contact</a>Error.TIMEOUT_ERROR`
+- `<a href="../Contact/contact.html">Contact</a>Error.PENDING_OPERATION_ERROR`
+- `<a href="../Contact/contact.html">Contact</a>Error.IO_ERROR`
+- `<a href="../Contact/contact.html">Contact</a>Error.NOT_SUPPORTED_ERROR`
+- `<a href="../Contact/contact.html">Contact</a>Error.PERMISSION_DENIED_ERROR`
Description
-----------
-The `ContactError` object is returned to the user through the `contactError` callback function when an error occurs.
+The `<a href="../Contact/contact.html">Contact</a>Error` object is returned to the user through the `<a href="../parameters/contactError.html">contactError</a>` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/ContactField/contactfield.md b/www/docs/en/1.9.0/cordova/contacts/ContactField/contactfield.md
index f2377de..3fedbd8 100644
--- a/www/docs/en/1.9.0/cordova/contacts/ContactField/contactfield.md
+++ b/www/docs/en/1.9.0/cordova/contacts/ContactField/contactfield.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-ContactField
+<a href="../Contact/contact.html">Contact</a>Field
============
-Supports generic fields in a `Contact` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls.
+Supports generic fields in a `<a href="../Contact/contact.html">Contact</a>` object. Some properties that are stored as `<a href="../Contact/contact.html">Contact</a>Field` objects include email addresses, phone numbers, and urls.
Properties
----------
- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)_
- __value:__ The value of the field (such as a phone number or email address). _(DOMString)_
-- __pref:__ Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Field` contains the user's preferred value. _(boolean)_
Details
-------
-The `ContactField` object is a reusable component that is used to support contact fields in a generic fashion. Each `ContactField` object contains a value property, a type property, and a pref property. A `Contact` object stores several properties in `ContactField[]` arrays, such as phone numbers and email addresses.
+The `<a href="../Contact/contact.html">Contact</a>Field` object is a reusable component that is used to support contact fields in a generic fashion. Each `<a href="../Contact/contact.html">Contact</a>Field` object contains a value property, a type property, and a pref property. A `<a href="../Contact/contact.html">Contact</a>` object stores several properties in `<a href="../Contact/contact.html">Contact</a>Field[]` arrays, such as phone numbers and email addresses.
-In most instances, there are no pre-determined values for the __type__ attribute of a `ContactField` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `Contact` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string.
+In most instances, there are no pre-determined values for the __type__ attribute of a `<a href="../Contact/contact.html">Contact</a>Field` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `<a href="../Contact/contact.html">Contact</a>` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string.
Supported Platforms
-------------------
@@ -45,58 +45,58 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// create a new contact
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
- // store contact phone numbers in ContactField[]
+ // store contact phone numbers in <a href="../Contact/contact.html">Contact</a>Field[]
var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ phoneNumbers[0] = new <a href="../Contact/contact.html">Contact</a>Field('work', '212-555-1234', false);
+ phoneNumbers[1] = new <a href="../Contact/contact.html">Contact</a>Field('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new <a href="../Contact/contact.html">Contact</a>Field('home', '203-555-7890', false);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// create a new contact
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
- // store contact phone numbers in ContactField[]
+ // store contact phone numbers in <a href="../Contact/contact.html">Contact</a>Field[]
var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ phoneNumbers[0] = new <a href="../Contact/contact.html">Contact</a>Field('work', '212-555-1234', false);
+ phoneNumbers[1] = new <a href="../Contact/contact.html">Contact</a>Field('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new <a href="../Contact/contact.html">Contact</a>Field('home', '203-555-7890', false);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
// search contacts, returning display name and phone numbers
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","phoneNumbers"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -114,15 +114,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/ContactFindOptions/contactfindoptions.md b/www/docs/en/1.9.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 9a45a86..617288b 100644
--- a/www/docs/en/1.9.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/www/docs/en/1.9.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-ContactFindOptions
+<a href="../Contact/contact.html">Contact</a>FindOptions
==================
-Contains properties that can be used to filter the results of a `contacts.find` operation.
+Contains properties that can be used to filter the results of a `<a href="../contacts.find.html">contacts.find</a>` operation.
Properties
----------
@@ -38,7 +38,7 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// success callback
@@ -49,45 +49,45 @@ Quick Example
};
// error callback
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
// specify contact search criteria
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter=""; // empty search string returns all contacts
options.multiple=true; // return multiple results
filter = ["displayName"]; // return contact.displayName field
// find contacts
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// specify contact search criteria
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter=""; // empty search string returns all contacts
options.multiple=true; // return multiple results
filter = ["displayName"]; // return contact.displayName field
// find contacts
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -100,15 +100,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/ContactName/contactname.md b/www/docs/en/1.9.0/cordova/contacts/ContactName/contactname.md
index 0652aa9..26c413e 100644
--- a/www/docs/en/1.9.0/cordova/contacts/ContactName/contactname.md
+++ b/www/docs/en/1.9.0/cordova/contacts/ContactName/contactname.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-ContactName
+<a href="../Contact/contact.html">Contact</a>Name
===========
-Contains name properties of a `Contact` object.
+Contains name properties of a `<a href="../Contact/contact.html">Contact</a>` object.
Properties
----------
@@ -36,7 +36,7 @@ Properties
Details
-------
-The `ContactName` object stores name properties of a contact.
+The `<a href="../Contact/contact.html">Contact</a>Name` object stores name properties of a contact.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(contacts) {
@@ -60,37 +60,37 @@ Quick Example
}
};
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","name"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
- var options = new ContactFindOptions();
+ function on<a href="../../device/device.html">Device</a>Ready() {
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","name"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -108,15 +108,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/ContactOrganization/contactorganization.md b/www/docs/en/1.9.0/cordova/contacts/ContactOrganization/contactorganization.md
index aaa743b..6ab83b0 100644
--- a/www/docs/en/1.9.0/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/www/docs/en/1.9.0/cordova/contacts/ContactOrganization/contactorganization.md
@@ -18,14 +18,14 @@ license: >
under the License.
---
-ContactOrganization
+<a href="../Contact/contact.html">Contact</a>Organization
===================
-Contains organization properties of a `Contact` object.
+Contains organization properties of a `<a href="../Contact/contact.html">Contact</a>` object.
Properties
----------
-- __pref:__ Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Organization` contains the user's preferred value. _(boolean)_
- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
- __name:__ The name of the organization. _(DOMString)_
- __department:__ The department the contract works for. _(DOMString)_
@@ -34,7 +34,7 @@ Properties
Details
-------
-The `ContactOrganization` object stores a contact's organization properties. A `Contact` object stores one or more `ContactOrganization` objects in an array.
+The `<a href="../Contact/contact.html">Contact</a>Organization` object stores a contact's organization properties. A `<a href="../Contact/contact.html">Contact</a>` object stores one or more `<a href="../Contact/contact.html">Contact</a>Organization` objects in an array.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(contacts) {
@@ -59,37 +59,37 @@ Quick Example
}
};
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","organizations"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
- var options = new ContactFindOptions();
+ function on<a href="../../device/device.html">Device</a>Ready() {
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","organizations"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -108,15 +108,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
@@ -151,4 +151,4 @@ iOS Quirks
Bada 2.0 Quirks
---------------
-- ContactOrganization not supported
+- <a href="../Contact/contact.html">Contact</a>Organization not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/contacts.create.md b/www/docs/en/1.9.0/cordova/contacts/contacts.create.md
index c8acde8..911b3c8 100644
--- a/www/docs/en/1.9.0/cordova/contacts/contacts.create.md
+++ b/www/docs/en/1.9.0/cordova/contacts/contacts.create.md
@@ -21,16 +21,16 @@ license: >
contacts.create
===============
-Returns a new Contact object.
+Returns a new <a href="Contact/contact.html">Contact</a> object.
var contact = navigator.contacts.create(properties);
Description
-----------
-contacts.create is a synchronous function that returns a new `Contact` object.
+contacts.create is a synchronous function that returns a new `<a href="Contact/contact.html">Contact</a>` object.
-This method does not persist the Contact object to the device contacts database. To persist the Contact object to the device, invoke the `Contact.save` method.
+This method does not persist the <a href="Contact/contact.html">Contact</a> object to the device contacts database. To persist the <a href="Contact/contact.html">Contact</a> object to the device, invoke the `<a href="Contact/contact.html">Contact</a>.save` method.
Supported Platforms
-------------------
@@ -40,39 +40,39 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- var myContact = navigator.contacts.create({"displayName": "Test User"});
+ var my<a href="Contact/contact.html">Contact</a> = navigator.contacts.create({"displayName": "Test User"});
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="Contact/contact.html">Contact</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
- var myContact = navigator.contacts.create({"displayName": "Test User"});
- myContact.note = "This contact has a note.";
- console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
+ function on<a href="../device/device.html">Device</a>Ready() {
+ var my<a href="Contact/contact.html">Contact</a> = navigator.contacts.create({"displayName": "Test User"});
+ my<a href="Contact/contact.html">Contact</a>.note = "This contact has a note.";
+ console.log("The contact, " + my<a href="Contact/contact.html">Contact</a>.displayName + ", note: " + my<a href="Contact/contact.html">Contact</a>.note);
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Create Contact</p>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Create <a href="Contact/contact.html">Contact</a></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/contacts.find.md b/www/docs/en/1.9.0/cordova/contacts/contacts.find.md
index c1c0b80..7b8fd66 100644
--- a/www/docs/en/1.9.0/cordova/contacts/contacts.find.md
+++ b/www/docs/en/1.9.0/cordova/contacts/contacts.find.md
@@ -21,26 +21,26 @@ license: >
contacts.find
=============
-Queries the device contacts database and returns one or more `Contact` objects, each containing the fields specified.
+Queries the device contacts database and returns one or more `<a href="Contact/contact.html">Contact</a>` objects, each containing the fields specified.
- navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
+ navigator.contacts.find(<a href="parameters/contactFields.html">contactFields</a>, <a href="parameters/contactSuccess.html">contactSuccess</a>, <a href="parameters/contactError.html">contactError</a>, <a href="parameters/contactFindOptions.html">contactFindOptions</a>);
Description
-----------
-contacts.find is an asynchronous function that queries the device contacts database and returns an array of `Contact` objects. The resulting objects are passed to the `contactSuccess` callback function specified by the __contactSuccess__ parameter.
+contacts.find is an asynchronous function that queries the device contacts database and returns an array of `<a href="Contact/contact.html">Contact</a>` objects. The resulting objects are passed to the `<a href="parameters/contactSuccess.html">contactSuccess</a>` callback function specified by the __<a href="parameters/contactSuccess.html">contactSuccess</a>__ parameter.
-Users must specify the contact fields to be used as a search qualifier in the __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `Contact` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter will result in an array of `Contact` objects with only the `id` property populated. A __contactFields__ value of ["*"] will return all contact fields.
+Users must specify the contact fields to be used as a search qualifier in the __<a href="parameters/contactFields.html">contactFields</a>__ parameter. Only the fields specified in the __<a href="parameters/contactFields.html">contactFields</a>__ parameter will be returned as properties of the `<a href="Contact/contact.html">Contact</a>` objects that are passed to the __<a href="parameters/contactSuccess.html">contactSuccess</a>__ callback function. A zero-length __<a href="parameters/contactFields.html">contactFields</a>__ parameter will result in an array of `<a href="Contact/contact.html">Contact</a>` objects with only the `id` property populated. A __<a href="parameters/contactFields.html">contactFields</a>__ value of ["*"] will return all contact fields.
-The __contactFindOptions.filter__ string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the __contactFields__ parameter. If a match is found in a comparison with _any_ of the specified fields, the contact is returned.
+The __<a href="parameters/contactFindOptions.html">contactFindOptions</a>.filter__ string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the __<a href="parameters/contactFields.html">contactFields</a>__ parameter. If a match is found in a comparison with _any_ of the specified fields, the contact is returned.
Parameters
----------
-- __contactFields:__ Contact fields to be used as search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required]
-- __contactSuccess:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required]
-- __contactError:__ Error callback function. Invoked when error occurs. [Optional]
-- __contactFindOptions:__ Search options to filter contacts. [Optional]
+- __<a href="parameters/contactFields.html">contactFields</a>:__ <a href="Contact/contact.html">Contact</a> fields to be used as search qualifier. Only these fields will have values in the resulting `<a href="Contact/contact.html">Contact</a>` objects. _(DOMString[])_ [Required]
+- __<a href="parameters/contactSuccess.html">contactSuccess</a>:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required]
+- __<a href="parameters/contactError.html">contactError</a>:__ Error callback function. Invoked when error occurs. [Optional]
+- __<a href="parameters/contactFindOptions.html">contactFindOptions</a>:__ Search options to filter contacts. [Optional]
Supported Platforms
-------------------
@@ -50,43 +50,43 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(contacts) {
alert('Found ' + contacts.length + ' contacts.');
};
- function onError(contactError) {
+ function onError(<a href="parameters/contactError.html">contactError</a>) {
alert('onError!');
};
// find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
+ var options = new <a href="Contact/contact.html">Contact</a>FindOptions();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="Contact/contact.html">Contact</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.9.0.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() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
+ var options = new <a href="Contact/contact.html">Contact</a>FindOptions();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
@@ -102,15 +102,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.9.0/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.9.0/cordova/contacts/contacts.md b/www/docs/en/1.9.0/cordova/contacts/contacts.md
index 34346f0..ff5c180 100644
--- a/www/docs/en/1.9.0/cordova/contacts/contacts.md
+++ b/www/docs/en/1.9.0/cordova/contacts/contacts.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-Contacts
+<a href="Contact/contact.html">Contact</a>s
========
> The `contacts` object provides access to the device contacts database.
@@ -26,27 +26,27 @@ Contacts
Methods
-------
-- contacts.create
-- contacts.find
+- <a href="contacts.create.html">contacts.create</a>
+- <a href="contacts.find.html">contacts.find</a>
Arguments
---------
-- contactFields
-- contactSuccess
-- contactError
-- contactFindOptions
+- <a href="parameters/contactFields.html">contactFields</a>
+- <a href="parameters/contactSuccess.html">contactSuccess</a>
+- <a href="parameters/contactError.html">contactError</a>
+- <a href="parameters/contactFindOptions.html">contactFindOptions</a>
Objects
-------
-- Contact
-- ContactName
-- ContactField
-- ContactAddress
-- ContactOrganization
-- ContactFindOptions
-- ContactError
+- <a href="Contact/contact.html">Contact</a>
+- <a href="Contact/contact.html">Contact</a>Name
+- <a href="Contact/contact.html">Contact</a>Field
+- <a href="Contact/contact.html">Contact</a>Address
+- <a href="Contact/contact.html">Contact</a>Organization
+- <a href="Contact/contact.html">Contact</a>FindOptions
+- <a href="Contact/contact.html">Contact</a>Error
Permissions
-----------
@@ -55,7 +55,7 @@ Permissions
#### app/res/xml/plugins.xml
- <plugin name="Contacts" value="org.apache.cordova.ContactManager" />
+ <plugin name="<a href="Contact/contact.html">Contact</a>s" value="org.apache.cordova.<a href="Contact/contact.html">Contact</a>Manager" />
#### app/AndroidManifest.xml
@@ -75,23 +75,23 @@ Permissions
#### www/plugins.xml
- <plugin name="Contact" value="org.apache.cordova.pim.Contact" />
+ <plugin name="<a href="Contact/contact.html">Contact</a>" value="org.apache.cordova.pim.<a href="Contact/contact.html">Contact</a>" />
#### www/config.xml
<feature id="blackberry.find" required="true" version="1.0.0.0" />
<feature id="blackberry.identity" required="true" version="1.0.0.0" />
<feature id="blackberry.pim.Address" required="true" version="1.0.0.0" />
- <feature id="blackberry.pim.Contact" required="true" version="1.0.0.0" />
+ <feature id="blackberry.pim.<a href="Contact/contact.html">Contact</a>" required="true" version="1.0.0.0" />
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
- <key>Contacts</key>
- <string>CDVContacts</string>
+ <key><a href="Contact/contact.html">Contact</a>s</key>
+ <string>CDV<a href="Contact/contact.html">Contact</a>s</string>
</dict>
### webOS
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org