lp.services.feeds.interfaces.feed.IFeed : API documentation

Interface for feeds.

Feeds in Launchpad are published using the Atom syndication standard, as defined by the proposed standard RFC 4287[1] or as HTML snippets.

An Atom feed is an XML document consisting of a feed and zero or more entries. The feed section describes the feed as a whole while the entries are descriptions of the individual components of that feed. For instance the feed for "feeds.launchpad.net/ubuntu/announcement.atom" has metadata referring to the Ubuntu project and each entry in the feed represents a specific announcement.

The components of IFeed are those data specifically for the feed. The entry data is found in IFeedEntry.

[1] http://tools.ietf.org/html/rfc4287

Int	max_age	Undocumented
Int	quantity	Undocumented
TextLine	title	Undocumented
TextLine	link_self	Undocumented
TextLine	site_url	Undocumented
TextLine	link_alternate	Undocumented
TextLine	feed_id	Undocumented
TextLine	feed_format	Undocumented
TextLine	logo	Undocumented
TextLine	icon	Undocumented
Datetime	date_updated	Undocumented
Method	getItems	Get the individual items for the feed.
Method	renderAtom	Render the object as an Atom feed.
Method	renderHTML	Render the object as an html feed.

def getItems():

Get the individual items for the feed.

Individual items will provide IFeedEntry.

def renderAtom():

Render the object as an Atom feed.

Override this as opposed to overriding render().

def renderHTML():

Render the object as an html feed.

Override this as opposed to overriding render().

l.s.f.i.f.IFeed(Interface) : interface documentation