Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIFeedProgressListener Interface Reference

nsIFeedProgressListener defines callbacks used during feed processing. More...

import "nsIFeedListener.idl";

Inheritance diagram for nsIFeedProgressListener:
Inheritance graph
[legend]
Collaboration diagram for nsIFeedProgressListener:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void reportError (in AString errorText, in long lineNumber, in boolean bozo)
 ReportError will be called in the event of fatal XML errors, or if the document is not a feed.
void handleStartFeed (in nsIFeedResult result)
 StartFeed will be called as soon as a reasonable start to a feed is detected.
void handleFeedAtFirstEntry (in nsIFeedResult result)
 Called when the first entry/item is encountered.
void handleEntry (in nsIFeedEntry entry, in nsIFeedResult result)
 Called after each entry/item.
void handleResult (in nsIFeedResult result)
 Always called, even after an error.

Detailed Description

nsIFeedProgressListener defines callbacks used during feed processing.

Definition at line 66 of file nsIFeedListener.idl.


Member Function Documentation

Called after each entry/item.

If the document is a standalone item or entry, this HandleFeedAtFirstEntry will not have been called. Also, this entry's parent field will be null.

Parameters:
entryAn object implementing nsIFeedEntry that represents the latest entry encountered.
resultAn object implementing nsIFeedResult representing the feed and its metadata.

Called when the first entry/item is encountered.

In Atom, all feed data is required to preceed the entries. In RSS, the data usually does. If the type is one of the entry/item-only types, this event will not be called.

Parameters:
resultAn object implementing nsIFeedResult representing the feed and its metadata. At this point, the result will likely have most of its feed-level metadata.

Always called, even after an error.

There could be new feed-level data available at this point, if it followed or was interspersed with the items. Fire-and-Forget implementations only need this.

Parameters:
resultAn object implementing nsIFeedResult representing the feed and its metadata.

StartFeed will be called as soon as a reasonable start to a feed is detected.

Parameters:
resultAn object implementing nsIFeedResult representing the feed and its metadata. At this point, the result has version information.
void nsIFeedProgressListener::reportError ( in AString  errorText,
in long  lineNumber,
in boolean  bozo 
)

ReportError will be called in the event of fatal XML errors, or if the document is not a feed.

The bozo bit will be set if the error was due to a fatal error.

Parameters:
errorTextA short description of the error.
lineNumberThe line on which the error occured.

The documentation for this interface was generated from the following file: