Visit Mozilla.org

nsIDownload

出典: MDC

この記事は Firefox 3 の新機能について述べています

nsIDownload インタフェースは、ダウンロードオブジェクトを表します。ダウンロードオブジェクトは、ダウンロードマネージャによって利用されています。(ダウンロード待ち、ダウンロード中、ダウンロード完了後のファイルを管理する nsIDownloadManager を参照してください)

注意: ダウンロードが完了すると、ダウンロードマネージャは nsIDownload オブジェクトの更新を停止します。完了ステータスは、nsIDownloadManager::DOWNLOAD_FINISHEDnsIDownloadManager::DOWNLOAD_FAILEDnsIDownloadManager::DOWNLOAD_CANCELED のいずれかになります。

目次

nsIDownloadtoolkit/components/downloads/public/nsIDownload.idl で定義されています。これは scriptable非凍結です。 (Mozilla 1.9から更新されていません)

継承元: nsITransfer

[編集] 属性

属性 説明
targetFile nsILocalFile ダウンロードされたファイルが保存される (あるいはダウンロードが完了している場合は保存された) 場所を示します。読み取り専用。
percentComplete PRint32 完了したファイル転送の割合。ファイルサイズが不明な場合は -1 となります。読み取り専用。
amountTransferred PRUint64 完了したダウンロードのバイト数。読み取り専用。
size PRUint64 ファイルの合計サイズ (バイト)。ファイルサイズが不明な場合は LL_MAXUINT となります。読み取り専用。
source nsIURI ダウンロードファイルの取得元 URI。読み取り専用。
cancelable nsICancelable ダウンロードをキャンセルするために使用できるオブジェクト。ダウンロード完了後、この値は null に設定されます。読み取り専用。
displayName AString ユーザが読める形での転送の説明。読み取り専用。
startTime long long ファイル転送が開始された時刻。読み取り専用。
speed double ダウンロードの転送速度 (バイト/秒)。読み取り専用。
MIMEInfo nsIMIMEInfo この任意の属性は、MIME タイプ、ヘルパーアプリケーション、ダウンロード完了後にヘルパーアプリケーションを自動的に実行するかどうかなど、ターゲットに関連する MIME 情報を提供します。
id unsigned long データベース内でダウンロードを固有に識別できる ID。
state short ダウンロードの状況。nsIDownloadManager の定数一覧 を参照してください。
referrer nsIURI ダウンロードのリファラ URI。これは HTTP ダウンロードの場合のみ使用され、null になる可能性もあります。
resumable boolean ダウンロードを中止後に再開できるかどうかを示します。これは、ダウンロードが HTTP/1.1 あるいは FTP を通じて行われていて、サーバが再開に対応している場合のみ有効になります。

[編集] 関連記事

nsIDownloadManager, nsIDownloadProgressListener, nsIXPInstallManagerUI