offline-playback/com.brightcove.player.network/DownloadStatus

DownloadStatus

open class DownloadStatus

Download status describes the current status of a download request.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
@Retention(value = RetentionPolicy.SOURCE)
annotation class ReasonCode
The list of possible reasons code that will be set when StatusCode is either STATUS_RETRY or STATUS_FAILED.
Link copied to clipboard
@Retention(value = RetentionPolicy.SOURCE)
annotation class StatusCode
The list of possible status values for android.app.DownloadManager.

Properties

Link copied to clipboard
open val actualSize: Long
The actual total size of the file as number of bytes.
Link copied to clipboard
open val bytesDownloaded: Long
The total number of bytes download so far
Link copied to clipboard
open val code: Int
The download status.
Link copied to clipboard
val CREATOR: Creator<DownloadStatus>
Provides a creator field as required by the Parcelable contract.
Link copied to clipboard
val ERROR_CANNOT_RESUME: Int
The download has failed because some possibly transient error occurred but prevents resuming the download.
Link copied to clipboard
val ERROR_DEVICE_NOT_FOUND: Int
The download has failed because no external storage device was found.
Link copied to clipboard
val ERROR_FILE_ALREADY_EXISTS: Int
The download has failed because the requested destination file already exists.
Link copied to clipboard
val ERROR_FILE_ERROR: Int
The download has failed because of storage issue which doesn't fit under any other error code.
Link copied to clipboard
val ERROR_HTTP_DATA_ERROR: Int
The download has failed because an error occurred while receiving or processing data at the HTTP level.
Link copied to clipboard
val ERROR_INSUFFICIENT_SPACE: Int
The download has failed because there was insufficient storage space.
Link copied to clipboard
val ERROR_NONE: Int = 0
There are no errors in the download request.
Link copied to clipboard
val ERROR_TOO_MANY_REDIRECTS: Int
The download has failed because there were too many redirects.
Link copied to clipboard
val ERROR_UNHANDLED_HTTP_CODE: Int
The download has failed because an HTTP code was received that cannot be handled.
Link copied to clipboard
val ERROR_UNKNOWN: Int
The download has failed with an error that doesn't fit under any other error code.
Link copied to clipboard
open val estimatedSize: Long
The estimated total size of the file as number of bytes.
Link copied to clipboard
val PAUSED_QUEUED_FOR_WIFI: Int
The download exceeds a size limit for downloads over the mobile network and the download manager is waiting for a Wi-Fi connection to proceed.
Link copied to clipboard
val PAUSED_UNKNOWN: Int
The download is paused for some other reason.
Link copied to clipboard
val PAUSED_WAITING_FOR_NETWORK: Int
The download is waiting for network connectivity to proceed.
Link copied to clipboard
val PAUSED_WAITING_TO_RETRY: Int
The download is paused because some network error occurred and the download manager is waiting before retrying the request.
Link copied to clipboard
open val reason: Int
The reason why the download is currently paused or failed.
Link copied to clipboard
val STATUS_CANCELLING: Int = -2
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_COMPLETE: Int
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_DELETING: Int = -3
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_DOWNLOADING: Int
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_FAILED: Int
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_NOT_QUEUED: Int = 0
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_PAUSED: Int = -4
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_PENDING: Int
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_QUEUEING: Int = -1
Status of android.app.DownloadManager.
Link copied to clipboard
val STATUS_RETRY: Int
Status of android.app.DownloadManager.
Link copied to clipboard
open val time: Long
The date and time when the status changed as number of milliseconds since January 1, 1970, 00:00:00 GMT.

Functions

Link copied to clipboard
open fun createForInvalidDownloadsFile(): DownloadStatus
Creates a new DownloadStatus instance with error specifying that the DownloadsFile is invalid.
Link copied to clipboard
open fun describeContents(): Int
Link copied to clipboard
open fun equals(o: Any): Boolean
Link copied to clipboard
open fun getMaxSize(): Long
Gets the maximum size of the file as number of bytes by comparing actualSize and estimatedSize
Link copied to clipboard
open fun getProgress(): Double
Calculates the download progress as percentage value.
Link copied to clipboard
open fun getReasonMessage(): Int
Converts the current status code the string resourced identifier that explains the status.
Link copied to clipboard
open fun getStatusMessage(): Int
Converts the current status code to a string resource identifier that explains status.
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun isMarkedForDeletion(): Boolean
Checks if the status indicates the download is currently marked for deletion.
Link copied to clipboard
open fun toReasonMessage(reason: Int): Int
Converts the given reason code to a string resource identifier that explains the reason.
Link copied to clipboard
open fun toStatusMessage(code: Int): Int
Converts the given status code to a string resource identifier that explains the status.
Link copied to clipboard
open fun toString(): String
Link copied to clipboard
open fun writeToParcel(dest: Parcel, flags: Int)