You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/09/04 05:10:52 UTC
[09/51] [partial] Delete rc versions of docs
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/fileentry/fileentry.md b/docs/en/2.1.0rc1/cordova/file/fileentry/fileentry.md
deleted file mode 100644
index 4137ba9..0000000
--- a/docs/en/2.1.0rc1/cordova/file/fileentry/fileentry.md
+++ /dev/null
@@ -1,324 +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.
-- __setMetadata__: Set metadata on 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.
-- __toURL__: Return a URL that can be used to locate a file.
-- __remove__: Delete a file.
-- __getParent__: Look up the parent directory.
-- __createWriter__: Creates a FileWriter object that can be used to write to a file.
-- __file__: Creates a File object containing file properties.
-
-
-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);
-
-
-setMetadata
-----------------
-
-Set metadata on a file.
-**Only works on iOS currently** - this will set the extended attributes of a file.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called when the metadata was successfully set. _(Function)_
-- __errorCallback__ - A callback that is called when the metadata was not successfully set. _(Function)_
-- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
-
-
-__Quick Example__
-
- function success() {
- console.log("The metadata was successfully set.");
- }
-
- function fail() {
- alert("There was an error in setting the metadata");
- }
-
- // Set the metadata
- entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
-__iOS Quirk__
-
-- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the file to be backed up by iCloud. Set the value to **0** to re-enable the file to be backed up by iCloud.
-
-__Quick Example__
-
- function setFileMetadata(localFileSystem, filePath, metadataKey, metadataValue)
- {
- var onSetMetadataWin = function() {
- console.log("success setting metadata")
- }
- var onSetMetadataFail = function() {
- console.log("error setting metadata")
- }
-
- var onGetFileWin = function(parent) {
- parent.setMetadata(onSetMetadataWin, onSetMetadataFail, { metadataKey: metadataValue});
- }
- var onGetFileFail = function() {
- console.log("error getting file")
- }
-
- var onFSWin = function(fileSystem) {
- fileSystem.root.getFile(filePath, {create: true, exclusive: false}, onGetFileWin, onGetFileFail);
- }
-
- var onFSFail = function(evt) {
- console.log(evt.target.error.code);
- }
-
- window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
- }
-
- setFileMetadata(LocalFileSystem.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
-
-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,
- parentName = parent.substring(parent.lastIndexOf('/')+1),
- parentEntry = new DirectoryEntry(parentName, 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,
- parentName = parent.substring(parent.lastIndexOf('/')+1),
- parentEntry = new DirectoryEntry(parentName, parent);
-
- // copy the file to a new directory and rename it
- entry.copyTo(parentEntry, "file.copy", success, fail);
- }
-
-
-toURL
------
-
-Returns a URL that can be used to locate the file.
-
-__Quick Example__
-
- // Request the URL for this entry
- var fileURL = entry.toURL();
- console.log(fileURL);
-
-
-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/875c8fe2/docs/en/2.1.0rc1/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/fileerror/fileerror.md b/docs/en/2.1.0rc1/cordova/file/fileerror/fileerror.md
deleted file mode 100644
index 75511c5..0000000
--- a/docs/en/2.1.0rc1/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/875c8fe2/docs/en/2.1.0rc1/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/fileobj/fileobj.md b/docs/en/2.1.0rc1/cordova/file/fileobj/fileobj.md
deleted file mode 100644
index 5c37994..0000000
--- a/docs/en/2.1.0rc1/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/875c8fe2/docs/en/2.1.0rc1/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/filereader/filereader.md b/docs/en/2.1.0rc1/cordova/file/filereader/filereader.md
deleted file mode 100644
index 495a6f0..0000000
--- a/docs/en/2.1.0rc1/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
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>FileReader Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // Cordova is ready
- //
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
- }
-
- function gotFS(fileSystem) {
- fileSystem.root.getFile("readme.txt", null, gotFileEntry, fail);
- }
-
- function gotFileEntry(fileEntry) {
- fileEntry.file(gotFile, fail);
- }
-
- function gotFile(file){
- readDataUrl(file);
- readAsText(file);
- }
-
- function readDataUrl(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("Read as data URL");
- console.log(evt.target.result);
- };
- reader.readAsDataURL(file);
- }
-
- function readAsText(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("Read as text");
- console.log(evt.target.result);
- };
- reader.readAsText(file);
- }
-
- function fail(evt) {
- console.log(evt.target.error.code);
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Read File</p>
- </body>
- </html>
-
-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/875c8fe2/docs/en/2.1.0rc1/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/filesystem/filesystem.md b/docs/en/2.1.0rc1/cordova/file/filesystem/filesystem.md
deleted file mode 100644
index 4274315..0000000
--- a/docs/en/2.1.0rc1/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
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>File System Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
- }
-
- function onFileSystemSuccess(fileSystem) {
- console.log(fileSystem.name);
- console.log(fileSystem.root.name);
- }
-
- function fail(evt) {
- console.log(evt.target.error.code);
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>File System</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/filetransfer/filetransfer.md b/docs/en/2.1.0rc1/cordova/file/filetransfer/filetransfer.md
deleted file mode 100644
index 71537a7..0000000
--- a/docs/en/2.1.0rc1/cordova/file/filetransfer/filetransfer.md
+++ /dev/null
@@ -1,217 +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 (must already be encoded using encodeURI())
-- __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 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, encodeURI("http://some.server.com/upload.php"), win, fail, options);
-
-__Full Example__
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>File Transfer Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
-
- // Retrieve image file location from specified source
- navigator.camera.getPicture(uploadPhoto,
- function(message) { alert('get picture failed'); },
- { quality: 50,
- destinationType: navigator.camera.DestinationType.FILE_URI,
- sourceType: navigator.camera.PictureSourceType.PHOTOLIBRARY }
- );
-
- }
-
- function uploadPhoto(imageURI) {
- var options = new FileUploadOptions();
- options.fileKey="file";
- options.fileName=imageURI.substr(imageURI.lastIndexOf('/')+1);
- options.mimeType="image/jpeg";
-
- var params = new Object();
- params.value1 = "test";
- params.value2 = "param";
-
- options.params = params;
-
- var ft = new FileTransfer();
- ft.upload(imageURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
- }
-
- function win(r) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
- }
-
- function fail(error) {
- alert("An error has occurred: Code = " + error.code);
- console.log("upload error source " + error.source);
- console.log("upload error target " + error.target);
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Upload File</p>
- </body>
- </html>
-
-iOS Quirks
-----------
-
-Setting headers for FileTransfer Upload:
-
-__Quick Example__
-
- function win(r) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
- }
-
- function fail(error) {
- alert("An error has occurred: Code = " + error.code);
- console.log("upload error source " + error.source);
- console.log("upload error target " + error.target);
- }
-
- var uri = encodeURI("http://some.server.com/upload.php");
-
- var options = new FileUploadOptions();
- options.fileKey="file";
- options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
- options.mimeType="text/plain";
-
- var params = new Object();
- params.headers={'headerParam':'headerValue'};
-
- options.params = params;
-
- var ft = new FileTransfer();
- ft.upload(fileURI, uri, win, fail, options);
-
-download
---------------
-
-__Parameters:__
-
-- __source__ - URL of the server to download the file (must already be encoded using encodeURI())
-- __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 Metadata. 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();
- var uri = encodeURI("http://some.server.com/download.php");
-
- fileTransfer.download(
- uri,
- 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);
- }
- );
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/filetransfererror/filetransfererror.md b/docs/en/2.1.0rc1/cordova/file/filetransfererror/filetransfererror.md
deleted file mode 100644
index a643bf3..0000000
--- a/docs/en/2.1.0rc1/cordova/file/filetransfererror/filetransfererror.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.
----
-
-FileTransferError
-========
-
-A `FileTransferError` object is returned via the error callback when an error occurs.
-
-Properties
-----------
-
-- __code__ One of the predefined error codes listed below. (Number)
-- __source__ URI to the source (String)
-- __target__ URI to the target (String)
-- __http_status__ HTTP status code. This attribute is only available when a response code is received from the HTTP connection. (Number)
-
-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 or downloading a file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/2.1.0rc1/cordova/file/fileuploadoptions/fileuploadoptions.md
deleted file mode 100644
index 5246ce8..0000000
--- a/docs/en/2.1.0rc1/cordova/file/fileuploadoptions/fileuploadoptions.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.
----
-
-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)
-- __headers:__ A map of header name => header value. To specify multiple values for a header, use an array of values. (Object)
-
-
-Description
------------
-
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
-
-WP7 Quirk
----------
-
-- __chunkedMode:__
- This parameter is ignored on WP7.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/2.1.0rc1/cordova/file/fileuploadresult/fileuploadresult.md
deleted file mode 100644
index f21d036..0000000
--- a/docs/en/2.1.0rc1/cordova/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/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/filewriter/filewriter.md b/docs/en/2.1.0rc1/cordova/file/filewriter/filewriter.md
deleted file mode 100644
index 11cc217..0000000
--- a/docs/en/2.1.0rc1/cordova/file/filewriter/filewriter.md
+++ /dev/null
@@ -1,194 +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 (progress.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 with a UTF-8 encoding.
-
-Details
--------
-
-The `FileWriter` object is a way to write files to the device file system (UTF-8 encoded). 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
-------------
- <!DOCTYPE html>
- <html>
- <head>
- <title>FileWriter Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
- }
-
- function gotFS(fileSystem) {
- fileSystem.root.getFile("readme.txt", {create: true, exclusive: false}, gotFileEntry, fail);
- }
-
- function gotFileEntry(fileEntry) {
- fileEntry.createWriter(gotFileWriter, fail);
- }
-
- function gotFileWriter(writer) {
- writer.onwriteend = function(evt) {
- console.log("contents of file now 'some sample text'");
- writer.truncate(11);
- writer.onwriteend = function(evt) {
- console.log("contents of file now 'some sample'");
- writer.seek(4);
- writer.write(" different text");
- writer.onwriteend = function(evt){
- console.log("contents of file now 'some different text'");
- }
- };
- };
- writer.write("some sample text");
- }
-
- function fail(error) {
- console.log(error.code);
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Write File</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/flags/flags.md b/docs/en/2.1.0rc1/cordova/file/flags/flags.md
deleted file mode 100644
index 054c2fc..0000000
--- a/docs/en/2.1.0rc1/cordova/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});
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/localfilesystem/localfilesystem.md b/docs/en/2.1.0rc1/cordova/file/localfilesystem/localfilesystem.md
deleted file mode 100644
index 903362e..0000000
--- a/docs/en/2.1.0rc1/cordova/file/localfilesystem/localfilesystem.md
+++ /dev/null
@@ -1,110 +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.
----
-
-LocalFileSystem
-===============
-
-This object provides a way to obtain root file systems.
-
-Methods
-----------
-
-- __requestFileSystem:__ Requests a filesystem. _(Function)_
-- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_
-
-Constants
----------
-
-- `LocalFileSystem.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission.
-- `LocalFileSystem.TEMPORARY`: Used for storage with no guarantee of persistence.
-
-Details
--------
-
-The `LocalFileSystem` object methods are defined on the __window__ object.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-Request File System Quick Example
----------------------------------
-
- function onSuccess(fileSystem) {
- console.log(fileSystem.name);
- }
-
- // request the persistent file system
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
-
-Resolve Local File System URI Quick Example
--------------------------------------------
-
- function onSuccess(fileEntry) {
- console.log(fileEntry.name);
- }
-
- window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
-
-Full Example
-------------
-
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Local File System Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
- window.resolveLocalFileSystemURI("file:///example.txt", onResolveSuccess, fail);
- }
-
- function onFileSystemSuccess(fileSystem) {
- console.log(fileSystem.name);
- }
-
- function onResolveSuccess(fileEntry) {
- console.log(fileEntry.name);
- }
-
- function fail(evt) {
- console.log(evt.target.error.code);
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Local File System</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/metadata/metadata.md b/docs/en/2.1.0rc1/cordova/file/metadata/metadata.md
deleted file mode 100644
index 0bc75e5..0000000
--- a/docs/en/2.1.0rc1/cordova/file/metadata/metadata.md
+++ /dev/null
@@ -1,51 +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.
----
-
-Metadata
-==========
-
-This interface supplies information about the state of a file or directory.
-
-Properties
-----------
-
-- __modificationTime:__ This is the time at which the file or directory was last modified. _(Date)_
-
-Details
--------
-
-The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `DirectoryEntry` or `FileEntry` object.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-Quick Example
--------------
-
- function win(metadata) {
- console.log("Last Modified: " + metadata.modificationTime);
- }
-
- // Request the metadata object for this entry
- entry.getMetadata(win, null);
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/geolocation/Coordinates/coordinates.md b/docs/en/2.1.0rc1/cordova/geolocation/Coordinates/coordinates.md
deleted file mode 100644
index 5afcf9c..0000000
--- a/docs/en/2.1.0rc1/cordova/geolocation/Coordinates/coordinates.md
+++ /dev/null
@@ -1,125 +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.
----
-
-Coordinates
-===========
-
-A set of properties that describe the geographic coordinates of a position.
-
-Properties
-----------
-
-* __latitude__: Latitude in decimal degrees. _(Number)_
-* __longitude__: Longitude in decimal degrees. _(Number)_
-* __altitude__: Height of the position in meters above the ellipsoid. _(Number)_
-* __accuracy__: Accuracy level of the latitude and longitude coordinates in meters. _(Number)_
-* __altitudeAccuracy__: Accuracy level of the altitude coordinate in meters. _(Number)_
-* __heading__: Direction of travel, specified in degrees counting clockwise relative to the true north. _(Number)_
-* __speed__: Current ground speed of the device, specified in meters per second. _(Number)_
-
-Description
------------
-
-The `Coordinates` object is created and populated by Cordova, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-- Bada 1.2 & 2.x
-- webOS
-
-Quick Example
--------------
-
- // onSuccess Callback
- //
- var onSuccess = function(position) {
- alert('Latitude: ' + position.coords.latitude + '\n' +
- 'Longitude: ' + position.coords.longitude + '\n' +
- 'Altitude: ' + position.coords.altitude + '\n' +
- 'Accuracy: ' + position.coords.accuracy + '\n' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
- 'Heading: ' + position.coords.heading + '\n' +
- 'Speed: ' + position.coords.speed + '\n' +
- 'Timestamp: ' + position.timestamp + '\n');
- };
-
- // onError Callback
- //
- var onError = function() {
- alert('onError!');
- };
-
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Geolocation Position Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Set an event to wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is loaded and Ready
- //
- function onDeviceReady() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
- }
-
- // Display `Position` properties from the geolocation
- //
- function onSuccess(position) {
- var div = document.getElementById('myDiv');
-
- div.innerHTML = 'Latitude: ' + position.coords.latitude + '<br/>' +
- 'Longitude: ' + position.coords.longitude + '<br/>' +
- 'Altitude: ' + position.coords.altitude + '<br/>' +
- 'Accuracy: ' + position.coords.accuracy + '<br/>' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br/>' +
- 'Heading: ' + position.coords.heading + '<br/>' +
- 'Speed: ' + position.coords.speed + '<br/>';
- }
-
- // Show an alert if there is a problem getting the geolocation
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <div id="myDiv"></div>
- </body>
- </html>
-
-Android Quirks
--------------
-
-__altitudeAccuracy:__ This property is not support by Android devices, it will always return null.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/geolocation/Position/position.md b/docs/en/2.1.0rc1/cordova/geolocation/Position/position.md
deleted file mode 100644
index 009192b..0000000
--- a/docs/en/2.1.0rc1/cordova/geolocation/Position/position.md
+++ /dev/null
@@ -1,119 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-Position
-========
-
-Contains `Position` coordinates and timestamp, created by the geolocation API.
-
-Properties
-----------
-
-- __coords:__ A set of geographic coordinates. _(Coordinates)_
-- __timestamp:__ Creation timestamp for `coords`. _(Date)_
-
-Description
------------
-
-The `Position` object is created and populated by Cordova, and returned to the user through a callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-- Bada 1.2 & 2.x
-- webOS
-
-Quick Example
--------------
-
- // onSuccess Callback
- //
- var onSuccess = function(position) {
- alert('Latitude: ' + position.coords.latitude + '\n' +
- 'Longitude: ' + position.coords.longitude + '\n' +
- 'Altitude: ' + position.coords.altitude + '\n' +
- 'Accuracy: ' + position.coords.accuracy + '\n' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
- 'Heading: ' + position.coords.heading + '\n' +
- 'Speed: ' + position.coords.speed + '\n' +
- 'Timestamp: ' + position.timestamp + '\n');
- };
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
- }
-
- // onSuccess Geolocation
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- 'Altitude: ' + position.coords.altitude + '<br />' +
- 'Accuracy: ' + position.coords.accuracy + '<br />' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
- 'Heading: ' + position.coords.heading + '<br />' +
- 'Speed: ' + position.coords.speed + '<br />' +
- 'Timestamp: ' +
- position.timestamp + '<br />';
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- </script>
- </head>
- <body>
- <p id="geolocation">Finding geolocation...</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/geolocation/PositionError/positionError.md b/docs/en/2.1.0rc1/cordova/geolocation/PositionError/positionError.md
deleted file mode 100755
index 5fda2f5..0000000
--- a/docs/en/2.1.0rc1/cordova/geolocation/PositionError/positionError.md
+++ /dev/null
@@ -1,59 +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.
----
-
-PositionError
-========
-
-A `PositionError` object is returned to the `geolocationError` callback when an error occurs.
-
-Properties
-----------
-
-- __code:__ One of the predefined error codes listed below.
-- __message:__ Error message describing the details of the error encountered.
-
-Constants
----------
-
-- `PositionError.PERMISSION_DENIED`
-- `PositionError.POSITION_UNAVAILABLE`
-- `PositionError.TIMEOUT`
-
-Description
------------
-
-The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
-
-### `PositionError.PERMISSION_DENIED`
-
-Returned when the user does not allow your application to retrieve
-position information. This is dependent on the platform.
-
-### `PositionError.POSITION_UNAVAILABLE`
-
-Returned when the device was unable to retrieve a position. In general
-this means the device has no network connectivity and/or cannot get a
-satellite fix.
-
-### `PositionError.TIMEOUT`
-
-Returned when the device was unable to retrieve a position within the
-time specified in the `geolocationOptions`' `timeout` property. When using
-in conjunction with `geolocation.watchPosition`, this error could be
-called into the `geolocationError` callback every `timeout` milliseconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/geolocation/geolocation.clearWatch.md b/docs/en/2.1.0rc1/cordova/geolocation/geolocation.clearWatch.md
deleted file mode 100644
index 15fbd1d..0000000
--- a/docs/en/2.1.0rc1/cordova/geolocation/geolocation.clearWatch.md
+++ /dev/null
@@ -1,117 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-geolocation.clearWatch
-======================
-
-Stop watching for changes to the device's location referenced by the `watchID` parameter.
-
- navigator.geolocation.clearWatch(watchID);
-
-Parameters
-----------
-
-- __watchID:__ The id of the `watchPosition` interval to clear. (String)
-
-Description
------------
-
-`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-- Bada 1.2 & 2.x
-- webOS
-
-Quick Example
--------------
-
- // Options: watch for changes in position, and use the most
- // accurate position acquisition method available.
- //
- var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });
-
- // ...later on...
-
- navigator.geolocation.clearWatch(watchID);
-
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- var watchID = null;
-
- // Cordova is ready
- //
- function onDeviceReady() {
- // Get the most accurate position updates available on the
- // device.
- var options = { enableHighAccuracy: true };
- watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
- }
-
- // onSuccess Geolocation
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- '<hr />' + element.innerHTML;
- }
-
- // clear the watch that was started earlier
- //
- function clearWatch() {
- if (watchID != null) {
- navigator.geolocation.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- </script>
- </head>
- <body>
- <p id="geolocation">Watching geolocation...</p>
- <button onclick="clearWatch();">Clear Watch</button>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/2.1.0rc1/cordova/geolocation/geolocation.getCurrentPosition.md
deleted file mode 100644
index f97f3d1..0000000
--- a/docs/en/2.1.0rc1/cordova/geolocation/geolocation.getCurrentPosition.md
+++ /dev/null
@@ -1,126 +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.
----
-
-geolocation.getCurrentPosition
-==============================
-
-Returns the device's current position as a `Position` object.
-
- navigator.geolocation.getCurrentPosition(geolocationSuccess,
- [geolocationError],
- [geolocationOptions]);
-
-Parameters
-----------
-
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: (Optional) The callback that is called if there was an error.
-- __geolocationOptions__: (Optional) The geolocation options.
-
-Description
------------
-
-`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
-
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-- Bada 1.2 & 2.x
-- webOS
-
-Quick Example
--------------
-
- // onSuccess Callback
- // This method accepts a `Position` object, which contains
- // the current GPS coordinates
- //
- var onSuccess = function(position) {
- alert('Latitude: ' + position.coords.latitude + '\n' +
- 'Longitude: ' + position.coords.longitude + '\n' +
- 'Altitude: ' + position.coords.altitude + '\n' +
- 'Accuracy: ' + position.coords.accuracy + '\n' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
- 'Heading: ' + position.coords.heading + '\n' +
- 'Speed: ' + position.coords.speed + '\n' +
- 'Timestamp: ' + position.timestamp + '\n');
- };
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
- }
-
- // onSuccess Geolocation
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- 'Altitude: ' + position.coords.altitude + '<br />' +
- 'Accuracy: ' + position.coords.accuracy + '<br />' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
- 'Heading: ' + position.coords.heading + '<br />' +
- 'Speed: ' + position.coords.speed + '<br />' +
- 'Timestamp: ' + position.timestamp + '<br />';
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- </script>
- </head>
- <body>
- <p id="geolocation">Finding geolocation...</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/geolocation/geolocation.md b/docs/en/2.1.0rc1/cordova/geolocation/geolocation.md
deleted file mode 100644
index b638662..0000000
--- a/docs/en/2.1.0rc1/cordova/geolocation/geolocation.md
+++ /dev/null
@@ -1,104 +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.
----
-
-Geolocation
-===========
-
-> The `geolocation` object provides access to the device's GPS sensor.
-
-Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
-
-This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices (Android, BlackBerry, Bada, Windows Phone 7 and webOS, to be specific) already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have geolocation support, the Cordova implementation adheres to the W3C specification.
-
-Methods
--------
-
-- geolocation.getCurrentPosition
-- geolocation.watchPosition
-- geolocation.clearWatch
-
-
-Arguments
----------
-
-- geolocationSuccess
-- geolocationError
-- geolocationOptions
-
-Objects (Read-Only)
--------------------
-
-- Position
-- PositionError
-- Coordinates
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/plugins.xml
-
- <plugin name="Geolocation" value="org.apache.cordova.GeoBroker" />
-
-#### app/AndroidManifest.xml
-
- <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
- <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
- <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
-
-### Bada
-
- No permissions are required.
-
-### BlackBerry WebWorks
-
-#### www/plugins.xml
-
- <plugin name="Geolocation" value="org.apache.cordova.geolocation.Geolocation" />
-
-#### www/config.xml
-
- <rim:permissions>
- <rim:permit>read_geolocation</rim:permit>
- </rim:permissions>
-
-### iOS
-
-#### App/Supporting Files/Cordova.plist
-
- <key>Plugins</key>
- <dict>
- <key>Geolocation</key>
- <string>CDVLocation</string>
- </dict>
-
-### webOS
-
- No permissions are required.
-
-### Windows Phone
-
-#### Properties/WPAppManifest.xml
-
- <Capabilities>
- <Capability Name="ID_CAP_LOCATION" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/geolocation/geolocation.watchPosition.md b/docs/en/2.1.0rc1/cordova/geolocation/geolocation.watchPosition.md
deleted file mode 100644
index 89727db..0000000
--- a/docs/en/2.1.0rc1/cordova/geolocation/geolocation.watchPosition.md
+++ /dev/null
@@ -1,128 +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.
----
-
-geolocation.watchPosition
-=========================
-
-Watches for changes to the device's current position.
-
- var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
- [geolocationError],
- [geolocationOptions]);
-
-Parameters
-----------
-
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: (Optional) The callback that is called if there was an error.
-- __geolocationOptions__: (Optional) The geolocation options.
-
-Returns
--------
-
-- __String__: returns a watch id that references the watch position interval. The watch id should be used with `geolocation.clearWatch` to stop watching for changes in position.
-
-Description
------------
-
-`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-- Bada 1.2 & 2.x
-- webOS
-
-Quick Example
--------------
-
- // onSuccess Callback
- // This method accepts a `Position` object, which contains
- // the current GPS coordinates
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- '<hr />' + element.innerHTML;
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Options: throw an error if no update is received every 30 seconds.
- //
- var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- var watchID = null;
-
- // Cordova is ready
- //
- function onDeviceReady() {
- // Throw an error if no update is received every 30 seconds
- var options = { timeout: 30000 };
- watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
- }
-
- // onSuccess Geolocation
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- '<hr />' + element.innerHTML;
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- </script>
- </head>
- <body>
- <p id="geolocation">Watching geolocation...</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/geolocation/parameters/geolocation.options.md b/docs/en/2.1.0rc1/cordova/geolocation/parameters/geolocation.options.md
deleted file mode 100644
index d822d24..0000000
--- a/docs/en/2.1.0rc1/cordova/geolocation/parameters/geolocation.options.md
+++ /dev/null
@@ -1,41 +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.
----
-
-geolocationOptions
-==================
-
-Optional parameters to customize the retrieval of the geolocation
-`Position`.
-
- { maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
-
-Options
--------
-
-- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
-- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback will be invoked with a `PositionError.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds! _(Number)_
-- __maximumAge:__ Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
-
-Android Quirks
---------------
-
-The Android 2.x simulators will not return a geolocation result unless the enableHighAccuracy option is set to true.
-
- { enableHighAccuracy: true }
-