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 A46D7E559 for ; Tue, 19 Feb 2013 22:27:21 +0000 (UTC) Received: (qmail 61866 invoked by uid 500); 19 Feb 2013 22:27:19 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 61795 invoked by uid 500); 19 Feb 2013 22:27:19 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 60620 invoked by uid 99); 19 Feb 2013 22:27:17 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 19 Feb 2013 22:27:17 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 9475D82CC4F; Tue, 19 Feb 2013 22:27:17 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mwbrooks@apache.org To: commits@cordova.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [21/52] [partial] [#2454] Remove versions pre-dating Apache Cordova. Message-Id: <20130219222717.9475D82CC4F@tyr.zones.apache.org> Date: Tue, 19 Feb 2013 22:27:17 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/camera/parameter/cameraOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/camera/parameter/cameraOptions.md b/docs/en/1.0.0rc1/phonegap/camera/parameter/cameraOptions.md deleted file mode 100644 index ec2f47b..0000000 --- a/docs/en/1.0.0rc1/phonegap/camera/parameter/cameraOptions.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -cameraOptions -============= - -Optional parameters to customize the camera settings. - - { quality : 75, - destinationType : Camera.DestinationType.DATA_URL, - sourceType : Camera.PictureSourceType.CAMERA, - allowEdit : true }; - -Options -------- - -- __quality:__ Quality of saved image. Range is [0, 100]. (`Number`) - -- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`) - - Camera.DestinationType = { - DATA_URL : 0, // Return image as base64 encoded string - FILE_URI : 1 // Return image file URI - }; - -- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`) - - Camera.PictureSourceType = { - PHOTOLIBRARY : 0, - CAMERA : 1, - SAVEDPHOTOALBUM : 2 - }; - -- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`) - -Android Quirks --------------- - -- Ignores the `allowEdit` parameter. -- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album. - -BlackBerry Quirks ------------------ - -- Ignores the `quality` parameter. -- Ignores the `sourceType` parameter. -- Ignores the `allowEdit` parameter. -- Application must have key injection permissions to close native Camera application after photo is taken. -- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800). - -Palm Quirks ------------ - -- Ignores the `quality` parameter. -- Ignores the `sourceType` parameter. -- Ignores the `allowEdit` parameter. - -iPhone Quirks --------------- - -- Set `quality` below 50 to avoid memory error on some devices. -- When `destinationType.FILE_URI` is used, photos taken with the camera and edited photos are saved in the application's Documents/tmp directory. -- The application's Documents/tmp directory is deleted when the application ends. Developers may also delete this directory using the navigator.fileMgr APIs if storage space is a concern. - - navigator.fileMgr.deleteDirectory("tmp", onSuccess, onFail); - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/camera/parameter/cameraSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/camera/parameter/cameraSuccess.md b/docs/en/1.0.0rc1/phonegap/camera/parameter/cameraSuccess.md deleted file mode 100644 index 773fba4..0000000 --- a/docs/en/1.0.0rc1/phonegap/camera/parameter/cameraSuccess.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -cameraSuccess -============= - -onSuccess callback function that provides the image data. - - function(imageData) { - // Do something with the image - } - -Parameters ----------- - -- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`) - -Example -------- - - // Show image - // - function cameraCallback(imageData) { - var image = document.getElementById('myImage'); - image.src = "data:image/jpeg;base64," + imageData; - } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/compass/compass.clearWatch.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/compass/compass.clearWatch.md b/docs/en/1.0.0rc1/phonegap/compass/compass.clearWatch.md deleted file mode 100755 index 07274d2..0000000 --- a/docs/en/1.0.0rc1/phonegap/compass/compass.clearWatch.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -compass.clearWatch -======================== - -Stop watching the compass referenced by the watch ID parameter. - - navigator.compass.clearWatch(watchID); - -- __watchID__: The ID returned by `compass.watchHeading`. - -Supported Platforms -------------------- - -- Android -- iPhone - -Quick Example -------------- - - var watchID = navigator.compass.watchHeading(onSuccess, onError, options); - - // ... later on ... - - navigator.compass.clearWatch(watchID); - -Full Example ------------- - - - - - Compass Example - - - - - -
Waiting for heading...
- - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/compass/compass.getCurrentHeading.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/compass/compass.getCurrentHeading.md b/docs/en/1.0.0rc1/phonegap/compass/compass.getCurrentHeading.md deleted file mode 100755 index c8778af..0000000 --- a/docs/en/1.0.0rc1/phonegap/compass/compass.getCurrentHeading.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -compass.getCurrentHeading -========================= - -Get the current compass heading. - - navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions); - -Description ------------ - -The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99. - -The compass heading is returned using the `compassSuccess` callback function. - -Supported Platforms -------------------- - -- Android -- iPhone - -Quick Example -------------- - - function onSuccess(heading) { - alert('Heading: ' + heading); - }; - - function onError() { - alert('onError!'); - }; - - navigator.compass.getCurrentHeading(onSuccess, onError); - -Full Example ------------- - - - - - Compass Example - - - - - -

Example

-

getCurrentHeading

- - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/compass/compass.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/compass/compass.md b/docs/en/1.0.0rc1/phonegap/compass/compass.md deleted file mode 100755 index 48c6046..0000000 --- a/docs/en/1.0.0rc1/phonegap/compass/compass.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Compass -======= - -> Obtains the direction that the device is pointing. - -Methods -------- - -- compass.getCurrentHeading -- compass.watchHeading -- compass.clearWatch - -Arguments ---------- - -- compassSuccess -- compassError -- compassOptions http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/compass/compass.watchHeading.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/compass/compass.watchHeading.md b/docs/en/1.0.0rc1/phonegap/compass/compass.watchHeading.md deleted file mode 100755 index 8f4b3f0..0000000 --- a/docs/en/1.0.0rc1/phonegap/compass/compass.watchHeading.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -compass.watchHeading -==================== - -At a regular interval, get the compass heading in degrees. - - var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]); - -Description ------------ - -The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99. - -The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object. - -The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass. - -Supported Platforms -------------------- - -- Android -- iPhone - - -Quick Example -------------- - - function onSuccess(heading) { - var element = document.getElementById('heading'); - element.innerHTML = 'Heading: ' + heading; - }; - - function onError() { - alert('onError!'); - }; - - var options = { frequency: 3000 }; // Update every 3 seconds - - var watchID = navigator.compass.watchHeading(onSuccess, onError, options); - -Full Example ------------- - - - - - Compass Example - - - - - -
Waiting for heading...
- - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/compass/parameters/compassError.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/compass/parameters/compassError.md b/docs/en/1.0.0rc1/phonegap/compass/parameters/compassError.md deleted file mode 100755 index b65b056..0000000 --- a/docs/en/1.0.0rc1/phonegap/compass/parameters/compassError.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -compassError -============ - -onError callback function for compass functions. - - function() { - // Handle the error - } - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/compass/parameters/compassOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/compass/parameters/compassOptions.md b/docs/en/1.0.0rc1/phonegap/compass/parameters/compassOptions.md deleted file mode 100755 index ef9b7fa..0000000 --- a/docs/en/1.0.0rc1/phonegap/compass/parameters/compassOptions.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -compassOptions -============== - -An optional parameter to customize the retrieval of the compass. - -Options -------- - -- __frequency:__ How often to retrieve the compass heading in milliseconds. _(Number)_ (Default: 100) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/compass/parameters/compassSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/compass/parameters/compassSuccess.md b/docs/en/1.0.0rc1/phonegap/compass/parameters/compassSuccess.md deleted file mode 100755 index 7663046..0000000 --- a/docs/en/1.0.0rc1/phonegap/compass/parameters/compassSuccess.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -compassSuccess -============== - -onSuccess callback function that provides the compass heading information. - - function(heading) { - // Do something - } - -Parameters ----------- - -- __heading:__ The heading in degrees from 0 - 359.99 at a single moment in time. _(Number)_ - -Example -------- - - function onSuccess(heading) { - alert('Heading: ' + heading); - }; http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/connection/connection.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/connection/connection.md b/docs/en/1.0.0rc1/phonegap/connection/connection.md deleted file mode 100644 index f550d63..0000000 --- a/docs/en/1.0.0rc1/phonegap/connection/connection.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Connection -========== - -> The `connection` object gives access to the device's cellular and wifi connection information. - -This object is accessed under the navigator.network interface. - -Properties ----------- - -- connection.type - -Constants ---------- - -- Connection.UNKNOWN -- Connection.ETHERNET -- Connection.WIFI -- Connection.CELL_2G -- Connection.CELL_3G -- Connection.CELL_4G -- Connection.NONE - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/connection/connection.type.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/connection/connection.type.md b/docs/en/1.0.0rc1/phonegap/connection/connection.type.md deleted file mode 100644 index 2697bf3..0000000 --- a/docs/en/1.0.0rc1/phonegap/connection/connection.type.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -connection.type -=================== - -Checks the active network connection that is being used. - -Description ------------ - -This property is a fast way to determine the device's network connection state, and type of connection. - - -Supported Platforms -------------------- - -- iOS -- Android -- BlackBerry WebWorks (OS 5.0 and higher) - -Quick Example -------------- - - function checkConnection() { - var networkState = navigator.network.connection.type; - - var states = {}; - states[Connection.UNKNOWN] = 'Unknown connection'; - states[Connection.ETHERNET] = 'Ethernet connection'; - states[Connection.WIFI] = 'WiFi connection'; - states[Connection.CELL_2G] = 'Cell 2G connection'; - states[Connection.CELL_3G] = 'Cell 3G connection'; - states[Connection.CELL_4G] = 'Cell 4G connection'; - states[Connection.NONE] = 'No network connection'; - - alert('Connection type: ' + states[networkState]); - } - - checkConnection(); - - -Full Example ------------- - - - - - navigator.network.connection.type Example - - - - - -

A dialog box will report the network state.

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/Contact/contact.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/Contact/contact.md b/docs/en/1.0.0rc1/phonegap/contacts/Contact/contact.md deleted file mode 100644 index fae8dd0..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/Contact/contact.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Contact -======= - -Contains properties that describe a contact, such as a user's personal or business contact. - -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)_ -- __phoneNumbers:__ An array of all the contact's phone numbers. _(ContactField[])_ -- __emails:__ An array of all the contact's email addresses. _(ContactField[])_ -- __addresses:__ An array of all the contact's addresses. _(ContactAddresses[])_ -- __ims:__ An array of all the contact's IM addresses. _(ContactField[])_ -- __organizations:__ An array of all the contact's organizations. _(ContactOrganization[])_ -- __revision:__ The last date the contact was revised. _(DOMString)_ -- __birthday:__ The birthday of the contact. _(Date)_ -- __gender:__ The gender of the contact. _(DOMString)_ -- __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[])_ -- __timezone:__ The timezone of the contact. _(DOMString)_ - -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. -- __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. - -_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._ - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Save Quick Example ------------------- - - function onSuccess(contacts) { - alert("Save Success"); - }; - - function onError(contactError) { - alert("Error = " + contactError.code); - }; - - // create a new contact object - var contact = navigator.service.contacts.create(); - contact.displayName = "Plumber"; - contact.nickname = "Plumber"; //specify both to support all devices - - // populate some fields - var name = new ContactName(); - name.givenName = "Jane"; - name.familyName = "Doe"; - contact.name = name; - - // save to device - contact.save(onSuccess,onError); - -Clone Quick Example -------------------- - - // clone the contact object - var clone = contact.clone(); - clone.name.givenName = "John"; - console.log("Original contact name = " + contact.name.givenName); - console.log("Cloned contact name = " + clone.name.givenName); - -Remove Quick Example --------------------- - - function onSuccess() { - alert("Removal Success"); - }; - - function onError(contactError) { - alert("Error = " + contactError.code); - }; - - // remove the contact from the device - contact.remove(onSuccess,onError); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

