nsIContentPrefService in Firefox 3.5

Implemented by

@mozilla.org/content-pref/service;1

[scriptable, uuid(5047e359-dfda-4858-abec-d145c7463250)]

Attributes

 The database connection to the content preferences database.
 Useful for accessing and manipulating preferences in ways that are caller-
 specific or for which there is not yet a generic method, although generic
 functionality useful to multiple callers should generally be added to this
 unfrozen interface.  Also useful for testing the database creation
 and migration code.

readonly attribute mozIStorageConnection DBConnection

 The component that the service uses to determine the groups to which
 URIs belong.  By default this is the "hostname grouper", which groups
 URIs by full hostname (a.k.a. site).

readonly attribute nsIContentURIGrouper grouper

Methods

 Add an observer.
 
 @param    aName       the setting to observe, or null to add
                       a generic observer that observes all settings
 @param    aObserver   the observer to add

void addObserver(in AString aName, in nsIContentPrefObserver aObserver)

 Get a pref.

 Besides the regular string, integer, boolean, etc. values, this method
 may return null (nsIDataType::VTYPE_EMPTY), which means the pref is set
 to NULL in the database, as well as undefined (nsIDataType::VTYPE_VOID),
 which means there is no record for this pref in the database.

 @param    aURI        the URI for which to get the pref, or null to get
                       the global pref (applies to all URIs)
 @param    aName       the name of the pref to get

 @returns  the value of the pref

nsIVariant getPref(in nsIURI aURI, in AString aName)

 Get the prefs that apply to the given URI.

 @param    aURI        the URI for which to retrieve prefs
 
 @returns  a property bag of prefs

nsIPropertyBag2 getPrefs(in nsIURI aURI)

 Check whether or not a pref exists.

 @param    aURI        the URI for which to check for the pref
 @param    aName       the name of the pref to check for

boolean hasPref(in nsIURI aURI, in AString aName)

 Remove all grouped prefs.  Useful for removing references to the sites
 the user has visited when the user clears their private data.

void removeGroupedPrefs()

 Remove an observer.

 @param    aName       the setting being observed, or null to remove
                       a generic observer that observes all settings
 @param    aObserver   the observer to remove

void removeObserver(in AString aName, in nsIContentPrefObserver aObserver)

 Remove a pref.

 @param    aURI        the URI for which to remove the pref
 @param    aName       the name of the pref to remove

void removePref(in nsIURI aURI, in AString aName)

 Set a pref.

 @param    aURI        the URI for which to set the pref, or null to set
                       the global pref (applies to all URIs)
 @param    aName       the name of the pref to set
 @param    aValue      the new value of the pref

void setPref(in nsIURI aURI, in AString aName, in nsIVariant aValue)