Struct xpcom::interfaces::nsIDownloadManager

#[repr(C)]
pub struct nsIDownloadManager { /* fields omitted */ }

interface nsIDownloadManager : nsISupports

Methods

impl nsIDownloadManager

pub fn coerce<T: nsIDownloadManagerCoerce>(&self) -> &T

Cast this nsIDownloadManager to one of its base interfaces.

impl nsIDownloadManager

pub const DOWNLOAD_TYPE_DOWNLOAD: i64

DOWNLOAD_TYPE_DOWNLOAD: i64 = 0

/**
   * Download type for generic file download.
   */

pub const DOWNLOAD_NOTSTARTED: i64

DOWNLOAD_NOTSTARTED: i64 = -1

/**
   * Download state for uninitialized download object.
   */

pub const DOWNLOAD_DOWNLOADING: i64

DOWNLOAD_DOWNLOADING: i64 = 0

/**
   * Download is currently transferring data.
   */

pub const DOWNLOAD_FINISHED: i64

DOWNLOAD_FINISHED: i64 = 1

/**
   * Download completed including any processing of the target
   * file.  (completed)
   */

pub const DOWNLOAD_FAILED: i64

DOWNLOAD_FAILED: i64 = 2

/**
   * Transfer failed due to error. (completed)
   */

pub const DOWNLOAD_CANCELED: i64

DOWNLOAD_CANCELED: i64 = 3

/**
   * Download was canceled by the user. (completed)
   */

pub const DOWNLOAD_PAUSED: i64

DOWNLOAD_PAUSED: i64 = 4

/**
   * Transfer was paused by the user.
   */

pub const DOWNLOAD_QUEUED: i64

DOWNLOAD_QUEUED: i64 = 5

/**
   * Download is active but data has not yet been received.
   */

pub const DOWNLOAD_BLOCKED_PARENTAL: i64

DOWNLOAD_BLOCKED_PARENTAL: i64 = 6

/**
   * Transfer request was blocked by parental controls proxies. (completed)
   */

pub const DOWNLOAD_SCANNING: i64

DOWNLOAD_SCANNING: i64 = 7

/**
   * Transferred download is being scanned by virus scanners.
   */

pub const DOWNLOAD_DIRTY: i64

DOWNLOAD_DIRTY: i64 = 8

/**
   * A virus was detected in the download. The target will most likely
   * no longer exist. (completed)
   */

pub const DOWNLOAD_BLOCKED_POLICY: i64

DOWNLOAD_BLOCKED_POLICY: i64 = 9

/**
   * Win specific: Request was blocked by zone policy settings.
   * (see bug #416683) (completed)
   */

pub unsafe fn AddDownload(
    &self,
    aDownloadType: int16_t,
    aSource: *const nsIURI,
    aTarget: *const nsIURI,
    aDisplayName: &nsAString,
    aMIMEInfo: *const nsIMIMEInfo,
    aStartTime: PRTime,
    aTempFile: *const nsIFile,
    aCancelable: *const nsICancelable,
    aIsPrivate: bool,
    _retval: *mut *const nsIDownload
) -> nsresult

/**
   * Creates an nsIDownload and adds it to be managed by the download manager.
   *
   * @param aSource The source URI of the transfer. Must not be null.
   *
   * @param aTarget The target URI of the transfer. Must not be null.
   *
   * @param aDisplayName The user-readable description of the transfer.
   *                     Can be empty.
   *
   * @param aMIMEInfo The MIME info associated with the target,
   *                  including MIME type and helper app when appropriate.
   *                  This parameter is optional.
   *
   * @param startTime Time when the download started
   *
   * @param aTempFile The location of a temporary file; i.e. a file in which
   *                  the received data will be stored, but which is not
   *                  equal to the target file. (will be moved to the real
   *                  target by the DownloadManager, when the download is
   *                  finished). This will be null for all callers except for
   *                  nsExternalHelperAppHandler. Addons should generally pass
   *                  null for aTempFile. This will be moved to the real target
   *                  by the download manager when the download is finished,
   *                  and the action indicated by aMIMEInfo will be executed.
   *
   * @param aCancelable An object that can be used to abort the download.
   *                    Must not be null.
   *
   * @param aIsPrivate Used to determine the privacy status of the new download.
   *                   If true, the download is stored in a manner that leaves
   *                   no permanent trace outside of the current private session.
   *
   * @return The newly created download item with the passed-in properties.
   *
   * @note This does not actually start a download.  If you want to add and
   *       start a download, you need to create an nsIWebBrowserPersist, pass it
   *       as the aCancelable object, call this method, set the progressListener
   *       as the returned download object, then call saveURI.
   */

nsIDownload addDownload (in short aDownloadType, in nsIURI aSource, in nsIURI aTarget, in AString aDisplayName, in nsIMIMEInfo aMIMEInfo, in PRTime aStartTime, in nsIFile aTempFile, in nsICancelable aCancelable, in boolean aIsPrivate);

pub unsafe fn GetDownload(
    &self,
    aID: uint32_t,
    _retval: *mut *const nsIDownload
) -> nsresult

