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

/* -*- 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"
#include "nsIUrlListManager.idl"

// A map that contains a string keys mapped to string values.

[scriptable, uuid(fd1f8334-1859-472d-b01f-4ac6b1121ce4)]
interface nsIUrlClassifierTable : nsISupports
{
    /**
     * The name used to identify this table
     */
    attribute ACString name;

    /**
     * Set to false if we don't want to update this table.
     */
    attribute boolean needsUpdate;

    /**
     * In the simple case, exists just looks up the string in the
     * table and call the callback after the query returns with true or
     * false.  It's possible that something more complex happens
     * (e.g., canonicalize the url).
     */
    void exists(in ACString key, in nsIUrlListManagerCallback cb);
};