Register | Log in

Mozilla.com

  1. MDC
  2. Main Page
  3. nsIMicrosummaryGenerator
Table of contents
  1. 1. Method overview
  2. 2. Attributes
  3. 3. Methods
    1. 3.1. euqals()
          1. 3.1.1.1.1. Parameters
          2. 3.1.1.1.2. Return value
    2. 3.2. generateMicrosummary()
          1. 3.2.1.1.1. Parameters
          2. 3.2.1.1.2. Return value
    3. 3.3. calculateUpdateInterval()
          1. 3.3.1.1.1. Parameters
          2. 3.3.1.1.2. Return value
    4. 3.4. See also

nsIMicrosummaryGenerator

The nsIMicrosummaryGenerator interface provides access to a microsummary that has been installed in Firefox.


nsIMicrosummaryGenerator is defined in browser/components/microsummaries/public/nsIMicrosummaryService.idl#47 . It is scriptable and unfrozen (hasn't changed since Mozilla 1.8) .

Inherits from: nsISupports

Method overview

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

Attributes

Attribute Type Description
loaded boolean Has the generator itself (which may be a remote resource) been loaded.
name AUTF8String An arbitrary descriptive name for this microsummary generator.
uri nsIURI The canonical location and unique identifier of the generator. It tells us where the generator comes from and where to go for updates.
For generators referenced by web pages via <link> tags, this URI is the URL specified by the tag.
For generators installed via nsISidebar.addMicrosummaryGenerator() , this URI is a URN of the form urn:source:<url>, where <url> is the remote location from which we installed the generator.
For generators installed via some other mechanism (f.e. 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 nsIUUIDGenerator into the URNs of the generators they create.
localURI nsIURI 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.
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.

Methods

euqals()

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

Returns 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.

Note: In the future, this may be expanded to support rich text content.
 generateMicrosummary(in nsIDOMNode aPageContent);
Parameters
aPageContent
The content of the page being summarized.
Return value

Returns the text result of processing the template.

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. 

 calculateUpdateInterval(in nsIDOMNode aPageContent);
Parameters
aPageContent
The content of the page being summarized.
Return value

Returns the interval in milliseconds until the next update request.

Page last modified 21:15, 9 Jan 2008 by Sheppy

Tags:

Files (0)