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 C70B518C7D for ; Thu, 23 Jul 2015 22:20:05 +0000 (UTC) Received: (qmail 33062 invoked by uid 500); 23 Jul 2015 22:20:05 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 32948 invoked by uid 500); 23 Jul 2015 22:20:05 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 32750 invoked by uid 99); 23 Jul 2015 22:20:05 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 23 Jul 2015 22:20:05 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4F487E6845; Thu, 23 Jul 2015 22:20:05 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dblotsky@apache.org To: commits@cordova.apache.org Date: Thu, 23 Jul 2015 22:20:09 -0000 Message-Id: In-Reply-To: <77e03c3543824ad08ea8ea0872583c4d@git.apache.org> References: <77e03c3543824ad08ea8ea0872583c4d@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [05/75] [partial] docs commit: Moved docs to www/docs. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.batterystatus.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.batterystatus.md b/docs/en/1.6.0/cordova/events/events.batterystatus.md deleted file mode 100644 index bf25c17..0000000 --- a/docs/en/1.6.0/cordova/events/events.batterystatus.md +++ /dev/null @@ -1,102 +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. ---- - -batterystatus -=========== - -This is an event that fires when a Cordova application detects a change in the battery status. - - window.addEventListener("batterystatus", yourCallbackFunction, false); - -Details -------- - -This event that fires when a Cordova application detects the percentage of battery has changed by at least 1 percent. It is also fired if the device has been plugged in or un-plugged. - -The battery status handler will be called with an object that contains two properties: - -- __level:__ The percentage of battery (0-100). _(Number)_ -- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_ - -Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- iOS -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- Windows Phone 7 ( Mango ) - - -Windows Phone 7 Quirks ----------------------- - -The `level` property is unavailable as Windows Phone 7 does not provide -native APIs for determining battery level. The `isPlugged` parameter -_is_ supported. - -Quick Example -------------- - - window.addEventListener("batterystatus", onBatteryStatus, false); - - function onBatteryStatus(info) { - // Handle the online event - console.log("Level: " + info.level + " isPlugged: " + info.isPlugged); - } - -Full Example ------------- - - - - - Cordova Device Ready Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.deviceready.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.deviceready.md b/docs/en/1.6.0/cordova/events/events.deviceready.md deleted file mode 100644 index 1517190..0000000 --- a/docs/en/1.6.0/cordova/events/events.deviceready.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. ---- - -deviceready -=========== - -This is an event that fires when Cordova is fully loaded. - - document.addEventListener("deviceready", yourCallbackFunction, false); - -Details -------- - -This is a very important event that every Cordova application should use. - -Cordova consists of two code bases: native and JavaScript. While the native code is loading, a custom loading image is displayed. However, JavaScript is only loaded once the DOM loads. This means your web application could, potentially, call a Cordova JavaScript function before it is loaded. - -The Cordova `deviceready` event fires once Cordova has fully loaded. After the device has fired, you can safely make calls to Cordova 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) -- iOS -- Windows Phone 7 - -Quick Example -------------- - - document.addEventListener("deviceready", onDeviceReady, false); - - function onDeviceReady() { - // Now safe to use the Cordova API - } - -Full Example ------------- - - - - - Cordova Device Ready Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.endcallbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.endcallbutton.md b/docs/en/1.6.0/cordova/events/events.endcallbutton.md deleted file mode 100644 index f7126fe..0000000 --- a/docs/en/1.6.0/cordova/events/events.endcallbutton.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. ---- - -endcallbutton -=========== - -This is an event that fires when the user presses the end call button. - - document.addEventListener("endcallbutton", yourCallbackFunction, false); - -Details -------- - -If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- BlackBerry WebWorks (OS 5.0 and higher) - -Quick Example -------------- - - document.addEventListener("endcallbutton", onEndCallKeyDown, false); - - function onEndCallKeyDown() { - // Handle the end call button - } - -Full Example ------------- - - - - - Cordova End Call Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.md b/docs/en/1.6.0/cordova/events/events.md deleted file mode 100644 index b6cd43a..0000000 --- a/docs/en/1.6.0/cordova/events/events.md +++ /dev/null @@ -1,43 +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 -====== - -> Cordova lifecycle events. - -Event Types ------------ - -- deviceready -- pause -- resume -- online -- offline -- backbutton -- batterycritical -- batterylow -- batterystatus -- menubutton -- searchbutton -- startcallbutton -- endcallbutton -- volumedownbutton -- volumeupbutton - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.menubutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.menubutton.md b/docs/en/1.6.0/cordova/events/events.menubutton.md deleted file mode 100644 index 8e2e9f9..0000000 --- a/docs/en/1.6.0/cordova/events/events.menubutton.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. ---- - -menubutton -=========== - -This is an event that fires when the user presses the menu button. - - document.addEventListener("menubutton", yourCallbackFunction, false); - -Details -------- - -If you need to override the default menu button behaviour you can register an event listener for the 'menubutton' event. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) - -Quick Example -------------- - - document.addEventListener("menubutton", onMenuKeyDown, false); - - function onMenuKeyDown() { - // Handle the back button - } - -Full Example ------------- - - - - - Cordova Menu Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.offline.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.offline.md b/docs/en/1.6.0/cordova/events/events.offline.md deleted file mode 100644 index 1040fe8..0000000 --- a/docs/en/1.6.0/cordova/events/events.offline.md +++ /dev/null @@ -1,95 +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. ---- - -offline -=========== - -This is an event that fires when a Cordova application is offline (not connected to the Internet). - - document.addEventListener("offline", yourCallbackFunction, false); - -Details -------- - -When the application's network connection changes to being offline, the offline event is fired. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 - -Quick Example -------------- - - document.addEventListener("offline", onOffline, false); - - function onOffline() { - // Handle the offline event - } - -Full Example ------------- - - - - - Cordova Offline Example - - - - - - - - -iOS Quirks --------------------------- -During initial startup, the first offline event (if applicable) will take at least a second to fire. - -Windows Phone 7 Quirks --------------------------- -When running in the Emulator, the connection.status of the device is always unknown, and this event will NOT fire. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.online.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.online.md b/docs/en/1.6.0/cordova/events/events.online.md deleted file mode 100644 index 3fa2a32..0000000 --- a/docs/en/1.6.0/cordova/events/events.online.md +++ /dev/null @@ -1,95 +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. ---- - -online -=========== - -This is an event that fires when a Cordova application is online (connected to the Internet). - - document.addEventListener("online", yourCallbackFunction, false); - -Details -------- - -When the application's network connection changes to being online, the online event is fired. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 - -Quick Example -------------- - - document.addEventListener("online", onOnline, false); - - function onOnline() { - // Handle the online event - } - -Full Example ------------- - - - - - Cordova Online Example - - - - - - - - -iOS Quirks --------------------------- -During initial startup, the first online event (if applicable) will take at least a second to fire. - -Windows Phone 7 Quirks --------------------------- -When running in the Emulator, the connection.status of the device is always unknown, and this event will NOT fire. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.pause.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.pause.md b/docs/en/1.6.0/cordova/events/events.pause.md deleted file mode 100644 index a4feadb..0000000 --- a/docs/en/1.6.0/cordova/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 Cordova application is put into the background. - - document.addEventListener("pause", yourCallbackFunction, false); - -Details -------- - -Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 - -Quick Example -------------- - - document.addEventListener("pause", onPause, false); - - function onPause() { - // Handle the pause event - } - -Full Example ------------- - - - - - Cordova Pause Example - - - - - - - - -iOS Quirks --------------------------- -In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app resumes (processed on the next run-loop). http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.resume.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.resume.md b/docs/en/1.6.0/cordova/events/events.resume.md deleted file mode 100644 index e012451..0000000 --- a/docs/en/1.6.0/cordova/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 Cordova application is retrieved from the background. - - document.addEventListener("resume", yourCallbackFunction, false); - -Details -------- - -Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 - -Quick Example -------------- - - document.addEventListener("resume", onResume, false); - - function onResume() { - // Handle the resume event - } - -Full Example ------------- - - - - - Cordova Resume Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.searchbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.searchbutton.md b/docs/en/1.6.0/cordova/events/events.searchbutton.md deleted file mode 100644 index 45817bc..0000000 --- a/docs/en/1.6.0/cordova/events/events.searchbutton.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. ---- - -searchbutton -=========== - -This is an event that fires when the user presses the search button on Android. - - document.addEventListener("searchbutton", yourCallbackFunction, false); - -Details -------- - -If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- Android - -Quick Example -------------- - - document.addEventListener("searchbutton", onSearchKeyDown, false); - - function onSearchKeyDown() { - // Handle the search button - } - -Full Example ------------- - - - - - Cordova Search Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.startcallbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.startcallbutton.md b/docs/en/1.6.0/cordova/events/events.startcallbutton.md deleted file mode 100644 index 9e22f3b..0000000 --- a/docs/en/1.6.0/cordova/events/events.startcallbutton.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. ---- - -startcallbutton -=========== - -This is an event that fires when the user presses the start call button. - - document.addEventListener("startcallbutton", yourCallbackFunction, false); - -Details -------- - -If you need to override the default start call behaviour you can register an event listener for the 'startcallbutton' event. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- BlackBerry WebWorks (OS 5.0 and higher) - -Quick Example -------------- - - document.addEventListener("startcallbutton", onStartCallKeyDown, false); - - function onStartCallKeyDown() { - // Handle the start call button - } - -Full Example ------------- - - - - - Cordova Start Call Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.volumedownbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.volumedownbutton.md b/docs/en/1.6.0/cordova/events/events.volumedownbutton.md deleted file mode 100644 index cf31da5..0000000 --- a/docs/en/1.6.0/cordova/events/events.volumedownbutton.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. ---- - -volumedownbutton -=========== - -This is an event that fires when the user presses the volume down button. - - document.addEventListener("volumedownbutton", yourCallbackFunction, false); - -Details -------- - -If you need to override the default volume down behaviour you can register an event listener for the 'volumedownbutton' event. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- BlackBerry WebWorks (OS 5.0 and higher) - -Quick Example -------------- - - document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false); - - function onVolumeDownKeyDown() { - // Handle the volume down button - } - -Full Example ------------- - - - - - Cordova Volume Down Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/events/events.volumeupbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/events/events.volumeupbutton.md b/docs/en/1.6.0/cordova/events/events.volumeupbutton.md deleted file mode 100644 index 542837f..0000000 --- a/docs/en/1.6.0/cordova/events/events.volumeupbutton.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. ---- - -volumeupbutton -=========== - -This is an event that fires when the user presses the volume up button. - - document.addEventListener("volumeupbutton", yourCallbackFunction, false); - -Details -------- - -If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event. - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- BlackBerry WebWorks (OS 5.0 and higher) - -Quick Example -------------- - - document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false); - - function onVolumeUpKeyDown() { - // Handle the volume up button - } - -Full Example ------------- - - - - - Cordova Volume Up Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/directoryentry/directoryentry.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/directoryentry/directoryentry.md b/docs/en/1.6.0/cordova/file/directoryentry/directoryentry.md deleted file mode 100644 index 7b80bf1..0000000 --- a/docs/en/1.6.0/cordova/file/directoryentry/directoryentry.md +++ /dev/null @@ -1,319 +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 Cordova: - -- __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 -- Windows Phone 7 ( Mango ) - -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/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/directoryreader/directoryreader.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/directoryreader/directoryreader.md b/docs/en/1.6.0/cordova/file/directoryreader/directoryreader.md deleted file mode 100644 index 58e59ba..0000000 --- a/docs/en/1.6.0/cordova/file/directoryreader/directoryreader.md +++ /dev/null @@ -1,66 +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 -- Windows Phone 7 ( Mango ) - -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 This API is based on the W3C [File API](http://www.w3.org/TR/FileAPI). An API to read, write and navigate file system hierarchies. - -Objects -------- - -- DirectoryEntry -- DirectoryReader -- File -- FileEntry -- FileError -- FileReader -- FileSystem -- FileTransfer -- FileTransferError -- FileUploadOptions -- FileUploadResult -- FileWriter -- Flags -- LocalFileSystem -- Metadata \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/fileentry/fileentry.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/fileentry/fileentry.md b/docs/en/1.6.0/cordova/file/fileentry/fileentry.md deleted file mode 100644 index cde59bf..0000000 --- a/docs/en/1.6.0/cordova/file/fileentry/fileentry.md +++ /dev/null @@ -1,261 +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. ---- - -FileEntry -========== - -This object represents a file 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 true. _(boolean)_ -- __isDirectory:__ Always false. _(boolean)_ -- __name:__ The name of the FileEntry, excluding the path leading to it. _(DOMString)_ -- __fullPath:__ The full absolute path from the root to the FileEntry. _(DOMString)_ - -NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by Cordova: - -- __filesystem:__ The file system on which the FileEntry resides. _(FileSystem)_ - - -Methods -------- - -- __getMetadata__: Look up metadata about a file. -- __moveTo__: Move a file to a different location on the file system. -- __copyTo__: Copy a file to a different location on the file system. -- __toURI__: Return a URI that can be used to locate a file. -- __remove__: Delete a file. -- __getParent__: Look up the parent directory. -- __createWriter__: Creates a FileWriter object that can be used to write to a file. -- __file__: Creates a File object containing file properties. - - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 ( Mango ) - - -getMetadata ----------------- - -Look up metadata about a file. - -__Parameters:__ - -- __successCallback__ - A callback that is called with a Metadata object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_ - - -__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 file to a different location on the file system. It is an error to attempt to: - -- move a file into its parent if a name different from its current one isn't provided; -- move a file to a path occupied by a directory; - -In addition, an attempt to move a file on top of an existing file must attempt to delete and replace that file. - -__Parameters:__ - -- __parent__ - The parent directory to which to move the file. _(DirectoryEntry)_ -- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_ -- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_ - - -__Quick Example__ - - function success(entry) { - console.log("New Path: " + entry.fullPath); - } - - function fail(error) { - alert(error.code); - } - - function moveFile(entry) { - var parent = document.getElementById('parent').value, - parentEntry = new DirectoryEntry({fullPath: parent}); - - // move the file to a new directory and rename it - entry.moveTo(parentEntry, "newFile.txt", success, fail); - } - - -copyTo ------- - -Copy a file to a new location on the file system. It is an error to attempt to: - -- copy a file into its parent if a name different from its current one is not provided. - -__Parameters:__ - -- __parent__ - The parent directory to which to copy the file. _(DirectoryEntry)_ -- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_ -- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_ - - -__Quick Example__ - - function win(entry) { - console.log("New Path: " + entry.fullPath); - } - - function fail(error) { - alert(error.code); - } - - function copyFile(entry) { - var parent = document.getElementById('parent').value, - parentEntry = new DirectoryEntry({fullPath: parent}); - - // copy the file to a new directory and rename it - entry.copyTo(parentEntry, "file.copy", success, fail); - } - - -toURI ------ - -Returns a URI that can be used to locate the file. - -__Quick Example__ - - // Request the URI for this entry - var uri = entry.toURI(); - console.log(uri); - - -remove ------- - -Deletes a file. - -__Parameters:__ - -- __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(entry) { - console.log("Removal succeeded"); - } - - function fail(error) { - alert('Error removing file: ' + error.code); - } - - // remove the file - entry.remove(success, fail); - - -getParent ---------- - -Look up the parent DirectoryEntry containing the file. - -__Parameters:__ - -- __successCallback__ - A callback that is called with the file's parent DirectoryEntry. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(parent) { - console.log("Parent Name: " + parent.name); - } - - function fail(error) { - alert(error.code); - } - - // Get the parent DirectoryEntry - entry.getParent(success, fail); - - -createWriter ------------- - -Create a FileWriter object associated with the file that the FileEntry represents. - -__Parameters:__ - -- __successCallback__ - A callback that is called with a FileWriter object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs while attempting to create the FileWriter. Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(writer) { - writer.write("Some text to the file"); - } - - function fail(error) { - alert(error.code); - } - - // create a FileWriter to write to the file - entry.createWriter(success, fail); - - -file ----- - -Return a File object that represents the current state of the file that this FileEntry represents. - -__Parameters:__ - -- __successCallback__ - A callback that is called with a File object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs when creating the File object (e.g. the underlying file no longer exists). Invoked with a FileError object. _(Function)_ - -__Quick Example__ - - function success(file) { - console.log("File size: " + file.size); - } - - function fail(error) { - alert("Unable to retrieve file properties: " + error.code); - } - - // obtain properties of a file - entry.file(success, fail); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/fileerror/fileerror.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/fileerror/fileerror.md b/docs/en/1.6.0/cordova/file/fileerror/fileerror.md deleted file mode 100644 index 75511c5..0000000 --- a/docs/en/1.6.0/cordova/file/fileerror/fileerror.md +++ /dev/null @@ -1,49 +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. ---- - -FileError -======== - -A 'FileError' object is set when an error occurs in any of the File API methods. - -Properties ----------- - -- __code:__ One of the predefined error codes listed below. - -Constants ---------- - -- `FileError.NOT_FOUND_ERR` -- `FileError.SECURITY_ERR` -- `FileError.ABORT_ERR` -- `FileError.NOT_READABLE_ERR` -- `FileError.ENCODING_ERR` -- `FileError.NO_MODIFICATION_ALLOWED_ERR` -- `FileError.INVALID_STATE_ERR` -- `FileError.SYNTAX_ERR` -- `FileError.INVALID_MODIFICATION_ERR` -- `FileError.QUOTA_EXCEEDED_ERR` -- `FileError.TYPE_MISMATCH_ERR` -- `FileError.PATH_EXISTS_ERR` - -Description ------------ - -The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/fileobj/fileobj.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/fileobj/fileobj.md b/docs/en/1.6.0/cordova/file/fileobj/fileobj.md deleted file mode 100644 index 5c37994..0000000 --- a/docs/en/1.6.0/cordova/file/fileobj/fileobj.md +++ /dev/null @@ -1,45 +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. ---- - -File -==== - -This object contains attributes of a single file. - -Properties ----------- - -- __name:__ The name of the file. _(DOMString)_ -- __fullPath:__ The full path of the file including the file name. _(DOMString)_ -- __type:__ The mime type of the file. _(DOMString)_ -- __lastModifiedDate:__ The last time the file was modified. _(Date)_ -- __size:__ The size of the file in bytes. _(long)_ - -Details -------- - -The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 ( Mango ) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/filereader/filereader.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/filereader/filereader.md b/docs/en/1.6.0/cordova/file/filereader/filereader.md deleted file mode 100644 index 2264e52..0000000 --- a/docs/en/1.6.0/cordova/file/filereader/filereader.md +++ /dev/null @@ -1,196 +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. ---- - -FileReader -========== - -FileReader is an object that allows one to read a file. - -Properties ----------- - -- __readyState:__ One of the three states the reader can be in EMPTY, LOADING or DONE. -- __result:__ The contents of the file that has been read. _(DOMString)_ -- __error:__ An object containing errors. _(FileError)_ -- __onloadstart:__ Called when the read starts. . _(Function)_ -- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -NOT SUPPORTED -- __onload:__ Called when the read has successfully completed. _(Function)_ -- __onabort:__ Called when the read has been aborted. For instance, by invoking the abort() method. _(Function)_ -- __onerror:__ Called when the read has failed. _(Function)_ -- __onloadend:__ Called when the request has completed (either in success or failure). _(Function)_ - -Methods -------- - -- __abort__: Aborts reading file. -- __readAsDataURL__: Read file and return data as a base64 encoded data url. -- __readAsText__: Reads text file. - -Details -------- - -The `FileReader` object is a way to read files from the devices file system. Files can be read as text or as a base64 data encoded string. Users register their own event listeners to receive the loadstart, progress, load, loadend, error and abort events. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 ( Mango ) - -Read As Data URL ----------------- - -__Parameters:__ -- file - the file object to read - - -Quick Example -------------- - - function win(file) { - var reader = new FileReader(); - reader.onloadend = function(evt) { - console.log("read success"); - console.log(evt.target.result); - }; - reader.readAsDataURL(file); - }; - - var fail = function(evt) { - console.log(error.code); - }; - - entry.file(win, fail); - -Read As Text ------------- - -__Parameters:__ - -- file - the file object to read -- encoding - the encoding to use to encode the file's content. Default is UTF8. - -Quick Example -------------- - - function win(file) { - var reader = new FileReader(); - reader.onloadend = function(evt) { - console.log("read success"); - console.log(evt.target.result); - }; - reader.readAsText(file); - }; - - var fail = function(evt) { - console.log(error.code); - }; - - entry.file(win, fail); - -Abort Quick Example -------------------- - - function win(file) { - var reader = new FileReader(); - reader.onloadend = function(evt) { - console.log("read success"); - console.log(evt.target.result); - }; - reader.readAsText(file); - reader.abort(); - }; - - function fail(error) { - console.log(error.code); - } - - entry.file(win, fail); - -Full Example ------------- - - - - - FileReader Example - - - - - -

Example

-

Read File

- - - -iOS Quirks ----------- -- __encoding__ parameter is not supported, UTF8 encoding is always used. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/filesystem/filesystem.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/filesystem/filesystem.md b/docs/en/1.6.0/cordova/file/filesystem/filesystem.md deleted file mode 100644 index 1d693ea..0000000 --- a/docs/en/1.6.0/cordova/file/filesystem/filesystem.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. ---- - -FileSystem -========== - -This object represents a file system. - -Properties ----------- - -- __name:__ The name of the file system. _(DOMString)_ -- __root:__ The root directory of the file system. _(DirectoryEntry)_ - -Details -------- - -The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `DirectoryEntry` object which represents the root directory of the file system. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 ( Mango ) - -File System Quick Example -------------------------- - - function onSuccess(fileSystem) { - console.log(fileSystem.name); - console.log(fileSystem.root.name); - } - - // request the persistent file system - window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null); - -Full Example ------------- - - - - - File System Example - - - - - -

Example

-

File System

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/filetransfer/filetransfer.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/filetransfer/filetransfer.md b/docs/en/1.6.0/cordova/file/filetransfer/filetransfer.md deleted file mode 100644 index 5f74e00..0000000 --- a/docs/en/1.6.0/cordova/file/filetransfer/filetransfer.md +++ /dev/null @@ -1,182 +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. ---- - -FileTransfer -========== - -FileTransfer is an object that allows you to upload files to a server or download files from a server. - -Properties ----------- - -N/A - -Methods -------- - -- __upload__: sends a file to a server. -- __download__: downloads a file from server. - -Details -------- - -The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object. -It is also possible to download a file from remote and save it on the device (only iOS and Android). - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 ( Mango ) - -upload --------------- - -__Parameters:__ - -- __filePath__ - Full path of the file on the device -- __server__ - URL of the server to receive the file -- __successCallback__ - A callback that is called with a FileUploadResult object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs uploading the file. Invoked with a FileTransferError object. _(Function)_ -- __options__ - Optional parameters such as file name and mimetype - -__Quick Example__ - - // !! Assumes variable fileURI contains a valid URI to a text file on the device - - var win = function(r) { - console.log("Code = " + r.responseCode); - console.log("Response = " + r.response); - console.log("Sent = " + r.bytesSent); - } - - var fail = function(error) { - alert("An error has occurred: Code = " + error.code); - console.log("upload error source " + error.source); - console.log("upload error target " + error.target); - } - - var options = new FileUploadOptions(); - options.fileKey="file"; - options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1); - options.mimeType="text/plain"; - - var params = new Object(); - params.value1 = "test"; - params.value2 = "param"; - - options.params = params; - - var ft = new FileTransfer(); - ft.upload(fileURI, "http://some.server.com/upload.php", win, fail, options); - -__Full Example__ - - - - - File Transfer Example - - - - - -

Example

-

Upload File

- - - -download --------------- - -__Parameters:__ - -- __source__ - URL of the server to receive the file -- __target__ - Full path of the file on the device -- __successCallback__ - A callback that is called with a FileEntry object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs retrieving the FileEntry. Invoked with a FileTransferError object. _(Function)_ - -__Quick Example__ - - // !! Assumes variable url contains a valid URI to a file on a server and filePath is a valid path on the device - - var fileTransfer = new FileTransfer(); - - fileTransfer.download( - url, - filePath, - function(entry) { - console.log("download complete: " + entry.fullPath); - }, - function(error) { - console.log("download error source " + error.source); - console.log("download error target " + error.target); - console.log("upload error code" + error.code); - } - ); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.6.0/cordova/file/filetransfererror/filetransfererror.md ---------------------------------------------------------------------- diff --git a/docs/en/1.6.0/cordova/file/filetransfererror/filetransfererror.md b/docs/en/1.6.0/cordova/file/filetransfererror/filetransfererror.md deleted file mode 100644 index edb49b5..0000000 --- a/docs/en/1.6.0/cordova/file/filetransfererror/filetransfererror.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. ---- - -FileTransferError -======== - -A `FileTransferError` object is returned via the error callback when an error occurs. - -Properties ----------- - -- __code__ One of the predefined error codes listed below. (int) -- __source__ URI to the source (string) -- __target__ URI to the target (string) - -Constants ---------- - -- `FileTransferError.FILE_NOT_FOUND_ERR` -- `FileTransferError.INVALID_URL_ERR` -- `FileTransferError.CONNECTION_ERR` - -Description ------------ - -The `FileTransferError` object is returned via the error callback when an error occurs when uploading a file. --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org For additional commands, e-mail: commits-help@cordova.apache.org