You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/11 06:41:17 UTC
[33/51] [partial] docs commit: Reverting autolinking change because
of inconsistencies.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/camera/camera.getPicture.md b/www/docs/en/1.5.0/phonegap/camera/camera.getPicture.md
index 88260b4..a4552ae 100644
--- a/www/docs/en/1.5.0/phonegap/camera/camera.getPicture.md
+++ b/www/docs/en/1.5.0/phonegap/camera/camera.getPicture.md
@@ -23,16 +23,16 @@ camera.getPicture
Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded `String` or as the URI of an image file.
- navigator.camera.getPicture( <a href="parameter/cameraSuccess.html">cameraSuccess</a>, <a href="parameter/cameraError.html">cameraError</a>, [ <a href="parameter/cameraOptions.html">cameraOptions</a> ] );
+ navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
Description
-----------
-Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `<a href="camera.html">Camera</a>.sourceType = <a href="camera.html">Camera</a>.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
+Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
-If `<a href="camera.html">Camera</a>.sourceType = <a href="camera.html">Camera</a>.PictureSourceType.PHOTOLIBRARY` or `<a href="camera.html">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
+If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
-The return value will be sent to the `<a href="parameter/cameraSuccess.html">cameraSuccess</a>` function, in one of the following formats, depending on the `<a href="parameter/cameraOptions.html">cameraOptions</a>` you specify:
+The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
- A `String` containing the Base64 encoded photo image.
- A `String` representing the image file location on local storage (default).
@@ -40,10 +40,10 @@ The return value will be sent to the `<a href="parameter/cameraSuccess.html">cam
You can do whatever you want with the encoded image or URI, for example:
- Render the image in an `<img>` tag _(see example below)_
-- Save the data locally (`Local<a href="../storage/storage.html">Storage</a>`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
+- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
- Post the data to a remote server
-Note: The image quality of pictures taken using the camera on newer devices is quite good. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the '<a href="camera.html">Camera</a>.destinationType' is highly recommended.
+Note: The image quality of pictures taken using the camera on newer devices is quite good. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended.
Supported Platforms
-------------------
@@ -53,7 +53,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
Take photo and retrieve Base64-encoded image:
@@ -72,7 +72,7 @@ Take photo and retrieve Base64-encoded image:
Take photo and retrieve image file location:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: <a href="camera.html">Camera</a>.DestinationType.FILE_URI });
+ destinationType: Camera.DestinationType.FILE_URI });
function onSuccess(imageURI) {
var image = document.getElementById('myImage');
@@ -84,13 +84,13 @@ Take photo and retrieve image file location:
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../media/capture/capture.html">Capture</a> Photo</title>
+ <title>Capture Photo</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -100,11 +100,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for PhoneGap to connect with the device
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>",on<a href="../device/device.html">Device</a>Ready,false);
+ document.addEventListener("deviceready",onDeviceReady,false);
// PhoneGap is ready to be used!
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
pictureSource=navigator.camera.PictureSourceType;
destinationType=navigator.camera.DestinationType;
}
@@ -124,7 +124,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
smallImage.style.display = 'block';
// Show the captured photo
- // The inline CSS rules are used to re<a href="../storage/parameters/size.html">size</a> the image
+ // The inline CSS rules are used to resize the image
//
smallImage.src = "data:image/jpeg;base64," + imageData;
}
@@ -144,7 +144,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
largeImage.style.display = 'block';
// Show the captured photo
- // The inline CSS rules are used to re<a href="../storage/parameters/size.html">size</a> the image
+ // The inline CSS rules are used to resize the image
//
largeImage.src = imageURI;
}
@@ -181,8 +181,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <button onclick="capturePhoto();"><a href="../media/capture/capture.html">Capture</a> Photo</button> <br>
- <button onclick="capturePhotoEdit();"><a href="../media/capture/capture.html">Capture</a> Editable Photo</button> <br>
+ <button onclick="capturePhoto();">Capture Photo</button> <br>
+ <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
<button onclick="getPhoto(pictureSource.PHOTOLIBRARY);">From Photo Library</button><br>
<button onclick="getPhoto(pictureSource.SAVEDPHOTOALBUM);">From Photo Album</button><br>
<img style="display:none;width:60px;height:60px;" id="smallImage" src="" />
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/camera/camera.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/camera/camera.md b/www/docs/en/1.5.0/phonegap/camera/camera.md
index 4608c34..611035d 100644
--- a/www/docs/en/1.5.0/phonegap/camera/camera.md
+++ b/www/docs/en/1.5.0/phonegap/camera/camera.md
@@ -26,4 +26,4 @@ Camera
Methods
-------
-- <a href="camera.getPicture.html">camera.getPicture</a>
\ No newline at end of file
+- camera.getPicture
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/camera/parameter/cameraOptions.md b/www/docs/en/1.5.0/phonegap/camera/parameter/cameraOptions.md
index edd1e28..7ee2831 100644
--- a/www/docs/en/1.5.0/phonegap/camera/parameter/cameraOptions.md
+++ b/www/docs/en/1.5.0/phonegap/camera/parameter/cameraOptions.md
@@ -24,10 +24,10 @@ cameraOptions
Optional parameters to customize the camera settings.
{ quality : 75,
- destinationType : <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,
- sourceType : <a href="../camera.html">Camera</a>.PictureSourceType.CAMERA,
+ destinationType : Camera.DestinationType.DATA_URL,
+ sourceType : Camera.PictureSourceType.CAMERA,
allowEdit : true,
- encodingType: <a href="../camera.html">Camera</a>.EncodingType.JPEG,
+ encodingType: Camera.EncodingType.JPEG,
targetWidth: 100,
targetHeight: 100 };
@@ -38,14 +38,14 @@ Options
- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
- <a href="../camera.html">Camera</a>.DestinationType = {
+ Camera.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`)
- <a href="../camera.html">Camera</a>.PictureSourceType = {
+ Camera.PictureSourceType = {
PHOTOLIBRARY : 0,
CAMERA : 1,
SAVEDPHOTOALBUM : 2
@@ -55,7 +55,7 @@ Options
- __EncodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
- <a href="../camera.html">Camera</a>.EncodingType = {
+ Camera.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
@@ -63,9 +63,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`)
-- __<a href="../../media/media.html">Media</a>Type:__ 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`)
+- __MediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`)
- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type = {
+ Camera.MediaType = {
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,8 +75,8 @@ Android Quirks
--------------
- Ignores the `allowEdit` parameter.
-- <a href="../camera.html">Camera</a>.PictureSourceType.PHOTOLIBRARY and <a href="../camera.html">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
-- <a href="../camera.html">Camera</a>.EncodingType is not supported.
+- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
+- Camera.EncodingType is not supported.
BlackBerry Quirks
-----------------
@@ -84,9 +84,9 @@ BlackBerry Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native <a href="../camera.html">Camera</a> application after photo is taken.
-- Using Large image <a href="../../storage/parameters/size.html">size</a>s may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
+- Application must have key injection permissions to close native Camera 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.
Palm Quirks
-----------
@@ -94,7 +94,7 @@ Palm Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
+- Camera.MediaType is not supported.
iPhone Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/camera/parameter/cameraSuccess.md b/www/docs/en/1.5.0/phonegap/camera/parameter/cameraSuccess.md
index 6083130..ec04795 100644
--- a/www/docs/en/1.5.0/phonegap/camera/parameter/cameraSuccess.md
+++ b/www/docs/en/1.5.0/phonegap/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 `<a href="cameraOptions.html">cameraOptions</a>` used. (`String`)
+- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
// Show image
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/compass.clearWatch.md b/www/docs/en/1.5.0/phonegap/compass/compass.clearWatch.md
index 9040f66..e779584 100644
--- a/www/docs/en/1.5.0/phonegap/compass/compass.clearWatch.md
+++ b/www/docs/en/1.5.0/phonegap/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 `<a href="compass.watchHeading.html">compass.watchHeading</a>`.
+- __watchID__: The ID returned by `compass.watchHeading`.
Supported Platforms
-------------------
@@ -34,22 +34,22 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango ) if available in hardware
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- var watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
+ var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
// ... later on ...
navigator.compass.clearWatch(watchID);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -59,11 +59,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -74,7 +74,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Update compass every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
+ watchID = navigator.compass.watchHeading(onSuccess, onError, options);
}
// Stop watching the compass
@@ -95,8 +95,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- 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);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/compass.clearWatchFilter.md b/www/docs/en/1.5.0/phonegap/compass/compass.clearWatchFilter.md
index 6e78414..a135381 100644
--- a/www/docs/en/1.5.0/phonegap/compass/compass.clearWatchFilter.md
+++ b/www/docs/en/1.5.0/phonegap/compass/compass.clearWatchFilter.md
@@ -18,36 +18,36 @@ license: >
under the License.
---
-<a href="compass.clearWatch.html">compass.clearWatch</a>Filter
+compass.clearWatchFilter
========================
Stop watching the compass referenced by the watch ID parameter.
- navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>Filter(watchID);
+ navigator.compass.clearWatchFilter(watchID);
-- __watchID__: The ID returned by `<a href="<a href="compass.watchHeading.html">compass.watchHeading</a>Filter.html"><a href="compass.watchHeading.html">compass.watchHeading</a>Filter</a>`.
+- __watchID__: The ID returned by `compass.watchHeadingFilter`.
Supported Platforms
-------------------
- iPhone
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- var watchID = navigator.<a href="<a href="compass.watchHeading.html">compass.watchHeading</a>Filter.html"><a href="compass.watchHeading.html">compass.watchHeading</a>Filter</a>(onSuccess, onError, options);
+ var watchID = navigator.compass.watchHeadingFilter(onSuccess, onError, options);
// ... later on ...
- navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>Filter(watchID);
+ navigator.compass.clearWatchFilter(watchID);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -57,11 +57,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -72,14 +72,14 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Get notified on compass heading changes or 10 degrees or more
var options = { filter: 10 };
- watchID = navigator.<a href="<a href="compass.watchHeading.html">compass.watchHeading</a>Filter.html"><a href="compass.watchHeading.html">compass.watchHeading</a>Filter</a>(onSuccess, onError, options);
+ watchID = navigator.compass.watchHeadingFilter(onSuccess, onError, options);
}
// Stop watching the compass
//
function stopWatch() {
if (watchID) {
- navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>Filter(watchID);
+ navigator.compass.clearWatchFilter(watchID);
watchID = null;
}
}
@@ -93,8 +93,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- 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);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/compass.getCurrentHeading.md b/www/docs/en/1.5.0/phonegap/compass/compass.getCurrentHeading.md
index 84587a8..58ec9f3 100644
--- a/www/docs/en/1.5.0/phonegap/compass/compass.getCurrentHeading.md
+++ b/www/docs/en/1.5.0/phonegap/compass/compass.getCurrentHeading.md
@@ -23,14 +23,14 @@ compass.getCurrentHeading
Get the current compass heading.
- navigator.compass.getCurrentHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, <a href="parameters/compassOptions.html">compassOptions</a>);
+ navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
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 <a href="compass.html">Compass</a>Heading object using the `<a href="parameters/compassSuccess.html">compassSuccess</a>` callback function.
+The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
Supported Platforms
-------------------
@@ -39,7 +39,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango ) if available in hardware
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(heading) {
@@ -47,29 +47,29 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
};
function onError(error) {
- 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);
+ alert('CompassError: ' error.code);
};
navigator.compass.getCurrentHeading(onSuccess, onError);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
navigator.compass.getCurrentHeading(onSuccess, onError);
}
@@ -81,14 +81,14 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- 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);
+ function onError(compassError) {
+ alert('Compass Error: ' + compassError.code);
}
</script>
</head>
<body>
- <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <h1>Example</h1>
<p>getCurrentHeading</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/compass.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/compass.md b/www/docs/en/1.5.0/phonegap/compass/compass.md
index 1ba53e6..2812139 100644
--- a/www/docs/en/1.5.0/phonegap/compass/compass.md
+++ b/www/docs/en/1.5.0/phonegap/compass/compass.md
@@ -26,16 +26,16 @@ Compass
Methods
-------
-- <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>
-- <a href="<a href="compass.clearWatch.html">compass.clearWatch</a>Filter.html"><a href="compass.clearWatch.html">compass.clearWatch</a>Filter</a>
+- compass.getCurrentHeading
+- compass.watchHeading
+- compass.clearWatch
+- compass.watchHeadingFilter
+- compass.clearWatchFilter
Arguments
---------
-- <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>
+- compassSuccess
+- compassError
+- compassOptions
+- compassHeading
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/compass.watchHeading.md b/www/docs/en/1.5.0/phonegap/compass/compass.watchHeading.md
index 704526a..09e7384 100644
--- a/www/docs/en/1.5.0/phonegap/compass/compass.watchHeading.md
+++ b/www/docs/en/1.5.0/phonegap/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(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, [<a href="parameters/compassOptions.html">compassOptions</a>]);
+ var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
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 `<a href="parameters/compassOptions.html">compassOptions</a>` 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 `compassOptions` object.
-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.
+The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- Windows Phone 7 ( Mango ) if available in hardware
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(heading) {
@@ -50,21 +50,21 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
element.innerHTML = 'Heading: ' + heading.magneticHeading;
};
- 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);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
};
var options = { frequency: 3000 }; // Update every 3 seconds
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -74,11 +74,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -96,7 +96,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function stopWatch() {
if (watchID) {
- navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>(watchID);
+ navigator.compass.clearWatch(watchID);
watchID = null;
}
}
@@ -110,8 +110,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- 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);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/compass.watchHeadingFilter.md b/www/docs/en/1.5.0/phonegap/compass/compass.watchHeadingFilter.md
index 8c8608f..f6abf55 100644
--- a/www/docs/en/1.5.0/phonegap/compass/compass.watchHeadingFilter.md
+++ b/www/docs/en/1.5.0/phonegap/compass/compass.watchHeadingFilter.md
@@ -18,21 +18,21 @@ license: >
under the License.
---
-<a href="compass.watchHeading.html">compass.watchHeading</a>Filter
+compass.watchHeadingFilter
==========================
Get the compass heading in degrees when it changes by at least a certain number of degrees.
- var watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>Filter(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, <a href="parameters/compassOptions.html">compassOptions</a>);
+ var watchID = navigator.compass.watchHeadingFilter(compassSuccess, compassError, compassOptions);
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 `<a href="compass.watchHeading.html">compass.watchHeading</a>Filter` gets 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.
+The `compass.watchHeadingFilter` gets 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.
-The returned watch ID references references the compass watch interval. The watch ID can be used with `<a href="<a href="compass.clearWatch.html">compass.clearWatch</a>Filter.html"><a href="compass.clearWatch.html">compass.clearWatch</a>Filter</a>` to stop watching the compass via a degree filter. Only one watchHeadingFilter can be in effect at one time. If a watchHeadingFilter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS this method is more efficient than compass.watchFilter() based on the iOS mechanism for monitoring compass heading changes.
+The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatchFilter` to stop watching the compass via a degree filter. Only one watchHeadingFilter can be in effect at one time. If a watchHeadingFilter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS this method is more efficient than compass.watchFilter() based on the iOS mechanism for monitoring compass heading changes.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iPhone
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(heading) {
@@ -48,21 +48,21 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
element.innerHTML = 'Heading: ' + heading.magneticHeading;
};
- 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);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
};
var options = { filter: 10 }; // Get notified on compass heading changes or 10 degrees or more
- var watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>Filter(onSuccess, onError, options);
+ var watchID = navigator.compass.watchHeadingFilter(onSuccess, onError, options);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -72,11 +72,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -87,14 +87,14 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Get notified on compass heading changes or 10 degrees or more
var options = { filter: 10 };
- watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>Filter(onSuccess, onError, options);
+ watchID = navigator.compass.watchHeadingFilter(onSuccess, onError, options);
}
// Stop watching the compass
//
function stopWatch() {
if (watchID) {
- navigator.<a href="<a href="compass.clearWatch.html">compass.clearWatch</a>Filter.html"><a href="compass.clearWatch.html">compass.clearWatch</a>Filter</a>(watchID);
+ navigator.compass.clearWatchFilter(watchID);
watchID = null;
}
}
@@ -108,8 +108,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- 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);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/compassError/compassError.md b/www/docs/en/1.5.0/phonegap/compass/compassError/compassError.md
index e356b45..20d01c5 100644
--- a/www/docs/en/1.5.0/phonegap/compass/compassError/compassError.md
+++ b/www/docs/en/1.5.0/phonegap/compass/compassError/compassError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../compass.html">Compass</a>Error
+CompassError
==========
-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.
+A `CompassError` object is returned to the `compassError` callback function when an error occurs.
Properties
----------
@@ -30,12 +30,12 @@ Properties
Constants
---------
-- `<a href="../compass.html">Compass</a>Error.COMPASS_INTERNAL_ERR`
-- `<a href="../compass.html">Compass</a>Error.COMPASS_NOT_SUPPORTED`
+- `CompassError.COMPASS_INTERNAL_ERR`
+- `CompassError.COMPASS_NOT_SUPPORTED`
Description
-----------
-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.
+The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/parameters/compassError.md b/www/docs/en/1.5.0/phonegap/compass/parameters/compassError.md
index 44700bc..3d2f523 100644
--- a/www/docs/en/1.5.0/phonegap/compass/parameters/compassError.md
+++ b/www/docs/en/1.5.0/phonegap/compass/parameters/compassError.md
@@ -23,9 +23,9 @@ compassError
onError callback function for compass functions.
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
-function(<a href="../compassError/compassError.html"><a href="../compass.html">Compass</a>Error</a>) {
+function(CompassError) {
// Handle the error
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/parameters/compassHeading.md b/www/docs/en/1.5.0/phonegap/compass/parameters/compassHeading.md
index 0b176c3..5b04300 100644
--- a/www/docs/en/1.5.0/phonegap/compass/parameters/compassHeading.md
+++ b/www/docs/en/1.5.0/phonegap/compass/parameters/compassHeading.md
@@ -21,7 +21,7 @@ license: >
compassHeading
==========
-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.
+A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
Properties
----------
@@ -33,7 +33,7 @@ Properties
Description
-----------
-The `<a href="../compass.html">Compass</a>Heading` object is returned to the user through the `<a href="compassSuccess.html">compassSuccess</a>` callback function.
+The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/compass/parameters/compassSuccess.md b/www/docs/en/1.5.0/phonegap/compass/parameters/compassSuccess.md
index 015bb3f..a9bc5ff 100644
--- a/www/docs/en/1.5.0/phonegap/compass/parameters/compassSuccess.md
+++ b/www/docs/en/1.5.0/phonegap/compass/parameters/compassSuccess.md
@@ -21,7 +21,7 @@ license: >
compassSuccess
==============
-onSuccess callback function that provides the compass heading information via a <a href="compassHeading.html">compassHeading</a> object.
+onSuccess callback function that provides the compass heading information via a compassHeading object.
function(heading) {
// Do something
@@ -31,9 +31,9 @@ Parameters
----------
-- __heading:__ The heading information. _(<a href="compassHeading.html">compassHeading</a>)_
+- __heading:__ The heading information. _(compassHeading)_
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function onSuccess(heading) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/connection/connection.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/connection/connection.md b/www/docs/en/1.5.0/phonegap/connection/connection.md
index ec8ea53..479f532 100644
--- a/www/docs/en/1.5.0/phonegap/connection/connection.md
+++ b/www/docs/en/1.5.0/phonegap/connection/connection.md
@@ -28,7 +28,7 @@ This object is accessed under the navigator.network interface.
Properties
----------
-- <a href="connection.type.html">connection.type</a>
+- connection.type
Constants
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/connection/connection.type.md b/www/docs/en/1.5.0/phonegap/connection/connection.type.md
index fdc393f..dfb799f 100644
--- a/www/docs/en/1.5.0/phonegap/connection/connection.type.md
+++ b/www/docs/en/1.5.0/phonegap/connection/connection.type.md
@@ -37,61 +37,61 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- Windows Phone 7 ( Mango )
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- function check<a href="connection.html">Connection</a>() {
+ function checkConnection() {
var networkState = navigator.network.connection.type;
var states = {};
- 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';
+ 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('<a href="connection.html">Connection</a> type: ' + states[networkState]);
+ alert('Connection type: ' + states[networkState]);
}
- check<a href="connection.html">Connection</a>();
+ checkConnection();
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>navigator.network.connection.type <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>navigator.network.connection.type Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is loaded and it is now safe to make calls PhoneGap methods
//
- function on<a href="../device/device.html">Device</a>Ready() {
- check<a href="connection.html">Connection</a>();
+ function onDeviceReady() {
+ checkConnection();
}
- function check<a href="connection.html">Connection</a>() {
+ function checkConnection() {
var networkState = navigator.network.connection.type;
var states = {};
- 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]);
+ 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]);
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/Contact/contact.md b/www/docs/en/1.5.0/phonegap/contacts/Contact/contact.md
index b5deb51..1076dd5 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/Contact/contact.md
+++ b/www/docs/en/1.5.0/phonegap/contacts/Contact/contact.md
@@ -27,32 +27,32 @@ Properties
----------
- __id:__ A globally unique identifier. _(DOMString)_
-- __displayName:__ The <a href="../../storage/parameters/name.html">name</a> of this Contact, suitable for display to end-users. _(DOMString)_
-- __<a href="../../storage/parameters/name.html">name</a>:__ An object containing all components of a persons <a href="../../storage/parameters/name.html">name</a>. _(<a href="../ContactName/contactname.html">ContactName</a>)_
-- __nick<a href="../../storage/parameters/name.html">name</a>:__ A casual <a href="../../storage/parameters/name.html">name</a> to address the contact by. _(DOMString)_
-- __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>es[])_
-- __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>[])_
+- __displayName:__ The name of this Contact, suitable for display to end-users. _(DOMString)_
+- __name:__ An object containing all components of a persons name. _(ContactName)_
+- __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. _(ContactAddresses[])_
+- __ims:__ An array of all the contact's IM addresses. _(ContactField[])_
+- __organizations:__ An array of all the contact's organizations. _(ContactOrganization[])_
- __birthday:__ The birthday of the contact. _(Date)_
- __note:__ A note about the contact. _(DOMString)_
-- __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>[])_
+- __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[])_
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 `<a href="../ContactError/<a href="../parameters/contactError.html">contactError</a>.html">ContactError</a>` object if the removal is unsuccessful.
+- __remove__: Removes the contact from the device contacts database. An error callback is called with a `ContactError` 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. <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.
+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.
_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._
@@ -63,89 +63,89 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Save Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Save Quick Example
------------------
function onSuccess(contact) {
alert("Save Success");
};
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
- alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
};
// create a new contact object
- var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
+ var contact = navigator.contacts.create();
contact.displayName = "Plumber";
- contact.nick<a href="../../storage/parameters/name.html">name</a> = "Plumber"; //specify both to support all devices
+ contact.nickname = "Plumber"; //specify both to support all devices
// populate some fields
- var <a href="../../storage/parameters/name.html">name</a> = new <a href="../ContactName/contactname.html">ContactName</a>();
- <a href="../../storage/parameters/name.html">name</a>.givenName = "Jane";
- <a href="../../storage/parameters/name.html">name</a>.familyName = "Doe";
- contact.<a href="../../storage/parameters/name.html">name</a> = <a href="../../storage/parameters/name.html">name</a>;
+ var name = new ContactName();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
// save to device
contact.save(onSuccess,onError);
-Clone Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Clone Quick Example
-------------------
// clone the contact object
var clone = contact.clone();
- clone.<a href="../../storage/parameters/name.html">name</a>.givenName = "John";
- console.log("Original contact <a href="../../storage/parameters/name.html">name</a> = " + contact.<a href="../../storage/parameters/name.html">name</a>.givenName);
- console.log("Cloned contact <a href="../../storage/parameters/name.html">name</a> = " + clone.<a href="../../storage/parameters/name.html">name</a>.givenName);
+ clone.name.givenName = "John";
+ console.log("Original contact name = " + contact.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
-Remove Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Remove Quick Example
--------------------
function onSuccess() {
alert("Removal Success");
};
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
- alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
};
// remove the contact from the device
contact.remove(onSuccess,onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// create
- var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
+ var contact = navigator.contacts.create();
contact.displayName = "Plumber";
- contact.nick<a href="../../storage/parameters/name.html">name</a> = "Plumber"; //specify both to support all devices
- var <a href="../../storage/parameters/name.html">name</a> = new <a href="../ContactName/contactname.html">ContactName</a>();
- <a href="../../storage/parameters/name.html">name</a>.givenName = "Jane";
- <a href="../../storage/parameters/name.html">name</a>.familyName = "Doe";
- contact.<a href="../../storage/parameters/name.html">name</a> = <a href="../../storage/parameters/name.html">name</a>;
+ contact.nickname = "Plumber"; //specify both to support all devices
+ var name = new ContactName();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
// save
contact.save(onSaveSuccess,onSaveError);
// clone
var clone = contact.clone();
- clone.<a href="../../storage/parameters/name.html">name</a>.givenName = "John";
- console.log("Original contact <a href="../../storage/parameters/name.html">name</a> = " + contact.<a href="../../storage/parameters/name.html">name</a>.givenName);
- console.log("Cloned contact <a href="../../storage/parameters/name.html">name</a> = " + clone.<a href="../../storage/parameters/name.html">name</a>.givenName);
+ clone.name.givenName = "John";
+ console.log("Original contact name = " + contact.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
// remove
contact.remove(onRemoveSuccess,onRemoveError);
@@ -159,8 +159,8 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// onSaveError: Failed to get the contacts
//
- function onSaveError(<a href="../parameters/contactError.html">contactError</a>) {
- alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
+ function onSaveError(contactError) {
+ alert("Error = " + contactError.code);
}
// onRemoveSuccess: Get a snapshot of the current contacts
@@ -171,15 +171,15 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// onRemoveError: Failed to get the contacts
//
- function onRemoveError(<a href="../parameters/contactError.html">contactError</a>) {
- alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
+ function onRemoveError(contactError) {
+ alert("Error = " + contactError.code);
}
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Find <a href="../contacts.html">Contacts</a></p>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
</body>
</html>
@@ -191,8 +191,8 @@ Android 2.X Quirks
Android 1.X Quirks
------------------
-- __<a href="../../storage/parameters/name.html">name</a>:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __nick<a href="../../storage/parameters/name.html">name</a>:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
+- __name:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
+- __nickname:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
- __birthday:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
- __photos:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
- __categories:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
@@ -204,19 +204,19 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __id:__ Supported. Assigned by device when contact is saved.
- __displayName:__ Supported. Stored in BlackBerry __user1__ field.
-- __nick<a href="../../storage/parameters/name.html">name</a>:__ This property is not supported, and will always be returned as `null`.
+- __nickname:__ This property is not supported, and will always be returned as `null`.
- __phoneNumbers:__ Partially supported. Phone numbers will be stored in BlackBerry fields __homePhone1__ and __homePhone2__ if _type_ is 'home', __workPhone1__ and __workPhone2__ if _type_ is 'work', __mobilePhone__ if _type_ is 'mobile', __faxPhone__ if _type_ is 'fax', __pagerPhone__ if _type_ is 'pager', and __otherPhone__ if _type_ is none of the above.
- __emails:__ Partially supported. The first three email addresses will be stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
- __addresses:__ Partially supported. The first and second addresses will be stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
- __ims:__ This property is not supported, and will always be returned as `null`.
-- __organizations:__ Partially supported. The __<a href="../../storage/parameters/name.html">name</a>__ and __title__ of the first organization are stored in the BlackBerry __company__ and __title__ fields, respectively.
-- __photos:__ - Partially supported. A single thumbnail-<a href="../../storage/parameters/size.html">size</a>d photo is supported. To set a contact's photo, pass in a either a Base64 encoded image, or a URL pointing to the image. The image will be scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a Base64 encoded image.
+- __organizations:__ Partially supported. The __name__ and __title__ of the first organization are stored in the BlackBerry __company__ and __title__ fields, respectively.
+- __photos:__ - Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a Base64 encoded image, or a URL pointing to the image. The image will be scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a Base64 encoded image.
- __categories:__ Partially supported. Only 'Business' and 'Personal' categories are supported.
- __urls:__ Partially supported. The first url is stored in BlackBerry __webpage__ field.
iOS Quirks
----------
-- __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 <a href="../../storage/parameters/name.html">name</a>, __nick<a href="../../storage/parameters/name.html">name</a>__ or "" is returned for __displayName__, respectively.
+- __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.
- __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 <a href="../../file/fileobj/fileobj.html">File</a> 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 File 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/af6a5545/www/docs/en/1.5.0/phonegap/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/ContactAddress/contactaddress.md b/www/docs/en/1.5.0/phonegap/contacts/ContactAddress/contactaddress.md
index 62cbc71..ddb0f8c 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/ContactAddress/contactaddress.md
+++ b/www/docs/en/1.5.0/phonegap/contacts/ContactAddress/contactaddress.md
@@ -18,26 +18,26 @@ license: >
under the License.
---
-<a href="../Contact/contact.html">Contact</a>Address
+ContactAddress
==============
-Contains address properties for a `<a href="../Contact/contact.html">Contact</a>` object.
+Contains address properties for a `Contact` object.
Properties
----------
-- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Address` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `ContactAddress` 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)_
- __locality:__ The city or locality. _(DOMString)_
- __region:__ The state or region. _(DOMString)_
- __postalCode:__ The zip code or postal code. _(DOMString)_
-- __country:__ The country <a href="../../storage/parameters/name.html">name</a>. _(DOMString)_
+- __country:__ The country name. _(DOMString)_
Details
-------
-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.
+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.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// display the address information for all contacts
@@ -65,39 +65,39 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
}
};
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
};
// find all contacts
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter="";
var filter = ["displayName","addresses"];
- navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
+ navigator.contacts.find(filter, onSuccess, onError, options);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// find all contacts
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter="";
var filter = ["displayName","addresses"];
- navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -120,15 +120,15 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the contacts
//
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
}
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/ContactError/contactError.md b/www/docs/en/1.5.0/phonegap/contacts/ContactError/contactError.md
index ad3bc3d..b0f07c8 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/ContactError/contactError.md
+++ b/www/docs/en/1.5.0/phonegap/contacts/ContactError/contactError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../Contact/contact.html">Contact</a>Error
+ContactError
========
-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.
+A `ContactError` object is returned to the `contactError` callback when an error occurs.
Properties
----------
@@ -31,16 +31,16 @@ Properties
Constants
---------
-- `<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`
+- `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`
Description
-----------
-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.
+The `ContactError` object is returned to the user through the `contactError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/ContactField/contactfield.md b/www/docs/en/1.5.0/phonegap/contacts/ContactField/contactfield.md
index 33b60db..968e18d 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/ContactField/contactfield.md
+++ b/www/docs/en/1.5.0/phonegap/contacts/ContactField/contactfield.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-<a href="../Contact/contact.html">Contact</a>Field
+ContactField
============
-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.
+Supports generic fields in a `Contact` object. Some properties that are stored as `ContactField` 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 `<a href="../Contact/contact.html">Contact</a>Field` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
Details
-------
-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.
+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.
-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, PhoneGap makes use of the __type__ field to indicate the format of the returned image. PhoneGap 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 `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, PhoneGap makes use of the __type__ field to indicate the format of the returned image. PhoneGap 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
-------------------
@@ -44,58 +44,58 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// create a new contact
- var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
+ var contact = navigator.contacts.create();
- // store contact phone numbers in <a href="../Contact/contact.html">Contact</a>Field[]
+ // store contact phone numbers in ContactField[]
var phoneNumbers = [];
- 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);
+ 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);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// create a new contact
- var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
+ var contact = navigator.contacts.create();
- // store contact phone numbers in <a href="../Contact/contact.html">Contact</a>Field[]
+ // store contact phone numbers in ContactField[]
var phoneNumbers = [];
- 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);
+ 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);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
- // search contacts, returning display <a href="../../storage/parameters/name.html">name</a> and phone numbers
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ // search contacts, returning display name and phone numbers
+ var options = new ContactFindOptions();
options.filter="";
filter = ["displayName","phoneNumbers"];
- navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -113,15 +113,15 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the contacts
//
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
}
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/ContactFindOptions/contactfindoptions.md b/www/docs/en/1.5.0/phonegap/contacts/ContactFindOptions/contactfindoptions.md
index 22d61cc..b81cab8 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/ContactFindOptions/contactfindoptions.md
+++ b/www/docs/en/1.5.0/phonegap/contacts/ContactFindOptions/contactfindoptions.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../Contact/contact.html">Contact</a>FindOptions
+ContactFindOptions
==================
-Contains properties that can be used to filter the results of a `<a href="../contacts.find.html">contacts.find</a>` operation.
+Contains properties that can be used to filter the results of a `contacts.find` operation.
Properties
----------
@@ -37,7 +37,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// success callback
@@ -48,45 +48,45 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
};
// error callback
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
};
// specify contact search criteria
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter=""; // empty search string returns all contacts
options.multiple=true; // return multiple results
filter = ["displayName"]; // return contact.displayName field
// find contacts
- navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
+ navigator.contacts.find(filter, onSuccess, onError, options);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// specify contact search criteria
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter=""; // empty search string returns all contacts
options.multiple=true; // return multiple results
filter = ["displayName"]; // return contact.displayName field
// find contacts
- navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -99,15 +99,15 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the contacts
//
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
}
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
</body>
</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org