docshell/base/nsIDownloadHistory.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 sts=2
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Mozilla Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2007
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Shawn Wilsher <me@shawnwilsher.com> (Original Author)
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41
  42 interface nsIURI;
  43
  44 /**
  45  * This interface can be used to add a download to history.  There is a separate
  46  * interface specifically for downloads in case embedders choose to track
  47  * downloads differently from other types of history.
  48  */
  49 [scriptable, uuid(202533cd-a8f1-4ee4-8d20-3a6a0d2c6c51)]
  50 interface nsIDownloadHistory : nsISupports {
  51   /**
  52    * Adds a download to history.  This will also notify observers that the
  53    * URI aSource is visited with the topic NS_LINK_VISITED_EVENT_TOPIC if
  54    * aSource has not yet been visited.
  55    *
  56    * @param aSource
  57    *        The source of the download we are adding to history.  This cannot be
  58    *        null.
  59    * @param aReferrer
  60    *        [optional] The referrer of source URI.
  61    * @param aStartTime
  62    *        [optional] The time the download was started.  If the start time
  63    *        is not given, the current time is used.
  64    * @throws NS_ERROR_NOT_AVAILABLE
  65    *         In a situation where a history implementation is not available,
  66    *         where 'history implementation' refers to something like
  67    *         nsIGlobalHistory and friends.
  68    */
  69   void addDownload(in nsIURI aSource, [optional] in nsIURI aReferrer,
  70                    [optional] in PRTime aStartTime);
  71 };
  72