nsIMicrosummaryGenerator
| IID: | 05b48344-d0a7-427e-934e-9a6e0d5ecced |
| Inherits From: | nsISupports |
Properties
readonly PRBool loaded
readonly nsIURI localURI
readonly AUTF8String name
readonly PRBool needsPageContent
readonly nsIURI uri
Methods
PRInt32 calculateUpdateInterval ( nsIDOMNode pageContent )
PRBool equals ( nsIMicrosummaryGenerator other )
AString generateMicrosummary ( nsIDOMNode pageContent )
PRInt32 calculateUpdateInterval ( nsIDOMNode pageContent )
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.
- Arguments:
- pageContent: the content of the page being summarized
PRBool equals ( nsIMicrosummaryGenerator other )
Microsummary-generator equivalence test generators equal if their canonical locations equal, see uri attribute.
- Arguments:
- other
AString generateMicrosummary ( nsIDOMNode pageContent )
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.
- Arguments:
- pageContent: the content of the page being summarized
References
This interface is the type of the following properties:
This interface is passed as an argument to the following methods:
nsIMicrosummaryGenerator.equals
This interface is returned from the following methods:
nsIMicrosummaryService.getGenerator, nsIMicrosummaryService.installGenerator
Reference documentation is generated from Mozilla's source.