SettingsLock.clear()

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 internal applications only.

Summary

This method clears the queue of SettingsLock objects.

As with all of the methods in the SettingsLock interface, this method is asynchronous and returns a DOMRequest object which you use to determine if the request has been completed, so that you may act accordingly.

Syntax

SettingsLock.clear();

Example

var lock = navigator.mozSettings.createLock();
var result = lock.clear();

result.onsuccess = function () {
  console.log("the queue has been cleared");
}

result.onerror = function () {
  console.log("An error occure, the queue 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

Document Tags and Contributors

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