Songbird / Development / Songbird Add-Ons API Documentation

sbILibraryLoggingService Interface Reference

Library and media list logging service. More...

List of all members.

Public Member Functions

void addLibrary (in sbIMediaList aMediaList, in nsISupports aLogConsumer)
void removeLibrary (in sbIMediaList aMediaList, in nsISupports aLogConsumer)
sbILibraryChangeset getChangesetForLibrary (in sbIMediaList aMediaList, in nsISupports aLogConsumer, in boolean aPeekLog)
boolean hasChangesetForLibrary (in sbIMediaList aMediaList, in nsISupports aLogConsumer)


Detailed Description

Library and media list logging service.

The library logging service enables to log changes that are made to a library or list. The changeset will include all information about each change that was made to the library or list. This includes items being added, modified (properties) and removed.

See also:
sbILibraryDiffingService, sbILibraryChangeset

Definition at line 50 of file sbILibraryLoggingService.idl.


Member Function Documentation

void sbILibraryLoggingService::addLibrary ( in sbIMediaList  aMediaList,
in nsISupports  aLogConsumer 
)

Start logging changes to a library.

If the consumer is null, the log may be consumed by all.

The same library or media list may be added to the logging service multiple times if the log consumer is not already registered.

The same consumer may be used for multiple library or media lists.

Parameters:
aMediaList The library or media list to log.
aLogConsumer The consumer of the log.

void sbILibraryLoggingService::removeLibrary ( in sbIMediaList  aMediaList,
in nsISupports  aLogConsumer 
)

Stop logging changes to a library.

Parameters:
aLibrary The library to stop logging.
aLogConsumer The consumer of the log.

sbILibraryChangeset sbILibraryLoggingService::getChangesetForLibrary ( in sbIMediaList  aMediaList,
in nsISupports  aLogConsumer,
in boolean  aPeekLog 
)

Get the changeset for a library.

Parameters:
aMediaList The library or media list.
aLogConsumer The consumer of the log.
aPeekLog Flag indicating whether the log will be consumed or peeked.

boolean sbILibraryLoggingService::hasChangesetForLibrary ( in sbIMediaList  aMediaList,
in nsISupports  aLogConsumer 
)

Indicates if there is a changeset available for the library / log consumer pair.

Parameters:
aMediaList The library.
aLogConsumer The log consumer.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:59 2009 for Songbird by  doxygen 1.5.2