WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

@mozilla.org/feed;1

This component implements the following interfaces:

Constants

PRUint32 nsIFeed.TYPE_FEED = 0
PRUint32 nsIFeed.TYPE_AUDIO = 1
PRUint32 nsIFeed.TYPE_IMAGE = 2
PRUint32 nsIFeed.TYPE_VIDEO = 4

Properties

nsISAXAttributes nsIFeedElementBase.attributes

The attributes found on the element. Most interfaces provide convenience accessors for their standard fields, so this useful only when looking for an extension.

nsIArray nsIFeedContainer.authors

A list of nsIFeedPersons that authored the feed.

nsIURI nsIFeedElementBase.baseURI

The baseURI for the Entry or Feed.

nsIArray nsIFeedContainer.categories

Returns the categories found in a feed or entry.

nsIWritablePropertyBag2 nsIFeed.cloud

No one really knows what cloud is for.

It supposedly enables some sort of interaction with an XML-RPC or SOAP service.

nsIArray nsIFeedContainer.contributors

A list of nsIFeedPersons that contributed to the feed.

PRInt32 nsIFeed.enclosureCount

The total number of enclosures found in the feed.

nsIWritablePropertyBag2 nsIFeedContainer.fields

The fields found in the document. Common Atom and RSS fields are normalized. This includes some namespaced extensions such as dc:subject and content:encoded. Consumers can avoid normalization by checking the feed type and accessing specific fields.

Common namespaces are accessed using prefixes, like get("dc:subject");. See nsIFeedResult::registerExtensionPrefix.

nsIFeedGenerator nsIFeed.generator

Information about the software that produced the feed.

AString nsIFeedContainer.id

Many feeds contain an ID distinct from their URI, and entries have standard fields for this in all major formats.

nsIWritablePropertyBag2 nsIFeed.image

An image url and some metadata (as defined by RSS2).

nsIArray nsIFeed.items

The items or entries in feed.

nsIURI nsIFeedContainer.link

Returns the primary link for the feed or entry.

nsIArray nsIFeedContainer.links

Returns all links for a feed or entry.

nsIFeedTextConstruct nsIFeedContainer.rights

The rights or license associated with a feed or entry.

nsIArray nsIFeed.skipDays

Days to skip fetching. This field was supposed to designate intervals for feed fetching. It's not generally implemented. For example, if this array contained "Monday", aggregators should not fetch the feed on Mondays.

nsIArray nsIFeed.skipHours

Hours to skip fetching. This field was supposed to designate intervals for feed fetching. It's not generally implemented. See for more information.

nsIFeedTextConstruct nsIFeed.subtitle

Uses description, subtitle, and extensions to generate a summary.

nsIWritablePropertyBag2 nsIFeed.textInput

No one really knows what textInput is for.

See for more details.

nsIFeedTextConstruct nsIFeedContainer.title

Sometimes there's no title, or the title contains markup, so take care in decoding the attribute.

readonly PRUint32 nsIFeed.type

The type of feed. For example, a podcast would be TYPE_AUDIO.

AString nsIFeedContainer.updated

The date the feed was updated, in RFC822 form. Parsable by JS and mail code.

Methods

InterfaceMethod
nsIFeedContainer void normalize ( )

Reference documentation is generated from Mozilla's source.