Find Contacts

- - - -Android 2.X Quirks ------------------- - -- __revision:__ This property is not support by Android 2.X devices, and will always be returned as `null`. -- __gender:__ This property is not support by Android 2.X devices, and will always be returned as `null`. -- __categories:__ This property is not support by Android 2.X devices, and will always be returned as `null`. -- __timezone:__ This property is not support by Android 2.X devices, and will always be returned as `null`. - -Android 1.X Quirks ------------------- - -- __name:__ This property is not support by Android 1.X devices, and will always be returned as `null`. -- __nickname:__ This property is not support by Android 1.X devices, and will always be returned as `null`. -- __revision:__ This property is not support by Android 1.X devices, and will always be returned as `null`. -- __birthday:__ This property is not support by Android 1.X devices, and will always be returned as `null`. -- __gender:__ This property is not support by Android 1.X devices, and will always be returned as `null`. -- __photos:__ This property is not support by Android 1.X devices, and will always be returned as `null`. -- __categories:__ This property is not support by Android 1.X devices, and will always be returned as `null`. -- __urls:__ This property is not support by Android 1.X devices, and will always be returned as `null`. -- __timezone:__ This property is not support by Android 1.X devices, and will always be returned as `null`. - -BlackBerry WebWorks (OS 5.0 and higher) Quirks ---------------------------------------------- - -- __id:__ Supported. Assigned by device when contact is saved. -- __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`. -- __organizations:__ Partially supported. The __name__ and __title__ of the first organization are stored in the BlackBerry __company__ and __title__ fields, respectively. -- __revision:__ This property is not supported, and will always be returned as `null`. -- __gender:__ This property is not supported, and will always be returned as `null`. -- __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. -- __timezone:__ This property is not supported, and will always be returned as `null`. - -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. -- __revision:__ This property is output only and can not be modified. It is returned as a JavaScript Date object. -- __birthday:__ For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object. -- __gender:__ This property is not supported by iOS devices, and will always be returned as `null`. -- __photos:__ Returned Photo is stored in the application's temporary directory and a File URL to photo is returned. Temporary folder is deleted when application exits. -- __categories:__ This property is not currently supported and will always be returned as `null`. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/ContactAddress/contactaddress.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/ContactAddress/contactaddress.md b/docs/en/1.0.0rc1/phonegap/contacts/ContactAddress/contactaddress.md deleted file mode 100644 index 1993c26..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/ContactAddress/contactaddress.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -ContactAddress -============== - -Contains address properties for a `Contact` object. - -Properties ----------- - -- __formatted:__ The full address formatted for display. _(DOMString)_ -- __streetAddress:__ The full street address. _(DOMString)_ -- __locality:__ The city or locality. _(DOMString)_ -- __region:__ The state or region. _(DOMString)_ -- __postalCode:__ The zip code or postal code. _(DOMString)_ -- __country:__ The country name. _(DOMString)_ - -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. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - // display the address information for all contacts - function onSuccess(contacts) { - for (var i=0; i - - - Contact Example - - - - - -

Example

-

Find Contacts

- - - -Android 1.X Quirks ------------------- - -- __streetAddress:__ This property is not support by Android 1.X devices, and will always return `null`. -- __locality:__ This property is not support by Android 1.X devices, and will always return `null`. -- __region:__ This property is not support by Android 1.X devices, and will always return `null`. -- __postalCode:__ This property is not support by Android 1.X devices, and will always return `null`. -- __country:__ This property is not support by Android 1.X devices, and will always return `null`. - -BlackBerry WebWorks (OS 5.0 and higher) Quirks --------------------------------------------- - -- __formatted:__ Partially supported. Will return concatenation of all BlackBerry address fields. -- __streetAddress:__ Supported. Will return 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. -- __country:__ Supported. - -iOS Quirks ----------- -- __formatted:__ Not currently supported. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/ContactError/contactError.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/ContactError/contactError.md b/docs/en/1.0.0rc1/phonegap/contacts/ContactError/contactError.md deleted file mode 100644 index 1f86df7..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/ContactError/contactError.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -ContactError -======== - -A `ContactError` object is returned to the `contactError` callback when an error occurs. - -Properties ----------- - -- __code:__ One of the predefined error codes listed below. - -Constants ---------- - -- `ContactError.UNKNOWN_ERROR` -- `ContactError.INVALID_ARGUMENT_ERROR` -- `ContactError.NOT_FOUND_ERROR` -- `ContactError.TIMEOUT_ERROR` -- `ContactError.PENDING_OPERATION_ERROR` -- `ContactError.IO_ERROR` -- `ContactError.NOT_SUPPORTED_ERROR` -- `ContactError.PERMISSION_DENIED_ERROR` - -Description ------------ - -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/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/ContactField/contactfield.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/ContactField/contactfield.md b/docs/en/1.0.0rc1/phonegap/contacts/ContactField/contactfield.md deleted file mode 100644 index e57f2c0..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/ContactField/contactfield.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -ContactField -============ - -Supports generic fields in a `Contact` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls. - -Properties ----------- - -- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)_ -- __value:__ The value of the field (such as a phone number or email address). _(DOMString)_ -- __pref:__ Set to `true` if this `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, PhoneGap makes use of the __type__ field to indicate the format of the returned image. PhoneGap will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - // create a new contact - var contact = navigator.service.contacts.create(); - - // store contact phone numbers in ContactField[] - var phoneNumbers = []; - phoneNumbers[0] = new ContactField('work', '212-555-1234', false); - phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number - phoneNumbers[2] = new ContactField('home', '203-555-7890', false); - contact.phoneNumbers = phoneNumbers; - - // save the contact - contact.save(); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

