sbIFileDownloader.idl

Go to the documentation of this file.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

#include "nsISupports.idl"

interface nsIFile;
interface nsIRequest;
interface nsIURI;
interface sbIFileDownloaderListener;
interface sbITemporaryFileFactory;

[scriptable, uuid(7a497d5c-1dd2-11b2-8c68-a37686c9bb01)]
interface sbIFileDownloader : nsISupports
{
  readonly attribute unsigned long long bytesToDownload;


  readonly attribute unsigned long long bytesDownloaded;


  readonly attribute unsigned long percentComplete;


  readonly attribute boolean complete;


  readonly attribute boolean succeeded;


  attribute sbIFileDownloaderListener listener;


  attribute nsIURI sourceURI;


  attribute AString sourceURISpec;


  attribute nsIFile destinationFile;


  attribute AString destinationFileExtension;

  attribute sbITemporaryFileFactory temporaryFileFactory;


  void start();


  void cancel();

  readonly attribute nsIRequest request;
};


[scriptable, uuid(3267334a-a1ef-4bf3-b6e5-8c8ae5f19f44)]
interface sbIFileDownloaderListener : nsISupports
{
  void onProgress();


  void onComplete();
};


//
// C++ defs.
//

%{C++
#define SB_FILEDOWNLOADER_CONTRACTID \
          "@songbirdnest.com/Songbird/FileDownloader;1"
%}C++