toolkit/components/places/nsPIPlacesDatabase.idl

Wed, 31 Dec 2014 06:09:35 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 06:09:35 +0100
changeset 0
6474c204b198
permissions
-rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

     1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
     2  * vim: sw=2 ts=2 sts=2
     3  * This Source Code Form is subject to the terms of the Mozilla Public
     4  * License, v. 2.0. If a copy of the MPL was not distributed with this
     5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     7 #include "nsISupports.idl"
     9 interface mozIStorageConnection;
    10 interface nsINavHistoryQuery;
    11 interface nsINavHistoryQueryOptions;
    12 interface mozIStorageStatementCallback;
    13 interface mozIStoragePendingStatement;
    15 /**
    16  * This is a private interface used by Places components to get access to the
    17  * database.  If outside consumers wish to use this, they should only read from
    18  * the database so they do not break any internal invariants.
    19  */
    20 [scriptable, uuid(6eb7ed3d-13ca-450b-b370-15c75e2f3dab)]
    21 interface nsPIPlacesDatabase : nsISupports
    22 {
    23   /**
    24    * The database connection used by Places.
    25    */
    26   readonly attribute mozIStorageConnection DBConnection;
    28   /**
    29    * Asynchronously executes the statement created from queries.
    30    *
    31    * @see nsINavHistoryService::executeQueries
    32    * @note THIS IS A TEMPORARY API.  Don't rely on it, since it will be replaced
    33    *       in future versions by a real async querying API.
    34    * @note Results obtained from this method differ from results obtained from
    35    *       executeQueries, because there is additional filtering and sorting
    36    *       done by the latter.  Thus you should use executeQueries, unless you
    37    *       are absolutely sure that the returned results are fine for
    38    *       your use-case.
    39    */
    40   mozIStoragePendingStatement asyncExecuteLegacyQueries(
    41     [array, size_is(aQueryCount)] in nsINavHistoryQuery aQueries,
    42     in unsigned long aQueryCount,
    43     in nsINavHistoryQueryOptions aOptions,
    44     in mozIStorageStatementCallback aCallback);
    45 };

mercurial