nsIMicrosummaryGenerator Interface Reference

import"nsIMicrosummaryService.idl";

Inheritance diagram for nsIMicrosummaryGenerator:
[legend]
Collaboration diagram for nsIMicrosummaryGenerator:
[legend]

Public Member Functions

boolean equals (in nsIMicrosummaryGenerator aOther)
 
AString generateMicrosummary (in nsIDOMNode aPageContent)
 
long calculateUpdateInterval (in nsIDOMNode aPageContent)
 

Public Attributes

readonly attribute boolean loaded
 
readonly attribute AUTF8String name
 
readonly attribute nsIURI uri
 
readonly attribute nsIURI localURI
 
readonly attribute boolean needsPageContent
 

Detailed Description

Definition at line 48 of file nsIMicrosummaryService.idl.

Member Function Documentation

long nsIMicrosummaryGenerator::calculateUpdateInterval ( in nsIDOMNode  aPageContent)

Calculate the interval until the microsummary should be updated for the next time, depending on the page content. If the generator doesn't specify an interval, null is returned.

Parameters
pageContentthe content of the page being summarized
Returns
the interval in milliseconds until the next update request
boolean nsIMicrosummaryGenerator::equals ( in nsIMicrosummaryGenerator  aOther)

microsummary-generator equivalence test generators equal if their canonical locations equal, see uri attribute.

AString nsIMicrosummaryGenerator::generateMicrosummary ( in nsIDOMNode  aPageContent)

Generate a microsummary by processing the generator template against the page content. If a generator doesn't need content, pass null as the parameter to this method.

XXX In the future, this should support returning rich text content, so perhaps we should make it return a DOM node now and have the caller convert that to text if it doesn't support rich content.

Parameters
pageContentthe content of the page being summarized
Returns
the text result of processing the template

Member Data Documentation

readonly attribute boolean nsIMicrosummaryGenerator::loaded

Definition at line 51 of file nsIMicrosummaryService.idl.

readonly attribute nsIURI nsIMicrosummaryGenerator::localURI

Definition at line 83 of file nsIMicrosummaryService.idl.

readonly attribute AUTF8String nsIMicrosummaryGenerator::name

Definition at line 54 of file nsIMicrosummaryService.idl.

readonly attribute boolean nsIMicrosummaryGenerator::needsPageContent

Definition at line 89 of file nsIMicrosummaryService.idl.

readonly attribute nsIURI nsIMicrosummaryGenerator::uri

Definition at line 72 of file nsIMicrosummaryService.idl.


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