Previous | Next

OnFileDownloadProgress Event

Occurs when the progress has been made downloading a file.

OnFileDownloadProgress(
     Long fileId,
     String fileSize,
     String downloadedSize,
     Long downloadedTime,
     String remainSize,
     Long remainTime,
     Double rate
)

Parameters

fileId
Type: Long
The ID of the file for which the download progress has been made. The file ID is a value returned from the AddFile method when the file was added to the file list.

fileSize
Type: String
The file size (in bytes). If the file size is not known, the fileSize is "-1". Even though the fileSize is of String type (to support large file sizes - up to 263 bytes in Professional Edition and up to 227 bytes in Free Edition), it always contains integer values specifying the file size in bytes.

downloadedSize
Type: String
The size of the file content already downloaded (in bytes). Even though the downloadedSize is of String type (to support large file sizes - up to 263 bytes in Professional Edition and up to 227 bytes in Free Edition), it always contains integer values specifying the size of the already downloaded file content in bytes.

downloadedTime
Type: Long
The number of seconds elapsed since the file started downloading.

remainSize
Type: String
The size of the file content remaining to be downloaded (in bytes). If the file size is not known, the remainSize is "-1". Even though the remainSize is of String type (to support large file sizes - up to 263 bytes in Professional Edition and up to 227 bytes in Free Edition), it always contains integer values specifying the size of the file content remaining to be downloaded in bytes.

remainTime
Type: Long
The number of seconds remaining to download the file completely. If the file size is not known, the remainTime is -1.

rate
Type: Double
The rate at which the file gets downloaded (in KB/s).