• Skip to main content
  • Select language
  • Skip to search
MDN Web Docs
  • Technologies
    • HTML
    • CSS
    • JavaScript
    • Graphics
    • HTTP
    • APIs / DOM
    • WebExtensions
    • MathML
  • References & Guides
    • Learn web development
    • Tutorials
    • References
    • Developer Guides
    • Accessibility
    • Game development
    • ...more docs
B2G OS
  1. MDN
  2. Archive of obsolete content
  3. B2G OS
  4. B2G OS APIs
  5. SettingsLock
  6. SettingsLock.set()

SettingsLock.set()

In This Article
  1. Summary
  2. Syntax
    1. Parameters
  3. Example
  4. Specification
  5. See also

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

Summary

This method is changes the value of one or more given settings.

This method is asynchronous and return a DOMRequest object which you use to detect when the change has been completed (or if an error occurs), and to act as needed once that's happened.

Syntax

SettingsLock.set(settings);

Parameters

settings
An object containing a set of key/value pairs where each key represents the string name of a given setting. 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.

Example

This example turns on WiFi on the device.

var lock = navigator.mozSettings.createLock();
var result = lock.set({
  'wifi.enabled': true
});
result.onsuccess = function () {
  console.log("The setting has been changed");
}
result.onerror = function () {
  console.log("An error occure, the setting remain unchanged");
}

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

  • SettingsManager
  • SettingsLock
  • Settings API

Document Tags and Contributors

Tags: 
  • API
  • B2G
  • Firefox OS
  • Method
  • Non-standard
  • Reference
  • Référence
  • Settings
 Contributors to this page: chrisdavidmills, teoli, MHasan, kscarfone, Sheppy, Jeremie
 Last updated by: chrisdavidmills, Feb 27, 2017, 2:07:34 AM
See also
  1. Settings API
  2. Archive
  3. Events
    1. settingchange
  4. Related pages for Settings API
    1. MozSettingsEvent
    2. SettingsLock
    3. SettingsManager