sbIDownloadDevice.idl
Go to the documentation of this file.
1 /*
2 //
3 // BEGIN SONGBIRD GPL
4 //
5 // This file is part of the Songbird web player.
6 //
7 // Copyright(c) 2005-2008 POTI, Inc.
8 // http://songbirdnest.com
9 //
10 // This file may be licensed under the terms of of the
11 // GNU General Public License Version 2 (the "GPL").
12 //
13 // Software distributed under the License is distributed
14 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
15 // express or implied. See the GPL for the specific language
16 // governing rights and limitations.
17 //
18 // You should have received a copy of the GPL along with this
19 // program. If not, go to http://www.gnu.org/licenses/gpl.html
20 // or write to the Free Software Foundation, Inc.,
21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 //
23 // END SONGBIRD GPL
24 //
25  */
26 
33 #include "nsISupports.idl"
34 #include "sbIDeviceBase.idl"
35 
36 interface sbIMediaItem;
37 interface sbIMediaList;
38 interface nsIFile;
39 interface nsISimpleEnumerator;
40 
50 [scriptable, uuid(bf8a7663-0c07-4fc6-8d89-aa3024b42e9a)]
52 {
56  readonly attribute sbIMediaList downloadMediaList;
57 
61  readonly attribute unsigned long completedItemCount;
62 
66  void clearCompletedItems();
67 };
68 
69 [scriptable, uuid(765c110d-ffd0-4bca-a145-192b677254e6)]
71 {
77  nsIFile getDownloadFolder(in AString aContentType);
78  nsIFile getDefaultDownloadFolder(in AString aContentType);
79 
80  void downloadItem(in sbIMediaItem aMediaItem);
81 
82  void downloadSome(in nsISimpleEnumerator aMediaItems);
83 
84  void downloadAll(in sbIMediaList aMediaList);
85 };
nsIFile getDefaultDownloadFolder(in AString aContentType)
void clearCompletedItems()
Clear all completed items from download device.
var uuid
A brief description of the contents of this interface.
void downloadSome(in nsISimpleEnumerator aMediaItems)
readonly attribute sbIMediaList downloadMediaList
The media list containing items for download.
[SOON TO BE DEPRECATED AFTER 0.3] Base interface for all supported devices.
readonly attribute unsigned long completedItemCount
The number of completed download items.
void downloadItem(in sbIMediaItem aMediaItem)
nsIFile getDownloadFolder(in AString aContentType)
sbIMediaList getDownloadMediaList()
Songbird DownloadDevice Interface.
Interface that defines a single item of media in the system.
The IDL for sbIDeviceBase.
void downloadAll(in sbIMediaList aMediaList)