You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/06/11 02:11:17 UTC
[6/8] Update documentation with standard STYLESHEET guide.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/Contact/contact.md b/docs/en/edge/cordova/contacts/Contact/contact.md
index 34d96db..3f05775 100644
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ b/docs/en/edge/cordova/contacts/Contact/contact.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -28,7 +28,7 @@ Properties
- __id:__ A globally unique identifier. _(DOMString)_
- __displayName:__ The name of this Contact, suitable for display to end-users. _(DOMString)_
- __name:__ An object containing all components of a persons name. _(ContactName)_
-- __nickname:__ A casual name to address the contact by. _(DOMString)_
+- __nickname:__ A casual name by which to address the contact. _(DOMString)_
- __phoneNumbers:__ An array of all the contact's phone numbers. _(ContactField[])_
- __emails:__ An array of all the contact's email addresses. _(ContactField[])_
- __addresses:__ An array of all the contact's addresses. _(ContactAddress[])_
@@ -37,23 +37,27 @@ Properties
- __birthday:__ The birthday of the contact. _(Date)_
- __note:__ A note about the contact. _(DOMString)_
- __photos:__ An array of the contact's photos. _(ContactField[])_
-- __categories:__ An array of all the contacts user defined categories. _(ContactField[])_
-- __urls:__ An array of web pages associated to the contact. _(ContactField[])_
+- __categories:__ An array of all the contact's user-defined categories. _(ContactField[])_
+- __urls:__ An array of web pages associated with 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 `ContactError` object if the removal is unsuccessful.
+- __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, otherwise executes an error callback with a `ContactError` object.
- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
-
Details
-------
-The `Contact` object represents a user contact. Contacts can be created, saved to, or removed from the device contacts database. Contacts can also be retrieved (individually or in bulk) from the database by invoking the `contacts.find` method.
+The `Contact` object represents a user contact. Contacts can be
+created, stored, 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._
+__NOTE:__ Not all of the contact fields listed above are supported on
+every device platform. Please check each platform's _Quirks_ section
+for details.
Supported Platforms
-------------------
@@ -97,7 +101,7 @@ Clone Quick Example
var clone = contact.clone();
clone.name.givenName = "John";
console.log("Original contact name = " + contact.name.givenName);
- console.log("Cloned contact name = " + clone.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
Remove Quick Example
--------------------
@@ -147,7 +151,7 @@ Full Example
var clone = contact.clone();
clone.name.givenName = "John";
console.log("Original contact name = " + contact.name.givenName);
- console.log("Cloned contact name = " + clone.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
// remove
contact.remove(onRemoveSuccess,onRemoveError);
@@ -188,51 +192,50 @@ Full Example
Android 2.X Quirks
------------------
-- __categories:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-
+- __categories:__ Not supported on Android 2.X devices, returning `null`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
-- __id:__ Supported. Assigned by device when contact is saved.
+- __id:__ Supported. Assigned by the device when saving the contact.
- __displayName:__ Supported. Stored in BlackBerry __user1__ field.
-- __nickname:__ This property is not supported, and will always be returned as `null`.
-- __phoneNumbers:__ Partially supported. Phone numbers will be stored in BlackBerry fields __homePhone1__ and __homePhone2__ if _type_ is 'home', __workPhone1__ and __workPhone2__ if _type_ is 'work', __mobilePhone__ if _type_ is 'mobile', __faxPhone__ if _type_ is 'fax', __pagerPhone__ if _type_ is 'pager', and __otherPhone__ if _type_ is none of the above.
-- __emails:__ Partially supported. The first three email addresses will be stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
-- __addresses:__ Partially supported. The first and second addresses will be stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
-- __ims:__ This property is not supported, and will always be returned as `null`.
+- __nickname:__ Not supported, returning `null`.
+- __phoneNumbers:__ Partially supported. Phone numbers are stored in BlackBerry fields __homePhone1__ and __homePhone2__ if _type_ is 'home', __workPhone1__ and __workPhone2__ if _type_ is 'work', __mobilePhone__ if _type_ is 'mobile', __faxPhone__ if _type_ is 'fax', __pagerPhone__ if _type_ is 'pager', and __otherPhone__ if _type_ is none of the above.
+- __emails:__ Partially supported. The first three email addresses are stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
+- __addresses:__ Partially supported. The first and second addresses are stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
+- __ims:__ Not supported, returning `null`.
- __organizations:__ Partially supported. The __name__ and __title__ of the first organization are stored in the BlackBerry __company__ and __title__ fields, respectively.
-- __photos:__ - Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a Base64 encoded image, or a URL pointing to the image. The image will be scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a Base64 encoded image.
-- __categories:__ Partially supported. Only 'Business' and 'Personal' categories are supported.
-- __urls:__ Partially supported. The first url is stored in BlackBerry __webpage__ field.
+- __photos:__ Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a base64-encoded image, or a URL pointing to the image. The image is scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a base64-encoded image.
+- __categories:__ Partially supported. Only _Business_ and _Personal_ categories are supported.
+- __urls:__ Partially supported. The first URL is stored in BlackBerry __webpage__ field.
iOS Quirks
----------
-- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no 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 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`.
+
+- __displayName:__ Not supported on iOS, returning `null` unless there is no `ContactName` specified, in which case it returns the composite name, __nickname__ or `""`, respectively.
+- __birthday:__ Must be input as a JavaScript `Date` object, the same way it is returned.
+- __photos:__ Returns a File URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.
+- __categories:__ This property is currently not supported, returning `null`.
Windows Phone 7 and 8 Quirks
-----------
-- __displayName:__ When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.
-- __urls:__ When creating a contact, user inputs multiple web addresses in the url field and saves the contact. While pulling the information during the contact search url field do not show up multiple web addresses
-- __phoneNumbers:__ _pref_ is not supported, _type_ is not supported in a _find_ operation, only supports one phoneNumber of each _type_
-- __emails:__ _pref_ is not supported, home and personal points to same email entry, supports only one entry for each _type_
-- __addresses:__ supports only _type_ of work, home/personal, _type_ home and personal points to same address entry, supports only one entry for each _type_
-- __organizations:__ Multiple _organizations_ are not supported, does not support the attributes: _pref_, _type_, _department_
-- __note:__ This property is not supported, and will always be returned as `null`.
-- __ims:__ This property is not supported, and will always be returned as `null`.
-- __birthdays:__ This property is not supported, and will always be returned as `null`.
-- __categories:__ This property is not supported, and will always be returned as `null`.
-
+- __displayName:__ When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.
+- __urls:__ When creating a contact, users can input and save more than one web address, but only one is available is available when searching the contact.
+- __phoneNumbers:__ The _pref_ option is not supported. The _type_ is not supported in a _find_ operation. Only one `phoneNumber` is allowed for each _type_.
+- __emails:__ The _pref_ option is not supported. Home and personal references same email entry. Only one entry is allowed for each _type_.
+- __addresses:__ Supports only work, and home/personal _type_. The home and personal _type_ reference the same address entry. Only one entry is allowed for each _type_.
+- __organizations:__ Only one is allowed, and does not support the _pref_, _type_, and _department_ attributes.
+- __note:__ Not supported, returning `null`.
+- __ims:__ Not supported, returning `null`.
+- __birthdays:__ Not supported, returning `null`.
+- __categories:__ Not supported, returning `null`.
Bada Quirks
-----------
-- __displayName:__ This property is not supported
-- __birthday:__ This property is not supported
+- __displayName:__ Not supported.
+- __birthday:__ Not supported.
- __photos:__ This property should be a list with one URL to a photo
-- __categories:__ This property is not supported
-- __ims:__ This property is not supported
+- __categories:__ Not supported.
+- __ims:__ Not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
index 937e9de..8939fe5 100644
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -25,7 +25,7 @@ Contains address properties for a `Contact` object.
Properties
----------
- __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)
+- __type:__ A string indicating what type of field this is, _home_ for example. _(DOMString)_
- __formatted:__ The full address formatted for display. _(DOMString)_
- __streetAddress:__ The full street address. _(DOMString)_
- __locality:__ The city or locality. _(DOMString)_
@@ -36,7 +36,9 @@ Properties
Details
-------
-The `ContactAddress` object stores the properties of a single address of a contact. A `Contact` object can have one or more addresses in a `ContactAddress[]` array.
+The `ContactAddress` object stores the properties of a single address
+of a contact. A `Contact` object may include more than one address in
+a `ContactAddress[]` array.
Supported Platforms
-------------------
@@ -57,11 +59,11 @@ Quick Example
for (var j=0; j<contacts[i].addresses.length; j++) {
alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
"Type: " + contacts[i].addresses[j].type + "\n" +
- "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
"Country: " + contacts[i].addresses[j].country);
}
}
@@ -73,7 +75,7 @@ Quick Example
// find all contacts
var options = new ContactFindOptions();
- options.filter="";
+ options.filter="";
var filter = ["displayName","addresses"];
navigator.contacts.find(filter, onSuccess, onError, options);
@@ -97,7 +99,7 @@ Full Example
function onDeviceReady() {
// find all contacts
var options = new ContactFindOptions();
- options.filter="";
+ options.filter="";
var filter = ["displayName","addresses"];
navigator.contacts.find(filter, onSuccess, onError, options);
}
@@ -110,11 +112,11 @@ Full Example
for (var j=0; j<contacts[i].addresses.length; j++) {
alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
"Type: " + contacts[i].addresses[j].type + "\n" +
- "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
"Country: " + contacts[i].addresses[j].country);
}
}
@@ -137,14 +139,14 @@ Full Example
Android 2.X Quirks
------------------
-- __pref:__ This property is not supported by Android 2.X devices and will always return `false`.
+- __pref:__ Not supported, returning `false` on Android 2.X devices.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
-- __pref:__ This property is not supported on Blackberry devices and will always return `false`.
-- __type:__ Partially supported. Only one each of "Work" and "Home" type addresses can be stored per contact.
-- __formatted:__ Partially supported. Will return concatenation of all BlackBerry address fields.
-- __streetAddress:__ Supported. Will return concatenation of BlackBerry __address1__ and __address2__ address fields.
+- __pref:__ Not supported on Blackberry devices, returning `false`.
+- __type:__ Partially supported. Only one each of _Work_ and _Home_ type addresses can be stored per contact.
+- __formatted:__ Partially supported. Returns a concatenation of all BlackBerry address fields.
+- __streetAddress:__ Supported. Returns a concatenation of BlackBerry __address1__ and __address2__ address fields.
- __locality:__ Supported. Stored in BlackBerry __city__ address field.
- __region:__ Supported. Stored in BlackBerry __stateProvince__ address field.
- __postalCode:__ Supported. Stored in BlackBerry __zipPostal__ address field.
@@ -152,10 +154,10 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
iOS Quirks
----------
-- __pref:__ This property is not supported on iOS devices and will always return `false`.
-- __formatted:__ Not currently supported.
+- __pref:__ Not supported on iOS devices, returning `false`.
+- __formatted:__ Currently not supported.
Bada Quirks
-----------
-- __formatted:__ This property is not supported
-- __type:__ Has to be one of the following: WORK, HOME
+- __formatted:__ Not supported.
+- __type:__ Has to be either `WORK` or `HOME`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactError/contactError.md b/docs/en/edge/cordova/contacts/ContactError/contactError.md
index 45b5873..0e67b68 100644
--- a/docs/en/edge/cordova/contacts/ContactError/contactError.md
+++ b/docs/en/edge/cordova/contacts/ContactError/contactError.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
ContactError
========
-A `ContactError` object is returned to the `contactError` callback when an error occurs.
+A `ContactError` object is passed to the `contactError` callback when an error occurs.
Properties
----------
@@ -41,5 +41,6 @@ Constants
Description
-----------
-The `ContactError` object is returned to the user through the `contactError` 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/39353f45/docs/en/edge/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactField/contactfield.md b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
index f85a704..727b184 100644
--- a/docs/en/edge/cordova/contacts/ContactField/contactfield.md
+++ b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,21 +20,35 @@ license: Licensed to the Apache Software Foundation (ASF) under one
ContactField
============
-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 `Contact` object. Some properties 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)_
+- __type:__ A string that indicates what type of field this is, _home_ for example. _(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)_
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.
-
-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.
+The `ContactField` object is a reusable component that represents
+contact fields generically. Each `ContactField` object contains a
+`value`, `type`, and `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 a
+`ContactField` object's __type__ attribute. For example, a phone
+number can specify __type__ values of _home_, _work_, _mobile_,
+_iPhone_, or any other value that is supported by a particular device
+platform's contact database. However, for the `Contact` __photos__
+field, Cordova uses the __type__ field to indicate the format of the
+returned image. Cordova returns a __type__ of __url__ when the
+__value__ attribute contains a URL to the photo image, or _base64_
+when the __value__ contains a base64-encoded image string.
Supported Platforms
-------------------
@@ -106,8 +120,8 @@ Full Example
for (var i=0; i<contacts.length; i++) {
// display phone numbers
for (var j=0; j<contacts[i].phoneNumbers.length; j++) {
- alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
- "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
+ alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
+ "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
"Preferred: " + contacts[i].phoneNumbers[j].pref);
}
}
@@ -130,19 +144,20 @@ Full Example
Android Quirks
--------------
-- __pref:__ This property is not support by Android devices, and will always return `false`.
+- __pref:__ Not supported, returning `false`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
- __type:__ Partially supported. Used for phone numbers.
- __value:__ Supported.
-- __pref:__ This property is not supported, and will always return `false`.
+- __pref:__ Not supported, returning `false`.
iOS Quirks
-----------
-- __pref:__ This property is not supported on iOS devices and will always return `false`.
+- __pref:__ Not supported, returning `false`.
Bada Quirks
-----------
-- __type:__ Property has to be one of the following for Email or Address fields: "WORK", "HOME". Property has to be one of the following for Phone fields: "WORK", "HOME", "VOICE", "FAX", "MSG", "CELL", "PAGER","BBS", "MODEM", "CAR", "ISDN","VIDEO", "PCS"
+
+- __type:__ For email or address fields, property must be _WORK_ or _HOME_. For phone fields, must be _WORK_, _HOME_, _VOICE_, _FAX_, _MSG_, _CELL_, _PAGER_, _BBS_, _MODEM_, _CAR_, _ISDN_,_VIDEO_, or _PCS_.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 4acf254..10ff14a 100644
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -25,9 +25,8 @@ Contains properties that can be used to filter the results of a `contacts.find`
Properties
----------
-- __filter:__ The search string used to find contacts. _(DOMString)_ (Default: "")
-- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: false)
-
+- __filter:__ The search string used to find contacts. _(DOMString)_ (Default: `""`)
+- __multiple:__ Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: false)
Supported Platforms
-------------------
@@ -115,4 +114,5 @@ Full Example
Bada Quirks
-----------
-__filter:__ Property can only apply to the following: "firstName", "lastName", "nickname", "phoneNumber", "email", "address"
+
+__filter:__ Property can only apply to the following: _firstName_, _lastName_, _nickname_, _phoneNumber_, _email_, and _address_.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactName/contactname.md b/docs/en/edge/cordova/contacts/ContactName/contactname.md
index 91915fb..9799472 100644
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/edge/cordova/contacts/ContactName/contactname.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,22 +20,22 @@ license: Licensed to the Apache Software Foundation (ASF) under one
ContactName
===========
-Contains name properties of a `Contact` object.
+Contains different kinds of information about a `Contact` object's name.
Properties
----------
- __formatted:__ The complete name of the contact. _(DOMString)_
-- __familyName:__ The contacts family name. _(DOMString)_
-- __givenName:__ The contacts given name. _(DOMString)_
-- __middleName:__ The contacts middle name. _(DOMString)_
-- __honorificPrefix:__ The contacts prefix (example Mr. or Dr.) _(DOMString)_
-- __honorificSuffix:__ The contacts suffix (example Esq.). _(DOMString)_
+- __familyName:__ The contact's family name. _(DOMString)_
+- __givenName:__ The contact's given name. _(DOMString)_
+- __middleName:__ The contact's middle name. _(DOMString)_
+- __honorificPrefix:__ The contact's prefix (example _Mr._ or _Dr._) _(DOMString)_
+- __honorificSuffix:__ The contact's suffix (example _Esq._). _(DOMString)_
Details
-------
-The `ContactName` object stores name properties of a contact.
+The `ContactName` object stores a contact's name properties.
Supported Platforms
-------------------
@@ -52,11 +52,11 @@ Quick Example
function onSuccess(contacts) {
for (var i=0; i<contacts.length; i++) {
- alert("Formatted: " + contacts[i].name.formatted + "\n" +
- "Family Name: " + contacts[i].name.familyName + "\n" +
- "Given Name: " + contacts[i].name.givenName + "\n" +
- "Middle Name: " + contacts[i].name.middleName + "\n" +
- "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
"Prefix: " + contacts[i].name.honorificSuffix);
}
};
@@ -98,11 +98,11 @@ Full Example
//
function onSuccess(contacts) {
for (var i=0; i<contacts.length; i++) {
- alert("Formatted: " + contacts[i].name.formatted + "\n" +
- "Family Name: " + contacts[i].name.familyName + "\n" +
- "Given Name: " + contacts[i].name.givenName + "\n" +
- "Middle Name: " + contacts[i].name.middleName + "\n" +
- "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
"Prefix: " + contacts[i].name.honorificPrefix);
}
};
@@ -123,25 +123,25 @@ Full Example
Android Quirks
------------
-- __formatted:__ Partially supported. Will return the concatenation of honorificPrefix, givenName, middleName, familyName and honorificSuffix but will not store.
+- __formatted:__ Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
-- __formatted:__ Partially supported. Will return concatenation of BlackBerry __firstName__ and __lastName__ fields.
+- __formatted:__ Partially supported. Returns a concatenation of BlackBerry __firstName__ and __lastName__ fields.
- __familyName:__ Supported. Stored in BlackBerry __lastName__ field.
- __givenName:__ Supported. Stored in BlackBerry __firstName__ field.
-- __middleName:__ This property is not supported, and will always return `null`.
-- __honorificPrefix:__ This property is not supported, and will always return `null`.
-- __honorificSuffix:__ This property is not supported, and will always return `null`.
+- __middleName:__ Not supported, returning `null`.
+- __honorificPrefix:__ Not supported, returning `null`.
+- __honorificSuffix:__ Not supported, returning `null`.
iOS Quirks
------------
-- __formatted:__ Partially supported. Will return iOS Composite Name but will not store.
+- __formatted:__ Partially supported. Returns iOS Composite Name, but is read-only.
Bada Quirks
-----------
-- __formatted:__ Property not supported
-- __middleName:__ Property not supported
-_ __honorificPrefix:__ Property not supported
-- __honorificSuffix:__ Property not supported
+- __formatted:__ Not supported
+- __middleName:__ Not supported
+_ __honorificPrefix:__ Not supported
+- __honorificSuffix:__ Not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
index aef1248..7ddbf8e 100644
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,20 +20,22 @@ license: Licensed to the Apache Software Foundation (ASF) under one
ContactOrganization
===================
-Contains organization properties of a `Contact` object.
+Contains a `Contact` object's organization properties.
Properties
----------
- __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)
+- __type:__ A string that indicates what type of field this is, _home_ for example. _(DOMString)
- __name:__ The name of the organization. _(DOMString)_
- __department:__ The department the contract works for. _(DOMString)_
-- __title:__ The contacts title at the organization. _(DOMString)_
+- __title:__ The contact's title at the organization. _(DOMString)_
Details
-------
-The `ContactOrganization` object stores a contact's organization properties. A `Contact` object stores one or more `ContactOrganization` 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
-------------------
@@ -53,8 +55,8 @@ Quick Example
for (var j=0; j<contacts[i].organizations.length; j++) {
alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
"Type: " + contacts[i].organizations[j].type + "\n" +
- "Name: " + contacts[i].organizations[j].name + "\n" +
- "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
"Title: " + contacts[i].organizations[j].title);
}
}
@@ -100,8 +102,8 @@ Full Example
for (var j=0; j<contacts[i].organizations.length; j++) {
alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
"Type: " + contacts[i].organizations[j].type + "\n" +
- "Name: " + contacts[i].organizations[j].name + "\n" +
- "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
"Title: " + contacts[i].organizations[j].title);
}
}
@@ -125,24 +127,24 @@ Full Example
Android 2.X Quirks
------------------
-- __pref:__ This property is not supported by Android 2.X devices and will always return `false`.
+- __pref:__ Not supported by Android 2.X devices, returning `false`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
-- __pref:__ This property is not supported by Blackberry devices and will always return `false`.
-- __type:__ This property is not supported by Blackberry devices and will always return `null`.
-- __name:__ Partially supported. The first organization name will be stored in the BlackBerry __company__ field.
-- __department:__ This property is not supported, and will always be returned as `null`.
-- __title:__ Partially supported. The first organization title will be stored in the BlackBerry __jobTitle__ field.
+- __pref:__ Not supported by Blackberry devices, returning `false`.
+- __type:__ Not supported by Blackberry devices, returning `null`.
+- __name:__ Partially supported. The first organization name is stored in the BlackBerry __company__ field.
+- __department:__ Not supported, returning `null`.
+- __title:__ Partially supported. The first organization title is stored in the BlackBerry __jobTitle__ field.
iOS Quirks
-----------
-- __pref:__ This property is not supported on iOS devices and will always return `false`.
-- __type:__ This property is not supported on iOS devices and will always return `null`.
-- __name:__ Partially supported. The first organization name will be stored in the iOS __kABPersonOrganizationProperty__ field.
-- __department__: Partially supported. The first department name will be stored in the iOS __kABPersonDepartmentProperty__ field.
-- __title__: Partially supported. The first title will be stored in the iOS __kABPersonJobTitleProperty__ field.
+- __pref:__ Not supported on iOS devices, returning `false`.
+- __type:__ Not supported on iOS devices, returning `null`.
+- __name:__ Partially supported. The first organization name is stored in the iOS __kABPersonOrganizationProperty__ field.
+- __department__: Partially supported. The first department name is stored in the iOS __kABPersonDepartmentProperty__ field.
+- __title__: Partially supported. The first title is stored in the iOS __kABPersonJobTitleProperty__ field.
Bada 2.0 Quirks
---------------
-- ContactOrganization not supported
+- `ContactOrganization` is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.create.md b/docs/en/edge/cordova/contacts/contacts.create.md
index 42e8cb3..f3548d3 100644
--- a/docs/en/edge/cordova/contacts/contacts.create.md
+++ b/docs/en/edge/cordova/contacts/contacts.create.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -27,9 +27,10 @@ Returns a new Contact object.
Description
-----------
-contacts.create is a synchronous function that returns a new `Contact` object.
+The `contacts.create` method is synchronous, and returns a new `Contact` 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 retain the Contact object in the device contacts
+database, for which you need to invoke the `Contact.save` method.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.find.md b/docs/en/edge/cordova/contacts/contacts.find.md
index ad97108..592c621 100644
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ b/docs/en/edge/cordova/contacts/contacts.find.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,25 +20,38 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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 `Contact`
+objects, each containing the fields specified.
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 `Contact` objects. The resulting objects are passed to the `contactSuccess` callback function specified by the __contactSuccess__ parameter.
+The `contacts.find` method executes asynchronously, querying the
+device contacts database and returning 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 __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 is invalid and will result in a `ContactError.INVALID_ARGUMENT_ERROR` . A __contactFields__ value of ["*"] will return all contact fields.
+The __contactFields__ parameter specifies the fields to be used as a
+search qualifier, and only those results are passed to the
+__contactSuccess__ callback function. A zero-length __contactFields__
+parameter is invalid and results in
+`ContactError.INVALID_ARGUMENT_ERROR`. A __contactFields__ value of
+`"*"` returns 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 __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 there's a match for
+_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]
+- __contactFields:__ Contact fields to use as a search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required]
+- __contactSuccess:__ Success callback function invoked with the contacts returned from the database. [Required]
+- __contactError:__ Error callback function, invoked when an error occurs. [Optional]
- __contactFindOptions:__ Search options to filter contacts. [Optional]
Supported Platforms
@@ -65,7 +78,7 @@ Quick Example
// find all contacts with 'Bob' in any name field
var options = new ContactFindOptions();
options.filter="Bob";
- options.multiple=true;
+ options.multiple=true;
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
@@ -89,7 +102,7 @@ Full Example
function onDeviceReady() {
// find all contacts with 'Bob' in any name field
var options = new ContactFindOptions();
- options.filter="Bob";
+ options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
}
@@ -115,5 +128,4 @@ Full Example
<p>Find Contacts</p>
</body>
</html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.md b/docs/en/edge/cordova/contacts/contacts.md
index 094b856..54058fc 100644
--- a/docs/en/edge/cordova/contacts/contacts.md
+++ b/docs/en/edge/cordova/contacts/contacts.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/parameters/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactError.md b/docs/en/edge/cordova/contacts/parameters/contactError.md
index 6b50ddc..5c451b1 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactError.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactError.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -24,4 +24,4 @@ Error callback function for contact functions.
function(error) {
// Handle the error
- }
\ No newline at end of file
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFields.md b/docs/en/edge/cordova/contacts/parameters/contactFields.md
index 66c9d3d..d3b5988 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFields.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFields.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,6 +20,6 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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 for the `contacts.find` method, used 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/39353f45/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
index 2eb9afc..660615b 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
contactFindOptions
==================
-Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database.
+Optional parameter of the `contacts.find` method, used to filter the
+contacts returned from the contacts database.
- {
- filter: "",
- multiple: true,
- };
+ {
+ filter: "",
+ multiple: true,
+ };
Options
-------
-- __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: "")
-- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: false)
+- __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: `""`)
+- __multiple:__ Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
index 9068218..a8cf4dc 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -35,6 +35,7 @@ Example
-------
function contactSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- console.log("Display Name = " + contacts[i].displayName;
- }
\ No newline at end of file
+ for (var i=0; i<contacts.length; i++) {
+ console.log("Display Name = " + contacts[i].displayName);
+ }
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.cordova.md b/docs/en/edge/cordova/device/device.cordova.md
index 451aeb3..c7891ff 100644
--- a/docs/en/edge/cordova/device/device.cordova.md
+++ b/docs/en/edge/cordova/device/device.cordova.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -23,7 +23,7 @@ device.cordova
Get the version of Cordova running on the device.
var string = device.cordova;
-
+
Description
-----------
@@ -65,10 +65,10 @@ Full Example
function onDeviceReady() {
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 />' +
+ 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 />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.md b/docs/en/edge/cordova/device/device.md
index 294cb42..3748d36 100644
--- a/docs/en/edge/cordova/device/device.md
+++ b/docs/en/edge/cordova/device/device.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.model.md b/docs/en/edge/cordova/device/device.model.md
index 7aaa5da..59a711b 100644
--- a/docs/en/edge/cordova/device/device.model.md
+++ b/docs/en/edge/cordova/device/device.model.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -23,11 +23,13 @@ device.model
Get the device's model name.
var string = device.model;
-
+
Description
-----------
-`device.model` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
+The `device.model` returns the name of the device's model or
+product. The value is set by the device manufacturer and may be
+different across versions of the same product.
Supported Platforms
-------------------
@@ -71,11 +73,11 @@ Full Example
function onDeviceReady() {
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 Model: ' + device.model + '<br />' +
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
'Device Version: ' + device.version + '<br />';
}
@@ -86,23 +88,20 @@ Full Example
</body>
</html>
-
Android Quirks
--------------
-- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL).
- - The product name is often the code name given during production.
- - e.g. Nexus One returns "Passion", Motorola Droid returns "voles"
+- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL), which is often the production code name. For example, the Nexus One returns `Passion`, and Motorola Droid returns `voles`.
Windows Phone 7 and 8 Quirks
-------------
-- returns the manufacturer specified device model, for example, the Samsung Focus returns 'SGH-i917'
+- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
Bada Quirks
-----------
-- returns the manufacturer model name. For example 'Samsung Wave S8500'
+- Returns the manufacturer model name, for example, `Samsung Wave S8500`
Tizen Quirks
-----------
-- returns the device model assigned by the vendor. For example 'TIZEN'
+- Returns the device model assigned by the vendor, for example, `TIZEN`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.name.md b/docs/en/edge/cordova/device/device.name.md
index 180c770..5391f8d 100644
--- a/docs/en/edge/cordova/device/device.name.md
+++ b/docs/en/edge/cordova/device/device.name.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -19,16 +19,19 @@ license: Licensed to the Apache Software Foundation (ASF) under one
device.name
===========
-WARNING: device.name is deprecated as of version 2.3.0, use device.model instead
+
+__WARNING:__ `device.name` is deprecated as of version 2.3.0. Use `device.model` instead.
Get the device's model name.
var string = device.name;
-
+
Description
-----------
-`device.name` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
+`device.name` returns the name of the device's model or product. This
+value is set by the device manufacturer and may be different across
+versions of the same product.
Supported Platforms
-------------------
@@ -72,11 +75,11 @@ Full Example
function onDeviceReady() {
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 Model: ' + device.model + '<br />' +
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
'Device Version: ' + device.version + '<br />';
}
@@ -87,23 +90,20 @@ Full Example
</body>
</html>
-
Android Quirks
--------------
-- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL).
- - The product name is often the code name given during production.
- - e.g. Nexus One returns "Passion", Motorola Droid returns "voles"
+- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL), which is often the production code name. For example, the Nexus One returns `Passion`, and Motorola Droid returns `voles`.
Windows Phone 7 and 8 Quirks
-------------
-- returns the manufacturer specified device name, for example, the Samsung Focus returns 'SGH-i917'
+- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
Bada Quirks
-----------
-- returns the manufacturer model name. For example 'Samsung Wave S8500'
+- Returns the manufacturer model name, for example, `Samsung Wave S8500`
Tizen Quirks
-----------
-- returns the device model assigned by the vendor. For example 'TIZEN'
+- Returns the device model assigned by the vendor, for example, `TIZEN`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.platform.md b/docs/en/edge/cordova/device/device.platform.md
index 410798e..a259587 100644
--- a/docs/en/edge/cordova/device/device.platform.md
+++ b/docs/en/edge/cordova/device/device.platform.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -68,10 +68,10 @@ Full Example
function onDeviceReady() {
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 />' +
+ 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 />';
}
@@ -81,19 +81,20 @@ Full Example
<p id="deviceProperties">Loading device properties...</p>
</body>
</html>
-
+
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.
+Devices may return the device platform version number instead of the
+platform name. For example, the Storm2 9550 returns a value such as
+`2.13.0.95`.
Windows Phone 7 Quirks
-----------------
-Windows Phone 7 devices report platform as 'WinCE'
-
+Windows Phone 7 devices report the platform as `WinCE`.
Windows Phone 8 Quirks
-----------------
-Windows Phone 8 devices report platform as 'Win32NT'
+Windows Phone 8 devices report the platform as `Win32NT`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.uuid.md b/docs/en/edge/cordova/device/device.uuid.md
index 24c0964..565ffae 100644
--- a/docs/en/edge/cordova/device/device.uuid.md
+++ b/docs/en/edge/cordova/device/device.uuid.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -23,11 +23,11 @@ device.uuid
Get the device's Universally Unique Identifier ([UUID](http://en.wikipedia.org/wiki/Universally_Unique_Identifier)).
var string = device.uuid;
-
+
Description
-----------
-The details of how a UUID is generated are determined by the device manufacturer and specific to the device's platform or model.
+The details of how a UUID is generated are determined by the device manufacturer and are specific to the device's platform or model.
Supported Platforms
-------------------
@@ -54,9 +54,9 @@ Quick Example
// 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.
- // Windows Phone 7 : Returns a hash of device+current user,
+ // Windows Phone 7 : Returns a hash of device+current user,
// if the user is not defined, a guid is generated and will persist until the app is uninstalled
- //
+ //
// webOS: returns the device NDUID
//
// Tizen: returns the device IMEI (International Mobile Equipment Identity or IMEI is a number
@@ -83,10 +83,10 @@ Full Example
function onDeviceReady() {
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 />' +
+ 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 />';
}
@@ -100,9 +100,17 @@ Full Example
iOS Quirk
-------------
-The uuid for iOS is not unique for a device, but is unique per application per install. This will change if you delete the app and re-install, and possibly also when you upgrade your iOS version, or even upgrade your app per version (as we've seen in iOS 5.1). Not a reliable value.
+The `uuid` on iOS is not unique to a device, but varies for each
+application, for each installation. It changes if you delete and
+re-install the app, and possibly also when you upgrade iOS, or even
+upgrade your app per version (apparent in iOS 5.1). The `uuid` is not
+a reliable value.
Windows Phone 7 and 8 Quirks
-------------
-The uuid for Windows Phone 7 requires the permission ID_CAP_IDENTITY_DEVICE. Microsoft will likely be deprecating this property in the near future. If the capability is not available, the application generates a persistent guid, that will be maintained for the install-lifetime of the application on the device.
+The `uuid` for Windows Phone 7 requires the permission
+`ID_CAP_IDENTITY_DEVICE`. Microsoft will likely deprecate this
+property soon. If the capability is not available, the application
+generates a persistent guid that is maintained for the duration of the
+application's installation on the device.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.version.md b/docs/en/edge/cordova/device/device.version.md
index b88de98..9e1db70 100644
--- a/docs/en/edge/cordova/device/device.version.md
+++ b/docs/en/edge/cordova/device/device.version.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -41,7 +41,7 @@ Quick Example
// Android: Froyo OS would return "2.2"
// Eclair OS would return "2.1", "2.0.1", or "2.0"
- // Version can also return update level "2.1-update1"
+ // Version can also return update level "2.1-update1"
//
// BlackBerry: Torch 9800 using OS 6.0 would return "6.0.0.600"
//
@@ -72,10 +72,10 @@ Full Example
function onDeviceReady() {
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 />' +
+ 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 />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.backbutton.md b/docs/en/edge/cordova/events/events.backbutton.md
index 0f668b9..2041c96 100644
--- a/docs/en/edge/cordova/events/events.backbutton.md
+++ b/docs/en/edge/cordova/events/events.backbutton.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,16 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
backbutton
===========
-This is an event that fires when the user presses the back button.
+The event fires when the user presses the back button.
document.addEventListener("backbutton", yourCallbackFunction, false);
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.
+To override the default back-button behavior, register an event
+listener for the `backbutton` event, typically by calling
+`document.addEventListener` once you receive the Cordova `deviceready`
+event. It is no longer necessary to call any other method to override
+the back-button behaviour.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterycritical.md b/docs/en/edge/cordova/events/events.batterycritical.md
index b11294a..0fa68f9 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,21 +20,25 @@ license: Licensed to the Apache Software Foundation (ASF) under one
batterycritical
===========
-This is an event that fires when a Cordova application detects the battery has reached the critical level threshold.
+The event fires when the battery has reached the critical level
+threshold.
window.addEventListener("batterycritical", yourCallbackFunction, false);
Details
-------
-This event that fires when a Cordova application detects the percentage of battery has reached the critical battery threshold. This value is device specific.
+The event fires when the percentage of battery charge has reached the
+critical battery threshold. The value is device-specific.
-The batterycritical handler will be called with an object that contains two properties:
+The `batterycritical` handler is called with an object that contains
+two properties:
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+- __level:__ The percentage of battery charge (0-100). _(Number)_
+- __isPlugged:__ A boolean that indicates whether the device is plugged in. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `window.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
@@ -51,7 +55,7 @@ Quick Example
function onBatteryCritical(info) {
// Handle the battery critical event
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
Full Example
@@ -70,7 +74,7 @@ Full Example
// At this point, the document has loaded but cordova-x.x.x.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);
}
@@ -84,7 +88,7 @@ Full Example
// Handle the batterycritical event
//
function onBatteryCritical(info) {
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterylow.md b/docs/en/edge/cordova/events/events.batterylow.md
index 804a7a5..d40ddf6 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,21 +20,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
batterylow
===========
-This is an event that fires when a Cordova application detects the battery has reached the low level threshold.
+The event fires when the battery has reached the low level threshold.
window.addEventListener("batterylow", yourCallbackFunction, false);
Details
-------
-This event that fires when a Cordova application detects the percentage of battery has reached the low battery threshold. This value is device specific.
+The event fires when the percentage of battery charge has reached the
+low battery threshold, device-specific value.
-The batterylow handler will be called with an object that contains two properties:
+The `batterylow` handler is called with an object that contains two
+properties:
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+- __level:__ The percentage of battery charge (0-100). _(Number)_
+- __isPlugged:__ A boolean that indicates whether the device is plugged in. _(Boolean)_
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
@@ -51,7 +54,7 @@ Quick Example
function onBatteryLow(info) {
// Handle the battery low event
- alert("Battery Level Low " + info.level + "%");
+ alert("Battery Level Low " + info.level + "%");
}
Full Example
@@ -70,7 +73,7 @@ Full Example
// At this point, the document has loaded but cordova-x.x.x.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);
}
@@ -84,7 +87,7 @@ Full Example
// Handle the batterylow event
//
function onBatteryLow(info) {
- alert("Battery Level Low " + info.level + "%");
+ alert("Battery Level Low " + info.level + "%");
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterystatus.md b/docs/en/edge/cordova/events/events.batterystatus.md
index 6ef4a25..9040074 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,21 +20,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
batterystatus
===========
-This is an event that fires when a Cordova application detects a change in the battery status.
+The event fires when there is a change in the battery status.
window.addEventListener("batterystatus", yourCallbackFunction, false);
Details
-------
-This event that fires when a Cordova application detects the percentage of battery has changed by at least 1 percent. It is also fired if the device has been plugged in or un-plugged.
+This event fires when the percentage of battery charge changes by at
+least 1 percent, or if the device is plugged in or unplugged.
-The battery status handler will be called with an object that contains two properties:
+The battery status handler is called with an object that contains two
+properties:
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+- __level:__ The percentage of battery charge (0-100). _(Number)_
+- __isPlugged:__ A boolean that indicates whether the device is plugged in. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `window.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
@@ -48,9 +51,9 @@ Supported Platforms
Windows Phone 7 and 8 Quirks
----------------------
-The `level` property is unavailable as Windows Phone 7 does not provide
-native APIs for determining battery level. The `isPlugged` parameter
-_is_ supported.
+Windows Phone 7 does not provide native APIs to determine battery
+level, so the `level` property is unavailable. The `isPlugged`
+parameter _is_ supported.
Quick Example
-------------
@@ -59,7 +62,7 @@ Quick Example
function onBatteryStatus(info) {
// Handle the online event
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
Full Example
@@ -78,7 +81,7 @@ Full Example
// At this point, the document has loaded but cordova-x.x.x.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);
}
@@ -92,7 +95,7 @@ Full Example
// Handle the batterystatus event
//
function onBatteryStatus(info) {
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.deviceready.md b/docs/en/edge/cordova/events/events.deviceready.md
index b44c9f0..30786ae 100644
--- a/docs/en/edge/cordova/events/events.deviceready.md
+++ b/docs/en/edge/cordova/events/events.deviceready.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
deviceready
===========
-This is an event that fires when Cordova is fully loaded.
+The event fires when Cordova is fully loaded.
document.addEventListener("deviceready", yourCallbackFunction, false);
@@ -29,13 +29,20 @@ Details
This is a very important event that every Cordova application should use.
-Cordova consists of two code bases: native and JavaScript. While the native code is loading, a custom loading image is displayed. However, JavaScript is only loaded once the DOM loads. This means your web application could, potentially, call a Cordova JavaScript function before it is loaded.
+Cordova consists of two code bases: native and JavaScript. While the
+native code loads, a custom loading image displays. However,
+JavaScript only loads once the DOM loads. This means your web
+application may potentially call a Cordova JavaScript function before
+the corresponding native code is available.
-The Cordova `deviceready` event fires once Cordova has fully loaded. After the device has fired, you can safely make calls to Cordova function.
+The Cordova `deviceready` event fires once Cordova has fully loaded.
+After the device has fired, you can safely make calls to Cordova APIs.
+Applications typically attach an event listener with
+`document.addEventListener` once the HTML document's DOM has loaded.
-Typically, you will want to attach an event listener with `document.addEventListener` once the HTML document's DOM has loaded.
-
-This event behaves differently from others in that any event handler registered after the event has been fired will have its callback function called immediately.
+The `deviceready` event behaves somewhat differently from others. Any
+event handler registered after the `deviceready` event fires has its
+callback function called immediately.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.endcallbutton.md b/docs/en/edge/cordova/events/events.endcallbutton.md
index 7fab690..a9abb30 100644
--- a/docs/en/edge/cordova/events/events.endcallbutton.md
+++ b/docs/en/edge/cordova/events/events.endcallbutton.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
endcallbutton
===========
-This is an event that fires when the user presses the end call button.
+This event fires when the user presses the end call button.
document.addEventListener("endcallbutton", yourCallbackFunction, false);
Details
-------
-If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event.
+The event overrides the default end call behavior.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.md b/docs/en/edge/cordova/events/events.md
index 1581844..4ae67aa 100644
--- a/docs/en/edge/cordova/events/events.md
+++ b/docs/en/edge/cordova/events/events.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.menubutton.md b/docs/en/edge/cordova/events/events.menubutton.md
index f97ebc9..3f47e4f 100644
--- a/docs/en/edge/cordova/events/events.menubutton.md
+++ b/docs/en/edge/cordova/events/events.menubutton.md
@@ -20,16 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
menubutton
===========
-This is an event that fires when the user presses the menu button.
+The event fires when the user presses the menu button.
document.addEventListener("menubutton", yourCallbackFunction, false);
Details
-------
-If you need to override the default menu button behaviour you can register an event listener for the 'menubutton' event.
+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.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.offline.md b/docs/en/edge/cordova/events/events.offline.md
index fa4cf58..19f47e5 100644
--- a/docs/en/edge/cordova/events/events.offline.md
+++ b/docs/en/edge/cordova/events/events.offline.md
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
offline
===========
-This is an event that fires when a Cordova application is offline (not connected to the Internet).
+This event fires when a Cordova application is offline (not connected to the Internet).
document.addEventListener("offline", yourCallbackFunction, false);
Details
-------
-When the application's network connection changes to being offline, the offline event is fired.
+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.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------