Implemented by
Represents a download object.
@note This object is no longer updated once it enters a completed state.
Completed states are the following:
nsIDownloadManager::DOWNLOAD_FINISHED
nsIDownloadManager::DOWNLOAD_FAILED
nsIDownloadManager::DOWNLOAD_CANCELED
nsIDownloadManager::DOWNLOAD_BLOCKED_PARENTAL
nsIDownloadManager::DOWNLOAD_DIRTY
nsIDownloadManager::DOWNLOAD_BLOCKED_POLICY
[scriptable, uuid(c891111e-92a6-47b8-bc46-874ebb61ac9d)]
interface nsIDownload : nsITransfer
Attributes
The amount of bytes downloaded so far.
readonly attribute
long long
amountTransferred
Object that can be used to cancel the download. Will be null after the download is finished.
readonly attribute
nsICancelable
cancelable
The user-readable description of the transfer.
readonly attribute
AString
displayName
The id of the download that is stored in the database.
readonly attribute
unsigned long
id
Optional. If set, it will contain the target's relevant MIME information. This includes it's MIME Type, helper app, and whether that helper should be executed.
readonly attribute
nsIMIMEInfo
MIMEInfo
The percentage of transfer completed. If the file size is unknown it'll be -1 here.
readonly attribute
long
percentComplete
The referrer uri of the download. This is only valid for HTTP downloads, and can be null.
readonly attribute
nsIURI
referrer
Indicates if the download can be resumed after being paused or not. This is only the case if the download is over HTTP/1.1 or FTP and if the server supports it.
readonly attribute
boolean
resumable
The size of file in bytes. Unknown size is represented by -1.
readonly attribute
long long
size
The source of the transfer.
readonly attribute
nsIURI
source
The speed of the transfer in bytes/sec.
readonly attribute
double
speed
The time a transfer was started.
readonly attribute
long long
startTime
The state of the download. @see nsIDownloadManager and nsIXPInstallManagerUI
readonly attribute
short
state
The target of the transfer.
readonly attribute
nsIURI
target
The target of a download is always a file on the local file system.
readonly attribute
nsILocalFile
targetFile
Compare to: