gecko/toolkit/components/url-classifier/nsIUrlListManager.idl

68 lines
2.2 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
interface nsIPrincipal;
/**
* Interface for a class that manages updates of the url classifier database.
*/
// Interface for JS function callbacks
[scriptable, function, uuid(fa4caf12-d057-4e7e-81e9-ce066ceee90b)]
interface nsIUrlListManagerCallback : nsISupports {
void handleEvent(in ACString value);
};
[scriptable, uuid(d60a08ee-5c83-4eb6-bdfb-79fd0716501e)]
interface nsIUrlListManager : nsISupports
{
/**
* Get the gethash url for this table
*/
ACString getGethashUrl(in ACString tableName);
/**
* Add a table to the list of tables we are managing. The name is a
* string of the format provider_name-semantic_type-table_type. For
* @param tableName A string of the format
* provider_name-semantic_type-table_type. For example,
* goog-white-enchash or goog-black-url.
* @param providerName The name of the entity providing the list.
* @param updateUrl The URL from which to fetch updates.
* @param gethashUrl The URL from which to fetch hash completions.
*/
boolean registerTable(in ACString tableName,
in ACString providerName,
in ACString updateUrl,
in ACString gethashUrl);
/**
* Turn on update checking for a table. I.e., during the next server
* check, download updates for this table.
*/
void enableUpdate(in ACString tableName);
/**
* Turn off update checking for a table.
*/
void disableUpdate(in ACString tableName);
/**
* Toggle update checking, if necessary.
*/
void maybeToggleUpdateChecking();
/**
* Lookup a key. Should not raise exceptions. Calls the callback
* function with a comma-separated list of tables to which the key
* belongs.
*/
void safeLookup(in nsIPrincipal key,
in nsIUrlListManagerCallback cb);
};