Public Member Functions

nsIFeedProgressListener Interface Reference

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

import "nsIFeedListener.idl";

Inheritance diagram for nsIFeedProgressListener:
Collaboration diagram for nsIFeedProgressListener:

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.

Detailed Description

nsIFeedProgressListener defines callbacks used during feed processing.


Member Function Documentation

void nsIFeedProgressListener::handleEntry ( in nsIFeedEntry  entry,
in nsIFeedResult  result 
)

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:
entry An object implementing nsIFeedEntry that represents the latest entry encountered.
result An object implementing nsIFeedResult representing the feed and its metadata.
void nsIFeedProgressListener::handleFeedAtFirstEntry ( in nsIFeedResult  result  ) 

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:
result An object implementing nsIFeedResult representing the feed and its metadata. At this point, the result will likely have most of its feed-level metadata.
void nsIFeedProgressListener::handleStartFeed ( in nsIFeedResult  result  ) 

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

Parameters:
result An 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:
errorText A short description of the error.
lineNumber The line on which the error occured.

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