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:01 UTC
[17/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.7.0/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compass.watchHeading.md b/www/docs/en/1.7.0/cordova/compass/compass.watchHeading.md
index 8727f2e..07403fd 100644
--- a/www/docs/en/1.7.0/cordova/compass/compass.watchHeading.md
+++ b/www/docs/en/1.7.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(<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
-------------------
@@ -43,7 +43,7 @@ Supported Platforms
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(heading) {
@@ -51,21 +51,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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -75,11 +75,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -97,7 +97,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;
}
}
@@ -111,8 +111,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>
@@ -127,6 +127,6 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
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 `<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 `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 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/af6a5545/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md b/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md
index f05a774..991da30 100644
--- a/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md
+++ b/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="compass.watchHeading.html">compass.watchHeading</a>Filter
+compass.watchHeadingFilter
==========================
-No longer supported as of 1.6, see `<a href="compass.watchHeading.html">compass.watchHeading</a>` for equivalent functionality.
+No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md b/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md
index e356b45..20d01c5 100644
--- a/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md
+++ b/www/docs/en/1.7.0/cordova/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.7.0/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/parameters/compassError.md b/www/docs/en/1.7.0/cordova/compass/parameters/compassError.md
index 44700bc..3d2f523 100644
--- a/www/docs/en/1.7.0/cordova/compass/parameters/compassError.md
+++ b/www/docs/en/1.7.0/cordova/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.7.0/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/parameters/compassHeading.md b/www/docs/en/1.7.0/cordova/compass/parameters/compassHeading.md
index 8293202..adae2f6 100644
--- a/www/docs/en/1.7.0/cordova/compass/parameters/compassHeading.md
+++ b/www/docs/en/1.7.0/cordova/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.7.0/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/parameters/compassSuccess.md b/www/docs/en/1.7.0/cordova/compass/parameters/compassSuccess.md
index 015bb3f..a9bc5ff 100644
--- a/www/docs/en/1.7.0/cordova/compass/parameters/compassSuccess.md
+++ b/www/docs/en/1.7.0/cordova/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.7.0/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/connection/connection.md b/www/docs/en/1.7.0/cordova/connection/connection.md
index d09f9e8..7d9def8 100644
--- a/www/docs/en/1.7.0/cordova/connection/connection.md
+++ b/www/docs/en/1.7.0/cordova/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
---------
@@ -45,7 +45,7 @@ WP7 Quirk
---------
- __type:__
-Windows Phone Emulator always reports navigator.network.<a href="connection.type.html">connection.type</a> is Connection.UNKNOWN
+Windows Phone Emulator always reports navigator.network.connection.type is Connection.UNKNOWN
iOS Quirk
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/connection/connection.type.md b/www/docs/en/1.7.0/cordova/connection/connection.type.md
index 8d00149..82238c8 100644
--- a/www/docs/en/1.7.0/cordova/connection/connection.type.md
+++ b/www/docs/en/1.7.0/cordova/connection/connection.type.md
@@ -38,61 +38,61 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 2.x
-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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is loaded and it is now safe to make calls Cordova 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.7.0/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/Contact/contact.md b/www/docs/en/1.7.0/cordova/contacts/Contact/contact.md
index 87053a7..4297c35 100644
--- a/www/docs/en/1.7.0/cordova/contacts/Contact/contact.md
+++ b/www/docs/en/1.7.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. _(<a href="../ContactName/contactname.html">ContactName</a>)_
+- __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. _(<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>[])_
+- __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._
@@ -64,24 +64,24 @@ Supported Platforms
- iOS
- Bada 1.2
-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.nickname = "Plumber"; //specify both to support all devices
// populate some fields
- var name = new <a href="../ContactName/contactname.html">ContactName</a>();
+ var name = new ContactName();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
@@ -89,7 +89,7 @@ Save Quick <a href="../../storage/storage.opendatabase.html">Example</a>
// save to device
contact.save(onSuccess,onError);
-Clone Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Clone Quick Example
-------------------
// clone the contact object
@@ -98,43 +98,43 @@ Clone Quick <a href="../../storage/storage.opendatabase.html">Example</a>
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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// create
- var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
+ var contact = navigator.contacts.create();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
- var name = new <a href="../ContactName/contactname.html">ContactName</a>();
+ var name = new ContactName();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
@@ -160,8 +160,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
@@ -172,15 +172,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>
@@ -217,7 +217,7 @@ 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 <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.
+- __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.7.0/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md b/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md
index 6ff5e7b..95c734e 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md
+++ b/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md
@@ -18,14 +18,14 @@ 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)_
@@ -37,7 +37,7 @@ Properties
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
-------------------
@@ -47,7 +47,7 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// display the address information for all contacts
@@ -66,39 +66,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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ 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
@@ -121,15 +121,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.7.0/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactError/contactError.md b/www/docs/en/1.7.0/cordova/contacts/ContactError/contactError.md
index ad3bc3d..b0f07c8 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactError/contactError.md
+++ b/www/docs/en/1.7.0/cordova/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.7.0/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactField/contactfield.md b/www/docs/en/1.7.0/cordova/contacts/ContactField/contactfield.md
index 4f6b781..261b4b1 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactField/contactfield.md
+++ b/www/docs/en/1.7.0/cordova/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, 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 `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.
Supported Platforms
-------------------
@@ -45,58 +45,58 @@ Supported Platforms
- iOS
- Bada 1.2
-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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ 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 name and phone numbers
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ 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
@@ -114,15 +114,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.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md b/www/docs/en/1.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 6be2647..e1c6647 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/www/docs/en/1.7.0/cordova/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
----------
@@ -38,7 +38,7 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// success callback
@@ -49,45 +49,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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ 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
@@ -100,15 +100,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.7.0/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactName/contactname.md b/www/docs/en/1.7.0/cordova/contacts/ContactName/contactname.md
index 792cff7..6e1e4e6 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactName/contactname.md
+++ b/www/docs/en/1.7.0/cordova/contacts/ContactName/contactname.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../Contact/contact.html">Contact</a>Name
+ContactName
===========
-Contains name properties of a `<a href="../Contact/contact.html">Contact</a>` object.
+Contains name properties of a `Contact` object.
Properties
----------
@@ -36,7 +36,7 @@ Properties
Details
-------
-The `<a href="../Contact/contact.html">Contact</a>Name` object stores name properties of a contact.
+The `ContactName` object stores name properties of a contact.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(contacts) {
@@ -60,37 +60,37 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
}
};
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
};
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter="";
filter = ["displayName","name"];
- 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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ function onDeviceReady() {
+ var options = new ContactFindOptions();
options.filter="";
filter = ["displayName","name"];
- 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
@@ -108,15 +108,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.7.0/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactOrganization/contactorganization.md b/www/docs/en/1.7.0/cordova/contacts/ContactOrganization/contactorganization.md
index 073e183..814640c 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/www/docs/en/1.7.0/cordova/contacts/ContactOrganization/contactorganization.md
@@ -18,14 +18,14 @@ license: >
under the License.
---
-<a href="../Contact/contact.html">Contact</a>Organization
+ContactOrganization
===================
-Contains organization properties of a `<a href="../Contact/contact.html">Contact</a>` object.
+Contains organization properties of a `Contact` object.
Properties
----------
-- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Organization` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `ContactOrganization` 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 `<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.
+The `ContactOrganization` object stores a contact's organization properties. A `Contact` object stores one or more `ContactOrganization` objects in an array.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(contacts) {
@@ -59,37 +59,37 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
}
};
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
};
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter="";
filter = ["displayName","organizations"];
- 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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ function onDeviceReady() {
+ var options = new ContactFindOptions();
options.filter="";
filter = ["displayName","organizations"];
- 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
@@ -108,15 +108,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.7.0/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/contacts.create.md b/www/docs/en/1.7.0/cordova/contacts/contacts.create.md
index e25e5db..40de2d3 100644
--- a/www/docs/en/1.7.0/cordova/contacts/contacts.create.md
+++ b/www/docs/en/1.7.0/cordova/contacts/contacts.create.md
@@ -21,16 +21,16 @@ license: >
contacts.create
===============
-Returns a new <a href="Contact/contact.html">Contact</a> object.
+Returns a new Contact object.
var contact = navigator.contacts.create(properties);
Description
-----------
-contacts.create is a synchronous function that returns a new `<a href="Contact/contact.html">Contact</a>` object.
+contacts.create is a synchronous function that returns a new `Contact` object.
-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.
+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.
Supported Platforms
-------------------
@@ -40,39 +40,39 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- var my<a href="Contact/contact.html">Contact</a> = navigator.contacts.create({"displayName": "Test User"});
+ var myContact = navigator.contacts.create({"displayName": "Test User"});
-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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
- 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);
+ 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);
}
</script>
</head>
<body>
- <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
- <p>Create <a href="Contact/contact.html">Contact</a></p>
+ <h1>Example</h1>
+ <p>Create Contact</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/contacts.find.md b/www/docs/en/1.7.0/cordova/contacts/contacts.find.md
index 85a2968..4cac5cc 100644
--- a/www/docs/en/1.7.0/cordova/contacts/contacts.find.md
+++ b/www/docs/en/1.7.0/cordova/contacts/contacts.find.md
@@ -21,26 +21,26 @@ license: >
contacts.find
=============
-Queries the device contacts database and returns one or more `<a href="Contact/contact.html">Contact</a>` objects, each containing the fields specified.
+Queries the device contacts database and returns one or more `Contact` objects, each containing the fields specified.
- 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>);
+ navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
Description
-----------
-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.
+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.
-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.
+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.
-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.
+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.
Parameters
----------
-- __<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]
+- __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]
Supported Platforms
-------------------
@@ -50,43 +50,43 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(contacts) {
alert('Found ' + contacts.length + ' contacts.');
};
- function onError(<a href="parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
};
// find all contacts with 'Bob' in any name field
- var options = new <a href="Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, 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.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// find all contacts with 'Bob' in any name field
- var options = new <a href="Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
@@ -102,15 +102,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.7.0/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/contacts.md b/www/docs/en/1.7.0/cordova/contacts/contacts.md
index 554a82d..03eb3d8 100644
--- a/www/docs/en/1.7.0/cordova/contacts/contacts.md
+++ b/www/docs/en/1.7.0/cordova/contacts/contacts.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="Contact/contact.html">Contact</a>s
+Contacts
========
> The `contacts` object provides access to the device contacts database.
@@ -26,24 +26,24 @@ license: >
Methods
-------
-- <a href="contacts.create.html">contacts.create</a>
-- <a href="contacts.find.html">contacts.find</a>
+- contacts.create
+- contacts.find
Arguments
---------
-- <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>
+- contactFields
+- contactSuccess
+- contactError
+- contactFindOptions
Objects
-------
-- <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
\ No newline at end of file
+- Contact
+- ContactName
+- ContactField
+- ContactAddress
+- ContactOrganization
+- ContactFindOptions
+- ContactError
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/parameters/contactFields.md b/www/docs/en/1.7.0/cordova/contacts/parameters/contactFields.md
index 487c226..1951960 100644
--- a/www/docs/en/1.7.0/cordova/contacts/parameters/contactFields.md
+++ b/www/docs/en/1.7.0/cordova/contacts/parameters/contactFields.md
@@ -21,6 +21,6 @@ license: >
contactFields
=============
-Required parameter of the `<a href="../contacts.find.html">contacts.find</a>` method. Use this parameter to specify which fields should be included in the `<a href="../Contact/contact.html">Contact</a>` objects resulting from a find operation.
+Required parameter of the `contacts.find` method. Use this parameter to specify which fields should be included in the `Contact` objects resulting from a find operation.
["name", "phoneNumbers", "emails"]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/parameters/contactFindOptions.md b/www/docs/en/1.7.0/cordova/contacts/parameters/contactFindOptions.md
index 9d92f9c..f2f3e12 100644
--- a/www/docs/en/1.7.0/cordova/contacts/parameters/contactFindOptions.md
+++ b/www/docs/en/1.7.0/cordova/contacts/parameters/contactFindOptions.md
@@ -21,7 +21,7 @@ license: >
contactFindOptions
==================
-Optional parameter of the `<a href="../contacts.find.html">contacts.find</a>` method. Use this parameter to filter the contacts returned from the contacts database.
+Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database.
{
filter: "",
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/parameters/contactSuccess.md b/www/docs/en/1.7.0/cordova/contacts/parameters/contactSuccess.md
index 0394b6d..925105f 100644
--- a/www/docs/en/1.7.0/cordova/contacts/parameters/contactSuccess.md
+++ b/www/docs/en/1.7.0/cordova/contacts/parameters/contactSuccess.md
@@ -21,7 +21,7 @@ license: >
contactSuccess
==============
-Success callback function that provides the `<a href="../Contact/contact.html">Contact</a>` array resulting from a `<a href="../contacts.find.html">contacts.find</a>` operation.
+Success callback function that provides the `Contact` array resulting from a `contacts.find` operation.
function(contacts) {
// Do something
@@ -30,9 +30,9 @@ Success callback function that provides the `<a href="../Contact/contact.html">C
Parameters
----------
-- __contacts:__ The contact array resulting from a find operation. (`<a href="../Contact/contact.html">Contact</a>`)
+- __contacts:__ The contact array resulting from a find operation. (`Contact`)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function contactSuccess(contacts) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/device/device.cordova.md b/www/docs/en/1.7.0/cordova/device/device.cordova.md
index ebcabfd..bc694f0 100644
--- a/www/docs/en/1.7.0/cordova/device/device.cordova.md
+++ b/www/docs/en/1.7.0/cordova/device/device.cordova.md
@@ -39,36 +39,36 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
var name = device.cordova;
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="device.html">Device</a>Ready() {
+ function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = '<a href="device.html">Device</a> Name: ' + <a href="device.name.html">device.name</a> + '<br />' +
- '<a href="device.html">Device</a> Cordova: ' + device.cordova + '<br />' +
- '<a href="device.html">Device</a> Platform: ' + <a href="device.platform.html">device.platform</a> + '<br />' +
- '<a href="device.html">Device</a> UUID: ' + <a href="device.uuid.html">device.uuid</a> + '<br />' +
- '<a href="device.html">Device</a> Version: ' + <a href="device.version.html">device.version</a> + '<br />';
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/device/device.md b/www/docs/en/1.7.0/cordova/device/device.md
index 40cd569..6a5f11a 100644
--- a/www/docs/en/1.7.0/cordova/device/device.md
+++ b/www/docs/en/1.7.0/cordova/device/device.md
@@ -26,11 +26,11 @@ Device
Properties
----------
-- <a href="device.name.html">device.name</a>
-- <a href="device.cordova.html">device.cordova</a>
-- <a href="device.platform.html">device.platform</a>
-- <a href="device.uuid.html">device.uuid</a>
-- <a href="device.version.html">device.version</a>
+- device.name
+- device.cordova
+- device.platform
+- device.uuid
+- device.version
Variable Scope
--------------
@@ -39,5 +39,5 @@ Since `device` is assigned to the `window` object, it is implicitly in the globa
// These reference the same `device`
//
- var phoneName = window.<a href="device.name.html">device.name</a>;
- var phoneName = <a href="device.name.html">device.name</a>;
\ No newline at end of file
+ var phoneName = window.device.name;
+ var phoneName = device.name;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/device/device.name.md b/www/docs/en/1.7.0/cordova/device/device.name.md
index 6b62bf8..2d194f9 100644
--- a/www/docs/en/1.7.0/cordova/device/device.name.md
+++ b/www/docs/en/1.7.0/cordova/device/device.name.md
@@ -39,7 +39,7 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Android: Nexus One returns "Passion" (Nexus One code name)
@@ -49,31 +49,31 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
//
var name = device.name;
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="device.html">Device</a>Ready() {
+ function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = '<a href="device.html">Device</a> Name: ' + device.name + '<br />' +
- '<a href="device.html">Device</a> Cordova: ' + <a href="device.cordova.html">device.cordova</a> + '<br />' +
- '<a href="device.html">Device</a> Platform: ' + <a href="device.platform.html">device.platform</a> + '<br />' +
- '<a href="device.html">Device</a> UUID: ' + <a href="device.uuid.html">device.uuid</a> + '<br />' +
- '<a href="device.html">Device</a> Version: ' + <a href="device.version.html">device.version</a> + '<br />';
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
}
</script>
@@ -94,7 +94,7 @@ Android Quirks
iPhone Quirks
-------------
-- Gets the [device's custom name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UI<a href="device.html">Device</a>_Class/Reference/UI<a href="device.html">Device</a>.html#//apple_ref/doc/uid/TP40006902-CH3-SW13) instead of the [device model name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UI<a href="device.html">Device</a>_Class/Reference/UI<a href="device.html">Device</a>.html#//apple_ref/doc/uid/TP40006902-CH3-SW1).
+- Gets the [device's custom name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW13) instead of the [device model name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW1).
- The custom name is set by the owner in iTunes.
- e.g. "Joe's iPhone"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/device/device.platform.md b/www/docs/en/1.7.0/cordova/device/device.platform.md
index 9fb6b26..dc3f78a 100644
--- a/www/docs/en/1.7.0/cordova/device/device.platform.md
+++ b/www/docs/en/1.7.0/cordova/device/device.platform.md
@@ -34,7 +34,7 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Depending on the device, a few examples are:
@@ -45,31 +45,31 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// - "WinCE"
var devicePlatform = device.platform;
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="device.html">Device</a>Ready() {
+ function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = '<a href="device.html">Device</a> Name: ' + <a href="device.name.html">device.name</a> + '<br />' +
- '<a href="device.html">Device</a> Cordova: ' + <a href="device.cordova.html">device.cordova</a> + '<br />' +
- '<a href="device.html">Device</a> Platform: ' + device.platform + '<br />' +
- '<a href="device.html">Device</a> UUID: ' + <a href="device.uuid.html">device.uuid</a> + '<br />' +
- '<a href="device.html">Device</a> Version: ' + <a href="device.version.html">device.version</a> + '<br />';
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
}
</script>
@@ -87,7 +87,7 @@ The iPhone returns `iPhone` as the platform. The iPad returns `iPad` as the plat
BlackBerry Quirks
-----------------
-<a href="device.html">Device</a>s may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar.
+Devices may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar.
Windows Phone 7 Quirks
-----------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/device/device.uuid.md b/www/docs/en/1.7.0/cordova/device/device.uuid.md
index 7d8ca4d..0d7e1dd 100644
--- a/www/docs/en/1.7.0/cordova/device/device.uuid.md
+++ b/www/docs/en/1.7.0/cordova/device/device.uuid.md
@@ -39,7 +39,7 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Android: Returns a random 64-bit integer (as a string, again!)
@@ -48,7 +48,7 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// BlackBerry: Returns the PIN number of the device
// This is a nine-digit unique integer (as a string, though!)
//
- // iPhone: (Paraphrased from the UI<a href="device.html">Device</a> Class documentation)
+ // iPhone: (Paraphrased from the UIDevice Class documentation)
// Returns a string of hash values created from multiple hardware identifies.
// It is guaranteed to be unique for every device and cannot be tied
// to the user account.
@@ -57,31 +57,31 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
//
var deviceID = device.uuid;
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="device.html">Device</a>Ready() {
+ function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = '<a href="device.html">Device</a> Name: ' + <a href="device.name.html">device.name</a> + '<br />' +
- '<a href="device.html">Device</a> Cordova: ' + <a href="device.cordova.html">device.cordova</a> + '<br />' +
- '<a href="device.html">Device</a> Platform: ' + <a href="device.platform.html">device.platform</a> + '<br />' +
- '<a href="device.html">Device</a> UUID: ' + device.uuid + '<br />' +
- '<a href="device.html">Device</a> Version: ' + <a href="device.version.html">device.version</a> + '<br />';
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.7.0/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/device/device.version.md b/www/docs/en/1.7.0/cordova/device/device.version.md
index d2a8850..388e7c9 100644
--- a/www/docs/en/1.7.0/cordova/device/device.version.md
+++ b/www/docs/en/1.7.0/cordova/device/device.version.md
@@ -34,7 +34,7 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// Android: Froyo OS would return "2.2"
@@ -48,31 +48,31 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
// Windows Phone 7: returns current OS version number, ex. on Mango returns 7.10.7720
var deviceVersion = device.version;
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Device Properties Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="device.html">Device</a>Ready() {
+ function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = '<a href="device.html">Device</a> Name: ' + <a href="device.name.html">device.name</a> + '<br />' +
- '<a href="device.html">Device</a> Cordova: ' + <a href="device.cordova.html">device.cordova</a> + '<br />' +
- '<a href="device.html">Device</a> Platform: ' + <a href="device.platform.html">device.platform</a> + '<br />' +
- '<a href="device.html">Device</a> UUID: ' + <a href="device.uuid.html">device.uuid</a> + '<br />' +
- '<a href="device.html">Device</a> Version: ' + device.version + '<br />';
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
}
</script>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org