Safari Developer Library

Developer

SafariExtensionSettingsChangeEvent Class Reference

Options
Deployment Target:

On This Page

SafariExtensionSettingsChangeEvent

Instances of the SafariExtensionsSettingsChangeEvent class are used to provide a description of a change made to the extension’s settings. A settings change event is sent when your extension changes a setting as well as when a setting is changed outside your extension (for example, a setting changed in the Safari preferences).

These events do not bubble; their target is the settings or secure settings object that changed.

The event type for this class is change.

  • key Property

    The key identifier of the setting that was changed.

    Declaration

    readonly attribute DOMString key

    Discussion

    If all of the settings have been removed, this value is null.

  • newValue Property

    The value after the settings change.

    Declaration

    readonly attribute any newValue

    Discussion

    If the key was removed or all settings have been removed, this value is null.

  • oldValue Property

    The value before the settings change.

    Declaration

    readonly attribute any oldValue

    Discussion

    If the key was added or all settings have been removed, this value is null.