Skip to main content

Visit Mozilla.org

nsIFeedProgressListener

出典: MDC

nsIFeedProgressListener インタフェースは、RSS あるいは Atom フィードの処理中に使われるコールバックを定義します。フィードコンテントアクセス API を使うプログラムはこれらのコールバックのいずれも実装する必要はありません。それらは任意ですが、パース処理中にフィードバックを提供することができます。

目次

nsIFeedProgressListener は toolkit/components/feeds/public/nsiFeedListener.idl で定義されています。これは scriptable で 非凍結です。 (Mozilla 1.8.1から更新されていません)

継承元: nsIFeedResultListener

[編集] メソッドの概要

void handleEntry(in nsIFeedEntry entry, in nsIFeedResult result);
void handleFeedAtFirstEntry(in nsIFeedResult result);
void handleStartFeed(in nsIFeedResult result);
void reportError(in AString errorText, in long lineNumber, in boolean bozo);

[編集] メソッド

[編集] handleEntry()

エントリあるいはアイテムが処理された後に呼ばれます。もしドキュメントが単独のアイテムあるいはエントリなら、 handleFeedAtFirstEntry() メソッドが呼ばれることなく、nsIFeedEntry が parent の値に null を持つでしょう。 

 void handleEntry(
   in nsIFeedEntry entry,
   in nsIFeedResult result
 );
[編集] パラメータ
entry
ちょうど処理されたエントリに関する情報を含んでいる nsIFeedEntry のポインタ。
result
処理されているフィードに関する現在の情報を含む nsIFeedResult のポインタ。

[編集] handleFeedAtFirstEntry()

そのフィードで最初にエントリあるいはアイテムに出会った時に呼ばれます。Atomでは全てのフィードデータがエントリーに先行する必要があります; RSSではこれは必要ではありませんが通常はそうです。言い替えるとこのメソッドが呼ばれるとき、十中八九、ほとんどあるいは全てのフィードレベルのメタデータが処理され、受け取った nsIFeedResult オブジェクトで利用できるでしょう。 

 void handleFeedAtFirstEntry(
   in nsIFeedResult result
 );
[編集] パラメータ
result
最初のエントリが見付かったが、処理される前の時点のフィードを表す nsIFeedResult。
注意: もしフィードのタイプがエントリのみあるいはアイテムのみのタイプの場合、このイベントが呼ばれることはありません。

[編集] handleStartFeed()

フィードで妥当な先頭部分が検出されるとただちに呼ばれます; これはあなたのコードにそのフィードが他の種類のドキュメントではなく実際のフィードであるように見えることを知らせてくれます。 


 void handleStartFeed(
   in nsIFeedResult result
 );
[編集] パラメータ
result
フィードがパースされ始めた時点での状態を表す nsIFeedResult。

[編集] reportError()

致命的な XML パースエラーが発生したときや、ドキュメントがフィードではなかったときにフィードプロセッサによって呼ばれます。 

 void reportError(
   in AString errorText,
   in long lineNumber,
   in boolean bozo
 );

それぞれのメソッドは少なくとも処理の時点での状態を表す nsIFeedResult を入力として受け取ります。

[編集] 参照

nsIFeedResultListener

"http://developer.mozilla.org/ja/docs/nsIFeedProgressListener" より作成