PreferenceObject

{{APIRef("User Preferences API")}}{{SeeCompatTable}}{{SecureContext_Header}}

The PreferenceObject interface of the User Preferences API provides attributes and methods for reading and overriding user preferences.

Use the document's {{domxref("PreferenceManager")}} (accessed via {{domxref("Navigator.preferences")}}) to get access to the PreferenceObject objects representing each available preference.

The PreferenceManager interface inherits from {{domxref("EventTarget")}}.

{{InheritanceDiagram}}

Instance properties

• {{domxref("PreferenceObject.override")}} {{ReadOnlyInline}} {{Experimental_Inline}}
  • : The override value if set, null otherwise.
• {{domxref("PreferenceObject.value")}} {{ReadOnlyInline}} {{Experimental_Inline}}
  • : The override value if set, the UA default otherwise.
• {{domxref("PreferenceObject.validValues")}} {{ReadOnlyInline}} {{Experimental_Inline}}
  • : The valid values for the override.

Instance methods

• {{domxref("PreferenceObject.clearOverride()")}} {{Experimental_Inline}}
  • : Resets any previously set override to null and fires the {{domxref("PreferenceObject.change_event" "change")}} event.
• {{domxref("PreferenceObject.requestOverride()")}} {{Experimental_Inline}}
  • : Requests an override of the preference and fires the {{domxref("PreferenceObject.change_event" "change")}} event on success.

Events

• {{domxref("PreferenceObject.change_event", "change")}} {{Experimental_Inline}}
  • : Fired when the override is set or reset.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}