FileDocCategorySizeDatePackage
Downloads.javaAPI DocAndroid 1.5 API18029Wed May 06 22:41:56 BST 2009android.provider

Downloads

public final class Downloads extends Object implements BaseColumns
Exposes constants used to interact with the download manager's content provider. The constants URI ... STATUS are the names of columns in the downloads table.
hide

Fields Summary
public static final String
PERMISSION_ACCESS
The permission to access the download manager
public static final String
PERMISSION_ACCESS_ADVANCED
The permission to access the download manager's advanced functions
public static final String
PERMISSION_CACHE
The permission to directly access the download manager's cache directory
public static final String
PERMISSION_SEND_INTENTS
The permission to send broadcasts on download completion
public static final android.net.Uri
CONTENT_URI
The content:// URI for the data table in the provider
public static final String
DOWNLOAD_COMPLETED_ACTION
Broadcast Action: this is sent by the download manager to the app that had initiated a download when that download completes. The download's content: uri is specified in the intent's data.
public static final String
NOTIFICATION_CLICKED_ACTION
Broadcast Action: this is sent by the download manager to the app that had initiated a download when the user selects the notification associated with that download. The download's content: uri is specified in the intent's data if the click is associated with a single download, or Downloads.CONTENT_URI if the notification is associated with multiple downloads. Note: this is not currently sent for downloads that have completed successfully.
public static final String
URI
The name of the column containing the URI of the data being downloaded.

Type: TEXT

Owner can Init/Read

public static final String
APP_DATA
The name of the column containing application-specific data.

Type: TEXT

Owner can Init/Read/Write

public static final String
NO_INTEGRITY
The name of the column containing the flags that indicates whether the initiating application is capable of verifying the integrity of the downloaded file. When this flag is set, the download manager performs downloads and reports success even in some situations where it can't guarantee that the download has completed (e.g. when doing a byte-range request without an ETag, or when it can't determine whether a download fully completed).

Type: BOOLEAN

Owner can Init

public static final String
FILENAME_HINT
The name of the column containing the filename that the initiating application recommends. When possible, the download manager will attempt to use this filename, or a variation, as the actual name for the file.

Type: TEXT

Owner can Init

public static final String
_DATA
The name of the column containing the filename where the downloaded data was actually stored.

Type: TEXT

Owner can Read

public static final String
MIMETYPE
The name of the column containing the MIME type of the downloaded data.

Type: TEXT

Owner can Init/Read

public static final String
DESTINATION
The name of the column containing the flag that controls the destination of the download. See the DESTINATION_* constants for a list of legal values.

Type: INTEGER

Owner can Init

public static final String
VISIBILITY
The name of the column containing the flags that controls whether the download is displayed by the UI. See the VISIBILITY_* constants for a list of legal values.

Type: INTEGER

Owner can Init/Read/Write

public static final String
CONTROL
The name of the column containing the current control state of the download. Applications can write to this to control (pause/resume) the download. the CONTROL_* constants for a list of legal values.

Type: INTEGER

Owner can Read

public static final String
STATUS
The name of the column containing the current status of the download. Applications can read this to follow the progress of each download. See the STATUS_* constants for a list of legal values.

Type: INTEGER

Owner can Read

public static final String
LAST_MODIFICATION
The name of the column containing the date at which some interesting status changed in the download. Stored as a System.currentTimeMillis() value.

Type: BIGINT

Owner can Read

public static final String
NOTIFICATION_PACKAGE
The name of the column containing the package name of the application that initiating the download. The download manager will send notifications to a component in this package when the download completes.

Type: TEXT

Owner can Init/Read

public static final String
NOTIFICATION_CLASS
The name of the column containing the component name of the class that will receive notifications associated with the download. The package/class combination is passed to Intent.setClassName(String,String).

Type: TEXT

Owner can Init/Read

public static final String
NOTIFICATION_EXTRAS
If extras are specified when requesting a download they will be provided in the intent that is sent to the specified class and package when a download has finished.

Type: TEXT

Owner can Init

public static final String
COOKIE_DATA
The name of the column contain the values of the cookie to be used for the download. This is used directly as the value for the Cookie: HTTP header that gets sent with the request.

Type: TEXT

Owner can Init

public static final String
USER_AGENT
The name of the column containing the user agent that the initiating application wants the download manager to use for this download.

Type: TEXT

Owner can Init

public static final String
REFERER
The name of the column containing the referer (sic) that the initiating application wants the download manager to use for this download.

Type: TEXT

Owner can Init

public static final String
TOTAL_BYTES
The name of the column containing the total size of the file being downloaded.

Type: INTEGER

Owner can Read

public static final String
CURRENT_BYTES
The name of the column containing the size of the part of the file that has been downloaded so far.

Type: INTEGER

Owner can Read

public static final String
OTHER_UID
The name of the column where the initiating application can provide the UID of another application that is allowed to access this download. If multiple applications share the same UID, all those applications will be allowed to access this download. This column can be updated after the download is initiated. This requires the permission android.permission.ACCESS_DOWNLOAD_MANAGER_ADVANCED.

Type: INTEGER

Owner can Init

public static final String
TITLE
The name of the column where the initiating application can provided the title of this download. The title will be displayed ito the user in the list of downloads.

Type: TEXT

Owner can Init/Read/Write

public static final String
DESCRIPTION
The name of the column where the initiating application can provide the description of this download. The description will be displayed to the user in the list of downloads.

Type: TEXT

