Join MDN and developers like you at Mozilla's View Source conference, 12-14 September in Berlin, Germany. Learn more at https://viewsourceconf.org

nsIDOMStorageManager

This interface provides methods for managing data stored in the offline apps cache.
1.0
36
Introduced
Gecko 1.9
Inherits from: nsISupports Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Implemented by @mozilla.org/dom/storagemanager;1 as a service:

var domStorageManager = Components.classes["@mozilla.org/dom/storagemanager;1"]
                        .getService(Components.interfaces.nsIDOMStorageManager);

Method overview

void clearOfflineApps();
nsIDOMStorage getLocalStorageForPrincipal(in nsIPrincipal aPrincipal, in DOMString aDocumentURI);
long getUsage(in AString aOwnerDomain);

Methods

clearOfflineApps()

Clears keys owned by offline applications. All data owned by a domain with the "offline-app" permission is removed from the database.

void clearOfflineApps();
Parameters

None.

getLocalStorageForPrincipal()

Requires Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)

Returns the instance of the localStorage object for aURI's origin. This is used to ensure that only one local storage area exists for a given origin.

nsIDOMStorage getLocalStorageForPrincipal(
  nsIPrincipal aPrincipal,
  DOMString aDocumentURI
);
Parameters
aPrincipal
The principal for which to return the local storage object.
aDocumentURI
The document's URI.
Return value

The local storage object for the specified principal.

getUsage()

Returns the amount of disk space used by a domain. Usage is checked against the domain of the page that set the key (the owner domain), not the domain of the storage object.

long getUsage(
  AString aOwnerDomain
);
Parameters
aOwnerDomain
The domain to check.
Return value

The space usage of the domain, in bytes.

See also

Document Tags and Contributors

 Contributors to this page: Sheppy, trevorh, Wjjohnst
 Last updated by: Sheppy,