Visit Mozilla.org

nsIFeed

From MDC

The nsIFeed interface represents a single Atom or RSS (Really Simple Syndication) news feed. It includes attributes that provide information about the feed, as well as access to the items or entries in the feed.

Contents

nsIFeed is defined in toolkit/components/feeds/public/nsIFeed.idl. It is scriptable and unfrozen (hasn't changed since Mozilla 1.8.1).

Inherits from: nsIFeedContainer

[edit] Attributes

Attribute Type Description
cloud nsIWritablePropertyBag2 Nobody's really sure what if anything the cloud attribute on a feed is. Supposedly it has something to do with XML-RPC or SOAP services.
enclosureCount long Indicates the number of enclosures associated with a feed.
generator nsIFeedGenerator Describes the software that produced a feed.
image nsIWritablePropertyBag2 Provides an image URL and metadata, as defined by RSS 2.
items nsIArray Specifies an array of the items or entries on the feed, as an array of nsIFeedEntry objects.
skipDays nsIArray An array of days of the week on which the feed should not be fetched. Each entry in the array is the name of one day of the week to skip. For example, to skip fetching on Mondays, a feed that does not want to be fetched on Mondays would specify "Monday" in this array.
Note: This field is rarely implemented.
skipHours nsIArray An array of the hours of the day during which the feed should not be fetched. The hours are represented as integer values from 0 (midnight) to 23 (11:00 PM), and are always indicated using UTC.
Note: This field is rarely implemented.
subtitle nsIFeedTextConstruct Returns a subtitle for the feed, based on its description, subtitle, and appropriate extensions..
textInput nsIWritablePropertyBag2 Information about a text box that can be displayed along with the feed by aggregators that support it, to allow the reader to send a response back to the source of the feed.
Note: This field is almost never used, and is incompatible with many aggregators.
type long Indicates the type of content presented by a feed.

The possible type values are:

TYPE_FEED
A standard text-based feed.
TYPE_AUDIO
An audio feed, such as a podcast.
TYPE_IMAGE
An image feed, such as a photocast.
TYPE_VIDEO
A video feed, such as a videocast.

This attribute is read-only.

Note: You should consider this a bit mask of values; at some point, the type may include more than one of these values ORed together.

[edit] See Also

nsIFeedContainer