SettingsLock.set()

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