You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by "Wouter (Created) (JIRA)" <ji...@apache.org> on 2012/04/13 09:34:35 UTC

[jira] [Created] (CB-498) Incorrect documentation for FileTransfer.upload and FileTransfer.download methods

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

       

[jira] [Resolved] (CB-498) Incorrect documentation for FileTransfer.upload and FileTransfer.download methods

Posted by "Simon MacDonald (Resolved) (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/CB-498?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Simon MacDonald resolved CB-498.
--------------------------------

       Resolution: Fixed
    Fix Version/s: 1.6.1

I'm sure I had fixed this previously but it appears to have been lost somehow.
                
> 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: Simon MacDonald
>            Priority: Trivial
>             Fix For: 1.6.1
>
>
> 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

       

[jira] [Assigned] (CB-498) Incorrect documentation for FileTransfer.upload and FileTransfer.download methods

Posted by "Simon MacDonald (Assigned) (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/CB-498?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Simon MacDonald reassigned CB-498:
----------------------------------

    Assignee: Simon MacDonald  (was: Michael Brooks)
    
> 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: Simon MacDonald
>            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