toolkit/components/antitracking/nsIPartitioningExceptionListService.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6
   7 /**
   8  * Observer for exception list updates.
   9  */
  10 [scriptable, function, uuid(d8db1086-7b59-44d3-9f88-f31a7e642637)]
  11 interface nsIPartitioningExceptionListObserver : nsISupports
  12 {
  13   /**
  14    * Called by nsIPartitioningExceptionListService when the exception list
  15    * changes and when the observer is first registered.
  16    *
  17    * @param aList
  18    *        A semicolon-separated list of comma-separated url pairs.
  19    */
  20   void onExceptionListUpdate(in ACString aList);
  21 };
  22
  23 /**
  24  * A service that monitors updates to the exception list of partitioning
  25  * from sources such as a local pref and remote settings updates.
  26  */
  27 [scriptable, uuid(cf83a9af-dd3f-43a2-88bb-489a22bca124)]
  28 interface nsIPartitioningExceptionListService : nsISupports
  29 {
  30   /**
  31    * Register a new observer to exception list updates. When the observer is
  32    * registered it is called immediately once. Afterwards it will be called
  33    * whenever the specified pref changes or when remote settings for
  34    * partitioning updates.
  35    *
  36    * @param aObserver
  37    *        An nsIPartitioningExceptionListObserver object or function that
  38    *        will receive updates to the exception list as a comma-separated
  39    *        string. Will be called immediately with the current exception
  40    *        list value.
  41    */
  42   void registerAndRunExceptionListObserver(in nsIPartitioningExceptionListObserver aObserver);
  43
  44   /**
  45    * Unregister an observer.
  46    *
  47    * @param aObserver
  48    *        The nsIPartitioningExceptionListObserver object to unregister.
  49    */
  50   void unregisterExceptionListObserver(in nsIPartitioningExceptionListObserver aObserver);
  51 };