Public Member Functions | Public Attributes

nsIFeedContainer Interface Reference

A shared base for feeds and items, which are pretty similar, but they have some divergent attributes and require different convenience methods. More...

import "nsIFeedContainer.idl";

Inheritance diagram for nsIFeedContainer:
Collaboration diagram for nsIFeedContainer:

List of all members.

Public Member Functions

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

Public Attributes

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.

Detailed Description

A shared base for feeds and items, which are pretty similar, but they have some divergent attributes and require different convenience methods.


Member Function Documentation

void nsIFeedContainer::normalize (  ) 

Syncs a container's fields with its convenience attributes.


Member Data Documentation

A list of nsIFeedPersons that authored the feed.

Returns the categories found in a feed or entry.

A list of nsIFeedPersons that contributed to the feed.

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.

attribute AString nsIFeedContainer::id

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

Returns the primary link for the feed or entry.

Returns all links for a feed or entry.

The rights or license associated with a feed or entry.

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

attribute AString nsIFeedContainer::updated

The date the feed was updated, in RFC822 form.

Parsable by JS and mail code.


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