Safari Developer Library

Developer

SafariExtensionSecureSettings Class Reference

Options
Deployment Target:

On This Page

SafariExtensionSecureSettings

Inheritance


Conforms To


Not Applicable

Import Statement


Not Applicable Not Applicable

Availability


Available in Safari 5.0 and later.

The SafariExtensionSecureSettings class provides a place for your extension to securely store settings that should persist between sessions. You interact with it in exactly the same way as you interact with the SafariExtensionSettings class.

  • Returns the current value of a key.

    Declaration

    JavaScript

    any getItem (in DOMString key);

    Parameters

    key

    The key whose value is being returned.

    Return Value

    If the key exists, its current value; otherwise, null.

    Availability

    Available in Safari 5.0 and later.

  • Sets the value of a key.

    Declaration

    JavaScript

    void setItem (in DOMString key, in any value);

    Parameters

    key

    The key whose value is being set.

    value

    The value being set.

    Discussion

    The behavior of this method is undefined if value cannot be serialized to a JSON value.

    On success, this method dispatches a SafariExtensionSettingsChangeEvent event describing the change.

    Availability

    Available in Safari 5.0 and later.

  • Removes a key.

    Declaration

    JavaScript

    void removeItem (in DOMString key);

    Parameters

    key

    The key being removed.

    Discussion

    If there is no value with the given key, this method does nothing.

    On success, this method dispatches a SafariExtensionSettingsChangeEvent event describing the change.

    Availability

    Available in Safari 5.0 and later.

  • Removes all key-value pairs.

    Declaration

    JavaScript

    void clear ();

    Discussion

    If there is nothing to remove, this method does nothing.

    On success, this method dispatches a SafariExtensionSettingsChangeEvent event describing the change.

    Availability

    Available in Safari 5.0 and later.