Owner can Init/Read/Write

public static final int
DESTINATION_EXTERNAL
This download will be saved to the external storage. This is the default behavior, and should be used for any file that the user can freely access, copy, delete. Even with that destination, unencrypted DRM files are saved in secure internal storage. Downloads to the external destination only write files for which there is a registered handler. The resulting files are accessible by filename to all applications.
public static final int
DESTINATION_CACHE_PARTITION
This download will be saved to the download manager's private partition. This is the behavior used by applications that want to download private files that are used and deleted soon after they get downloaded. All file types are allowed, and only the initiating application can access the file (indirectly through a content provider). This requires the android.permission.ACCESS_DOWNLOAD_MANAGER_ADVANCED permission.
public static final int
DESTINATION_CACHE_PARTITION_PURGEABLE
This download will be saved to the download manager's private partition and will be purged as necessary to make space. This is for private files (similar to CACHE_PARTITION) that aren't deleted immediately after they are used, and are kept around by the download manager as long as space is available.
public static final int
DESTINATION_CACHE_PARTITION_NOROAMING
This download will be saved to the download manager's private partition, as with DESTINATION_CACHE_PARTITION, but the download will not proceed if the user is on a roaming data connection.
public static final int
CONTROL_RUN
This download is allowed to run.
public static final int
CONTROL_PAUSED
This download must pause at the first opportunity.
public static final int
STATUS_PENDING
This download hasn't stated yet
public static final int
STATUS_PENDING_PAUSED
This download hasn't stated yet and is paused
public static final int
STATUS_RUNNING
This download has started
public static final int
STATUS_RUNNING_PAUSED
This download has started and is paused
public static final int
STATUS_SUCCESS
This download has successfully completed. Warning: there might be other status values that indicate success in the future. Use isSucccess() to capture the entire category.
public static final int
STATUS_BAD_REQUEST
This request couldn't be parsed. This is also used when processing requests with unknown/unsupported URI schemes.
public static final int
STATUS_NOT_ACCEPTABLE
This download can't be performed because the content type cannot be handled.
public static final int
STATUS_LENGTH_REQUIRED
This download cannot be performed because the length cannot be determined accurately. This is the code for the HTTP error "Length Required", which is typically used when making requests that require a content length but don't have one, and it is also used in the client when a response is received whose length cannot be determined accurately (therefore making it impossible to know when a download completes).
public static final int
STATUS_PRECONDITION_FAILED
This download was interrupted and cannot be resumed. This is the code for the HTTP error "Precondition Failed", and it is also used in situations where the client doesn't have an ETag at all.
public static final int
STATUS_CANCELED
This download was canceled
public static final int
STATUS_UNKNOWN_ERROR
This download has completed with an error. Warning: there will be other status values that indicate errors in the future. Use isStatusError() to capture the entire category.
public static final int
STATUS_FILE_ERROR
This download couldn't be completed because of a storage issue. Typically, that's because the filesystem is missing or full.
public static final int
STATUS_UNHANDLED_REDIRECT
This download couldn't be completed because of an HTTP redirect response that the download manager couldn't handle.
public static final int
STATUS_UNHANDLED_HTTP_CODE
This download couldn't be completed because of an unspecified unhandled HTTP code.
public static final int
STATUS_HTTP_DATA_ERROR
This download couldn't be completed because of an error receiving or processing data at the HTTP level.
public static final int
STATUS_HTTP_EXCEPTION
This download couldn't be completed because of an HttpException while setting up the request.
public static final int
STATUS_TOO_MANY_REDIRECTS
This download couldn't be completed because there were too many redirects.
public static final int
VISIBILITY_VISIBLE
This download is visible but only shows in the notifications while it's in progress.
public static final int
VISIBILITY_VISIBLE_NOTIFY_COMPLETED
This download is visible and shows in the notifications while in progress and after completion.
public static final int
VISIBILITY_HIDDEN
This download doesn't show in the UI or in the notifications.
Constructors Summary
private Downloads()

Methods Summary
public static booleanisStatusClientError(int status)
Returns whether the status is a client error (i.e. 4xx).
        return (status >= 400 && status < 500);
    
public static booleanisStatusCompleted(int status)
Returns whether the download has completed (either with success or
error).
        return (status >= 200 && status < 300) || (status >= 400 && status < 600);
    
public static booleanisStatusError(int status)
Returns whether the status is an error (i.e. 4xx or 5xx).
        return (status >= 400 && status < 600);
    
public static booleanisStatusInformational(int status)
Returns whether the status is informational (i.e. 1xx).

    /*
     * Lists the states that the download manager can set on a download
     * to notify applications of the download progress.
     * The codes follow the HTTP families:<br>
     * 1xx: informational<br>
     * 2xx: success<br>
     * 3xx: redirects (not used by the download manager)<br>
     * 4xx: client errors<br>
     * 5xx: server errors
     */

                 
         
        return (status >= 100 && status < 200);
    
public static booleanisStatusServerError(int status)
Returns whether the status is a server error (i.e. 5xx).
        return (status >= 500 && status < 600);
    
public static booleanisStatusSuccess(int status)
Returns whether the status is a success (i.e. 2xx).
        return (status >= 200 && status < 300);
    
public static booleanisStatusSuspended(int status)
Returns whether the download is suspended. (i.e. whether the download
won't complete without some action from outside the download
manager).
        return (status == STATUS_PENDING_PAUSED || status == STATUS_RUNNING_PAUSED);