RetroZilla/netwerk/base/public/nsIDownloader.idl

85 lines
3.4 KiB
Plaintext
Raw Normal View History

2015-10-21 05:03:22 +02:00
/* ***** 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.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2003
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Darin Fisher <darin@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 ***** */
#include "nsIStreamListener.idl"
interface nsIFile;
interface nsIDownloadObserver;
/**
* nsIDownloader
*
* A downloader is a special implementation of a nsIStreamListener that will
* make the contents of the stream available as a file. This may utilize the
* disk cache as an optimization to avoid an extra copy of the data on disk.
* The resulting file is valid from the time the downloader completes until
* the last reference to the downloader is released.
*/
[scriptable, uuid(fafe41a9-a531-4d6d-89bc-588a6522fb4e)]
interface nsIDownloader : nsIStreamListener
{
/**
* Initialize this downloader
*
* @param observer
* the observer to be notified when the download completes.
* @param downloadLocation
* the location where the stream contents should be written.
* if null, the downloader will select a location and the
* resulting file will be deleted (or otherwise made invalid)
* when the downloader object is destroyed. if an explicit
* download location is specified then the resulting file will
* not be deleted, and it will be the callers responsibility
* to keep track of the file, etc.
*/
void init(in nsIDownloadObserver observer,
in nsIFile downloadLocation);
};
[scriptable, uuid(44b3153e-a54e-4077-a527-b0325e40924e)]
interface nsIDownloadObserver : nsISupports
{
/**
* Called to signal a download that has completed.
*/
void onDownloadComplete(in nsIDownloader downloader,
in nsIRequest request,
in nsISupports ctxt,
in nsresult status,
in nsIFile result);
};