mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 06:35:42 +00:00
73 lines
3.0 KiB
Plaintext
73 lines
3.0 KiB
Plaintext
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||
|
|
* vim: sw=2 ts=2 sts=2
|
||
|
|
* ***** 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
|
||
|
|
* Mozilla Corporation.
|
||
|
|
* Portions created by the Initial Developer are Copyright (C) 2007
|
||
|
|
* the Initial Developer. All Rights Reserved.
|
||
|
|
*
|
||
|
|
* Contributor(s):
|
||
|
|
* Shawn Wilsher <me@shawnwilsher.com> (Original Author)
|
||
|
|
*
|
||
|
|
* 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 "nsISupports.idl"
|
||
|
|
|
||
|
|
interface nsIURI;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This interface can be used to add a download to history. There is a separate
|
||
|
|
* interface specifically for downloads in case embedders choose to track
|
||
|
|
* downloads differently from other types of history.
|
||
|
|
*/
|
||
|
|
[scriptable, uuid(202533cd-a8f1-4ee4-8d20-3a6a0d2c6c51)]
|
||
|
|
interface nsIDownloadHistory : nsISupports {
|
||
|
|
/**
|
||
|
|
* Adds a download to history. This will also notify observers that the
|
||
|
|
* URI aSource is visited with the topic NS_LINK_VISITED_EVENT_TOPIC if
|
||
|
|
* aSource has not yet been visited.
|
||
|
|
*
|
||
|
|
* @param aSource
|
||
|
|
* The source of the download we are adding to history. This cannot be
|
||
|
|
* null.
|
||
|
|
* @param aReferrer
|
||
|
|
* [optional] The referrer of source URI.
|
||
|
|
* @param aStartTime
|
||
|
|
* [optional] The time the download was started. If the start time
|
||
|
|
* is not given, the current time is used.
|
||
|
|
* @throws NS_ERROR_NOT_AVAILABLE
|
||
|
|
* In a situation where a history implementation is not available,
|
||
|
|
* where 'history implementation' refers to something like
|
||
|
|
* nsIGlobalHistory and friends.
|
||
|
|
*/
|
||
|
|
void addDownload(in nsIURI aSource, [optional] in nsIURI aReferrer,
|
||
|
|
[optional] in PRTime aStartTime);
|
||
|
|
};
|
||
|
|
|