Back to index

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

An nsIFeedEntry represents an Atom or RSS entry/item. More...

import "nsIFeedEntry.idl";

Inheritance diagram for nsIFeedEntry:
Inheritance graph
[legend]
Collaboration diagram for nsIFeedEntry:
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 summary
 Uses description, subtitle, summary, content and extensions to generate a summary.
attribute AString published
 The date the entry was published, in RFC822 form.
attribute nsIFeedTextConstruct content
 Uses atom:content and content:encoded to provide a 'full text' view of an entry.
attribute nsIArray enclosures
 Enclosures are podcasts, photocasts, etc.
attribute nsIArray mediaContent
 Enclosures, etc.
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 nsIFeedEntry represents an Atom or RSS entry/item.

Summary and/or full-text content may be available, but callers will have to check both.

Definition at line 48 of file nsIFeedEntry.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.

Uses atom:content and content:encoded to provide a 'full text' view of an entry.

Definition at line 68 of file nsIFeedEntry.idl.

A list of nsIFeedPersons that contributed to the feed.

Definition at line 104 of file nsIFeedContainer.idl.

Enclosures are podcasts, photocasts, etc.

Definition at line 73 of file nsIFeedEntry.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.

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.

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.

Enclosures, etc.

that might be displayed inline.

Definition at line 78 of file nsIFeedEntry.idl.

The date the entry was published, in RFC822 form.

Parsable by JS and mail code.

Definition at line 61 of file nsIFeedEntry.idl.

The rights or license associated with a feed or entry.

Definition at line 94 of file nsIFeedContainer.idl.

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

Definition at line 55 of file nsIFeedEntry.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.

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: