netwerk/base/public/nsIDownloader.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2003
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Darin Fisher <darin@netscape.com>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsIStreamListener.idl"
  39
  40 interface nsIFile;
  41 interface nsIDownloadObserver;
  42
  43 /**
  44  * nsIDownloader
  45  *
  46  * A downloader is a special implementation of a nsIStreamListener that will
  47  * make the contents of the stream available as a file.  This may utilize the
  48  * disk cache as an optimization to avoid an extra copy of the data on disk.
  49  * The resulting file is valid from the time the downloader completes until
  50  * the last reference to the downloader is released.
  51  */
  52 [scriptable, uuid(fafe41a9-a531-4d6d-89bc-588a6522fb4e)]
  53 interface nsIDownloader : nsIStreamListener
  54 {
  55     /**
  56      * Initialize this downloader
  57      *
  58      * @param observer
  59      *        the observer to be notified when the download completes.
  60      * @param downloadLocation
  61      *        the location where the stream contents should be written.
  62      *        if null, the downloader will select a location and the
  63      *        resulting file will be deleted (or otherwise made invalid)
  64      *        when the downloader object is destroyed.  if an explicit
  65      *        download location is specified then the resulting file will
  66      *        not be deleted, and it will be the callers responsibility
  67      *        to keep track of the file, etc.
  68      */
  69     void init(in nsIDownloadObserver observer,
  70               in nsIFile             downloadLocation);
  71 };
  72
  73 [scriptable, uuid(44b3153e-a54e-4077-a527-b0325e40924e)]
  74 interface nsIDownloadObserver : nsISupports
  75 {
  76     /**
  77      * Called to signal a download that has completed.
  78      */
  79     void onDownloadComplete(in nsIDownloader downloader,
  80                             in nsIRequest    request,
  81                             in nsISupports   ctxt,
  82                             in nsresult      status,
  83                             in nsIFile       result);
  84 };