Previous | Next

OnFileSegmentDownloadProgress Event

Occurs when the progress has been made downloading a file segment.

OnFileSegmentDownloadProgress(
     Long fileId,
     Long segmentIndex,
     String segmentSize,
     String segmentDownloadedSize,
     String segmentRemainSize
)

Parameters

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

segmentIndex
Type: Long
The index of the file segment for which the download progress has been made. The segmentIndex values are 0-based, meaning the first segment of the specified file has the segmentIndex value of 0.

segmentSize
Type: String
The size of the file segment (in bytes). If the file segment size is not known, the segmentSize is "-1". Even though the segmentSize 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 segment size in bytes.

segmentDownloadedSize
Type: String
The size of the file segment content already downloaded (in bytes). Even though the segmentDownloadedSize 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 segment content in bytes.

segmentRemainSize
Type: String
The size of the file segment content remaining to be downloaded (in bytes). If the file segment size is not known, the segmentRemainSize is "-1". Even though the segmentRemainSize 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 segment content remaining to be downloaded in bytes.