/**
   * Retrieves a download managed by the download manager.  This can be one that
   * is in progress, or one that has completed in the past and is stored in the
   * database.
   *
   * @param aID The unique ID of the download.
   * @return The download with the specified ID.
   * @throws NS_ERROR_NOT_AVAILABLE if the download is not in the database.
   */

nsIDownload getDownload (in unsigned long aID);

pub unsafe fn GetDownloadByGUID(
    &self,
    aGUID: &nsACString,
    aCallback: *const nsIDownloadManagerResult
) -> nsresult

/**
   * Retrieves a download managed by the download manager.  This can be one that
   * is in progress, or one that has completed in the past and is stored in the
   * database.  The result of this method is returned via an asynchronous callback,
   * the parameter of which will be an nsIDownload object, or null if none exists
   * with the provided GUID.
   *
   * @param aGUID The unique GUID of the download.
   * @param aCallback The callback to invoke with the result of the search.
   */

void getDownloadByGUID (in ACString aGUID, in nsIDownloadManagerResult aCallback);

pub unsafe fn CancelDownload(&self, aID: uint32_t) -> nsresult

/**
   * Cancels the download with the specified ID if it's currently in-progress.
   * This calls cancel(NS_BINDING_ABORTED) on the nsICancelable provided by the
   * download.
   *
   * @param aID The unique ID of the download.
   * @throws NS_ERROR_FAILURE if the download is not in-progress.
   */

void cancelDownload (in unsigned long aID);

pub unsafe fn RemoveDownload(&self, aID: uint32_t) -> nsresult

/**
   * Removes the download with the specified id if it's not currently
   * in-progress.  Whereas cancelDownload simply cancels the transfer, but
   * retains information about it, removeDownload removes all knowledge of it.
   *
   * Also notifies observers of the "download-manager-remove-download-guid"
   * topic with the download guid as the subject to allow any DM consumers to
   * react to the removal.
   *
   * Also may notify observers of the "download-manager-remove-download" topic
   * with the download id as the subject, if the download removed is public
   * or if global private browsing mode is in use. This notification is deprecated;
   * the guid notification should be relied upon instead.
   *
   * @param aID The unique ID of the download.
   * @throws NS_ERROR_FAILURE if the download is active.
   */

void removeDownload (in unsigned long aID);

pub unsafe fn RemoveDownloadsByTimeframe(
    &self,
    aBeginTime: int64_t,
    aEndTime: int64_t
) -> nsresult

/**
   * Removes all inactive downloads that were started inclusively within the
   * specified time frame.
   *
   * @param aBeginTime
   *        The start time to remove downloads by in microseconds.
   * @param aEndTime
   *        The end time to remove downloads by in microseconds.
   */

void removeDownloadsByTimeframe (in long long aBeginTime, in long long aEndTime);

pub unsafe fn PauseDownload(&self, aID: uint32_t) -> nsresult

/**
   * Pause the specified download.
   *
   * @param aID The unique ID of the download.
   * @throws NS_ERROR_FAILURE if the download is not in-progress.
   */

void pauseDownload (in unsigned long aID);

pub unsafe fn ResumeDownload(&self, aID: uint32_t) -> nsresult

/**
   * Resume the specified download.
   *
   * @param aID The unique ID of the download.
   * @throws NS_ERROR_FAILURE if the download is not in-progress.
   */

void resumeDownload (in unsigned long aID);

pub unsafe fn RetryDownload(&self, aID: uint32_t) -> nsresult

/**
   * Retries a failed download.
   *
   * @param aID The unique ID of the download.
   * @throws NS_ERROR_NOT_AVAILALE if the download id is not known.
   * @throws NS_ERROR_FAILURE if the download is not in the following states:
   *           nsIDownloadManager::DOWNLOAD_CANCELED
   *           nsIDownloadManager::DOWNLOAD_FAILED
   */

void retryDownload (in unsigned long aID);

pub unsafe fn GetDBConnection(
    &self,
    aDBConnection: *mut *const mozIStorageConnection
) -> nsresult

/**
   * The database connection to the downloads database.
   */

readonly attribute mozIStorageConnection DBConnection;

pub unsafe fn GetPrivateDBConnection(
    &self,
    aPrivateDBConnection: *mut *const mozIStorageConnection
) -> nsresult

readonly attribute mozIStorageConnection privateDBConnection;

pub unsafe fn GetCanCleanUp(&self, aCanCleanUp: *mut bool) -> nsresult

/**
   * Whether or not there are downloads that can be cleaned up (removed)
   * i.e. downloads that have completed, have failed or have been canceled.
   * In global private browsing mode, this reports the status of the relevant
   * private or public downloads. In per-window mode, it only reports for
   * public ones.
   */

readonly attribute boolean canCleanUp;

pub unsafe fn GetCanCleanUpPrivate(
    &self,
    aCanCleanUpPrivate: *mut bool
) -> nsresult

/**
   * Whether or not there are private downloads that can be cleaned up (removed)
   * i.e. downloads that have completed, have failed or have been canceled.
   */

