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 1A97ACAE2 for ; Thu, 12 Jul 2012 22:10:00 +0000 (UTC) Received: (qmail 75579 invoked by uid 500); 12 Jul 2012 22:09:56 -0000 Delivered-To: apmail-incubator-callback-commits-archive@incubator.apache.org Received: (qmail 75498 invoked by uid 500); 12 Jul 2012 22:09:56 -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 74474 invoked by uid 99); 12 Jul 2012 22:09:54 -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:54 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 7DA2E137F6; Thu, 12 Jul 2012 22:09:54 +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: [61/64] [partial] Remove all files. Message-Id: <20120712220954.7DA2E137F6@tyr.zones.apache.org> Date: Thu, 12 Jul 2012 22:09:54 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.menubutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.menubutton.md b/docs/en/1.1.0/phonegap/events/events.menubutton.md deleted file mode 100644 index 29764f7..0000000 --- a/docs/en/1.1.0/phonegap/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 listenter for the 'menubutton' event. - -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) - -Quick Example -------------- - - document.addEventListener("menubutton", onMenuKeyDown, false); - - function onMenuKeyDown() { - // Handle the back button - } - -Full Example ------------- - - - - - PhoneGap Menu Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.offline.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.offline.md b/docs/en/1.1.0/phonegap/events/events.offline.md deleted file mode 100644 index 50e019c..0000000 --- a/docs/en/1.1.0/phonegap/events/events.offline.md +++ /dev/null @@ -1,90 +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 PhoneGap 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 PhoneGap 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - document.addEventListener("offline", onOffline, false); - - function onOffline() { - // Handle the offline event - } - -Full Example ------------- - - - - - PhoneGap Offline Example - - - - - - - - -iOS Quirks --------------------------- -During initial startup, the first offline event (if applicable) will take at least a second to fire. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.online.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.online.md b/docs/en/1.1.0/phonegap/events/events.online.md deleted file mode 100644 index 7e8f55e..0000000 --- a/docs/en/1.1.0/phonegap/events/events.online.md +++ /dev/null @@ -1,90 +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 PhoneGap 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 PhoneGap 'deviceready' event. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - - document.addEventListener("online", onOnline, false); - - function onOnline() { - // Handle the online event - } - -Full Example ------------- - - - - - PhoneGap Online Example - - - - - - - - -iOS Quirks --------------------------- -During initial startup, the first online event (if applicable) will take at least a second to fire. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.pause.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.pause.md b/docs/en/1.1.0/phonegap/events/events.pause.md deleted file mode 100644 index 85ec9a7..0000000 --- a/docs/en/1.1.0/phonegap/events/events.pause.md +++ /dev/null @@ -1,90 +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) -- iOS - -Quick Example -------------- - - document.addEventListener("pause", onPause, false); - - function onPause() { - // Handle the pause event - } - -Full Example ------------- - - - - - PhoneGap 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 PhoneGap API. These will only be processed when the app resumes (processed on the next run-loop). http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.resume.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.resume.md b/docs/en/1.1.0/phonegap/events/events.resume.md deleted file mode 100644 index a352c45..0000000 --- a/docs/en/1.1.0/phonegap/events/events.resume.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. ---- - -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) -- iOS - -Quick Example -------------- - - document.addEventListener("resume", onResume, false); - - function onResume() { - // Handle the resume event - } - -Full Example ------------- - - - - - PhoneGap Resume Example - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.searchbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.searchbutton.md b/docs/en/1.1.0/phonegap/events/events.searchbutton.md deleted file mode 100644 index 0012d52..0000000 --- a/docs/en/1.1.0/phonegap/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 PhoneGap 'deviceready' event. - -Supported Platforms -------------------- - -- Android - -Quick Example -------------- - - document.addEventListener("searchbutton", onSearchKeyDown, false); - - function onSearchKeyDown() { - // Handle the search button - } - -Full Example ------------- - - - - - PhoneGap Search Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.startcallbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.startcallbutton.md b/docs/en/1.1.0/phonegap/events/events.startcallbutton.md deleted file mode 100644 index 3ddad3b..0000000 --- a/docs/en/1.1.0/phonegap/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 PhoneGap '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 ------------- - - - - - PhoneGap Start Call Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.volumedownbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.volumedownbutton.md b/docs/en/1.1.0/phonegap/events/events.volumedownbutton.md deleted file mode 100644 index 7424ee7..0000000 --- a/docs/en/1.1.0/phonegap/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 PhoneGap '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 ------------- - - - - - PhoneGap Volume Down Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/events/events.volumeupbutton.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/events/events.volumeupbutton.md b/docs/en/1.1.0/phonegap/events/events.volumeupbutton.md deleted file mode 100644 index 850673e..0000000 --- a/docs/en/1.1.0/phonegap/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 PhoneGap '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 ------------- - - - - - PhoneGap Volume Up Button Example - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/directoryentry/directoryentry.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/directoryentry/directoryentry.md b/docs/en/1.1.0/phonegap/file/directoryentry/directoryentry.md deleted file mode 100644 index d957daf..0000000 --- a/docs/en/1.1.0/phonegap/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 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 -- 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/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/directoryreader/directoryreader.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/directoryreader/directoryreader.md b/docs/en/1.1.0/phonegap/file/directoryreader/directoryreader.md deleted file mode 100644 index 58e59ba..0000000 --- a/docs/en/1.1.0/phonegap/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 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/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/fileentry/fileentry.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/fileentry/fileentry.md b/docs/en/1.1.0/phonegap/file/fileentry/fileentry.md deleted file mode 100644 index ee9099c..0000000 --- a/docs/en/1.1.0/phonegap/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 PhoneGap: - -- __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/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/fileerror/fileerror.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/fileerror/fileerror.md b/docs/en/1.1.0/phonegap/file/fileerror/fileerror.md deleted file mode 100644 index 75511c5..0000000 --- a/docs/en/1.1.0/phonegap/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/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/fileobj/fileobj.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/fileobj/fileobj.md b/docs/en/1.1.0/phonegap/file/fileobj/fileobj.md deleted file mode 100644 index 5c37994..0000000 --- a/docs/en/1.1.0/phonegap/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/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/filereader/filereader.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/filereader/filereader.md b/docs/en/1.1.0/phonegap/file/filereader/filereader.md deleted file mode 100644 index 450a30c..0000000 --- a/docs/en/1.1.0/phonegap/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 listners 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/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/filesystem/filesystem.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/filesystem/filesystem.md b/docs/en/1.1.0/phonegap/file/filesystem/filesystem.md deleted file mode 100644 index 4831472..0000000 --- a/docs/en/1.1.0/phonegap/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/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/filetransfer/filetransfer.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/filetransfer/filetransfer.md b/docs/en/1.1.0/phonegap/file/filetransfer/filetransfer.md deleted file mode 100644 index 0b752d3..0000000 --- a/docs/en/1.1.0/phonegap/file/filetransfer/filetransfer.md +++ /dev/null @@ -1,139 +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. - -Properties ----------- - -N/A - -Methods -------- - -- __upload__: sends a file to a 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. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 ( Mango ) - -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); - } - - 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

- - - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/filetransfererror/filetransfererror.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/filetransfererror/filetransfererror.md b/docs/en/1.1.0/phonegap/file/filetransfererror/filetransfererror.md deleted file mode 100644 index 08716e3..0000000 --- a/docs/en/1.1.0/phonegap/file/filetransfererror/filetransfererror.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. ---- - -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) - -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. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/fileuploadoptions/fileuploadoptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/fileuploadoptions/fileuploadoptions.md b/docs/en/1.1.0/phonegap/file/fileuploadoptions/fileuploadoptions.md deleted file mode 100644 index ce937a2..0000000 --- a/docs/en/1.1.0/phonegap/file/fileuploadoptions/fileuploadoptions.md +++ /dev/null @@ -1,38 +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. ---- - -FileUploadOptions -======== - -A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script. - -Properties ----------- - -- __fileKey:__ The name of the form element. If not set defaults to "file". (DOMString) -- __fileName:__ The file name you want the file to be saved as on the server. If not set defaults to "image.jpg". (DOMString) -- __mimeType:__ The mime type of the data you are uploading. If not set defaults to "image/jpeg". (DOMString) -- __params:__ A set of optional key/value pairs to be passed along in the HTTP request. (Object) -- __chunkedMode:__ Should the data be uploaded in chunked streaming mode. If not set defaults to "true". (Boolean) - - -Description ------------ - -A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/fileuploadresult/fileuploadresult.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/fileuploadresult/fileuploadresult.md b/docs/en/1.1.0/phonegap/file/fileuploadresult/fileuploadresult.md deleted file mode 100644 index f21d036..0000000 --- a/docs/en/1.1.0/phonegap/file/fileuploadresult/fileuploadresult.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. ---- - -FileUploadResult -======== - -A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method. - -Properties ----------- - -- __bytesSent:__ The number of bytes sent to the server as part of the upload. (long) -- __responseCode:__ The HTTP response code returned by the server. (long) -- __response:__ The HTTP response returned by the server. (DOMString) - -Description ------------ - -The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method. - -iOS Quirks ----------- -- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object. - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/filewriter/filewriter.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/filewriter/filewriter.md b/docs/en/1.1.0/phonegap/file/filewriter/filewriter.md deleted file mode 100644 index e104e82..0000000 --- a/docs/en/1.1.0/phonegap/file/filewriter/filewriter.md +++ /dev/null @@ -1,192 +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. ---- - -FileWriter -========== - -FileWriter is an object that allows one to write a file. - -Properties ----------- - -- __readyState:__ One of the three states the reader can be in INIT, WRITING or DONE. -- __fileName:__ The name of the file to be written. _(DOMString)_ -- __length:__ The length of the file to be written. _(long)_ -- __position:__ The current position of the file pointer. _(long)_ -- __error:__ An object containing errors. _(FileError)_ -- __onwritestart:__ Called when the write starts. . _(Function)_ -- __onprogress:__ Called while writing the file, reports progress (progess.loaded/progress.total). _(Function)_ -NOT SUPPORTED -- __onwrite:__ Called when the request has completed successfully. _(Function)_ -- __onabort:__ Called when the write has been aborted. For instance, by invoking the abort() method. _(Function)_ -- __onerror:__ Called when the write has failed. _(Function)_ -- __onwriteend:__ Called when the request has completed (either in success or failure). _(Function)_ - -Methods -------- - -- __abort__: Aborts writing file. -- __seek__: Moves the file pointer to the byte specified. -- __truncate__: Shortens the file to the length specified. -- __write__: Writes data to the file. - -Details -------- - -The `FileWriter` object is a way to write files from the devices file system. Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events. - -A FileWriter is created for a single file. You can use it to write to a file multiple times. The FileWriter maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the FileWriter writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor to begin writing to the end of the file. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 ( Mango ) - -Seek Quick Example ------------------------------- - - function win(writer) { - // fast forwards file pointer to end of file - writer.seek(writer.length); - }; - - var fail = function(evt) { - console.log(error.code); - }; - - entry.createWriter(win, fail); - -Truncate Quick Example --------------------------- - - function win(writer) { - writer.truncate(10); - }; - - var fail = function(evt) { - console.log(error.code); - }; - - entry.createWriter(win, fail); - -Write Quick Example -------------------- - - function win(writer) { - writer.onwrite = function(evt) { - console.log("write success"); - }; - writer.write("some sample text"); - }; - - var fail = function(evt) { - console.log(error.code); - }; - - entry.createWriter(win, fail); - -Append Quick Example --------------------- - - function win(writer) { - writer.onwrite = function(evt) { - console.log("write success"); - }; - writer.seek(writer.length); - writer.write("appended text"); - }; - - var fail = function(evt) { - console.log(error.code); - }; - - entry.createWriter(win, fail); - -Abort Quick Example -------------------- - - function win(writer) { - writer.onwrite = function(evt) { - console.log("write success"); - }; - writer.write("some sample text"); - writer.abort(); - }; - - var fail = function(evt) { - console.log(error.code); - }; - - entry.createWriter(win, fail); - -Full Example ------------- - - - - FileWriter Example - - - - - -

Example

Write File

- - http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/1.1.0/phonegap/file/flags/flags.md ---------------------------------------------------------------------- diff --git a/docs/en/1.1.0/phonegap/file/flags/flags.md b/docs/en/1.1.0/phonegap/file/flags/flags.md deleted file mode 100644 index 054c2fc..0000000 --- a/docs/en/1.1.0/phonegap/file/flags/flags.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Flags -===== - -This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively. - -Properties ----------- - -- __create:__ Used to indicate that the file or directory should be created, if it does not exist. _(boolean)_ -- __exclusive:__ By itself, exclusive has no effect. Used with create, it causes the file or directory creation to fail if the target path already exists. _(boolean)_ - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 ( Mango ) - -Quick Example -------------- - - // Get the data directory, creating it if it doesn't exist. - dataDir = fileSystem.root.getDirectory("data", {create: true}); - - // Create the lock file, if and only if it doesn't exist. - lockFile = dataDir.getFile("lockfile.txt", {create: true, exclusive: true});