DownloadManager

ACTION_DOWNLOAD_COMPLETE

String ACTION_DOWNLOAD_COMPLETE

Broadcast intent action sent by the download manager when a download completes.

Constant Value: "android.intent.action.DOWNLOAD_COMPLETE"

ACTION_NOTIFICATION_CLICKED

String ACTION_NOTIFICATION_CLICKED

Broadcast intent action sent by the download manager when the user clicks on a running download, either from a system notification or from the downloads UI.

Constant Value: "android.intent.action.DOWNLOAD_NOTIFICATION_CLICKED"

ACTION_VIEW_DOWNLOADS

String ACTION_VIEW_DOWNLOADS

Intent action to launch an activity to display all downloads.

Constant Value: "android.intent.action.VIEW_DOWNLOADS"

COLUMN_BYTES_DOWNLOADED_SO_FAR

String COLUMN_BYTES_DOWNLOADED_SO_FAR

Number of bytes download so far.

Constant Value: "bytes_so_far"

COLUMN_DESCRIPTION

String COLUMN_DESCRIPTION

The client-supplied description of this download. This will be displayed in system notifications. Defaults to the empty string.

Constant Value: "description"

COLUMN_ID

String COLUMN_ID

An identifier for a particular download, unique across the system. Clients use this ID to make subsequent calls related to the download.

Constant Value: "_id"

COLUMN_LAST_MODIFIED_TIMESTAMP

String COLUMN_LAST_MODIFIED_TIMESTAMP

Timestamp when the download was last modified, in System.currentTimeMillis() (wall clock time in UTC).

Constant Value: "last_modified_timestamp"

COLUMN_LOCAL_FILENAME

String COLUMN_LOCAL_FILENAME

This constant was deprecated in API level 24.
apps should transition to using openFileDescriptor(Uri, String) instead.

Path to the downloaded file on disk.

Note that apps may not have filesystem permissions to directly access this path. Instead of trying to open this path directly, apps should use openFileDescriptor(Uri, String) to gain access.

Constant Value: "local_filename"

COLUMN_LOCAL_URI

String COLUMN_LOCAL_URI

Uri where downloaded file will be stored. If a destination is supplied by client, that URI will be used here. Otherwise, the value will initially be null and will be filled in with a generated URI once the download has started.

Constant Value: "local_uri"

COLUMN_MEDIAPROVIDER_URI

String COLUMN_MEDIAPROVIDER_URI

The URI to the corresponding entry in MediaProvider for this downloaded entry. It is used to delete the entries from MediaProvider database when it is deleted from the downloaded list.

Constant Value: "mediaprovider_uri"

COLUMN_MEDIA_TYPE

String COLUMN_MEDIA_TYPE

Internet Media Type of the downloaded file. If no value is provided upon creation, this will initially be null and will be filled in based on the server's response once the download has started.

Constant Value: "media_type"

COLUMN_REASON

String COLUMN_REASON

Provides more detail on the status of the download. Its meaning depends on the value of COLUMN_STATUS. When COLUMN_STATUS is STATUS_FAILED, this indicates the type of error that occurred. If an HTTP error occurred, this will hold the HTTP status code as defined in RFC 2616. Otherwise, it will hold one of the ERROR_* constants. When COLUMN_STATUS is STATUS_PAUSED, this indicates why the download is paused. It will hold one of the PAUSED_* constants. If COLUMN_STATUS is neither STATUS_FAILED nor STATUS_PAUSED, this column's value is undefined.

Constant Value: "reason"

COLUMN_STATUS

String COLUMN_STATUS

Current status of the download, as one of the STATUS_* constants.

Constant Value: "status"

COLUMN_TITLE

String COLUMN_TITLE

The client-supplied title for this download. This will be displayed in system notifications. Defaults to the empty string.

Constant Value: "title"

COLUMN_TOTAL_SIZE_BYTES

String COLUMN_TOTAL_SIZE_BYTES

Total size of the download in bytes. This will initially be -1 and will be filled in once the download starts.

Constant Value: "total_size"

COLUMN_URI

String COLUMN_URI

URI to be downloaded.

Constant Value: "uri"

ERROR_CANNOT_RESUME

int ERROR_CANNOT_RESUME

Value of COLUMN_REASON when some possibly transient error occurred but we can't resume the download.

Constant Value: 1008 (0x000003f0)

ERROR_DEVICE_NOT_FOUND

int ERROR_DEVICE_NOT_FOUND

Value of COLUMN_REASON when no external storage device was found. Typically, this is because the SD card is not mounted.

Constant Value: 1007 (0x000003ef)

ERROR_FILE_ALREADY_EXISTS

int ERROR_FILE_ALREADY_EXISTS

Value of COLUMN_REASON when the requested destination file already exists (the download manager will not overwrite an existing file).

Constant Value: 1009 (0x000003f1)

ERROR_FILE_ERROR

int ERROR_FILE_ERROR

Value of COLUMN_REASON when a storage issue arises which doesn't fit under any other error code. Use the more specific ERROR_INSUFFICIENT_SPACE and ERROR_DEVICE_NOT_FOUND when appropriate.

Constant Value: 1001 (0x000003e9)

ERROR_HTTP_DATA_ERROR

int ERROR_HTTP_DATA_ERROR

Value of COLUMN_REASON when an error receiving or processing data occurred at the HTTP level.

Constant Value: 1004 (0x000003ec)

ERROR_INSUFFICIENT_SPACE

int ERROR_INSUFFICIENT_SPACE

Value of COLUMN_REASON when there was insufficient storage space. Typically, this is because the SD card is full.

Constant Value: 1006 (0x000003ee)

