[CB-498] Incorrect documentation for FileTransfer.upload and FileTransfer.download methods

• Type: Bug
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 1.6.0
• Fix Version/s: 1.6.1

Environment

http://docs.phonegap.com/en/1.6.0/cordova_file_file.md.html#FileTransfer

• Assignee: Simon MacDonald
• Reporter: Wouter
• Created: 13/Apr/12 07:33
• Updated: 23/Aug/18 06:45
• Resolved: 13/Apr/12 14:22

Description

In the documentation for the FileTransfer method (http://docs.phonegap.com/en/1.6.0/cordova_file_file.md.html#FileTransfer) this is listed as part of the parameters for the upload method:

• 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)

In my opinion this should be:

• successCallback - A callback that is called with a FileUploadResult object. (Function)
• errorCallback - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. (Function)

In the documentation for the download method this is listed as part of the parameters:

• errorCallback - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. (Function)

In my opinion this should be:

• errorCallback - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. (Function)