Your Search Results

    StorageEvent

    Describes an event occurring on HTML5 client-side storage data.
    1.0
    28
    Introduced
    Gecko 2.0
    Inherits from: nsIDOMEvent Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

    A StorageEvent is sent to a window when a storage area changes.

    Note: Although this event existed prior to Gecko 2.0, it did not match the specification. The old event format is now represented by the nsIDOMStorageEventObsolete 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 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
    The name of the event.
    canBubbleArg
    A boolean indicating whether the event bubbles up through the DOM or not.
    cancelableArg
    A boolean indicating whether the event is cancelable.
    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 Storage object representing the storage area on which this event occurred.

    See also

    Document Tags and Contributors

    Tags:
    Contributors to this page: Sheppy, kscarfone, namolmes, Sephr
    Last updated by: kscarfone,