ERROR_TOO_MANY_REDIRECTS

int ERROR_TOO_MANY_REDIRECTS

Value of COLUMN_REASON when there were too many redirects.

Constant Value: 1005 (0x000003ed)

ERROR_UNHANDLED_HTTP_CODE

int ERROR_UNHANDLED_HTTP_CODE

Value of COLUMN_REASON when an HTTP code was received that download manager can't handle.

Constant Value: 1002 (0x000003ea)

ERROR_UNKNOWN

int ERROR_UNKNOWN

Value of COLUMN_ERROR_CODE when the download has completed with an error that doesn't fit under any other error code.

Constant Value: 1000 (0x000003e8)

EXTRA_DOWNLOAD_ID

String EXTRA_DOWNLOAD_ID

Intent extra included with ACTION_DOWNLOAD_COMPLETE intents, indicating the ID (as a long) of the download that just completed.

Constant Value: "extra_download_id"

EXTRA_NOTIFICATION_CLICK_DOWNLOAD_IDS

String EXTRA_NOTIFICATION_CLICK_DOWNLOAD_IDS

When clicks on multiple notifications are received, the following provides an array of download ids corresponding to the download notification that was clicked. It can be retrieved by the receiver of this Intent using getLongArrayExtra(String).

Constant Value: "extra_click_download_ids"

INTENT_EXTRAS_SORT_BY_SIZE

String INTENT_EXTRAS_SORT_BY_SIZE

Intent extra included with ACTION_VIEW_DOWNLOADS to start DownloadApp in sort-by-size mode.

Constant Value: "android.app.DownloadManager.extra_sortBySize"

PAUSED_QUEUED_FOR_WIFI

int PAUSED_QUEUED_FOR_WIFI

Value of COLUMN_REASON when 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.

Constant Value: 3 (0x00000003)

PAUSED_UNKNOWN

int PAUSED_UNKNOWN

Value of COLUMN_REASON when the download is paused for some other reason.

Constant Value: 4 (0x00000004)

PAUSED_WAITING_FOR_NETWORK

int PAUSED_WAITING_FOR_NETWORK

Value of COLUMN_REASON when the download is waiting for network connectivity to proceed.

Constant Value: 2 (0x00000002)

PAUSED_WAITING_TO_RETRY

int PAUSED_WAITING_TO_RETRY

Value of COLUMN_REASON when the download is paused because some network error occurred and the download manager is waiting before retrying the request.

Constant Value: 1 (0x00000001)

STATUS_FAILED

int STATUS_FAILED

Value of COLUMN_STATUS when the download has failed (and will not be retried).

Constant Value: 16 (0x00000010)

STATUS_PAUSED

int STATUS_PAUSED

Value of COLUMN_STATUS when the download is waiting to retry or resume.

Constant Value: 4 (0x00000004)

STATUS_PENDING

int STATUS_PENDING

Value of COLUMN_STATUS when the download is waiting to start.

Constant Value: 1 (0x00000001)

STATUS_RUNNING

int STATUS_RUNNING

Value of COLUMN_STATUS when the download is currently running.

Constant Value: 2 (0x00000002)

STATUS_SUCCESSFUL

int STATUS_SUCCESSFUL

Value of COLUMN_STATUS when the download has successfully completed.

Constant Value: 8 (0x00000008)

addCompletedDownload

long addCompletedDownload (String title, 
                String description, 
                boolean isMediaScannerScannable, 
                String mimeType, 
                String path, 
                long length, 
                boolean showNotification)

Adds a file to the downloads database system, so it could appear in Downloads App (and thus become eligible for management by the Downloads App).

It is helpful to make the file scannable by MediaScanner by setting the param isMediaScannerScannable to true. It makes the file visible in media managing applications such as Gallery App, which could be a useful purpose of using this API.

addCompletedDownload

long addCompletedDownload (String title, 
                String description, 
                boolean isMediaScannerScannable, 
                String mimeType, 
                String path, 
                long length, 
                boolean showNotification, 
                Uri uri, 
                Uri referer)

Adds a file to the downloads database system, so it could appear in Downloads App (and thus become eligible for management by the Downloads App).

It is helpful to make the file scannable by MediaScanner by setting the param isMediaScannerScannable to true. It makes the file visible in media managing applications such as Gallery App, which could be a useful purpose of using this API.

enqueue

long enqueue (DownloadManager.Request request)

Enqueue a new download. The download will start automatically once the download manager is ready to execute it and connectivity is available.

getMaxBytesOverMobile

Long getMaxBytesOverMobile (Context context)

Returns maximum size, in bytes, of downloads that may go over a mobile connection; or null if there's no limit

getMimeTypeForDownloadedFile

String getMimeTypeForDownloadedFile (long id)

Returns the media type of the given downloaded file id, if the file was downloaded successfully. Otherwise, null is returned.

getRecommendedMaxBytesOverMobile

Long getRecommendedMaxBytesOverMobile (Context context)

Returns recommended maximum size, in bytes, of downloads that may go over a mobile connection; or null if there's no recommended limit. The user will have the option to bypass this limit.

getUriForDownloadedFile

Uri getUriForDownloadedFile (long id)

Returns the Uri of the given downloaded file id, if the file is downloaded successfully. Otherwise, null is returned.

openDownloadedFile

ParcelFileDescriptor openDownloadedFile (long id)

Open a downloaded file for reading. The download must have completed.

query

Cursor query (DownloadManager.Query query)

Query the download manager about downloads that have been requested.

remove

int remove (long... ids)

Cancel downloads and remove them from the download manager. Each download will be stopped if it was running, and it will no longer be accessible through the download manager. If there is a downloaded file, partial or complete, it is deleted.