readonly attribute boolean canCleanUpPrivate;

pub unsafe fn CleanUp(&self) -> nsresult

/**
   * Removes completed, failed, and canceled downloads from the list.
   * In global private browsing mode, this operates on the relevant
   * private or public downloads. In per-window mode, it only operates
   * on public ones.
   *
   * Also notifies observers of the "download-manager-remove-download-gui"
   * and "download-manager-remove-download" topics with a null subject to
   * allow any DM consumers to react to the removals.
   */

void cleanUp ();

pub unsafe fn CleanUpPrivate(&self) -> nsresult

/**
   * Removes completed, failed, and canceled downloads from the list
   * of private downloads.
   *
   * Also notifies observers of the "download-manager-remove-download-gui"
   * and "download-manager-remove-download" topics with a null subject to
   * allow any DM consumers to react to the removals.
   */

void cleanUpPrivate ();

pub unsafe fn GetActiveDownloadCount(
    &self,
    aActiveDownloadCount: *mut int32_t
) -> nsresult

/**
   * The number of files currently being downloaded.
   *
   * In global private browsing mode, this reports the status of the relevant
   * private or public downloads. In per-window mode, it only reports public
   * ones.
   */

readonly attribute long activeDownloadCount;

pub unsafe fn GetActivePrivateDownloadCount(
    &self,
    aActivePrivateDownloadCount: *mut int32_t
) -> nsresult

/**
   * The number of private files currently being downloaded.
   */

readonly attribute long activePrivateDownloadCount;

pub unsafe fn GetActiveDownloads(
    &self,
    aActiveDownloads: *mut *const nsISimpleEnumerator
) -> nsresult

/**
   * An enumeration of active nsIDownloads
   *
   * In global private browsing mode, this reports the status of the relevant
   * private or public downloads. In per-window mode, it only reports public
   * ones.
   */

readonly attribute nsISimpleEnumerator activeDownloads;

pub unsafe fn GetActivePrivateDownloads(
    &self,
    aActivePrivateDownloads: *mut *const nsISimpleEnumerator
) -> nsresult

/**
   * An enumeration of active private nsIDownloads
   */

readonly attribute nsISimpleEnumerator activePrivateDownloads;

pub unsafe fn AddListener(
    &self,
    aListener: *const nsIDownloadProgressListener
) -> nsresult

/**
   * Adds a listener to the download manager. It is expected that this
   * listener will only access downloads via their deprecated integer id attribute,
   * and when global private browsing compatibility mode is disabled, this listener
   * will receive no notifications for downloads marked private.
   */

void addListener (in nsIDownloadProgressListener aListener);

pub unsafe fn AddPrivacyAwareListener(
    &self,
    aListener: *const nsIDownloadProgressListener
) -> nsresult

/**
   * Adds a listener to the download manager. This listener must be able to
   * understand and use the guid attribute of downloads for all interactions
   * with the download manager.
   */

void addPrivacyAwareListener (in nsIDownloadProgressListener aListener);

pub unsafe fn RemoveListener(
    &self,
    aListener: *const nsIDownloadProgressListener
) -> nsresult

/**
   * Removes a listener from the download manager.
   */

void removeListener (in nsIDownloadProgressListener aListener);

pub unsafe fn GetDefaultDownloadsDirectory(
    &self,
    aDefaultDownloadsDirectory: *mut *const nsIFile
) -> nsresult

/**
   * Returns the platform default downloads directory.
   */

readonly attribute nsIFile defaultDownloadsDirectory;

pub unsafe fn GetUserDownloadsDirectory(
    &self,
    aUserDownloadsDirectory: *mut *const nsIFile
) -> nsresult

/**
   * Returns the user configured downloads directory.
   * The path is dependent on two user configurable prefs
   * set in preferences:
   *
   * browser.download.folderList
   *   Indicates the location users wish to save downloaded
   *   files too.
   *   Values:
   *     0 - The desktop is the default download location.
   *     1 - The system's downloads folder is the default download location.
   *     2 - The default download location is elsewhere as specified in
   *         browser.download.dir. If invalid, userDownloadsDirectory
   *         will fallback on defaultDownloadsDirectory.
   *
   * browser.download.dir -
   *   A local path the user may have selected at some point
   *   where downloaded files are saved. The use of which is
   *   enabled when folderList equals 2.
   */

readonly attribute nsIFile userDownloadsDirectory;

Methods from Deref<Target = nsISupports>

pub fn coerce<T: nsISupportsCoerce>(&self) -> &T

Cast this nsISupports to one of its base interfaces.

pub unsafe fn QueryInterface(
    &self,
    uuid: &nsIID,
    result: *mut *mut c_void
) -> nsresult

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

pub unsafe fn AddRef(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt AddRef ();

pub unsafe fn Release(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIDownloadManager

const IID: nsIID

IID: nsIID = nsID(2996481045, 32452, 19123, [165, 59, 8, 247, 138, 237, 59, 52])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for nsIDownloadManager

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIDownloadManager

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.