Return-Path: X-Original-To: apmail-incubator-callback-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-callback-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4E74ACABB for ; Thu, 12 Jul 2012 22:09:57 +0000 (UTC) Received: (qmail 74509 invoked by uid 500); 12 Jul 2012 22:09:54 -0000 Delivered-To: apmail-incubator-callback-commits-archive@incubator.apache.org Received: (qmail 74435 invoked by uid 500); 12 Jul 2012 22:09:54 -0000 Mailing-List: contact callback-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@incubator.apache.org Delivered-To: mailing list callback-commits@incubator.apache.org Received: (qmail 73614 invoked by uid 99); 12 Jul 2012 22:09:53 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 12 Jul 2012 22:09:53 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 4ECF2137B0; Thu, 12 Jul 2012 22:09:53 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mwbrooks@apache.org To: callback-commits@incubator.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [26/64] [partial] Remove all files. Message-Id: <20120712220953.4ECF2137B0@tyr.zones.apache.org> Date: Thu, 12 Jul 2012 22:09:53 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/ContactFindOptions/contactfindoptions.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/0.9.5.1/phonegap/contacts/ContactFindOptions/contactfindoptions.md deleted file mode 100644 index 5ae66db..0000000 --- a/docs/en/0.9.5.1/phonegap/contacts/ContactFindOptions/contactfindoptions.md +++ /dev/null @@ -1,122 +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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/ContactName/contactname.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/ContactName/contactname.md b/docs/en/0.9.5.1/phonegap/contacts/ContactName/contactname.md deleted file mode 100644 index c6353be..0000000 --- a/docs/en/0.9.5.1/phonegap/contacts/ContactName/contactname.md +++ /dev/null @@ -1,140 +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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/ContactOrganization/contactorganization.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/ContactOrganization/contactorganization.md b/docs/en/0.9.5.1/phonegap/contacts/ContactOrganization/contactorganization.md deleted file mode 100644 index fb0dcde..0000000 --- a/docs/en/0.9.5.1/phonegap/contacts/ContactOrganization/contactorganization.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. ---- - -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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/contacts.create.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/contacts.create.md b/docs/en/0.9.5.1/phonegap/contacts/contacts.create.md deleted file mode 100644 index 4453b17..0000000 --- a/docs/en/0.9.5.1/phonegap/contacts/contacts.create.md +++ /dev/null @@ -1,79 +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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/contacts.find.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/contacts.find.md b/docs/en/0.9.5.1/phonegap/contacts/contacts.find.md deleted file mode 100644 index 5788ac2..0000000 --- a/docs/en/0.9.5.1/phonegap/contacts/contacts.find.md +++ /dev/null @@ -1,120 +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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/contacts.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/contacts.md b/docs/en/0.9.5.1/phonegap/contacts/contacts.md deleted file mode 100644 index 90b49b5..0000000 --- a/docs/en/0.9.5.1/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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/parameters/contactError.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/parameters/contactError.md b/docs/en/0.9.5.1/phonegap/contacts/parameters/contactError.md deleted file mode 100644 index 6b50ddc..0000000 --- a/docs/en/0.9.5.1/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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/parameters/contactFields.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/parameters/contactFields.md b/docs/en/0.9.5.1/phonegap/contacts/parameters/contactFields.md deleted file mode 100644 index 66c9d3d..0000000 --- a/docs/en/0.9.5.1/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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/parameters/contactFindOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/parameters/contactFindOptions.md b/docs/en/0.9.5.1/phonegap/contacts/parameters/contactFindOptions.md deleted file mode 100644 index 98ddd08..0000000 --- a/docs/en/0.9.5.1/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/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/contacts/parameters/contactSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/contacts/parameters/contactSuccess.md b/docs/en/0.9.5.1/phonegap/contacts/parameters/contactSuccess.md deleted file mode 100644 index 9068218..0000000 --- a/docs/en/0.9.5.1/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 http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/device/device.name.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/device/device.name.md b/docs/en/0.9.5.1/phonegap/device/device.name.md deleted file mode 100644 index 70136e9..0000000 --- a/docs/en/0.9.5.1/phonegap/device/device.name.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. ---- - -device.name -=========== - -Get the device's model name. - - var string = device.name; - -Description ------------ - -`device.name` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product. - -Supported Platforms -------------------- - -- Android -- BlackBerry -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - // Android: Nexus One returns "Passion" (Nexus One code name) - // Motorola Droid returns "voles" - // BlackBerry: Bold 8900 returns "8900" - // iPhone: All devices returns a name set by iTunes e.g. "Joe's iPhone" - // - var name = device.name; - -Full Example ------------- - - - - - Device Properties Example - - - - - -

Loading device properties...

- - - - -Android Quirks --------------- - -- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL). - - The product name is often the code name given during production. - - e.g. Nexus One returns "Passion", Motorola Droid returns "voles" - -iPhone Quirks -------------- - -- Gets the [device's custom name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW13) instead of the [device model name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW1). - - The custom name is set by the owner in iTunes. - - e.g. "Joe's iPhone" \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/device/device.phonegap.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/device/device.phonegap.md b/docs/en/0.9.5.1/phonegap/device/device.phonegap.md deleted file mode 100644 index e843520..0000000 --- a/docs/en/0.9.5.1/phonegap/device/device.phonegap.md +++ /dev/null @@ -1,81 +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. ---- - -device.phonegap -=============== - -Get the version of phonegap running on the device. - - var string = device.phonegap; - -Description ------------ - -`device.phonegap` returns the version of phonegap running on the device. - -Supported Platforms -------------------- - -- Android -- BlackBerry -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - var name = device.phonegap; - -Full Example ------------- - - - - - Device Properties Example - - - - - -

Loading device properties...

- - - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/device/device.platform.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/device/device.platform.md b/docs/en/0.9.5.1/phonegap/device/device.platform.md deleted file mode 100644 index 7b21277..0000000 --- a/docs/en/0.9.5.1/phonegap/device/device.platform.md +++ /dev/null @@ -1,91 +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. ---- - -device.platform -=============== - -Get the device's operating system name. - - var string = device.platform; - -Supported Platforms -------------------- - -- Android -- BlackBerry -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - // Depending on the device, a few examples are: - // - "Android" - // - "BlackBerry" - // - "iPhone" - // - "webOS" - // - var devicePlatform = device.platform; - -Full Example ------------- - - - - - Device Properties Example - - - - - -

Loading device properties...

- - - -iPhone Quirks -------------- - -All devices return `iPhone` as the platform. This is inaccurate because Apple has rebranded the iPhone operating system as `iOS`. - -BlackBerry Quirks ------------------ - -Devices may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/device/device.uuid.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/device/device.uuid.md b/docs/en/0.9.5.1/phonegap/device/device.uuid.md deleted file mode 100644 index e2f0a22..0000000 --- a/docs/en/0.9.5.1/phonegap/device/device.uuid.md +++ /dev/null @@ -1,91 +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. ---- - -device.uuid -=========== - -Get the device's Universally Unique Identifier ([UUID](http://en.wikipedia.org/wiki/Universally_Unique_Identifier)). - - var string = device.uuid; - -Description ------------ - -The details of how a UUID is generated are determined by the device manufacturer and specific to the device's platform or model. - -Supported Platforms -------------------- - -- Android -- BlackBerry -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - // Android: Returns a random 64-bit integer (as a string, again!) - // The integer is generated on the device's first boot - // - // BlackBerry: Returns the PIN number of the device - // This is a nine-digit unique integer (as a string, though!) - // - // iPhone: (Paraphrased from the UIDevice Class documentation) - // Returns a string of hash values created from multiple hardware identifies. - // It is guaranteed to be unique for every device and cannot be tied - // to the user account. - // - var deviceID = device.uuid; - -Full Example ------------- - - - - - Device Properties Example - - - - - -

Loading device properties...

- - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/device/device.version.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/device/device.version.md b/docs/en/0.9.5.1/phonegap/device/device.version.md deleted file mode 100644 index 43dea28..0000000 --- a/docs/en/0.9.5.1/phonegap/device/device.version.md +++ /dev/null @@ -1,83 +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. ---- - -device.version -============== - -Get the operating system version. - - var string = device.version; - -Supported Platforms -------------------- - -- Android 2.1+ -- BlackBerry -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - // Android: Froyo OS would return "2.2" - // Eclair OS would return "2.1", "2.0.1", or "2.0" - // Version can also return update level "2.1-update1" - // - // BlackBerry: Bold 9000 using OS 4.6 would return "4.6.0.282" - // - // iPhone: iOS 3.2 returns "3.2" - // - var deviceVersion = device.version; - -Full Example ------------- - - - - - Device Properties Example - - - - - -

Loading device properties...

- - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/events/events.backbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/events/events.backbutton.md b/docs/en/0.9.5.1/phonegap/events/events.backbutton.md deleted file mode 100644 index 30b08e1..0000000 --- a/docs/en/0.9.5.1/phonegap/events/events.backbutton.md +++ /dev/null @@ -1,86 +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. ---- - -backbutton -=========== - -This is an event that fires when the user presses the back button on Android. - - document.addEventListener("backbutton", yourCallbackFunction, false); - -Details -------- - -If you need to over ride the default back button behaviour on Android you can register and event listenter 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 PhoneGap 'deviceready' event. - -Supported Platforms -------------------- - -- Android - -Quick Example -------------- - - document.addEventListener("backbutton", onBackKeyDown, false); - - function onBackKeyDown() { - // Handle the back buton - } - -Full Example ------------- - - - - - PhoneGap Device Ready Example - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/events/events.deviceready.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/events/events.deviceready.md b/docs/en/0.9.5.1/phonegap/events/events.deviceready.md deleted file mode 100644 index e194a3a..0000000 --- a/docs/en/0.9.5.1/phonegap/events/events.deviceready.md +++ /dev/null @@ -1,112 +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. ---- - -deviceready -=========== - -This is an event that fires when PhoneGap is fully loaded. - - document.addEventListener("deviceready", yourCallbackFunction, false); - -Details -------- - -This is a very important event that every PhoneGap application should use. - -PhoneGap consists of two code bases: native and JavaScript. While the native code is loading, a custom loading image is displayed. However, JavaScript is only loaded once the DOM loads. This means your web application could, potentially, call a PhoneGap JavaScript function before it is loaded. - -The PhoneGap `deviceready` event fires once PhoneGap has fully loaded. After the device has fired, you can safely make calls to PhoneGap function. - -Typically, you will want to attach an event listener with `document.addEventListener` once the HTML document's DOM has loaded. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - document.addEventListener("deviceready", onDeviceReady, false); - - function onDeviceReady() { - // Now safe to use the PhoneGap API - } - -Full Example ------------- - - - - - PhoneGap Device Ready Example - - - - - - - - -BlackBerry (OS 4.6) Quirks --------------------------- - -Custom events are not supported in the RIM BrowserField (web browser view), so the `deviceready` event will never fire. - -A workaround is to manually query `PhoneGap.available` until PhoneGap has fully loaded. - - function onLoad() { - // BlackBerry OS 4 browser does not support events. - // So, manually wait until PhoneGap is available. - // - var intervalID = window.setInterval( - function() { - if (PhoneGap.available) { - window.clearInterval(intervalID); - onDeviceReady(); - } - }, - 500 - ); - } - - function onDeviceReady() { - // Now safe to use the PhoneGap API - } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/events/events.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/events/events.md b/docs/en/0.9.5.1/phonegap/events/events.md deleted file mode 100644 index 4809234..0000000 --- a/docs/en/0.9.5.1/phonegap/events/events.md +++ /dev/null @@ -1,31 +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. ---- - -Events -====== - -> PhoneGap lifecycle events. - -Event Types ------------ - -- deviceready -- pause -- resume -- backbutton http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/events/events.pause.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/events/events.pause.md b/docs/en/0.9.5.1/phonegap/events/events.pause.md deleted file mode 100644 index 1b5cf08..0000000 --- a/docs/en/0.9.5.1/phonegap/events/events.pause.md +++ /dev/null @@ -1,91 +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. ---- - -pause -=========== - -This is an event that fires when a PhoneGap application is put into the background. - - document.addEventListener("pause", yourCallbackFunction, false); - -Details -------- - -PhoneGap 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 PhoneGap 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - document.addEventListener("pause", onPause, false); - - function onPause() { - // Handle the pause event - } - -Full Example ------------- - - - - - PhoneGap Device Ready Example - - - - - - - - -iOS Quirks --------------------------- -In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the PhoneGap API. These will only be processed when the app resumes (processed on the next run-loop). \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/events/events.resume.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/events/events.resume.md b/docs/en/0.9.5.1/phonegap/events/events.resume.md deleted file mode 100644 index cd12dcc..0000000 --- a/docs/en/0.9.5.1/phonegap/events/events.resume.md +++ /dev/null @@ -1,87 +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. ---- - -resume -=========== - -This is an event that fires when a PhoneGap application is retrieved from the background. - - document.addEventListener("resume", yourCallbackFunction, false); - -Details -------- - -PhoneGap 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 PhoneGap 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - document.addEventListener("resume", onResume, false); - - function onResume() { - // Handle the pause event - } - -Full Example ------------- - - - - - PhoneGap Device Ready Example - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/file/directoryentry/directoryentry.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/file/directoryentry/directoryentry.md b/docs/en/0.9.5.1/phonegap/file/directoryentry/directoryentry.md deleted file mode 100644 index 45f2512..0000000 --- a/docs/en/0.9.5.1/phonegap/file/directoryentry/directoryentry.md +++ /dev/null @@ -1,318 +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. ---- - -DirectoryEntry -============== - -This object represents a directory on a file system. It is defined in the [W3C Directories and Systems](http://www.w3.org/TR/file-system-api/) specification. - -Properties ----------- - -- __isFile:__ Always false. _(boolean)_ -- __isDirectory:__ Always true. _(boolean)_ -- __name:__ The name of the DirectoryEntry, excluding the path leading to it. _(DOMString)_ -- __fullPath:__ The full absolute path from the root to the DirectoryEntry. _(DOMString)_ - -NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by PhoneGap: - -- __filesystem:__ The file system on which the DirectoryEntry resides. _(FileSystem)_ - -Methods -------- - -The following methods can be invoked on a DirectoryEntry object: - -- __getMetadata__: Look up metadata about a directory. -- __moveTo__: Move a directory to a different location on the file system. -- __copyTo__: Copy a directory to a different location on the file system. -- __toURI__: Return a URI that can be used to locate a directory. -- __remove__: Delete a directory. The directory must be empty. -- __getParent__: Look up the parent directory. -- __createReader__: Create a new DirectoryReader that can read entries from a directory. -- __getDirectory__: Create or look up a directory. -- __getFile__: Create or look up a file. -- __removeRecursively__: Delete a directory and all of its contents. - - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -getMetadata ------------ - -Look up metadata about a directory. - -__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)_ - - -__Quick Example__ - - function success(metadata) { - console.log("Last Modified: " + metadata.modificationTime); - } - - function fail(error) { - alert(error.code); - } - - // Request the metadata object for this entry - entry.getMetadata(success, fail); - - -moveTo ------- - -Move a directory to a different location on the file system. It is an error to attempt to: - -- move a directory inside itself or to any child at any depth; -- move a directory into its parent if a name different from its current one is not provided; -- move a directory to a path occupied by a file; -- move a directory to a path occupied by a directory which is not empty. - -In addition, an attempt to move a directory on top of an existing empty directory must attempt to delete and replace that directory. - -__Parameters:__ - -- __parent__ - The parent directory to which to move the directory. _(DirectoryEntry)_ -- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_ -- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a FileError object. _(Function)_ - - -__Quick Example__ - - function success(entry) { - console.log("New Path: " + entry.fullPath); - } - - function fail(error) { - alert(error.code); - } - - function moveDir(entry) { - var parent = document.getElementById('parent').value, - newName = document.getElementById('newName').value, - parentEntry = new DirectoryEntry({fullPath: parent}); - - // move the directory to a new directory and rename it - entry.moveTo(parentEntry, newName, success, fail); - } - -copyTo ------- - -Copy a directory to a different location on the file system. It is an error to attempt to: - -- copy a directory inside itself at any depth; -- copy a directory into its parent if a name different from its current one is not provided. - -Directory copies are always recursive - that is, they copy all contents of the directory. - -__Parameters:__ - -- __parent__ - The parent directory to which to copy the directory. _(DirectoryEntry)_ -- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_ -- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a FileError object. _(Function)_ - - -__Quick Example__ - - function win(entry) { - console.log("New Path: " + entry.fullPath); - } - - function fail(error) { - alert(error.code); - } - - function copyDir(entry) { - var parent = document.getElementById('parent').value, - newName = document.getElementById('newName').value, - parentEntry = new DirectoryEntry({fullPath: parent}); - - // copy the directory to a new directory and rename it - entry.copyTo(parentEntry, newName, success, fail); - } - - -toURI ------ - -Returns a URI that can be used to locate the directory. - -__Quick Example__ - - // Get the URI for this directory - var uri = entry.toURI(); - console.log(uri); - - -remove ------- - -Deletes a directory. It is an error to attempt to: - -- delete a directory that is not empty; -- delete the root directory of a filesystem. - -__Parameters:__ - -- __successCallback__ - A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(entry) { - console.log("Removal succeeded"); - } - - function fail(error) { - alert('Error removing directory: ' + error.code); - } - - // remove this directory - entry.remove(success, fail); - - -getParent ---------- - -Look up the parent DirectoryEntry containing the directory. - -__Parameters:__ - -- __successCallback__ - A callback that is called with the directory'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)_ - -__Quick Example__ - - function success(parent) { - console.log("Parent Name: " + parent.name); - } - - function fail(error) { - alert('Failed to get parent directory: ' + error.code); - } - - // Get the parent DirectoryEntry - entry.getParent(success, fail); - - -createReader ------------- - -Creates a new DirectoryReader to read entries in a directory. - -__Quick Example__ - - // create a directory reader - var directoryReader = entry.createReader(); - - -getDirectory ------------- - -Creates or looks up an existing directory. It is an error to attempt to: - -- create a directory whose immediate parent does not yet exist. - -__Parameters:__ - -- __path__ - The path to the directory to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_ -- __options__ - Options to specify whether the directory is created if it doesn't exist. _(Flags)_ -- __successCallback__ - A callback that is invoked with a DirectoryEntry object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(parent) { - console.log("Parent Name: " + parent.name); - } - - function fail(error) { - alert("Unable to create new directory: " + error.code); - } - - // Retrieve an existing directory, or create it if it does not already exist - entry.getDirectory("newDir", {create: true, exclusive: false}, success, fail); - - -getFile -------- - -Creates or looks up a file. It is an error to attempt to: - -- create a file whose immediate parent does not yet exist. - -__Parameters:__ - -- __path__ - The path to the file to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_ -- __options__ - Options to specify whether the file is created if it doesn't exist. _(Flags)_ -- __successCallback__ - A callback that is invoked with a FileEntry object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(parent) { - console.log("Parent Name: " + parent.name); - } - - function fail(error) { - alert("Failed to retrieve file: " + error.code); - } - - // Retrieve an existing file, or create it if it does not exist - entry.getFile("newFile.txt", {create: true, exclusive: false}, success, fail); - - -removeRecursively ------------------ - -Deletes a directory and all of its contents. In the event of an error (e.g. trying to delete -a directory that contains a file that cannot be removed), some of the contents of the directory may -be deleted. It is an error to attempt to: - -- delete the root directory of a filesystem. - -__Parameters:__ - -- __successCallback__ - A callback that is called after the DirectoryEntry has been deleted. Invoked with no parameters. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(parent) { - console.log("Remove Recursively Succeeded"); - } - - function fail(error) { - alert("Failed to remove directory or it's contents: " + error.code); - } - - // remove the directory and all it's contents - entry.removeRecursively(success, fail); http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.5.1/phonegap/file/directoryreader/directoryreader.md ---------------------------------------------------------------------- diff --git a/docs/en/0.9.5.1/phonegap/file/directoryreader/directoryreader.md b/docs/en/0.9.5.1/phonegap/file/directoryreader/directoryreader.md deleted file mode 100644 index be929e7..0000000 --- a/docs/en/0.9.5.1/phonegap/file/directoryreader/directoryreader.md +++ /dev/null @@ -1,65 +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. ---- - -DirectoryReader -=============== - -An object that lists files and directories in a directory. Defined in the [Directories and Systems](http://www.w3.org/TR/file-system-api/) specification. - -Methods -------- - -- __readEntries__: Read the entries in a directory. - - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -readEntries ------------ - -Read the entries in this directory. - -__Parameters:__ - -- __successCallback__ - A callback that is passed an array of FileEntry and DirectoryEntry objects. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs retrieving the directory listing. Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(entries) { - var i; - for (i=0; i An API to read, write and navigate file system hierarchies. - -Objects -------- - -- DirectoryEntry -- DirectoryReader -- File -- FileEntry -- FileError -- FileReader -- FileSystem -- FileTransfer -- FileTransferError -- FileUploadOptions -- FileUploadResult -- FileWriter -- Flags -- LocalFileSystem -- Metadata \ No newline at end of file