offline-playback/com.brightcove.player.network/DownloadManager/Request

Request

open class Request : IDownloadManager.IRequest

Provides mutable implementation of IRequest, which can be used to submit download requests to the IDownloadManager.

Constructors

Link copied to clipboard
constructor(remoteUri: Uri)
Constructs a new download request.
constructor(remoteUri: Uri, localUri: Uri)
Constructs a new download request.

Properties

Link copied to clipboard
open var description: String
The description of this download to be displayed in notifications (if enabled)
Link copied to clipboard
open var estimatedSize: Long
The estimated total size of the download as number of bytes.
Link copied to clipboard
open var headers: Map<String, String>
The list of headers to the send in HTTP request.
Link copied to clipboard
open var localUri: Uri
The local destination for the downloaded file.
Link copied to clipboard
open var mimeType: String
The MIME content type of this download.
Link copied to clipboard
open var notificationVisibility: Int
Specifies whether a system notification is posted by the download manager while this download is running or when it is completed.
Link copied to clipboard
open var remoteUri: Uri
The URL to the remote file.
Link copied to clipboard
open var title: String
The title of this download to be displayed in notifications (if enabled).

Functions

Link copied to clipboard
open fun isAllowedOverBluetooth(): Boolean
Specifies whether this download may proceed over a bluetooth network connection.
Link copied to clipboard
open fun isAllowedOverMetered(): Boolean
Specifies whether this download may proceed over a metered network connection.
Link copied to clipboard
open fun isAllowedOverMobile(): Boolean
Specifies whether this download may proceed over a mobile network connection.
Link copied to clipboard
open fun isAllowedOverRoaming(): Boolean
Specifies whether this download may proceed over a roaming connection.
Link copied to clipboard
open fun isAllowedOverWifi(): Boolean
Specifies whether this download may proceed over a WIFI network connection.
Link copied to clipboard
open fun isAllowScanningByMediaScanner(): Boolean
Specifies whether the file to be downloaded should be marked as scannable by MediaScanner.
Link copied to clipboard
open fun isVisibleInDownloadsUi(): Boolean
Gets whether this download should be displayed in the system's Downloads UI.
Link copied to clipboard
open fun setAllowedOverBluetooth(allowed: Boolean): DownloadManager.Request
Specifies whether this download may proceed over a bluetooth network connection.
Link copied to clipboard
open fun setAllowedOverMetered(allowed: Boolean): DownloadManager.Request
Specifies whether this download may proceed over a metered network connection.
Link copied to clipboard
open fun setAllowedOverMobile(allowed: Boolean): DownloadManager.Request
Specifies whether this download may proceed over a mobile network connection.
Link copied to clipboard
open fun setAllowedOverRoaming(allowed: Boolean): DownloadManager.Request
Specifies whether this download may proceed over a roaming network connection.
Link copied to clipboard
open fun setAllowedOverWifi(allowed: Boolean): DownloadManager.Request
Specifies whether this download may proceed over a WIFI network connection.
Link copied to clipboard
open fun setAllowScanningByMediaScanner(allow: Boolean): DownloadManager.Request
Specifies whether the file to be downloaded should be marked as scannable by MediaScanner.
Link copied to clipboard
open fun setVisibleInDownloadsUi(visible: Boolean): DownloadManager.Request
Specifies whether this download should be displayed in the system's Downloads UI.