Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 173D517E8E for ; Tue, 20 Oct 2015 22:27:23 +0000 (UTC) Received: (qmail 58859 invoked by uid 500); 20 Oct 2015 22:27:22 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 58716 invoked by uid 500); 20 Oct 2015 22:27:22 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 58033 invoked by uid 99); 20 Oct 2015 22:27:21 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 20 Oct 2015 22:27:21 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 8E212E045F; Tue, 20 Oct 2015 22:27:21 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dblotsky@apache.org To: commits@cordova.apache.org Date: Tue, 20 Oct 2015 22:27:36 -0000 Message-Id: <015c708186ee4d5aa9638a246dd10976@git.apache.org> In-Reply-To: <3ae729680bb14b25aca206e864be3eb5@git.apache.org> References: <3ae729680bb14b25aca206e864be3eb5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [16/78] [abbrv] [partial] docs commit: Making links in docs manual instead of automatic. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/compass/compassError/compassError.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/compass/compassError/compassError.md b/www/docs/en/2.3.0/cordova/compass/compassError/compassError.md index 25a2547..254f12b 100644 --- a/www/docs/en/2.3.0/cordova/compass/compassError/compassError.md +++ b/www/docs/en/2.3.0/cordova/compass/compassError/compassError.md @@ -23,7 +23,7 @@ title: CompassError CompassError ========== -A `CompassError` object is returned to the `compassError` callback function when an error occurs. +A `CompassError` object is returned to the `[compassError](../parameters/compassError.html)` callback function when an error occurs. Properties ---------- @@ -38,6 +38,6 @@ Constants Description ----------- -The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs. +The `CompassError` object is returned to the user through the `[compassError](../parameters/compassError.html)` callback function when an error occurs. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/compass/parameters/compassError.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/compass/parameters/compassError.md b/www/docs/en/2.3.0/cordova/compass/parameters/compassError.md index fc209a5..facf067 100644 --- a/www/docs/en/2.3.0/cordova/compass/parameters/compassError.md +++ b/www/docs/en/2.3.0/cordova/compass/parameters/compassError.md @@ -25,7 +25,7 @@ compassError onError callback function for compass functions. -Example +[Example](../../storage/storage.opendatabase.html) ------- function(CompassError) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/compass/parameters/compassHeading.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/compass/parameters/compassHeading.md b/www/docs/en/2.3.0/cordova/compass/parameters/compassHeading.md index 1743f37..1d2bddc 100644 --- a/www/docs/en/2.3.0/cordova/compass/parameters/compassHeading.md +++ b/www/docs/en/2.3.0/cordova/compass/parameters/compassHeading.md @@ -23,7 +23,7 @@ title: compassHeading compassHeading ========== -A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs. +A `CompassHeading` object is returned to the `[compassSuccess](compassSuccess.html)` callback function when an error occurs. Properties ---------- @@ -35,7 +35,7 @@ Properties Description ----------- -The `CompassHeading` object is returned to the user through the `compassSuccess` callback function. +The `CompassHeading` object is returned to the user through the `[compassSuccess](compassSuccess.html)` callback function. Android Quirks -------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/compass/parameters/compassSuccess.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/compass/parameters/compassSuccess.md b/www/docs/en/2.3.0/cordova/compass/parameters/compassSuccess.md index 43ece54..597fe5a 100644 --- a/www/docs/en/2.3.0/cordova/compass/parameters/compassSuccess.md +++ b/www/docs/en/2.3.0/cordova/compass/parameters/compassSuccess.md @@ -23,7 +23,7 @@ title: compassSuccess compassSuccess ============== -onSuccess callback function that provides the compass heading information via a compassHeading object. +onSuccess callback function that provides the compass heading information via a [compassHeading](compassHeading.html) object. function(heading) { // Do something @@ -35,7 +35,7 @@ Parameters - __heading:__ The heading information. _(compassHeading)_ -Example +[Example](../../storage/storage.opendatabase.html) ------- function onSuccess(heading) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/connection/connection.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/connection/connection.md b/www/docs/en/2.3.0/cordova/connection/connection.md index 20f58dd..b6e14bd 100644 --- a/www/docs/en/2.3.0/cordova/connection/connection.md +++ b/www/docs/en/2.3.0/cordova/connection/connection.md @@ -30,7 +30,7 @@ This object is exposed as `navigator.connection`. Properties ---------- -- connection.type +- [connection.type](connection.type.html) Constants --------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/connection/connection.type.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/connection/connection.type.md b/www/docs/en/2.3.0/cordova/connection/connection.type.md index 1bce200..a436512 100644 --- a/www/docs/en/2.3.0/cordova/connection/connection.type.md +++ b/www/docs/en/2.3.0/cordova/connection/connection.type.md @@ -42,7 +42,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- function checkConnection() { @@ -62,7 +62,7 @@ Quick Example checkConnection(); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ @@ -95,7 +95,7 @@ Full Example states[Connection.CELL_4G] = 'Cell 4G connection'; states[Connection.NONE] = 'No network connection'; - alert('Connection type: ' + states[networkState]); + alert('[Connection](connection.html) type: ' + states[networkState]); } @@ -107,7 +107,7 @@ Full Example API Change ---------- -Before Cordova 2.3.0, the Connection object existed at: `navigator.network.connection`. +Before Cordova 2.3.0, the [Connection](connection.html) object existed at: `navigator.network.connection`. To match the spec, this was changed to `navigator.connection` in 2.3.0. @@ -133,7 +133,7 @@ webOS Quirks Windows Phone Quirks -------------------- -- When running in the emulator, always detects `navigator.connection.type` as `Connection.UNKNOWN`. +- When running in the emulator, always detects `navigator.connection.type` as `[Connection](connection.html).UNKNOWN`. Tizen Quirks -------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/Contact/contact.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/Contact/contact.md b/www/docs/en/2.3.0/cordova/contacts/Contact/contact.md index f1ea42a..34d47c4 100644 --- a/www/docs/en/2.3.0/cordova/contacts/Contact/contact.md +++ b/www/docs/en/2.3.0/cordova/contacts/Contact/contact.md @@ -47,14 +47,14 @@ Methods ------- - __clone__: Returns a new Contact object that is a deep copy of the calling object, with the id property set to `null`. -- __remove__: Removes the contact from the device contacts database. An error callback is called with a `ContactError` object if the removal is unsuccessful. +- __remove__: Removes the contact from the device contacts database. An error callback is called with a `[ContactError](../ContactError/contactError.html)` object if the removal is unsuccessful. - __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists. Details ------- -The `Contact` object represents a user contact. Contacts can be created, saved to, or removed from the device contacts database. Contacts can also be retrieved (individually or in bulk) from the database by invoking the `contacts.find` method. +The `Contact` object represents a user contact. [Contacts](../contacts.html) can be created, saved to, or removed from the device contacts database. [Contacts](../contacts.html) can also be retrieved (individually or in bulk) from the database by invoking the `[contacts.find](../contacts.find.html)` 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._ @@ -68,7 +68,7 @@ Supported Platforms - Bada 1.2 & 2.0 - Windows 8 -Save Quick Example +Save Quick [Example](../../storage/storage.opendatabase.html) ------------------ function onSuccess(contact) { @@ -76,7 +76,7 @@ Save Quick Example }; function onError(contactError) { - alert("Error = " + contactError.code); + alert("Error = " + [contactError](../parameters/contactError.html).code); }; // create a new contact object @@ -85,7 +85,7 @@ Save Quick Example contact.nickname = "Plumber"; //specify both to support all devices // populate some fields - var name = new ContactName(); + var name = new [ContactName](../ContactName/contactname.html)(); name.givenName = "Jane"; name.familyName = "Doe"; contact.name = name; @@ -93,7 +93,7 @@ Save Quick Example // save to device contact.save(onSuccess,onError); -Clone Quick Example +Clone Quick [Example](../../storage/storage.opendatabase.html) ------------------- // clone the contact object @@ -102,7 +102,7 @@ Clone Quick Example console.log("Original contact name = " + contact.name.givenName); console.log("Cloned contact name = " + clone.name.givenName); -Remove Quick Example +Remove Quick [Example](../../storage/storage.opendatabase.html) -------------------- function onSuccess() { @@ -116,7 +116,7 @@ Remove Quick Example // remove the contact from the device contact.remove(onSuccess,onError); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -138,7 +138,7 @@ Full Example var contact = navigator.contacts.create(); contact.displayName = "Plumber"; contact.nickname = "Plumber"; //specify both to support all devices - var name = new ContactName(); + var name = new [ContactName](../ContactName/contactname.html)(); name.givenName = "Jane"; name.familyName = "Doe"; contact.name = name; @@ -165,7 +165,7 @@ Full Example // onSaveError: Failed to get the contacts // function onSaveError(contactError) { - alert("Error = " + contactError.code); + alert("Error = " + [contactError](../parameters/contactError.html).code); } // onRemoveSuccess: Get a snapshot of the current contacts @@ -177,7 +177,7 @@ Full Example // onRemoveError: Failed to get the contacts // function onRemoveError(contactError) { - alert("Error = " + contactError.code); + alert("Error = " + [contactError](../parameters/contactError.html).code); } @@ -211,16 +211,16 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks iOS Quirks ---------- -- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no ContactName specified. If there is no ContactName, then composite name, __nickname__ or "" is returned for __displayName__, respectively. +- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no [ContactName](../ContactName/contactname.html) specified. If there is no [ContactName](../ContactName/contactname.html), then composite name, __nickname__ or "" is returned for __displayName__, respectively. - __birthday:__ For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object. -- __photos:__ Returned Photo is stored in the application's temporary directory and a File URL to photo is returned. Contents of temporary folder is deleted when application exits. +- __photos:__ Returned Photo is stored in the application's temporary directory and a [File](../../file/fileobj/fileobj.html) 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`. 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 +- __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](../../splashscreen/splashscreen.show.html) 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_ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/ContactAddress/contactaddress.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/ContactAddress/contactaddress.md b/www/docs/en/2.3.0/cordova/contacts/ContactAddress/contactaddress.md index 5108d96..6bc73c3 100644 --- a/www/docs/en/2.3.0/cordova/contacts/ContactAddress/contactaddress.md +++ b/www/docs/en/2.3.0/cordova/contacts/ContactAddress/contactaddress.md @@ -23,7 +23,7 @@ title: ContactAddress ContactAddress ============== -Contains address properties for a `Contact` object. +Contains address properties for a `[Contact](../Contact/contact.html)` object. Properties ---------- @@ -39,7 +39,7 @@ Properties Details ------- -The `ContactAddress` object stores the properties of a single address of a contact. A `Contact` object can have one or more addresses in a `ContactAddress[]` array. +The `ContactAddress` object stores the properties of a single address of a contact. A `[Contact](../Contact/contact.html)` object can have one or more addresses in a `ContactAddress[]` array. Supported Platforms ------------------- @@ -51,7 +51,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- // display the address information for all contacts @@ -80,7 +80,7 @@ Quick Example var filter = ["displayName","addresses"]; navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -99,7 +99,7 @@ Full Example // function onDeviceReady() { // find all contacts - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)(); options.filter=""; var filter = ["displayName","addresses"]; navigator.contacts.find(filter, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/ContactError/contactError.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/ContactError/contactError.md b/www/docs/en/2.3.0/cordova/contacts/ContactError/contactError.md index 0c6d3c4..bb2ae8a 100644 --- a/www/docs/en/2.3.0/cordova/contacts/ContactError/contactError.md +++ b/www/docs/en/2.3.0/cordova/contacts/ContactError/contactError.md @@ -23,7 +23,7 @@ title: ContactError ContactError ======== -A `ContactError` object is returned to the `contactError` callback when an error occurs. +A `ContactError` object is returned to the `[contactError](../parameters/contactError.html)` callback when an error occurs. Properties ---------- @@ -44,5 +44,5 @@ 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](../parameters/contactError.html)` callback function when an error occurs. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/ContactField/contactfield.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/ContactField/contactfield.md b/www/docs/en/2.3.0/cordova/contacts/ContactField/contactfield.md index e9d7060..25ff6ae 100644 --- a/www/docs/en/2.3.0/cordova/contacts/ContactField/contactfield.md +++ b/www/docs/en/2.3.0/cordova/contacts/ContactField/contactfield.md @@ -23,7 +23,7 @@ title: ContactField 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](../Contact/contact.html)` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls. Properties ---------- @@ -35,9 +35,9 @@ Properties 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 `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](../Contact/contact.html)` 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. +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](../Contact/contact.html)` __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 ------------------- @@ -49,7 +49,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- // create a new contact @@ -65,7 +65,7 @@ Quick Example // save the contact contact.save(); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -97,7 +97,7 @@ Full Example contact.save(); // search contacts, returning display name and phone numbers - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)(); options.filter=""; filter = ["displayName","phoneNumbers"]; navigator.contacts.find(filter, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/ContactFindOptions/contactfindoptions.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/ContactFindOptions/contactfindoptions.md b/www/docs/en/2.3.0/cordova/contacts/ContactFindOptions/contactfindoptions.md index e4ead22..900e63c 100644 --- a/www/docs/en/2.3.0/cordova/contacts/ContactFindOptions/contactfindoptions.md +++ b/www/docs/en/2.3.0/cordova/contacts/ContactFindOptions/contactfindoptions.md @@ -23,7 +23,7 @@ title: ContactFindOptions ContactFindOptions ================== -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 `[contacts.find](../contacts.find.html)` operation. Properties ---------- @@ -42,7 +42,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- // success callback @@ -66,7 +66,7 @@ Quick Example // find contacts navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/ContactName/contactname.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/ContactName/contactname.md b/www/docs/en/2.3.0/cordova/contacts/ContactName/contactname.md index 8ca9f50..188f03e 100644 --- a/www/docs/en/2.3.0/cordova/contacts/ContactName/contactname.md +++ b/www/docs/en/2.3.0/cordova/contacts/ContactName/contactname.md @@ -23,7 +23,7 @@ title: ContactName ContactName =========== -Contains name properties of a `Contact` object. +Contains name properties of a `[Contact](../Contact/contact.html)` object. Properties ---------- @@ -50,7 +50,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- function onSuccess(contacts) { @@ -73,7 +73,7 @@ Quick Example filter = ["displayName","name"]; navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -91,7 +91,7 @@ Full Example // Cordova is ready // function onDeviceReady() { - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)(); options.filter=""; filter = ["displayName","name"]; navigator.contacts.find(filter, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/ContactOrganization/contactorganization.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/ContactOrganization/contactorganization.md b/www/docs/en/2.3.0/cordova/contacts/ContactOrganization/contactorganization.md index 851a5ca..15255a9 100644 --- a/www/docs/en/2.3.0/cordova/contacts/ContactOrganization/contactorganization.md +++ b/www/docs/en/2.3.0/cordova/contacts/ContactOrganization/contactorganization.md @@ -23,7 +23,7 @@ title: ContactOrganization ContactOrganization =================== -Contains organization properties of a `Contact` object. +Contains organization properties of a `[Contact](../Contact/contact.html)` object. Properties ---------- @@ -36,7 +36,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 `ContactOrganization` object stores a contact's organization properties. A `[Contact](../Contact/contact.html)` object stores one or more `ContactOrganization` objects in an array. Supported Platforms ------------------- @@ -48,7 +48,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- function onSuccess(contacts) { @@ -72,7 +72,7 @@ Quick Example filter = ["displayName","organizations"]; navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -90,7 +90,7 @@ Full Example // Cordova is ready // function onDeviceReady() { - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)(); options.filter=""; filter = ["displayName","organizations"]; navigator.contacts.find(filter, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/contacts.create.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/contacts.create.md b/www/docs/en/2.3.0/cordova/contacts/contacts.create.md index 9451b0c..5303eb1 100644 --- a/www/docs/en/2.3.0/cordova/contacts/contacts.create.md +++ b/www/docs/en/2.3.0/cordova/contacts/contacts.create.md @@ -23,16 +23,16 @@ title: contacts.create contacts.create =============== -Returns a new Contact object. +Returns a new [Contact](Contact/contact.html) 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 `[Contact](Contact/contact.html)` 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 [Contact](Contact/contact.html) object to the device contacts database. To persist the [Contact](Contact/contact.html) object to the device, invoke the `[Contact](Contact/contact.html).save` method. Supported Platforms ------------------- @@ -43,12 +43,12 @@ Supported Platforms - Windows Phone 7 and 8 - Bada 1.2 & 2.0 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- var myContact = navigator.contacts.create({"displayName": "Test User"}); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/contacts.find.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/contacts.find.md b/www/docs/en/2.3.0/cordova/contacts/contacts.find.md index 2f62759..aa7aab5 100644 --- a/www/docs/en/2.3.0/cordova/contacts/contacts.find.md +++ b/www/docs/en/2.3.0/cordova/contacts/contacts.find.md @@ -23,23 +23,23 @@ title: contacts.find 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](Contact/contact.html)` 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. +contacts.find is an asynchronous function that queries the device contacts database and returns an array of `[Contact](Contact/contact.html)` objects. The resulting objects are passed to the `[contactSuccess](parameters/contactSuccess.html)` 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 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 __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `[Contact](Contact/contact.html)` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter will result in an array of `[Contact](Contact/contact.html)` objects with only the `id` property populated. A __contactFields__ 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. Parameters ---------- -- __contactFields:__ Contact fields to be used as search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required] +- __contactFields:__ [Contact](Contact/contact.html) fields to be used as search qualifier. Only these fields will have values in the resulting `[Contact](Contact/contact.html)` 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] @@ -54,7 +54,7 @@ Supported Platforms - Bada 1.2 & 2.0 - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- function onSuccess(contacts) { @@ -72,7 +72,7 @@ Quick Example var fields = ["displayName", "name"]; navigator.contacts.find(fields, onSuccess, onError, options); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ @@ -91,7 +91,7 @@ Full Example // function onDeviceReady() { // find all contacts with 'Bob' in any name field - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](ContactFindOptions/contactfindoptions.html)(); options.filter="Bob"; var fields = ["displayName", "name"]; navigator.contacts.find(fields, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/contacts.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/contacts.md b/www/docs/en/2.3.0/cordova/contacts/contacts.md index 38fb2dc..f23887e 100644 --- a/www/docs/en/2.3.0/cordova/contacts/contacts.md +++ b/www/docs/en/2.3.0/cordova/contacts/contacts.md @@ -28,27 +28,27 @@ Contacts Methods ------- -- contacts.create -- contacts.find +- [contacts.create](contacts.create.html) +- [contacts.find](contacts.find.html) Arguments --------- -- contactFields -- contactSuccess -- contactError -- contactFindOptions +- [contactFields](parameters/contactFields.html) +- [contactSuccess](parameters/contactSuccess.html) +- [contactError](parameters/contactError.html) +- [contactFindOptions](parameters/contactFindOptions.html) Objects ------- -- Contact -- ContactName -- ContactField -- ContactAddress -- ContactOrganization -- ContactFindOptions -- ContactError +- [Contact](Contact/contact.html) +- [ContactName](ContactName/contactname.html) +- [ContactField](ContactField/contactfield.html) +- [ContactAddress](ContactAddress/contactaddress.html) +- [ContactOrganization](ContactOrganization/contactorganization.html) +- [ContactFindOptions](ContactFindOptions/contactfindoptions.html) +- [ContactError](ContactError/contactError.html) Permissions ----------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/parameters/contactFields.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/parameters/contactFields.md b/www/docs/en/2.3.0/cordova/contacts/parameters/contactFields.md index ae27dd7..368541b 100644 --- a/www/docs/en/2.3.0/cordova/contacts/parameters/contactFields.md +++ b/www/docs/en/2.3.0/cordova/contacts/parameters/contactFields.md @@ -23,6 +23,6 @@ title: contactFields 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 `[contacts.find](../contacts.find.html)` method. Use this parameter to specify which fields should be included in the `[Contact](../Contact/contact.html)` objects resulting from a find operation. ["name", "phoneNumbers", "emails"] http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/contacts/parameters/contactFindOptions.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/parameters/contactFindOptions.md b/www/docs/en/2.3.0/cordova/contacts/parameters/contactFindOptions.md index b166110..9459ec4 100644 --- a/www/docs/en/2.3.0/cordova/contacts/parameters/contactFindOptions.md +++ b/www/docs/en/2.3.0/cordova/contacts/parameters/contactFindOptions.md @@ -23,7 +23,7 @@ title: contactFindOptions 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](../contacts.find.html)` 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/c4881540/www/docs/en/2.3.0/cordova/contacts/parameters/contactSuccess.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/contacts/parameters/contactSuccess.md b/www/docs/en/2.3.0/cordova/contacts/parameters/contactSuccess.md index 22137b6..6b5204c 100644 --- a/www/docs/en/2.3.0/cordova/contacts/parameters/contactSuccess.md +++ b/www/docs/en/2.3.0/cordova/contacts/parameters/contactSuccess.md @@ -23,7 +23,7 @@ title: contactSuccess contactSuccess ============== -Success callback function that provides the `Contact` array resulting from a `contacts.find` operation. +Success callback function that provides the `[Contact](../Contact/contact.html)` array resulting from a `[contacts.find](../contacts.find.html)` operation. function(contacts) { // Do something @@ -32,9 +32,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. (`[Contact](../Contact/contact.html)`) -Example +[Example](../../storage/storage.opendatabase.html) ------- function contactSuccess(contacts) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/device/device.cordova.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/device/device.cordova.md b/www/docs/en/2.3.0/cordova/device/device.cordova.md index e81759d..da07b07 100644 --- a/www/docs/en/2.3.0/cordova/device/device.cordova.md +++ b/www/docs/en/2.3.0/cordova/device/device.cordova.md @@ -43,12 +43,12 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- var name = device.cordova; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/device/device.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/device/device.md b/www/docs/en/2.3.0/cordova/device/device.md index 3e50ace..5c97373 100644 --- a/www/docs/en/2.3.0/cordova/device/device.md +++ b/www/docs/en/2.3.0/cordova/device/device.md @@ -28,12 +28,12 @@ Device Properties ---------- -- device.name -- device.cordova -- device.platform -- device.uuid -- device.version -- device.model +- [device.name](device.name.html) +- [device.cordova](device.cordova.html) +- [device.platform](device.platform.html) +- [device.uuid](device.uuid.html) +- [device.version](device.version.html) +- [device.model](device.model.html) Variable Scope -------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/device/device.model.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/device/device.model.md b/www/docs/en/2.3.0/cordova/device/device.model.md index 9f0a741..1e00aa1 100644 --- a/www/docs/en/2.3.0/cordova/device/device.model.md +++ b/www/docs/en/2.3.0/cordova/device/device.model.md @@ -44,7 +44,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Android: Nexus One returns "Passion" (Nexus One code name) @@ -54,7 +54,7 @@ Quick Example // var model = device.model; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/device/device.name.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/device/device.name.md b/www/docs/en/2.3.0/cordova/device/device.name.md index 34197e8..0b82563 100644 --- a/www/docs/en/2.3.0/cordova/device/device.name.md +++ b/www/docs/en/2.3.0/cordova/device/device.name.md @@ -22,7 +22,7 @@ title: device.name 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](device.model.html) instead Get the device's model name. @@ -45,7 +45,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Android: Nexus One returns "Passion" (Nexus One code name) @@ -55,7 +55,7 @@ Quick Example // var name = device.name; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ @@ -109,4 +109,4 @@ Bada Quirks Tizen Quirks ----------- -- returns the device model assigned by the vendor. For example 'TIZEN' +- returns the [device.model](device.model.html) assigned by the vendor. For example 'TIZEN' http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/device/device.platform.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/device/device.platform.md b/www/docs/en/2.3.0/cordova/device/device.platform.md index 2992fde..904cd8c 100644 --- a/www/docs/en/2.3.0/cordova/device/device.platform.md +++ b/www/docs/en/2.3.0/cordova/device/device.platform.md @@ -39,7 +39,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Depending on the device, a few examples are: @@ -51,7 +51,7 @@ Quick Example // - "Tizen" var devicePlatform = device.platform; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/device/device.uuid.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/device/device.uuid.md b/www/docs/en/2.3.0/cordova/device/device.uuid.md index 05d6936..d61d876 100644 --- a/www/docs/en/2.3.0/cordova/device/device.uuid.md +++ b/www/docs/en/2.3.0/cordova/device/device.uuid.md @@ -44,7 +44,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Android: Returns a random 64-bit integer (as a string, again!) @@ -66,7 +66,7 @@ Quick Example // unique to every GSM and UMTS mobile phone. var deviceID = device.uuid; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/device/device.version.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/device/device.version.md b/www/docs/en/2.3.0/cordova/device/device.version.md index b3106ca..8bba560 100644 --- a/www/docs/en/2.3.0/cordova/device/device.version.md +++ b/www/docs/en/2.3.0/cordova/device/device.version.md @@ -39,7 +39,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Android: Froyo OS would return "2.2" @@ -55,7 +55,7 @@ Quick Example // Tizen: returns "TIZEN_20120425_2" var deviceVersion = device.version; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.backbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.backbutton.md b/www/docs/en/2.3.0/cordova/events/events.backbutton.md index e9d9561..00bd270 100644 --- a/www/docs/en/2.3.0/cordova/events/events.backbutton.md +++ b/www/docs/en/2.3.0/cordova/events/events.backbutton.md @@ -32,7 +32,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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -41,7 +41,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - Windows Phone 7 and 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("backbutton", onBackKeyDown, false); @@ -50,7 +50,7 @@ Quick Example // Handle the back button } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.batterycritical.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.batterycritical.md b/www/docs/en/2.3.0/cordova/events/events.batterycritical.md index 0ba9bb3..04f4129 100644 --- a/www/docs/en/2.3.0/cordova/events/events.batterycritical.md +++ b/www/docs/en/2.3.0/cordova/events/events.batterycritical.md @@ -37,7 +37,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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -47,7 +47,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - Tizen -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- window.addEventListener("batterycritical", onBatteryCritical, false); @@ -57,7 +57,7 @@ Quick Example alert("Battery Level Critical " + info.level + "%\nRecharge Soon!"); } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.batterylow.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.batterylow.md b/www/docs/en/2.3.0/cordova/events/events.batterylow.md index 60579d3..35bb879 100644 --- a/www/docs/en/2.3.0/cordova/events/events.batterylow.md +++ b/www/docs/en/2.3.0/cordova/events/events.batterylow.md @@ -37,7 +37,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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -47,7 +47,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - Tizen -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- window.addEventListener("batterylow", onBatteryLow, false); @@ -57,7 +57,7 @@ Quick Example alert("Battery Level Low " + info.level + "%"); } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.batterystatus.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.batterystatus.md b/www/docs/en/2.3.0/cordova/events/events.batterystatus.md index 69ce955..63f2dce 100644 --- a/www/docs/en/2.3.0/cordova/events/events.batterystatus.md +++ b/www/docs/en/2.3.0/cordova/events/events.batterystatus.md @@ -37,7 +37,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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -55,7 +55,7 @@ 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 [Example](../storage/storage.opendatabase.html) ------------- window.addEventListener("batterystatus", onBatteryStatus, false); @@ -65,7 +65,7 @@ Quick Example console.log("Level: " + info.level + " isPlugged: " + info.isPlugged); } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.deviceready.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.deviceready.md b/www/docs/en/2.3.0/cordova/events/events.deviceready.md index b18df25..db1f6d5 100644 --- a/www/docs/en/2.3.0/cordova/events/events.deviceready.md +++ b/www/docs/en/2.3.0/cordova/events/events.deviceready.md @@ -51,7 +51,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("deviceready", onDeviceReady, false); @@ -60,7 +60,7 @@ Quick Example // Now safe to use the Cordova API } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.endcallbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.endcallbutton.md b/www/docs/en/2.3.0/cordova/events/events.endcallbutton.md index ab72f77..9837478 100644 --- a/www/docs/en/2.3.0/cordova/events/events.endcallbutton.md +++ b/www/docs/en/2.3.0/cordova/events/events.endcallbutton.md @@ -32,14 +32,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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- - BlackBerry WebWorks (OS 5.0 and higher) -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("endcallbutton", onEndCallKeyDown, false); @@ -48,7 +48,7 @@ Quick Example // Handle the end call button } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.online.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.online.md b/www/docs/en/2.3.0/cordova/events/events.online.md index 3959a97..a89b9d1 100644 --- a/www/docs/en/2.3.0/cordova/events/events.online.md +++ b/www/docs/en/2.3.0/cordova/events/events.online.md @@ -32,7 +32,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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -44,7 +44,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("online", onOnline, false); @@ -53,7 +53,7 @@ Quick Example // Handle the online event } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.pause.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.pause.md b/www/docs/en/2.3.0/cordova/events/events.pause.md index 5a6462b..ec63a70 100644 --- a/www/docs/en/2.3.0/cordova/events/events.pause.md +++ b/www/docs/en/2.3.0/cordova/events/events.pause.md @@ -32,7 +32,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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -43,7 +43,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("pause", onPause, false); @@ -52,7 +52,7 @@ Quick Example // Handle the pause event } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.resume.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.resume.md b/www/docs/en/2.3.0/cordova/events/events.resume.md index ed8818a..5611162 100644 --- a/www/docs/en/2.3.0/cordova/events/events.resume.md +++ b/www/docs/en/2.3.0/cordova/events/events.resume.md @@ -32,7 +32,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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -43,7 +43,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("resume", onResume, false); @@ -52,7 +52,7 @@ Quick Example // Handle the resume event } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/events/events.searchbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/events/events.searchbutton.md b/www/docs/en/2.3.0/cordova/events/events.searchbutton.md index e656435..f75ff5d 100644 --- a/www/docs/en/2.3.0/cordova/events/events.searchbutton.md +++ b/www/docs/en/2.3.0/cordova/events/events.searchbutton.md @@ -32,14 +32,14 @@ Details If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' 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 '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- - Android -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("searchbutton", onSearchKeyDown, false); @@ -48,7 +48,7 @@ Quick Example // Handle the search button } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ title: File --- -File +[File](fileobj/fileobj.html) ========== > This API is based on the W3C [File API](http://www.w3.org/TR/FileAPI). An API to read, write and navigate file system hierarchies. @@ -28,21 +28,21 @@ File Objects ------- -- DirectoryEntry -- DirectoryReader -- File -- FileEntry -- FileError -- FileReader -- FileSystem -- FileTransfer -- FileTransferError -- FileUploadOptions -- FileUploadResult -- FileWriter -- Flags -- LocalFileSystem -- Metadata +- [DirectoryEntry](directoryentry/directoryentry.html) +- [DirectoryReader](directoryreader/directoryreader.html) +- [File](fileobj/fileobj.html) +- [FileEntry](fileentry/fileentry.html) +- [FileError](fileerror/fileerror.html) +- [FileReader](filereader/filereader.html) +- [FileSystem](filesystem/filesystem.html) +- [FileTransfer](filetransfer/filetransfer.html) +- [FileTransferError](filetransfererror/filetransfererror.html) +- [FileUploadOptions](fileuploadoptions/fileuploadoptions.html) +- [FileUploadResult](fileuploadresult/fileuploadresult.html) +- [FileWriter](filewriter/filewriter.html) +- [Flags](flags/flags.html) +- [LocalFileSystem](localfilesystem/localfilesystem.html) +- [Metadata](metadata/metadata.html) Permissions ----------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/file/fileentry/fileentry.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/file/fileentry/fileentry.md b/www/docs/en/2.3.0/cordova/file/fileentry/fileentry.md index 9e8b758..0e4e105 100644 --- a/www/docs/en/2.3.0/cordova/file/fileentry/fileentry.md +++ b/www/docs/en/2.3.0/cordova/file/fileentry/fileentry.md @@ -48,8 +48,8 @@ Methods - __toURL__: Return a URL that can be used to locate a file. - __remove__: Delete a file. - __getParent__: Look up the parent directory. -- __createWriter__: Creates a FileWriter object that can be used to write to a file. -- __file__: Creates a File object containing file properties. +- __createWriter__: Creates a [FileWriter](../filewriter/filewriter.html) object that can be used to write to a file. +- __file__: Creates a [File](../fileobj/fileobj.html) object containing file properties. Supported Platforms @@ -69,8 +69,8 @@ Look up metadata about a file. __Parameters:__ -- __successCallback__ - A callback that is called with a Metadata object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_ +- __successCallback__ - A callback that is called with a [Metadata](../metadata/metadata.html) object. _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_ __Quick Example__ @@ -147,7 +147,7 @@ __Quick Example__ window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail); } - setFileMetadata(LocalFileSystem.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1); + setFileMetadata([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1); moveTo ------ @@ -164,7 +164,7 @@ __Parameters:__ - __parent__ - The parent directory to which to move the file. _(DirectoryEntry)_ - __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_ - __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_ __Quick Example__ @@ -199,7 +199,7 @@ __Parameters:__ - __parent__ - The parent directory to which to copy the file. _(DirectoryEntry)_ - __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_ - __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_ __Quick Example__ @@ -242,7 +242,7 @@ Deletes a file. __Parameters:__ - __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_ __Quick Example__ @@ -261,12 +261,12 @@ __Quick Example__ getParent --------- -Look up the parent DirectoryEntry containing the file. +Look up the parent [DirectoryEntry](../directoryentry/directoryentry.html) containing the file. __Parameters:__ -- __successCallback__ - A callback that is called with the file's parent DirectoryEntry. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_ +- __successCallback__ - A callback that is called with the file's parent [DirectoryEntry](../directoryentry/directoryentry.html). _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent [DirectoryEntry](../directoryentry/directoryentry.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_ __Quick Example__ @@ -285,12 +285,12 @@ __Quick Example__ createWriter ------------ -Create a FileWriter object associated with the file that the FileEntry represents. +Create a [FileWriter](../filewriter/filewriter.html) object associated with the file that the FileEntry represents. __Parameters:__ -- __successCallback__ - A callback that is called with a FileWriter object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs while attempting to create the FileWriter. Invoked with a FileError object. _(Function)_ +- __successCallback__ - A callback that is called with a [FileWriter](../filewriter/filewriter.html) object. _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs while attempting to create the [FileWriter](../filewriter/filewriter.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_ __Quick Example__ @@ -309,12 +309,12 @@ __Quick Example__ file ---- -Return a File object that represents the current state of the file that this FileEntry represents. +Return a [File](../fileobj/fileobj.html) object that represents the current state of the file that this FileEntry represents. __Parameters:__ -- __successCallback__ - A callback that is called with a File object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when creating the File object (e.g. the underlying file no longer exists). Invoked with a FileError object. _(Function)_ +- __successCallback__ - A callback that is called with a [File](../fileobj/fileobj.html) object. _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs when creating the [File](../fileobj/fileobj.html) object (e.g. the underlying file no longer exists). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_ __Quick Example__ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/file/fileerror/fileerror.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/file/fileerror/fileerror.md b/www/docs/en/2.3.0/cordova/file/fileerror/fileerror.md index dac6d35..3a4068c 100644 --- a/www/docs/en/2.3.0/cordova/file/fileerror/fileerror.md +++ b/www/docs/en/2.3.0/cordova/file/fileerror/fileerror.md @@ -23,7 +23,7 @@ title: FileError FileError ======== -A 'FileError' object is set when an error occurs in any of the File API methods. +A 'FileError' object is set when an error occurs in any of the [File](../fileobj/fileobj.html) API methods. Properties ---------- @@ -49,4 +49,4 @@ Constants Description ----------- -The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error. \ No newline at end of file +The `FileError` object is the only parameter of any of the [File](../fileobj/fileobj.html) API's error callbacks. Developers must read the code property to determine the type of error. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/file/fileobj/fileobj.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/file/fileobj/fileobj.md b/www/docs/en/2.3.0/cordova/file/fileobj/fileobj.md index 8802f53..d550a8e 100644 --- a/www/docs/en/2.3.0/cordova/file/fileobj/fileobj.md +++ b/www/docs/en/2.3.0/cordova/file/fileobj/fileobj.md @@ -37,7 +37,7 @@ Properties Details ------- -The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object. +The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `[FileEntry](../fileentry/fileentry.html)` object. Supported Platforms ------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/file/filereader/filereader.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/file/filereader/filereader.md b/www/docs/en/2.3.0/cordova/file/filereader/filereader.md index 0671a85..98e214b 100644 --- a/www/docs/en/2.3.0/cordova/file/filereader/filereader.md +++ b/www/docs/en/2.3.0/cordova/file/filereader/filereader.md @@ -66,7 +66,7 @@ __Parameters:__ - file - the file object to read -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- function win(file) { @@ -92,7 +92,7 @@ __Parameters:__ - file - the file object to read - encoding - the encoding to use to encode the file's content. Default is UTF8. -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- function win(file) { @@ -110,7 +110,7 @@ Quick Example entry.file(win, fail); -Abort Quick Example +Abort Quick [Example](../../storage/storage.opendatabase.html) ------------------- function win(file) { @@ -129,7 +129,7 @@ Abort Quick Example entry.file(win, fail); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -149,7 +149,7 @@ Full Example // Cordova is ready // function onDeviceReady() { - window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail); + window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, gotFS, fail); } function gotFS(fileSystem) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/2.3.0/cordova/file/filesystem/filesystem.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.3.0/cordova/file/filesystem/filesystem.md b/www/docs/en/2.3.0/cordova/file/filesystem/filesystem.md index e24992c..2873a82 100644 --- a/www/docs/en/2.3.0/cordova/file/filesystem/filesystem.md +++ b/www/docs/en/2.3.0/cordova/file/filesystem/filesystem.md @@ -34,7 +34,7 @@ Properties Details ------- -The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `DirectoryEntry` object which represents the root directory of the file system. +The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `[DirectoryEntry](../directoryentry/directoryentry.html)` object which represents the root directory of the file system. Supported Platforms ------------------- @@ -45,7 +45,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -File System Quick Example +[File](../fileobj/fileobj.html) System Quick [Example](../../storage/storage.opendatabase.html) ------------------------- function onSuccess(fileSystem) { @@ -54,9 +54,9 @@ File System Quick Example } // request the persistent file system - window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null); + window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, onSuccess, null); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -74,7 +74,7 @@ Full Example // Cordova is ready // function onDeviceReady() { - window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail); + window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, onFileSystemSuccess, fail); } function onFileSystemSuccess(fileSystem) { --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org For additional commands, e-mail: commits-help@cordova.apache.org