nsISupports
Last changed in Gecko 1.9 (Firefox 3)Method overview
long calculateUpdateInterval(in nsIDOMNode aPageContent); |
boolean equals(in nsIMicrosummaryGenerator aOther); |
AString generateMicrosummary(in nsIDOMNode aPageContent); |
Attributes
| Attribute | Type | Description |
loaded | boolean | Has the generator itself (which may be a remote resource) been loaded. Read only. |
localURI | | For generators installed by the user or bundled with the browser, the local URI points to the location of the local file containing the generator's XML. Read only. |
name | AUTF8String | An arbitrary descriptive name for this microsummary generator. Read only. |
needsPageContent | boolean | Whether or not this generator needs page content to generate a microsummary. Microsummaries generated by XSLT templates need page content, while those which represent the actual microsummary do not. Read only. |
uri | | The canonical location and unique identifier of the generator. It tells us where the generator comes from and where to go for updates. Read only. For generators referenced by web pages via For generators installed via For generators installed via some other mechanism (for example an extension that dynamically creates generators), this URI is a URN in a form of the extension's own choosing, with the only restriction being that the URI be globally unique. To ensure this, we recommend that such extensions incorporate UUIDs created by |
Methods
calculateUpdateInterval()
Calculates 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.
long calculateUpdateInterval( in nsIDOMNode aPageContent );
Parameters
aPageContent- The content of the page being summarized.
Return value
The interval in milliseconds until the next update request.
equals()
Microsummary-generator equivalence test. Generators are considered equal if their canonical locations (uri attribute) are equal.
boolean equals( in nsIMicrosummaryGenerator aOther );
Parameters
aOther- The generator to compare against.
Return value
A boolean indicating if the two generators are equal.
generateMicrosummary()
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.
AString generateMicrosummary( in nsIDOMNode aPageContent );
Parameters
aPageContent- The content of the page being summarized.
Return value
The text result of processing the template.