Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIFeedResult Interface Reference

The nsIFeedResult interface provides access to HTTP and parsing metadata for a feed or entry. More...

import "nsIFeedResult.idl";

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

List of all members.

Public Member Functions

void registerExtensionPrefix (in AString namespace, in AString prefix)
 Registers a prefix used to access an extension in the feed/entry.

Public Attributes

attribute boolean bozo
 The Feed parser will set the bozo bit when a feed triggers a fatal error during XML parsing.
attribute nsIFeedContainer doc
 The parsed feed or entry.
attribute nsIURI uri
 The address from which the feed was fetched.
attribute AString version
 Feed Version: atom, rss2, rss09, rss091, rss091userland, rss092, rss1, atom03, atomEntry, rssItem.
attribute nsIURI stylesheet
 An XSLT stylesheet available to transform the source of the feed.
attribute nsIProperties headers
 HTTP response headers that accompanied the feed.

Detailed Description

The nsIFeedResult interface provides access to HTTP and parsing metadata for a feed or entry.

Definition at line 47 of file nsIFeedResult.idl.


Member Function Documentation

void nsIFeedResult::registerExtensionPrefix ( in AString  namespace,
in AString  prefix 
)

Registers a prefix used to access an extension in the feed/entry.


Member Data Documentation

The Feed parser will set the bozo bit when a feed triggers a fatal error during XML parsing.

There may be entries and feed metadata that were parsed before the error. Thanks to Tim Bray for suggesting this terminology. http://www.tbray.org/ongoing/When/200x/2004/01/11/PostelPilgrim

Definition at line 56 of file nsIFeedResult.idl.

The parsed feed or entry.

Will be null if a non-feed is processed.

Definition at line 63 of file nsIFeedResult.idl.

HTTP response headers that accompanied the feed.

Definition at line 90 of file nsIFeedResult.idl.

An XSLT stylesheet available to transform the source of the feed.

Some feeds include this information in a processing instruction. It's generally intended for clients with specific feed capabilities.

Definition at line 85 of file nsIFeedResult.idl.

The address from which the feed was fetched.

Definition at line 68 of file nsIFeedResult.idl.

Feed Version: atom, rss2, rss09, rss091, rss091userland, rss092, rss1, atom03, atomEntry, rssItem.

Will be null if a non-feed is processed.

Definition at line 77 of file nsIFeedResult.idl.


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