1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/toolkit/components/places/nsPIPlacesDatabase.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,45 @@
1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
1.5 + * vim: sw=2 ts=2 sts=2
1.6 + * This Source Code Form is subject to the terms of the Mozilla Public
1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.9 +
1.10 +#include "nsISupports.idl"
1.11 +
1.12 +interface mozIStorageConnection;
1.13 +interface nsINavHistoryQuery;
1.14 +interface nsINavHistoryQueryOptions;
1.15 +interface mozIStorageStatementCallback;
1.16 +interface mozIStoragePendingStatement;
1.17 +
1.18 +/**
1.19 + * This is a private interface used by Places components to get access to the
1.20 + * database. If outside consumers wish to use this, they should only read from
1.21 + * the database so they do not break any internal invariants.
1.22 + */
1.23 +[scriptable, uuid(6eb7ed3d-13ca-450b-b370-15c75e2f3dab)]
1.24 +interface nsPIPlacesDatabase : nsISupports
1.25 +{
1.26 + /**
1.27 + * The database connection used by Places.
1.28 + */
1.29 + readonly attribute mozIStorageConnection DBConnection;
1.30 +
1.31 + /**
1.32 + * Asynchronously executes the statement created from queries.
1.33 + *
1.34 + * @see nsINavHistoryService::executeQueries
1.35 + * @note THIS IS A TEMPORARY API. Don't rely on it, since it will be replaced
1.36 + * in future versions by a real async querying API.
1.37 + * @note Results obtained from this method differ from results obtained from
1.38 + * executeQueries, because there is additional filtering and sorting
1.39 + * done by the latter. Thus you should use executeQueries, unless you
1.40 + * are absolutely sure that the returned results are fine for
1.41 + * your use-case.
1.42 + */
1.43 + mozIStoragePendingStatement asyncExecuteLegacyQueries(
1.44 + [array, size_is(aQueryCount)] in nsINavHistoryQuery aQueries,
1.45 + in unsigned long aQueryCount,
1.46 + in nsINavHistoryQueryOptions aOptions,
1.47 + in mozIStorageStatementCallback aCallback);
1.48 +};
