Class FTPCallbackStatus
Object
|
+--FTPCallbackStatus
- class
FTPCallbackStatus
Reports on the status of the an FTP operation.
FTPCallbackStatus objects are passed as the first argument of every
FTPClient callback. It informs the callback of the success or failure
of the operations and the error-message (in case of failure). It also
contains the unique identifier of the operation (returned by the
FTPClient method that launched the operation, as well as the tag that
was passed in when the operation was launched. Please refer to the
Integral FTP Developer's Guide for details.
Defined in ftpclient.js
Field Summary |
string |
errorMessage
Error message (in case of failure) |
FTPClient |
ftpClient
FTPClient which called back. |
boolean |
success
Flag indicating whether or not the operation succeeded. |
object |
tag
User-defined tag that was passed into the method |
int |
taskID
Unique identifier that identifies the task. |
Constructor Summary |
FTPCallbackStatus(ftpClient, <boolean> success, <string> errorMessage, <int> taskID, <object> tag)
Construct an FTPCallbackStatus object.
|
errorMessage
string errorMessage
Error message (in case of failure)
ftpClient
FTPClient ftpClient
FTPClient which called back.
success
boolean success
Flag indicating whether or not the operation succeeded.
tag
object tag
User-defined tag that was passed into the method
taskID
int taskID
Unique identifier that identifies the task.
FTPCallbackStatus
FTPCallbackStatus(ftpClient, <boolean> success, <string> errorMessage, <int> taskID, <object> tag)
Construct an FTPCallbackStatus object.
Parameters:
success
- True if the operation succeeded.
errorMessage
- Error message (in case of failure).
taskID
- Task identifier.
tag
- User-defined tag that was passed into the method. that launched the operation.
Documentation generated by
JSDoc on Tue Jan 24 10:46:49 2012