toolkit/components/antitracking/nsIURLDecorationAnnotationsService.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  * A service that monitors updates to the anti-tracking URL decoration
   9  * annotations from remote settings.
  10  */
  11 [scriptable, uuid(937d0c66-6821-4e3f-9e04-50dbc2b2b476)]
  12 interface nsIURLDecorationAnnotationsService : nsISupports
  13 {
  14   /**
  15    * Ensures that the list is updated and resolves the returned promise when
  16    * the update is finished.
  17    *
  18    * The new list will be written to a space-separated list of tokens inside
  19    * the following string preference:
  20    *   privacy.restrict3rdpartystorage.url_decorations
  21    *
  22    * This preference will be kept up to date with future list updates from
  23    * the remote settings server.  This preference cannot be modified by any
  24    * external component and is managed by this service.
  25    */
  26   Promise ensureUpdated();
  27 };