| /* -*- 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> |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either of 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 "nsITransfer.idl" |
| |
| interface nsIURI; |
| interface nsILocalFile; |
| interface nsIObserver; |
| interface nsICancelable; |
| interface nsIWebProgressListener; |
| interface nsIMIMEInfo; |
| |
| /** |
| * Represents a download object. |
| * |
| * @note This object is no longer updated once it enters a completed state. |
| * Completed states are the following: |
| * nsIDownloadManager::DOWNLOAD_FINISHED |
| * nsIDownloadManager::DOWNLOAD_FAILED |
| * nsIDownloadManager::DOWNLOAD_CANCELED |
| * nsIDownloadManager::DOWNLOAD_BLOCKED_PARENTAL |
| * nsIDownloadManager::DOWNLOAD_DIRTY |
| * nsIDownloadManager::DOWNLOAD_BLOCKED_POLICY |
| */ |
| [scriptable, uuid(c891111e-92a6-47b8-bc46-874ebb61ac9d)] |
| interface nsIDownload : nsITransfer { |
| |
| /** |
| * The target of a download is always a file on the local file system. |
| */ |
| readonly attribute nsILocalFile targetFile; |
| |
| /** |
| * The percentage of transfer completed. |
| * If the file size is unknown it'll be -1 here. |
| */ |
| readonly attribute long percentComplete; |
| |
| /** |
| * The amount of bytes downloaded so far. |
| */ |
| readonly attribute long long amountTransferred; |
| |
| /** |
| * The size of file in bytes. |
| * Unknown size is represented by -1. |
| */ |
| readonly attribute long long size; |
| |
| /** |
| * The source of the transfer. |
| */ |
| readonly attribute nsIURI source; |
| |
| /** |
| * The target of the transfer. |
| */ |
| readonly attribute nsIURI target; |
| |
| /** |
| * Object that can be used to cancel the download. |
| * Will be null after the download is finished. |
| */ |
| readonly attribute nsICancelable cancelable; |
| |
| /** |
| * The user-readable description of the transfer. |
| */ |
| readonly attribute AString displayName; |
| |
| /** |
| * The time a transfer was started. |
| */ |
| readonly attribute long long startTime; |
| |
| /** |
| * The speed of the transfer in bytes/sec. |
| */ |
| readonly attribute double speed; |
| |
| /** |
| * Optional. If set, it will contain the target's relevant MIME information. |
| * This includes it's MIME Type, helper app, and whether that helper should be |
| * executed. |
| */ |
| readonly attribute nsIMIMEInfo MIMEInfo; |
| |
| /** |
| * The id of the download that is stored in the database. |
| */ |
| readonly attribute unsigned long id; |
| |
| /** |
| * The state of the download. |
| * @see nsIDownloadManager and nsIXPInstallManagerUI |
| */ |
| readonly attribute short state; |
| |
| /** |
| * The referrer uri of the download. This is only valid for HTTP downloads, |
| * and can be null. |
| */ |
| readonly attribute nsIURI referrer; |
| |
| /** |
| * Indicates if the download can be resumed after being paused or not. This |
| * is only the case if the download is over HTTP/1.1 or FTP and if the |
| * server supports it. |
| */ |
| readonly attribute boolean resumable; |
| }; |
| |
| %{C++ |
| // {E3FA9D0A-1DD1-11B2-BDEF-8C720B597445} |
| #define NS_DOWNLOAD_CID \ |
| { 0xe3fa9d0a, 0x1dd1, 0x11b2, { 0xbd, 0xef, 0x8c, 0x72, 0x0b, 0x59, 0x74, 0x45 } } |
| %} |