SettingsManager.removeObserver

« DOM Reference

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

This API is available on Firefox OS for certified applications only.

Summary

This method is used to remove a callback function that has been added with SettingsManager.addObserver().

Syntax

SettingsManager.removeObserver(settingName, callback);

Parameters

settingName
The string representing the setting to stop to observe. The exact list of possible strings is device dependent. Each Gaia build can have its own list of settings. For an up to date list of those strings, take a look at the Gaia source code.
callback
The function to be removed from the callback stack.

Example

function myCallback(event) {
  console.log(event.settingName + ": " + event.settingValue);
}

// Start listening to changes on the wifi.enabled setting
navigator.mozSettings.addObserver('wifi.enabled', myCallback);

// Stop listening to changes on the wifi.enabled setting
navigator.mozSettings.removeObserver('wifi.enabled', myCallback);

Specification

Not part of any specification yet; however, this API will be discussed at W3C as part of the System Applications Working Group.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, kscarfone, Jeremie
Last updated by: kscarfone,