You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/10 23:28:12 UTC
[12/51] [partial] docs commit: Solidifying 'automatic' links.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/ContactField/contactfield.md b/www/docs/en/1.8.0/cordova/contacts/ContactField/contactfield.md
index 7482187..4ec2dbc 100644
--- a/www/docs/en/1.8.0/cordova/contacts/ContactField/contactfield.md
+++ b/www/docs/en/1.8.0/cordova/contacts/ContactField/contactfield.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-ContactField
+<a href="../Contact/contact.html">Contact</a>Field
============
-Supports generic fields in a `Contact` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls.
+Supports generic fields in a `<a href="../Contact/contact.html">Contact</a>` object. Some properties that are stored as `<a href="../Contact/contact.html">Contact</a>Field` objects include email addresses, phone numbers, and urls.
Properties
----------
- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)_
- __value:__ The value of the field (such as a phone number or email address). _(DOMString)_
-- __pref:__ Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Field` contains the user's preferred value. _(boolean)_
Details
-------
-The `ContactField` object is a reusable component that is used to support contact fields in a generic fashion. Each `ContactField` object contains a value property, a type property, and a pref property. A `Contact` object stores several properties in `ContactField[]` arrays, such as phone numbers and email addresses.
+The `<a href="../Contact/contact.html">Contact</a>Field` object is a reusable component that is used to support contact fields in a generic fashion. Each `<a href="../Contact/contact.html">Contact</a>Field` object contains a value property, a type property, and a pref property. A `<a href="../Contact/contact.html">Contact</a>` object stores several properties in `<a href="../Contact/contact.html">Contact</a>Field[]` arrays, such as phone numbers and email addresses.
-In most instances, there are no pre-determined values for the __type__ attribute of a `ContactField` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `Contact` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string.
+In most instances, there are no pre-determined values for the __type__ attribute of a `<a href="../Contact/contact.html">Contact</a>Field` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `<a href="../Contact/contact.html">Contact</a>` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string.
Supported Platforms
-------------------
@@ -45,58 +45,58 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// create a new contact
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
- // store contact phone numbers in ContactField[]
+ // store contact phone numbers in <a href="../Contact/contact.html">Contact</a>Field[]
var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ phoneNumbers[0] = new <a href="../Contact/contact.html">Contact</a>Field('work', '212-555-1234', false);
+ phoneNumbers[1] = new <a href="../Contact/contact.html">Contact</a>Field('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new <a href="../Contact/contact.html">Contact</a>Field('home', '203-555-7890', false);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// create a new contact
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
- // store contact phone numbers in ContactField[]
+ // store contact phone numbers in <a href="../Contact/contact.html">Contact</a>Field[]
var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ phoneNumbers[0] = new <a href="../Contact/contact.html">Contact</a>Field('work', '212-555-1234', false);
+ phoneNumbers[1] = new <a href="../Contact/contact.html">Contact</a>Field('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new <a href="../Contact/contact.html">Contact</a>Field('home', '203-555-7890', false);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
// search contacts, returning display name and phone numbers
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","phoneNumbers"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -114,15 +114,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/ContactFindOptions/contactfindoptions.md b/www/docs/en/1.8.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 513fd9a..ac3f031 100644
--- a/www/docs/en/1.8.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/www/docs/en/1.8.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-ContactFindOptions
+<a href="../Contact/contact.html">Contact</a>FindOptions
==================
-Contains properties that can be used to filter the results of a `contacts.find` operation.
+Contains properties that can be used to filter the results of a `<a href="../contacts.find.html">contacts.find</a>` operation.
Properties
----------
@@ -38,7 +38,7 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// success callback
@@ -49,45 +49,45 @@ Quick Example
};
// error callback
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
// specify contact search criteria
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter=""; // empty search string returns all contacts
options.multiple=true; // return multiple results
filter = ["displayName"]; // return contact.displayName field
// find contacts
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// specify contact search criteria
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter=""; // empty search string returns all contacts
options.multiple=true; // return multiple results
filter = ["displayName"]; // return contact.displayName field
// find contacts
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -100,15 +100,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/ContactName/contactname.md b/www/docs/en/1.8.0/cordova/contacts/ContactName/contactname.md
index c3d8d9c..05fa668 100644
--- a/www/docs/en/1.8.0/cordova/contacts/ContactName/contactname.md
+++ b/www/docs/en/1.8.0/cordova/contacts/ContactName/contactname.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-ContactName
+<a href="../Contact/contact.html">Contact</a>Name
===========
-Contains name properties of a `Contact` object.
+Contains name properties of a `<a href="../Contact/contact.html">Contact</a>` object.
Properties
----------
@@ -36,7 +36,7 @@ Properties
Details
-------
-The `ContactName` object stores name properties of a contact.
+The `<a href="../Contact/contact.html">Contact</a>Name` object stores name properties of a contact.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(contacts) {
@@ -60,37 +60,37 @@ Quick Example
}
};
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","name"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- var options = new ContactFindOptions();
+ function on<a href="../../device/device.html">Device</a>Ready() {
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","name"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -108,15 +108,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/ContactOrganization/contactorganization.md b/www/docs/en/1.8.0/cordova/contacts/ContactOrganization/contactorganization.md
index 24c6757..8098132 100644
--- a/www/docs/en/1.8.0/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/www/docs/en/1.8.0/cordova/contacts/ContactOrganization/contactorganization.md
@@ -18,14 +18,14 @@ license: >
under the License.
---
-ContactOrganization
+<a href="../Contact/contact.html">Contact</a>Organization
===================
-Contains organization properties of a `Contact` object.
+Contains organization properties of a `<a href="../Contact/contact.html">Contact</a>` object.
Properties
----------
-- __pref:__ Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Organization` contains the user's preferred value. _(boolean)_
- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
- __name:__ The name of the organization. _(DOMString)_
- __department:__ The department the contract works for. _(DOMString)_
@@ -34,7 +34,7 @@ Properties
Details
-------
-The `ContactOrganization` object stores a contact's organization properties. A `Contact` object stores one or more `ContactOrganization` objects in an array.
+The `<a href="../Contact/contact.html">Contact</a>Organization` object stores a contact's organization properties. A `<a href="../Contact/contact.html">Contact</a>` object stores one or more `<a href="../Contact/contact.html">Contact</a>Organization` objects in an array.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(contacts) {
@@ -59,37 +59,37 @@ Quick Example
}
};
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","organizations"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- var options = new ContactFindOptions();
+ function on<a href="../../device/device.html">Device</a>Ready() {
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","organizations"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -108,15 +108,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
@@ -151,4 +151,4 @@ iOS Quirks
Bada 2.0 Quirks
---------------
-- ContactOrganization not supported
+- <a href="../Contact/contact.html">Contact</a>Organization not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/contacts.create.md b/www/docs/en/1.8.0/cordova/contacts/contacts.create.md
index f20ec27..cabe735 100644
--- a/www/docs/en/1.8.0/cordova/contacts/contacts.create.md
+++ b/www/docs/en/1.8.0/cordova/contacts/contacts.create.md
@@ -21,16 +21,16 @@ license: >
contacts.create
===============
-Returns a new Contact object.
+Returns a new <a href="Contact/contact.html">Contact</a> object.
var contact = navigator.contacts.create(properties);
Description
-----------
-contacts.create is a synchronous function that returns a new `Contact` object.
+contacts.create is a synchronous function that returns a new `<a href="Contact/contact.html">Contact</a>` object.
-This method does not persist the Contact object to the device contacts database. To persist the Contact object to the device, invoke the `Contact.save` method.
+This method does not persist the <a href="Contact/contact.html">Contact</a> object to the device contacts database. To persist the <a href="Contact/contact.html">Contact</a> object to the device, invoke the `<a href="Contact/contact.html">Contact</a>.save` method.
Supported Platforms
-------------------
@@ -40,39 +40,39 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- var myContact = navigator.contacts.create({"displayName": "Test User"});
+ var my<a href="Contact/contact.html">Contact</a> = navigator.contacts.create({"displayName": "Test User"});
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="Contact/contact.html">Contact</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- var myContact = navigator.contacts.create({"displayName": "Test User"});
- myContact.note = "This contact has a note.";
- console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
+ function on<a href="../device/device.html">Device</a>Ready() {
+ var my<a href="Contact/contact.html">Contact</a> = navigator.contacts.create({"displayName": "Test User"});
+ my<a href="Contact/contact.html">Contact</a>.note = "This contact has a note.";
+ console.log("The contact, " + my<a href="Contact/contact.html">Contact</a>.displayName + ", note: " + my<a href="Contact/contact.html">Contact</a>.note);
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Create Contact</p>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Create <a href="Contact/contact.html">Contact</a></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/contacts.find.md b/www/docs/en/1.8.0/cordova/contacts/contacts.find.md
index 974bb37..b1a9fe2 100644
--- a/www/docs/en/1.8.0/cordova/contacts/contacts.find.md
+++ b/www/docs/en/1.8.0/cordova/contacts/contacts.find.md
@@ -21,26 +21,26 @@ license: >
contacts.find
=============
-Queries the device contacts database and returns one or more `Contact` objects, each containing the fields specified.
+Queries the device contacts database and returns one or more `<a href="Contact/contact.html">Contact</a>` objects, each containing the fields specified.
- navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
+ navigator.contacts.find(<a href="parameters/contactFields.html">contactFields</a>, <a href="parameters/contactSuccess.html">contactSuccess</a>, <a href="parameters/contactError.html">contactError</a>, <a href="parameters/contactFindOptions.html">contactFindOptions</a>);
Description
-----------
-contacts.find is an asynchronous function that queries the device contacts database and returns an array of `Contact` objects. The resulting objects are passed to the `contactSuccess` callback function specified by the __contactSuccess__ parameter.
+contacts.find is an asynchronous function that queries the device contacts database and returns an array of `<a href="Contact/contact.html">Contact</a>` objects. The resulting objects are passed to the `<a href="parameters/contactSuccess.html">contactSuccess</a>` callback function specified by the __<a href="parameters/contactSuccess.html">contactSuccess</a>__ parameter.
-Users must specify the contact fields to be used as a search qualifier in the __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `Contact` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter will result in an array of `Contact` objects with only the `id` property populated. A __contactFields__ value of ["*"] will return all contact fields.
+Users must specify the contact fields to be used as a search qualifier in the __<a href="parameters/contactFields.html">contactFields</a>__ parameter. Only the fields specified in the __<a href="parameters/contactFields.html">contactFields</a>__ parameter will be returned as properties of the `<a href="Contact/contact.html">Contact</a>` objects that are passed to the __<a href="parameters/contactSuccess.html">contactSuccess</a>__ callback function. A zero-length __<a href="parameters/contactFields.html">contactFields</a>__ parameter will result in an array of `<a href="Contact/contact.html">Contact</a>` objects with only the `id` property populated. A __<a href="parameters/contactFields.html">contactFields</a>__ value of ["*"] will return all contact fields.
-The __contactFindOptions.filter__ string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the __contactFields__ parameter. If a match is found in a comparison with _any_ of the specified fields, the contact is returned.
+The __<a href="parameters/contactFindOptions.html">contactFindOptions</a>.filter__ string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the __<a href="parameters/contactFields.html">contactFields</a>__ parameter. If a match is found in a comparison with _any_ of the specified fields, the contact is returned.
Parameters
----------
-- __contactFields:__ Contact fields to be used as search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required]
-- __contactSuccess:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required]
-- __contactError:__ Error callback function. Invoked when error occurs. [Optional]
-- __contactFindOptions:__ Search options to filter contacts. [Optional]
+- __<a href="parameters/contactFields.html">contactFields</a>:__ <a href="Contact/contact.html">Contact</a> fields to be used as search qualifier. Only these fields will have values in the resulting `<a href="Contact/contact.html">Contact</a>` objects. _(DOMString[])_ [Required]
+- __<a href="parameters/contactSuccess.html">contactSuccess</a>:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required]
+- __<a href="parameters/contactError.html">contactError</a>:__ Error callback function. Invoked when error occurs. [Optional]
+- __<a href="parameters/contactFindOptions.html">contactFindOptions</a>:__ Search options to filter contacts. [Optional]
Supported Platforms
-------------------
@@ -50,43 +50,43 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(contacts) {
alert('Found ' + contacts.length + ' contacts.');
};
- function onError(contactError) {
+ function onError(<a href="parameters/contactError.html">contactError</a>) {
alert('onError!');
};
// find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
+ var options = new <a href="Contact/contact.html">Contact</a>FindOptions();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="Contact/contact.html">Contact</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
+ var options = new <a href="Contact/contact.html">Contact</a>FindOptions();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
@@ -102,15 +102,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/contacts.md b/www/docs/en/1.8.0/cordova/contacts/contacts.md
index 34346f0..ff5c180 100644
--- a/www/docs/en/1.8.0/cordova/contacts/contacts.md
+++ b/www/docs/en/1.8.0/cordova/contacts/contacts.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-Contacts
+<a href="Contact/contact.html">Contact</a>s
========
> The `contacts` object provides access to the device contacts database.
@@ -26,27 +26,27 @@ Contacts
Methods
-------
-- contacts.create
-- contacts.find
+- <a href="contacts.create.html">contacts.create</a>
+- <a href="contacts.find.html">contacts.find</a>
Arguments
---------
-- contactFields
-- contactSuccess
-- contactError
-- contactFindOptions
+- <a href="parameters/contactFields.html">contactFields</a>
+- <a href="parameters/contactSuccess.html">contactSuccess</a>
+- <a href="parameters/contactError.html">contactError</a>
+- <a href="parameters/contactFindOptions.html">contactFindOptions</a>
Objects
-------
-- Contact
-- ContactName
-- ContactField
-- ContactAddress
-- ContactOrganization
-- ContactFindOptions
-- ContactError
+- <a href="Contact/contact.html">Contact</a>
+- <a href="Contact/contact.html">Contact</a>Name
+- <a href="Contact/contact.html">Contact</a>Field
+- <a href="Contact/contact.html">Contact</a>Address
+- <a href="Contact/contact.html">Contact</a>Organization
+- <a href="Contact/contact.html">Contact</a>FindOptions
+- <a href="Contact/contact.html">Contact</a>Error
Permissions
-----------
@@ -55,7 +55,7 @@ Permissions
#### app/res/xml/plugins.xml
- <plugin name="Contacts" value="org.apache.cordova.ContactManager" />
+ <plugin name="<a href="Contact/contact.html">Contact</a>s" value="org.apache.cordova.<a href="Contact/contact.html">Contact</a>Manager" />
#### app/AndroidManifest.xml
@@ -75,23 +75,23 @@ Permissions
#### www/plugins.xml
- <plugin name="Contact" value="org.apache.cordova.pim.Contact" />
+ <plugin name="<a href="Contact/contact.html">Contact</a>" value="org.apache.cordova.pim.<a href="Contact/contact.html">Contact</a>" />
#### www/config.xml
<feature id="blackberry.find" required="true" version="1.0.0.0" />
<feature id="blackberry.identity" required="true" version="1.0.0.0" />
<feature id="blackberry.pim.Address" required="true" version="1.0.0.0" />
- <feature id="blackberry.pim.Contact" required="true" version="1.0.0.0" />
+ <feature id="blackberry.pim.<a href="Contact/contact.html">Contact</a>" required="true" version="1.0.0.0" />
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
- <key>Contacts</key>
- <string>CDVContacts</string>
+ <key><a href="Contact/contact.html">Contact</a>s</key>
+ <string>CDV<a href="Contact/contact.html">Contact</a>s</string>
</dict>
### webOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/parameters/contactFields.md b/www/docs/en/1.8.0/cordova/contacts/parameters/contactFields.md
index 1951960..487c226 100644
--- a/www/docs/en/1.8.0/cordova/contacts/parameters/contactFields.md
+++ b/www/docs/en/1.8.0/cordova/contacts/parameters/contactFields.md
@@ -21,6 +21,6 @@ license: >
contactFields
=============
-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.
+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.
["name", "phoneNumbers", "emails"]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/parameters/contactFindOptions.md b/www/docs/en/1.8.0/cordova/contacts/parameters/contactFindOptions.md
index f2f3e12..9d92f9c 100644
--- a/www/docs/en/1.8.0/cordova/contacts/parameters/contactFindOptions.md
+++ b/www/docs/en/1.8.0/cordova/contacts/parameters/contactFindOptions.md
@@ -21,7 +21,7 @@ license: >
contactFindOptions
==================
-Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database.
+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.
{
filter: "",
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/contacts/parameters/contactSuccess.md b/www/docs/en/1.8.0/cordova/contacts/parameters/contactSuccess.md
index 925105f..0394b6d 100644
--- a/www/docs/en/1.8.0/cordova/contacts/parameters/contactSuccess.md
+++ b/www/docs/en/1.8.0/cordova/contacts/parameters/contactSuccess.md
@@ -21,7 +21,7 @@ license: >
contactSuccess
==============
-Success callback function that provides the `Contact` array resulting from a `contacts.find` operation.
+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.
function(contacts) {
// Do something
@@ -30,9 +30,9 @@ Success callback function that provides the `Contact` array resulting from a `co
Parameters
----------
-- __contacts:__ The contact array resulting from a find operation. (`Contact`)
+- __contacts:__ The contact array resulting from a find operation. (`<a href="../Contact/contact.html">Contact</a>`)
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
function contactSuccess(contacts) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/device/device.cordova.md b/www/docs/en/1.8.0/cordova/device/device.cordova.md
index 42fdf75..6015bff 100644
--- a/www/docs/en/1.8.0/cordova/device/device.cordova.md
+++ b/www/docs/en/1.8.0/cordova/device/device.cordova.md
@@ -39,36 +39,36 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
var name = device.cordova;
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="device.html">Device</a>Ready() {
var element = document.getElementById('deviceProperties');
- 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 />';
+ 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 />';
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/device/device.md b/www/docs/en/1.8.0/cordova/device/device.md
index 48fdceb..5a85b38 100644
--- a/www/docs/en/1.8.0/cordova/device/device.md
+++ b/www/docs/en/1.8.0/cordova/device/device.md
@@ -26,11 +26,11 @@ Device
Properties
----------
-- device.name
-- device.cordova
-- device.platform
-- device.uuid
-- device.version
+- <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>
Variable Scope
--------------
@@ -38,8 +38,8 @@ Variable Scope
Since `device` is assigned to the `window` object, it is implicitly in the global scope.
// These reference the same `device`
- var phoneName = window.device.name;
- var phoneName = device.name;
+ var phoneName = window.<a href="device.name.html">device.name</a>;
+ var phoneName = <a href="device.name.html">device.name</a>;
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/device/device.name.md b/www/docs/en/1.8.0/cordova/device/device.name.md
index 7192dbe..2618bfc 100644
--- a/www/docs/en/1.8.0/cordova/device/device.name.md
+++ b/www/docs/en/1.8.0/cordova/device/device.name.md
@@ -40,7 +40,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// Android: Nexus One returns "Passion" (Nexus One code name)
@@ -50,31 +50,31 @@ Quick Example
//
var name = device.name;
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="device.html">Device</a>Ready() {
var element = document.getElementById('deviceProperties');
- 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 />';
+ 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 />';
}
</script>
@@ -95,7 +95,7 @@ Android Quirks
iPhone Quirks
-------------
-- 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).
+- 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).
- 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/89392fa8/www/docs/en/1.8.0/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/device/device.platform.md b/www/docs/en/1.8.0/cordova/device/device.platform.md
index 9e16a82..792c4fc 100644
--- a/www/docs/en/1.8.0/cordova/device/device.platform.md
+++ b/www/docs/en/1.8.0/cordova/device/device.platform.md
@@ -35,7 +35,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// Depending on the device, a few examples are:
@@ -46,31 +46,31 @@ Quick Example
// - "WinCE"
var devicePlatform = device.platform;
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="device.html">Device</a>Ready() {
var element = document.getElementById('deviceProperties');
- 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 />';
+ 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 />';
}
</script>
@@ -88,7 +88,7 @@ The iPhone returns `iPhone` as the platform. The iPad returns `iPad` as the plat
BlackBerry Quirks
-----------------
-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.
+<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.
Windows Phone 7 Quirks
-----------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/device/device.uuid.md b/www/docs/en/1.8.0/cordova/device/device.uuid.md
index c0ea0e6..54cb4da 100644
--- a/www/docs/en/1.8.0/cordova/device/device.uuid.md
+++ b/www/docs/en/1.8.0/cordova/device/device.uuid.md
@@ -40,7 +40,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// Android: Returns a random 64-bit integer (as a string, again!)
@@ -49,7 +49,7 @@ Quick Example
// BlackBerry: Returns the PIN number of the device
// This is a nine-digit unique integer (as a string, though!)
//
- // iPhone: (Paraphrased from the UIDevice Class documentation)
+ // iPhone: (Paraphrased from the UI<a href="device.html">Device</a> 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.
@@ -59,31 +59,31 @@ Quick Example
// webOS: returns the device NDUID
var deviceID = device.uuid;
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="device.html">Device</a>Ready() {
var element = document.getElementById('deviceProperties');
- 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 />';
+ 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 />';
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/device/device.version.md b/www/docs/en/1.8.0/cordova/device/device.version.md
index 8275d91..5c8bd65 100644
--- a/www/docs/en/1.8.0/cordova/device/device.version.md
+++ b/www/docs/en/1.8.0/cordova/device/device.version.md
@@ -35,7 +35,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
// Android: Froyo OS would return "2.2"
@@ -50,31 +50,31 @@ Quick Example
// webOS: webOS 2.2.4 return 2.2.4
var deviceVersion = device.version;
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Device Properties Example</title>
+ <title><a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="device.html">Device</a>Ready() {
var element = document.getElementById('deviceProperties');
- 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 />';
+ 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 />';
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.backbutton.md b/www/docs/en/1.8.0/cordova/events/events.backbutton.md
index 7ef01c6..7307e9a 100644
--- a/www/docs/en/1.8.0/cordova/events/events.backbutton.md
+++ b/www/docs/en/1.8.0/cordova/events/events.backbutton.md
@@ -30,7 +30,7 @@ Details
If you need to override the default back button behaviour you can register an event listener for the 'backbutton' event. It is no longer necessary to call any other method to over ride the back button behaviour. Now, you only need to register an event listener for 'backbutton'.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -39,7 +39,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- Windows Phone 7 ( Mango )
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("backbutton", onBackKeyDown, false);
@@ -48,30 +48,30 @@ Quick Example
// Handle the back button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Back Button Example</title>
+ <title>Cordova Back Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to call Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("backbutton", onBackKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.batterycritical.md b/www/docs/en/1.8.0/cordova/events/events.batterycritical.md
index 32cf653..0ea407a 100644
--- a/www/docs/en/1.8.0/cordova/events/events.batterycritical.md
+++ b/www/docs/en/1.8.0/cordova/events/events.batterycritical.md
@@ -35,7 +35,7 @@ The batterycritical handler will be called with an object that contains two prop
- __level:__ The percentage of battery (0-100). _(Number)_
- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
window.addEventListener("batterycritical", onBatteryCritical, false);
@@ -54,30 +54,30 @@ Quick Example
alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Cordova <a href="../device/device.html">Device</a> Ready <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
window.addEventListener("batterycritical", onBatteryCritical, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.batterylow.md b/www/docs/en/1.8.0/cordova/events/events.batterylow.md
index df51d1e..45ce500 100644
--- a/www/docs/en/1.8.0/cordova/events/events.batterylow.md
+++ b/www/docs/en/1.8.0/cordova/events/events.batterylow.md
@@ -35,7 +35,7 @@ The batterylow handler will be called with an object that contains two propertie
- __level:__ The percentage of battery (0-100). _(Number)_
- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
window.addEventListener("batterylow", onBatteryLow, false);
@@ -54,30 +54,30 @@ Quick Example
alert("Battery Level Low " + info.level + "%");
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Cordova <a href="../device/device.html">Device</a> Ready <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
window.addEventListener("batterylow", onBatteryLow, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.batterystatus.md b/www/docs/en/1.8.0/cordova/events/events.batterystatus.md
index c4adcaa..ba71239 100644
--- a/www/docs/en/1.8.0/cordova/events/events.batterystatus.md
+++ b/www/docs/en/1.8.0/cordova/events/events.batterystatus.md
@@ -35,7 +35,7 @@ The battery status handler will be called with an object that contains two prope
- __level:__ The percentage of battery (0-100). _(Number)_
- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -53,40 +53,40 @@ The `level` property is unavailable as Windows Phone 7 does not provide
native APIs for determining battery level. The `isPlugged` parameter
_is_ supported.
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
window.addEventListener("batterystatus", onBatteryStatus, false);
function onBatteryStatus(info) {
- // Handle the online event
+ // Handle the <a href="events.online.html">online</a> event
console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Cordova <a href="../device/device.html">Device</a> Ready <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
window.addEventListener("batterystatus", onBatteryStatus, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.deviceready.md b/www/docs/en/1.8.0/cordova/events/events.deviceready.md
index 3c18e3d..ac473f7 100644
--- a/www/docs/en/1.8.0/cordova/events/events.deviceready.md
+++ b/www/docs/en/1.8.0/cordova/events/events.deviceready.md
@@ -45,39 +45,39 @@ Supported Platforms
- Windows Phone 7
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("deviceready", on<a href="../device/device.html">Device</a>Ready, false);
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Now safe to use the Cordova API
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Cordova <a href="../device/device.html">Device</a> Ready <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
// it will call the event `deviceready`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("deviceready", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Now safe to use the Cordova API
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.endcallbutton.md b/www/docs/en/1.8.0/cordova/events/events.endcallbutton.md
index b5a7e9b..a23b394 100644
--- a/www/docs/en/1.8.0/cordova/events/events.endcallbutton.md
+++ b/www/docs/en/1.8.0/cordova/events/events.endcallbutton.md
@@ -30,14 +30,14 @@ Details
If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("endcallbutton", onEndCallKeyDown, false);
@@ -46,31 +46,31 @@ Quick Example
// Handle the end call button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova End Call Button Example</title>
+ <title>Cordova End Call Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("endcallbutton", onEndCallKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.md b/www/docs/en/1.8.0/cordova/events/events.md
index 067c14c..23d0478 100644
--- a/www/docs/en/1.8.0/cordova/events/events.md
+++ b/www/docs/en/1.8.0/cordova/events/events.md
@@ -26,21 +26,21 @@ Events
Event Types
-----------
-- deviceready
-- pause
-- resume
-- online
-- offline
-- backbutton
-- batterycritical
-- batterylow
-- batterystatus
-- menubutton
-- searchbutton
-- startcallbutton
-- endcallbutton
-- volumedownbutton
-- volumeupbutton
+- <a href="events.deviceready.html">deviceready</a>
+- <a href="events.pause.html">pause</a>
+- <a href="events.resume.html">resume</a>
+- <a href="events.online.html">online</a>
+- <a href="events.offline.html">offline</a>
+- <a href="events.backbutton.html">backbutton</a>
+- <a href="events.batterycritical.html">batterycritical</a>
+- <a href="events.batterylow.html">batterylow</a>
+- <a href="events.batterystatus.html">batterystatus</a>
+- <a href="events.menubutton.html">menubutton</a>
+- <a href="events.searchbutton.html">searchbutton</a>
+- <a href="events.startcallbutton.html">startcallbutton</a>
+- <a href="events.endcallbutton.html">endcallbutton</a>
+- <a href="events.volumedownbutton.html">volumedownbutton</a>
+- <a href="events.volumeupbutton.html">volumeupbutton</a>
Permissions
-----------
@@ -77,7 +77,7 @@ Permissions
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.menubutton.md b/www/docs/en/1.8.0/cordova/events/events.menubutton.md
index 3c441f9..da5d2d7 100644
--- a/www/docs/en/1.8.0/cordova/events/events.menubutton.md
+++ b/www/docs/en/1.8.0/cordova/events/events.menubutton.md
@@ -30,7 +30,7 @@ Details
If you need to override the default menu button behaviour you can register an event listener for the 'menubutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -38,7 +38,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("menubutton", onMenuKeyDown, false);
@@ -47,31 +47,31 @@ Quick Example
// Handle the back button
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Menu Button Example</title>
+ <title>Cordova Menu Button <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
// Register the event listener
document.addEventListener("menubutton", onMenuKeyDown, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.offline.md b/www/docs/en/1.8.0/cordova/events/events.offline.md
index 1be048b..b91a17f 100644
--- a/www/docs/en/1.8.0/cordova/events/events.offline.md
+++ b/www/docs/en/1.8.0/cordova/events/events.offline.md
@@ -30,7 +30,7 @@ Details
When the application's network connection changes to being offline, the offline event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("offline", onOffline, false);
@@ -49,30 +49,30 @@ Quick Example
// Handle the offline event
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Offline Example</title>
+ <title>Cordova Offline <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
document.addEventListener("offline", onOffline, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.online.md b/www/docs/en/1.8.0/cordova/events/events.online.md
index 23ccf47..c43c72e 100644
--- a/www/docs/en/1.8.0/cordova/events/events.online.md
+++ b/www/docs/en/1.8.0/cordova/events/events.online.md
@@ -30,7 +30,7 @@ Details
When the application's network connection changes to being online, the online event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("online", onOnline, false);
@@ -49,30 +49,30 @@ Quick Example
// Handle the online event
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Online Example</title>
+ <title>Cordova Online <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
document.addEventListener("online", onOnline, false);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.pause.md b/www/docs/en/1.8.0/cordova/events/events.pause.md
index 6be4508..9676a8c 100644
--- a/www/docs/en/1.8.0/cordova/events/events.pause.md
+++ b/www/docs/en/1.8.0/cordova/events/events.pause.md
@@ -30,7 +30,7 @@ Details
Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("pause", onPause, false);
@@ -49,30 +49,30 @@ Quick Example
// Handle the pause event
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Pause Example</title>
+ <title>Cordova Pause <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
document.addEventListener("pause", onPause, false);
}
@@ -89,7 +89,7 @@ Full Example
iOS Quirks
--------------------------
-In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app resumes (processed on the next run-loop).
+In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app <a href="events.resume.html">resume</a>s (processed on the next run-loop).
- __resign__ event
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.resume.md b/www/docs/en/1.8.0/cordova/events/events.resume.md
index 9af6bc6..7787f48 100644
--- a/www/docs/en/1.8.0/cordova/events/events.resume.md
+++ b/www/docs/en/1.8.0/cordova/events/events.resume.md
@@ -30,7 +30,7 @@ Details
Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '<a href="events.deviceready.html">deviceready</a>' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
document.addEventListener("resume", onResume, false);
@@ -49,30 +49,30 @@ Quick Example
// Handle the resume event
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Resume Example</title>
+ <title>Cordova Resume <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Call on<a href="../device/device.html">Device</a>Ready when Cordova is loaded.
//
// At this point, the document has loaded but cordova-1.8.0.js has not.
// When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // it will call the event `<a href="events.deviceready.html">deviceready</a>`.
//
function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
}
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
document.addEventListener("resume", onResume, false);
}
@@ -89,7 +89,7 @@ Full Example
iOS Quirks
--------------------------
-Any calls to console.log during your **pause** event handler will be run now when the app resumes, see the iOS Quirks section for the **pause** event for an explanation.
+Any calls to console.log during your **<a href="events.pause.html">pause</a>** event handler will be run now when the app resumes, see the iOS Quirks section for the **<a href="events.pause.html">pause</a>** event for an explanation.
Interactive functions like `alert` when the **resume** event fires will need to be wrapped in a `setTimeout` call with a timeout value of zero, or else the app will hang. e.g.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org