nsIDOMOfflineResourceList

nsIDOMOfflineResourceList インタフェースは、アプリケーションキャッシュへのアクセスを提供します。これは、Web コンテンツのリソースをオフラインでも利用できるよう、ローカルにキャッシュできるようにする機能です。キャッシュにリソースを追加したり、キャッシュからリソースを削除したり、動的に管理されたリソースリストを列挙するためのメソッドが含まれます。

dom/public/idl/offline/nsIDOMOfflineResourceList.idlScriptable

Please add a summary to this article.

最終更新: Gecko 1.9 (Firefox 3)

継承元: nsISupports

メソッドの概要

void add(in DOMString uri);

DOMString item(in unsigned long index);

void remove(in DOMString uri);

void swapCache();

void update();

属性

属性	型	説明
`length`	`unsigned long`	動的に管理されたオフラインリソースリスト内のエントリー数。読み取り専用。
`onchecking`	`nsIDOMEventListener`	アプリケーションキャッシュマニフェストを取得したり、更新を確認する際に呼び出されるイベントリスナー。
`onerror`	`nsIDOMEventListener`	キャッシュプロセスの途中でエラーが発生した場合に呼び出されるイベントリスナー。
`onnoupdate`	`nsIDOMEventListener`	ダウンロードス売る更新がない場合に呼び出されるイベントリスナー。
`ondownloading`	`nsIDOMEventListener`	リソースがキャッシュにダウンロードされる際に呼び出されるイベントリスナー。
`onprogress`	`nsIDOMEventListener`	ダウンロードプロセスの途中で定期的に呼び出されるイベントリスナー。
`onupdateready`	`nsIDOMEventListener`	リソースの更新が完了した際に呼び出されるイベントリスナー。バージョン管理されたアプリケーションキャッシュがサポートされていないため、このイベントはまだ使われていません。
`oncached`	`nsIDOMEventListener`	キャッシュが完了した際に呼び出されるイベントリスナー。
`status`	`unsigned short`	アプリケーションキャッシュの状態を示す、いずれかの定数。

定数

定数	値	説明
`UNCACHED`	0	オブジェクトはアプリケーションキャッシュと関連付けられていません。
`IDLE`	1	アプリケーションキャッシュは更新プロセスの途中ではありません。
`CHECKING`	2	アプリケーションキャッシュマニフェストを取得して、更新を確認しています。
`DOWNLOADING`	3	リソースをダウンロードしてキャッシュに追加しています。
`UPDATEREADY`	4	新しいバージョンのアプリケーションキャッシュが利用可能です。註: バージョン管理されたアプリケーションキャッシュはまだ実装されていません。このため、このステータス値は現時点では使われていません。

メソッド

add()

動的に管理されたエントリーにアイテムを追加します。リソースは取得され、アプリケーションキャッシュに追加されます。

 void add(
   in DOMString uri
 );

引数

<tt>uri</tt>: リストに追加するリソースの URI。

item()

キャッシュされたリソースのリストから、特定のオフセットにあるアイテムの URI を返します。

 DOMString item(
   in unsigned long index
 );

引数

<tt>index</tt>: URI を取得する、キャッシュされたアイテムのインデックス。

戻り値

指定されたリソースの URI を含む DOMString。

remove()

動的に管理されたエントリーのリストからアイテムを削除します。アプリケーションキャッシュ内の指定された URI に対する最後の参照であった場合、キャッシュエントリーが削除されます。

 void remove(
   in DOMString uri
 );

引数

<tt>uri</tt>: リストから削除するアイテムの URI。

swapCache()

アプリケーションキャッシュの最新版でやりとりを行います。

註: バージョン管理されたアプリケーションキャッシュはまだサポートされていないため、このメソッドは例外を投げます。

 void swapCache();

引数

なし。

update()

アプリケーションキャッシュの更新プロセスを開始します。

 void update();

引数

なし。

参考資料

Offline resources in Firefox