Find Contacts

- - - -Android Quirks --------------- - -- __pref:__ This property is not support by Android devices, and will always return `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`. - -iOS Quirks ------------ -- __pref:__ This property is not supported on iOS devices and will always return `false`. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/ContactFindOptions/contactfindoptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/1.0.0rc1/phonegap/contacts/ContactFindOptions/contactfindoptions.md deleted file mode 100644 index 5139edf..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/ContactFindOptions/contactfindoptions.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -ContactFindOptions -================== - -Contains properties that can be used to filter the results of a `contacts.find` operation. - -Properties ----------- - -- __filter:__ The search string used to find contacts. _(DOMString)_ (Default: "") -- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: true) -- __updatedSince:__ Only return contacts updated since the date specified. _(Date)_ (Default: "") - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - // success callback - function onSuccess(contacts) { - for (var i=0; i - - - Contact Example - - - - - -

Example

-

Find Contacts

- - - -Android Quirks ----------- -- __updatedSince:__ Not currently supported. - -BlackBerry WebWorks (OS 5.0 and higher) Quirks ---------------------------------------------- -- __updatedSince:__ Not currently supported. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/ContactName/contactname.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/ContactName/contactname.md b/docs/en/1.0.0rc1/phonegap/contacts/ContactName/contactname.md deleted file mode 100644 index 4e0ec81..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/ContactName/contactname.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -ContactName -=========== - -Contains name properties of a `Contact` object. - -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)_ - -Details -------- - -The `ContactName` object stores name properties of a contact. - -Supported Platforms -------------------- - -- Android 2.X -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - function onSuccess(contacts) { - for (var i=0; i - - - Contact Example - - - - - -

Example

-

Find Contacts

- - - -Android Quirks ------------- -- __formatted:__ Partially supported. Will return the concatenation of honorificPrefix, givenName, middleName, familyName and honorificSuffix but will not store. - -BlackBerry WebWorks (OS 5.0 and higher) Quirks ---------------------------------------------- - -- __formatted:__ Partially supported. Will return 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`. - -iOS Quirks ------------- -- __formatted:__ Partially supported. Will return iOS Composite Name but will not store. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/ContactOrganization/contactorganization.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/ContactOrganization/contactorganization.md b/docs/en/1.0.0rc1/phonegap/contacts/ContactOrganization/contactorganization.md deleted file mode 100644 index ed7278e..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/ContactOrganization/contactorganization.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -ContactOrganization -=================== - -Contains organization properties of a `Contact` object. - -Properties ----------- - -- __name:__ The name of the organization. _(DOMString)_ -- __department:__ The department the contract works for. _(DOMString)_ -- __title:__ The contacts 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. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - function onSuccess(contacts) { - for (var i=0; i - - - Contact Example - - - - - -

Example

-

Find Contacts

- - - -Android 1.X Quirks ------------------- - -- __title:__ This property is not support by Android 1.X devices, and will always be returned as `null`. - -BlackBerry WebWorks (OS 5.0 and higher) Quirks --------------------------------------------- - -- __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. - -iOS Quirks ------------ -- __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. - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/contacts.create.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/contacts.create.md b/docs/en/1.0.0rc1/phonegap/contacts/contacts.create.md deleted file mode 100644 index 50e57a3..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/contacts.create.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -contacts.create -=============== - -Returns a new Contact object. - - var contact = navigator.service.contacts.create(properties); - -Description ------------ - -contacts.create is a synchronous function that 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. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - var myContact = navigator.service.contacts.create({"displayName": "Test User"}); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

Create Contact

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/contacts.find.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/contacts.find.md b/docs/en/1.0.0rc1/phonegap/contacts/contacts.find.md deleted file mode 100644 index c2287ad..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/contacts.find.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -contacts.find -============= - -Queries the device contacts database and returns one or more `Contact` objects, each containing the fields specified. - - navigator.service.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. - -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. - -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] -- __contactSuccess:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required] -- __contactError:__ Error callback function. Invoked when error occurs. [Optional] -- __contactFindOptions:__ Search options to filter contacts. [Optional] - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - function onSuccess(contacts) { - alert('Found ' + contacts.length + ' contacts.'); - }; - - function onError() { - alert('onError!'); - }; - - // find all contacts with 'Bob' in any name field - var options = new ContactFindOptions(); - options.filter="Bob"; - var fields = ["displayName", "name"]; - navigator.service.contacts.find(fields, onSuccess, onError, options); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

Find Contacts

- - - -iOS Quirks ----------- -- iOS returns null for array properties that have no results, other platforms return an empty array. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/contacts.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/contacts.md b/docs/en/1.0.0rc1/phonegap/contacts/contacts.md deleted file mode 100644 index 90b49b5..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/contacts.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Contacts -======== - -> The `contacts` object provides access to the device contacts database. - -Methods -------- - -- contacts.create -- contacts.find - -Arguments ---------- - -- contactFields -- contactSuccess -- contactError -- contactFindOptions - -Objects -------- - -- Contact -- ContactName -- ContactField -- ContactAddress -- ContactOrganization -- ContactFindOptions -- ContactError \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactError.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactError.md b/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactError.md deleted file mode 100644 index 6b50ddc..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactError.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -contactError -============ - -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/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactFields.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactFields.md b/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactFields.md deleted file mode 100644 index 66c9d3d..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactFields.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -contactFields -============= - -Required parameter of the `contacts.find` method. Use this parameter to specify which fields should be included in the `Contact` objects resulting from a find operation. - - ["name", "phoneNumbers", "emails"] http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactFindOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactFindOptions.md b/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactFindOptions.md deleted file mode 100644 index 98ddd08..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactFindOptions.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -contactFindOptions -================== - -Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database. - - { - filter: "", - multiple: true, - updatedSince: "" - }; - -Options -------- - -- __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: "") -- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: true) -- __updatedSince:__ Only return contacts updated since the date specified. _(Date)_ (Default: "") - -Android Quirks ----------- -- __updatedSince:__ Not currently supported. - -BlackBerry WebWorks (OS 5.0 and higher) Quirks ---------------------------------------------- -- __updatedSince:__ Not currently supported. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactSuccess.md b/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactSuccess.md deleted file mode 100644 index 9068218..0000000 --- a/docs/en/1.0.0rc1/phonegap/contacts/parameters/contactSuccess.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -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 - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -contactSuccess -============== - -Success callback function that provides the `Contact` array resulting from a `contacts.find` operation. - - function(contacts) { - // Do something - } - -Parameters ----------- - -- __contacts:__ The contact array resulting from a find operation. (`Contact`) - -Example -------- - - function contactSuccess(contacts) { - for (var i=0; i The `device` object describes the device's hardware and software. - -Properties ----------- - -- device.name -- device.phonegap -- device.platform -- device.uuid -- device.version - -Variable Scope --------------- - -Since `device` is assigned to the `window` object, it is implicitly in the global scope. - - // These reference the same `device` - // - var phoneName = window.device.name; - var phoneName = device.name; \ No newline at end of file