gecko/toolkit/components/downloads/public/nsIDownloadManager.idl

240 lines
8.7 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Blake Ross <blaker@netscape.com>
* Ben Goodger <ben@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
// Keeps track of ongoing downloads, in the form of nsIDownload's.
#include "nsISupports.idl"
interface nsIURI;
interface nsILocalFile;
interface nsIDownload;
interface nsICancelable;
interface nsIMIMEInfo;
interface nsIDownloadProgressListener;
interface nsISimpleEnumerator;
interface mozIStorageConnection;
[scriptable, uuid(05ed1d45-0aff-4ba0-9e2c-a9ef20383048)]
interface nsIDownloadManager : nsISupports {
// Download States
const short DOWNLOAD_NOTSTARTED = -1;
const short DOWNLOAD_DOWNLOADING = 0;
const short DOWNLOAD_FINISHED = 1;
const short DOWNLOAD_FAILED = 2;
const short DOWNLOAD_CANCELED = 3;
const short DOWNLOAD_PAUSED = 4;
const short DOWNLOAD_QUEUED = 5;
const short DOWNLOAD_BLOCKED = 6;
const short DOWNLOAD_SCANNING = 7;
const short DOWNLOAD_DIRTY = 8;
const short DOWNLOAD_TYPE_DOWNLOAD = 0;
/**
* 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 caller, when the download is finished)
* May be null.
*
* @param aCancelable An object that can be used to abort the download.
* Must not be null.
*
* @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 nsILocalFile aTempFile,
in nsICancelable aCancelable);
/**
* 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);
/**
* 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);
/**
* 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" topic
* with the download id as the subject to allow any DM consumers to react to
* the removal.
*
* @param aID The unique ID of the download.
* @throws NS_ERROR_FAILURE if the download is active.
*/
void removeDownload(in unsigned long aID);
/**
* 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);
/**
* 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);
/**
* 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);
/**
* The database connection to the downloads database.
*/
readonly attribute mozIStorageConnection DBConnection;
/**
* Whether or not there are downloads that can be cleaned up (removed)
* i.e. downloads that have completed, have failed or have been canceled.
*/
readonly attribute boolean canCleanUp;
/**
* Removes completed, failed, and canceled downloads from the list.
*
* Also notifies observers of the "download-manager-remove-download" topic
* with a null subject to allow any DM consumers to react to the removals.
*/
void cleanUp();
/**
* The number of files currently being downloaded.
*/
readonly attribute long activeDownloadCount;
/**
* An enumeration of active nsIDownloads
*/
readonly attribute nsISimpleEnumerator activeDownloads;
/**
* Adds a listener from the download manager.
*/
void addListener(in nsIDownloadProgressListener aListener);
/**
* Removes a listener from the download manager.
*/
void removeListener(in nsIDownloadProgressListener aListener);
/**
* Returns the platform default downloads directory.
*/
readonly attribute nsILocalFile defaultDownloadsDirectory;
/**
* 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 nsILocalFile userDownloadsDirectory;
};