nsIMicrosummary 编辑

toolkit/components/places/public/nsIMicrosummaryService.idlScriptable This interface defines attributes and methods for dealing with microsummaries generated by an nsIMicrosummaryGenerator. 1.0 66 Introduced Gecko 1.8 Obsolete Gecko 6.0 Inherits from: nsISupports Last changed in Gecko 1.9 (Firefox 3) Warning: Microsummary support was removed in Gecko 6.0 (Firefox 6.0 / Thunderbird 6.0 / SeaMonkey 2.3)

Method overview

void addObserver(in nsIMicrosummaryObserver observer);

boolean equals(in nsIMicrosummary aOther);

void removeObserver(in nsIMicrosummaryObserver observer);

void update();

Attributes

Attribute	Type	Description
content	AString	The content of the microsummary. Since generators and pages can be remote resources, and we need them to generate the content, this may not always be available. Read only.
generator	nsIMicrosummaryGenerator	The generator that generates this microsummary. May need to be loaded.
needsRemoval	boolean	Used when a site author has indicated that a microsummary (or an associated generator) will no longer be available. Read only.
pageURI	nsIURI	The URI of the page being summarized. Read only.
updateInterval	long	The minimum interval after which this microsummary would like to be refreshed or null if it doesn't care. Read only.

Methods

addObserver()

Add a microsummary observer to this microsummary.

void addObserver(
  in nsIMicrosummaryObserver observer
);

Parameters

observer

The microsummary observer to add.

equals()

Microsummary equivalence test. Microsummaries equal if they summarize the same page with the same microsummary-generator (see also nsIMicrosummaryGenerator.equals()).

boolean equals(
  in nsIMicrosummary aOther
);

Parameters

aOther

The microsummary to compare against.

Return value

Returns true if the microsummaries are equal. false if they aren't.

Note: This method returns false if either objects don't have a generator

removeObserver()

Remove a microsummary observer from this microsummary.

void removeObserver(
  in nsIMicrosummaryObserver observer
);

Parameters

observer

The microsummary observer to remove.

update()

Update the microsummary, first loading its generator and page content as necessary. If you want know when a microsummary finishes updating, add an observer before calling this method.

void update();

See also

• Microsummary topics
• Creating a Microsummary