Songbird / Development / Songbird Add-Ons API Documentation

sbIFileDownloader Interface Reference

import "sbIFileDownloader.idl";

List of all members.

Public Member Functions

void start ()
 Start file download from source URI to destination file. If source URI is not specified, use source URI spec. If destination file is not specified, create a temporary one.
void cancel ()
 Cancel file download.

Public Attributes

readonly attribute unsigned
long long 
bytesToDownload
 Number of bytes in file being downloaded.
readonly attribute unsigned
long long 
bytesDownloaded
 Number of bytes in file that have been downloaded.
readonly attribute unsigned
long 
percentComplete
 Percentage (0-100) of bytes of file that have been downloaded.
readonly attribute boolean complete
 True if file download has completed, whether successful or not.
readonly attribute boolean succeeded
 True if file downloaded successfully. Will be false if download is cancelled.
attribute sbIFileDownloaderListener listener
 Listener for download events.
attribute nsIURI sourceURI
 URI of source of file.
attribute AString sourceURISpec
 URI spec of source of file.
attribute nsIFile destinationFile
 Destination file. If not set when download is started, a temporary file will be created and set in destinationFile.
attribute AString destinationFileExtension
 Destination file extension. If a temporary file is created, set its file extension to destinationFileExtension.


Detailed Description

This interface provides support for downloading files.

"@songbirdnest.com/Songbird/FileDownloader;1" Use create instance with this component.

Definition at line 45 of file sbIFileDownloader.idl.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:58 2009 for Songbird by  doxygen 1.5.2