You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/03/14 18:27:04 UTC
[1/2] docs commit: Updated docs for FileTransfer.download headers
Updated docs for FileTransfer.download headers
As per issue CB-861, I have updated the docs for FileTransfer to list the optional headers
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/5716e84a
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/5716e84a
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/5716e84a
Branch: refs/heads/master
Commit: 5716e84a73901c146b3a232223588388519580b3
Parents: 060c2d2
Author: Tommy-Carlos Williams <to...@devgeeks.org>
Authored: Fri Mar 1 10:23:38 2013 +1100
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Thu Mar 14 10:26:11 2013 -0700
----------------------------------------------------------------------
.../edge/cordova/file/filetransfer/filetransfer.md | 7 +++++++
1 files changed, 7 insertions(+), 0 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5716e84a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index aa9dc95..39585c6 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -199,6 +199,7 @@ __Parameters:__
- __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)_
- __trustAllHosts__ - Optional parameter, defaults to false. If set to true then it will accept all security certificates. This is useful as Android rejects self signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
+- __options__ - Optional parameters, currently only supports headers (such as Basic Authentication, etc).
__Quick Example__
@@ -217,6 +218,12 @@ __Quick Example__
console.log("download error source " + error.source);
console.log("download error target " + error.target);
console.log("upload error code" + error.code);
+ },
+ false,
+ {
+ headers: {
+ "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
+ }
}
);