nsIFeed

This 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.
1.0
28
Introduced
Gecko 1.8
Inherits from: nsIFeedContainer Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Attributes

Attribute Type Description
cloud nsIWritablePropertyBag2 The cloud element on a feed is used to identify the API endpoint of an rssCloud ping server, which distributes notifications of changes to this feed.
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.
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 unsigned long Indicates the type of content presented by a feed. See Constants.
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.
Read only.

Constants

Constant Value Description
TYPE_FEED 0 A standard text-based feed.
TYPE_AUDIO 1 An audio feed, such as a podcast.
TYPE_IMAGE 2 An image feed, such as a photocast.
TYPE_VIDEO 4 A video feed, such as a videocast.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, lmorchard, trevorh, Ancestor, Planche
Last updated by: Sheppy,