WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIDOMStorage

IID:95CC1383-3B62-4B89-AAEF-1004A513EF47
Inherits From:nsISupports

This interface is implemented by the following components:

Properties

readonly PRUint32 length

The number of keys stored.

Methods

nsIDOMStorageItem getItem ( DOMString key ) DOMString key ( PRUint32 index ) void removeItem ( DOMString key ) void setItem ( DOMString key , DOMString data )

nsIDOMStorageItem getItem ( DOMString key )

Retrieve an item with a given key

Arguments:
key: key to retrieve

DOMString key ( PRUint32 index )

Retrieve the name of the key at a particular index.

Arguments:
index: index of the item to retrieve

void removeItem ( DOMString key )

Remove a key and its corresponding value.

Arguments:
key: key to remove

void setItem ( DOMString key , DOMString data )

Assign a value with a key. If the key does not exist already, a new key is added associated with that value. If the key already exists, then the existing value is replaced with a new value.

Arguments:
key: key to set
data: data to associate with the key

References

This interface is the type of the following properties:

nsIDOMStorageWindow.sessionStorage

This interface is passed as an argument to the following methods:

nsIDocShell.addSessionStorage

This interface is returned from the following methods:

nsIDOMStorageList.namedItem, nsIDocShell.getSessionStorageForURI

Reference documentation is generated from Mozilla's source.