WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIMicrosummary

IID:6867dc21-077f-4462-937d-cd8b7c680e0c
Inherits From:nsISupports

Properties

readonly AString content

nsIMicrosummaryGenerator generator

readonly PRBool needsRemoval

readonly nsIURI pageURI

readonly PRInt32 updateInterval

Methods

void addObserver ( nsIMicrosummaryObserver observer ) PRBool equals ( nsIMicrosummary other ) void removeObserver ( nsIMicrosummaryObserver observer ) void update ( )

void addObserver ( nsIMicrosummaryObserver observer )

Add a microsummary observer to this microsummary.

Arguments:
observer: the microsummary observer to add

PRBool equals ( nsIMicrosummary other )

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

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

Arguments:
other

void removeObserver ( nsIMicrosummaryObserver observer )

Remove a microsummary observer from this microsummary.

Arguments:
observer: the microsummary observer to remove

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

References

This interface is the type of the following properties:

nsILiveTitleNotificationSubject.microsummary

This interface is passed as an argument to the following methods:

nsIMicrosummary.equals, nsIMicrosummaryObserver.onContentLoaded, nsIMicrosummaryObserver.onElementAppended, nsIMicrosummaryObserver.onError, nsIMicrosummaryService.isMicrosummary, nsIMicrosummaryService.setMicrosummary, nsIPlacesTransactionsService.editBookmarkMicrosummary

This interface is returned from the following methods:

nsIMicrosummaryService.createMicrosummary, nsIMicrosummaryService.getMicrosummary, nsIMicrosummaryService.refreshMicrosummary

Reference documentation is generated from Mozilla's source.