dom/quota/nsIQuotaManager.idl

changeset 0
6474c204b198
equal deleted inserted replaced
-1:000000000000 0:edcd1aaef257
1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set ts=2 et sw=2 tw=80: */
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/. */
6
7 #include "nsISupports.idl"
8
9 interface nsIQuotaRequest;
10 interface nsIURI;
11 interface nsIUsageCallback;
12
13 [scriptable, builtinclass, uuid(2968fcd5-1872-4ddc-8c16-62b27e357f31)]
14 interface nsIQuotaManager : nsISupports
15 {
16 /**
17 * Schedules an asynchronous callback that will return the total amount of
18 * disk space being used by storages for the given origin.
19 *
20 * @param aURI
21 * The URI whose usage is being queried.
22 * @param aCallback
23 * The callback that will be called when the usage is available.
24 */
25 [optional_argc]
26 nsIQuotaRequest
27 getUsageForURI(in nsIURI aURI,
28 in nsIUsageCallback aCallback,
29 [optional] in unsigned long aAppId,
30 [optional] in boolean aInMozBrowserOnly);
31
32 /**
33 * Removes all storages. The files may not be deleted immediately depending
34 * on prohibitive concurrent operations.
35 * Be careful, this removes *all* the data that has ever been stored!
36 *
37 * If the dom.quotaManager.testing preference is not true the call will be
38 * a no-op.
39 */
40 void
41 clear();
42
43 /**
44 * Removes all storages stored for the given URI. The files may not be
45 * deleted immediately depending on prohibitive concurrent operations.
46 *
47 * @param aURI
48 * The URI whose storages are to be cleared.
49 */
50 [optional_argc]
51 void
52 clearStoragesForURI(in nsIURI aURI,
53 [optional] in unsigned long aAppId,
54 [optional] in boolean aInMozBrowserOnly,
55 [optional] in ACString aPersistenceType);
56
57 /**
58 * Resets quota and storage management. This can be used to force
59 * reinitialization of the temp storage, for example when the pref for
60 * overriding the temp storage limit has changed.
61 * Be carefull, this invalidates all live storages!
62 *
63 * If the dom.quotaManager.testing preference is not true the call will be
64 * a no-op.
65 */
66 void
67 reset();
68 };

mercurial