incubator-callback-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Wouter (Created) (JIRA)" <j...@apache.org>
Subject [jira] [Created] (CB-498) Incorrect documentation for FileTransfer.upload and FileTransfer.download methods
Date Fri, 13 Apr 2012 07:34:35 GMT
Incorrect documentation for FileTransfer.upload and FileTransfer.download methods
---------------------------------------------------------------------------------

                 Key: CB-498
                 URL: https://issues.apache.org/jira/browse/CB-498
             Project: Apache Callback
          Issue Type: Bug
          Components: Docs
    Affects Versions: 1.6.0
         Environment: http://docs.phonegap.com/en/1.6.0/cordova_file_file.md.html#FileTransfer
            Reporter: Wouter
            Assignee: Michael Brooks
            Priority: Trivial


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)



 

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

Mime
View raw message