sbILibraryLoggingService Interface Reference

import"sbILibraryLoggingService.idl";

Inheritance diagram for sbILibraryLoggingService:
[legend]
Collaboration diagram for sbILibraryLoggingService:
[legend]

Classes

interface  idl
 Library and media list logging service. More...
 

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

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
aMediaListThe library or media list to log.
aLogConsumerThe consumer of the log.
sbILibraryChangeset sbILibraryLoggingService::getChangesetForLibrary ( in sbIMediaList  aMediaList,
in nsISupports  aLogConsumer,
in boolean  aPeekLog 
)

Get the changeset for a library.

Parameters
aMediaListThe library or media list.
aLogConsumerThe consumer of the log.
aPeekLogFlag 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
aMediaListThe library.
aLogConsumerThe log consumer.
void sbILibraryLoggingService::removeLibrary ( in sbIMediaList  aMediaList,
in nsISupports  aLogConsumer 
)

Stop logging changes to a library.

Parameters
aLibraryThe library to stop logging.
aLogConsumerThe consumer of the log.

The documentation for this interface was generated from the following file: