{{ IFSummary("dom/interfaces/storage/nsIDOMStorageEvent.idl", "nsIDOMEvent", "Scriptable", "2.0", "Describes an event occurring on HTML5 client-side storage data.", "2.0") }}
A StorageEvent
is sent to a window when a storage area changes.
{{ gecko_callout_heading("2.0") }}
Although this event existed prior to Gecko 2.0 {{ geckoRelease("2.0") }}, it did not match the specification. The old event format is now represented by the {{ interface("nsIStorageEventObsolete") }} interface.
Method overview
void initStorageEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in DOMString keyArg, in DOMString oldValueArg, in DOMString newValueArg, in DOMString urlArg, in nsIDOMStorage storageAreaArg); |
Attributes
Attribute | Type | Description |
key | DOMString | Represents the key changed. The key attribute is null when the change is caused by the storage clear() method. Read only. |
newValue | DOMString | The new value of the key . The newValue is null when the change has been invoked by storage clear() method or the key has been removed from the storage. Read only. |
oldValue | DOMString | The original value of the key . The oldValue is null when the change has been invoked by storage clear() method or the key has been newly added and therefor doesn't have any previous value. Read only. |
storageArea | {{ Interface("nsIDOMStorage") }} | Represents the Storage object that was affected. Read only. |
url | DOMString | The URL of the document whose key changed. Read only. |
Methods
initStorageEvent()
Initializes the event in a manner analogous to the similarly-named method in the DOM Events interfaces.
void initStorageEvent( in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in DOMString keyArg, in DOMString oldValueArg, in DOMString newValueArg, in DOMString urlArg, in nsIDOMStorage storageAreaArg );
Parameters
typeArg
- Missing Description
canBubbleArg
- Missing Description
cancelableArg
- Missing Description
keyArg
- The key whose value is changing as a result of this event.
oldValueArg
- The key's old value.
newValueArg
- The key's new value.
urlArg
- Missing Description
storageAreaArg
- The DOM {{ domxref("Storage") }} object representing the storage area on which this event occurred.