dom/webidl/SettingsManager.webidl
author George Wright <george@mozilla.com>
Fri, 08 Apr 2016 13:33:27 -0400
changeset 317655 8d87452bfc44bf502e2a1a172db91f88e5284782
parent 316920 ce2b18491b16095d62de958317efdb5999cc5499
child 332349 20a6fd076505809220e031dd594e03029459a664
permissions -rw-r--r--
Revert "Bug 1261416 - Rename firefox-plugin-container back to plugin-container to satisfy Flash's protected mode checks, and ensure that we launch the correct binary r=ted" because of widespread breakage due to whitelisted executable names in third parties This reverts commit 2d44e8ffaf63a32292f8e5b8fdd1485d0a462afc.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 */

[JSImplementation="@mozilla.org/settingsLock;1",
 Pref="dom.mozSettings.enabled"]
interface SettingsLock : EventTarget {
  // Whether this lock is invalid
  readonly attribute boolean closed;

  // Contains a JSON object with name/value pairs to be set.
  DOMRequest set(object settings);

  // Result contains the value of the setting.
  DOMRequest get(DOMString name);

  DOMRequest clear();
  attribute EventHandler onsettingstransactionsuccess;
  attribute EventHandler onsettingstransactionfailure;
};

dictionary SettingChange {
  DOMString settingName;
  DOMString settingValue;
};

callback SettingChangeCallback = void (SettingChange setting);

[JSImplementation="@mozilla.org/settingsManager;1",
 NavigatorProperty="mozSettings",
 Pref="dom.mozSettings.enabled",
 CheckAnyPermissions="settings-api-read settings-api-write"]
interface SettingsManager : EventTarget {
  SettingsLock createLock();

  void addObserver(DOMString name, SettingChangeCallback callback);
  void removeObserver(DOMString name, SettingChangeCallback callback);

  attribute EventHandler onsettingchange;
};