Public Member Functions | Public Attributes

nsIFeedResultService Interface Reference

nsIFeedResultService provides a globally-accessible object for retrieving the results of feed processing. More...

import "nsIFeedResultService.idl";

List of all members.

Public Member Functions

void addToClientReader (in AUTF8String uri, in AString title, in AString subtitle, in unsigned long feedType)
 Adds a URI to the user's specified external feed handler, or live bookmarks.
void addFeedResult (in nsIFeedResult feedResult)
 Registers a Feed Result object with a globally accessible service so that it can be accessed by a singleton method outside the usual flow of control in document loading.
nsIFeedResult getFeedResult (in nsIURI uri)
 Gets a Feed Handler object registered using addFeedResult.
void removeFeedResult (in nsIURI uri)
 Unregisters a Feed Handler object registered using addFeedResult.

Public Attributes

attribute boolean forcePreviewPage
 When set to true, forces the preview page to be displayed, regardless of the user's preferences.

Detailed Description

nsIFeedResultService provides a globally-accessible object for retrieving the results of feed processing.


Member Function Documentation

void nsIFeedResultService::addFeedResult ( in nsIFeedResult  feedResult  ) 

Registers a Feed Result object with a globally accessible service so that it can be accessed by a singleton method outside the usual flow of control in document loading.

Parameters:
feedResult An object implementing nsIFeedResult representing the feed.
void nsIFeedResultService::addToClientReader ( in AUTF8String  uri,
in AString  title,
in AString  subtitle,
in unsigned long  feedType 
)

Adds a URI to the user's specified external feed handler, or live bookmarks.

Parameters:
uri The uri of the feed to add.
title The title of the feed to add.
subtitle The subtitle of the feed to add.
feedType The nsIFeed type of the feed. See nsIFeed.idl
nsIFeedResult nsIFeedResultService::getFeedResult ( in nsIURI  uri  ) 

Gets a Feed Handler object registered using addFeedResult.

Parameters:
uri The URI of the feed a handler is being requested for
void nsIFeedResultService::removeFeedResult ( in nsIURI  uri  ) 

Unregisters a Feed Handler object registered using addFeedResult.

Parameters:
uri The feed URI the handler was registered under. This must be the same *instance* the feed was registered under.

Member Data Documentation

When set to true, forces the preview page to be displayed, regardless of the user's preferences.


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