Back to index

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

An nsIFeed represents a single Atom or RSS feed. More...

import "nsIFeed.idl";

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

List of all members.

Public Member Functions

void normalize ()
 Syncs a container's fields with its convenience attributes.

Public Attributes

attribute nsIFeedTextConstruct subtitle
 Uses description, subtitle, and extensions to generate a summary.
const unsigned long TYPE_FEED = 0
const unsigned long TYPE_AUDIO = 1
const unsigned long TYPE_IMAGE = 2
const unsigned long TYPE_VIDEO = 4
readonly attribute unsigned long type
 The type of feed.
attribute long enclosureCount
 The total number of enclosures found in the feed.
attribute nsIArray items
 The items or entries in feed.
attribute nsIWritablePropertyBag2 cloud
 No one really knows what cloud is for.
attribute nsIFeedGenerator generator
 Information about the software that produced the feed.
attribute nsIWritablePropertyBag2 image
 An image url and some metadata (as defined by RSS2).
attribute nsIWritablePropertyBag2 textInput
 No one really knows what textInput is for.
attribute nsIArray skipDays
 Days to skip fetching.
attribute nsIArray skipHours
 Hours to skip fetching.
attribute AString id
 Many feeds contain an ID distinct from their URI, and entries have standard fields for this in all major formats.
attribute nsIWritablePropertyBag2 fields
 The fields found in the document.
attribute nsIFeedTextConstruct title
 Sometimes there's no title, or the title contains markup, so take care in decoding the attribute.
attribute nsIURI link
 Returns the primary link for the feed or entry.
attribute nsIArray links
 Returns all links for a feed or entry.
attribute nsIArray categories
 Returns the categories found in a feed or entry.
attribute nsIFeedTextConstruct rights
 The rights or license associated with a feed or entry.
attribute nsIArray authors
 A list of nsIFeedPersons that authored the feed.
attribute nsIArray contributors
 A list of nsIFeedPersons that contributed to the feed.
attribute AString updated
 The date the feed was updated, in RFC822 form.
attribute nsISAXAttributes attributes
 The attributes found on the element.
attribute nsIURI baseURI
 The baseURI for the Entry or Feed.

Detailed Description

An nsIFeed represents a single Atom or RSS feed.

Definition at line 48 of file nsIFeed.idl.


Member Function Documentation

Syncs a container's fields with its convenience attributes.


Member Data Documentation

The attributes found on the element.

Most interfaces provide convenience accessors for their standard fields, so this useful only when looking for an extension.

Definition at line 54 of file nsIFeedElementBase.idl.

A list of nsIFeedPersons that authored the feed.

Definition at line 99 of file nsIFeedContainer.idl.

The baseURI for the Entry or Feed.

Definition at line 59 of file nsIFeedElementBase.idl.

Returns the categories found in a feed or entry.

Definition at line 89 of file nsIFeedContainer.idl.

No one really knows what cloud is for.

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

Definition at line 83 of file nsIFeed.idl.

A list of nsIFeedPersons that contributed to the feed.

Definition at line 104 of file nsIFeedContainer.idl.

The total number of enclosures found in the feed.

Definition at line 70 of file nsIFeed.idl.

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.

Definition at line 68 of file nsIFeedContainer.idl.

Information about the software that produced the feed.

Definition at line 88 of file nsIFeed.idl.

attribute AString nsIFeedContainer::id [inherited]

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

Definition at line 56 of file nsIFeedContainer.idl.

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

Definition at line 94 of file nsIFeed.idl.

The items or entries in feed.

Definition at line 75 of file nsIFeed.idl.

Returns the primary link for the feed or entry.

Definition at line 79 of file nsIFeedContainer.idl.

Returns all links for a feed or entry.

Definition at line 84 of file nsIFeedContainer.idl.

The rights or license associated with a feed or entry.

Definition at line 94 of file nsIFeedContainer.idl.

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.

Definition at line 111 of file nsIFeed.idl.

Hours to skip fetching.

This field was supposed to designate intervals for feed fetching. It's not generally implemented. See http://blogs.law.harvard.edu/tech/rss for more information.

Definition at line 118 of file nsIFeed.idl.

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

Definition at line 54 of file nsIFeed.idl.

No one really knows what textInput is for.

See http://www.cadenhead.org/workbench/news/2894/rss-joy-textinput for more details.

Definition at line 103 of file nsIFeed.idl.

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

Definition at line 74 of file nsIFeedContainer.idl.

readonly attribute unsigned long nsIFeed::type

The type of feed.

For example, a podcast would be TYPE_AUDIO.

Definition at line 65 of file nsIFeed.idl.

Definition at line 58 of file nsIFeed.idl.

Definition at line 57 of file nsIFeed.idl.

Definition at line 59 of file nsIFeed.idl.

Definition at line 60 of file nsIFeed.idl.

attribute AString nsIFeedContainer::updated [inherited]

The date the feed was updated, in RFC822 form.

Parsable by JS and mail code.

Definition at line 110 of file nsIFeedContainer.idl.


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