kotlin-actions-cache/actions.cache/DownloadProgress

DownloadProgress

open external class DownloadProgress(source)

Constructors

DownloadProgress

constructor(contentLength: Number)

Properties

external var contentLength: Number

displayedComplete

external var displayedComplete: Boolean

external var receivedBytes: Number

external var segmentIndex: Number

external var segmentOffset: Number

external var segmentSize: Number

external var startTime: Number

external var timeoutHandle: Timeout?

Functions

external fun display()

Prints the current download stats. Once the download completes, this will print one last line and then stop.

getTransferredBytes

external fun getTransferredBytes(): Number

Returns the total number of bytes transferred.

external fun isDone(): Boolean

Returns true if the download is complete.

external fun nextSegment(segmentSize: Number)

Progress to the next segment. Only call this method when the previous segment is complete.

external fun onProgress(): (progress: TransferProgressEvent) -> Unit

Returns a function used to handle TransferProgressEvents.

setReceivedBytes

external fun setReceivedBytes(receivedBytes: Number)

Sets the number of bytes received for the current segment.

startDisplayTimer

external fun startDisplayTimer(delayInMs: Number = definedExternally)

Starts the timer that displays the stats.

stopDisplayTimer

external fun stopDisplayTimer()

Stops the timer that displays the stats. As this typically indicates the download is complete, this will display one last line, unless the last line has already been written.