third_party/closure_compiler/externs/settings_private.js

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview Externs generated from namespace: settingsPrivate
   7  * @externs
   8  */
   9
  10 /**
  11  * @const
  12  */
  13 chrome.settingsPrivate = {};
  14
  15 /**
  16  * @typedef {{
  17  *   key: string,
  18  *   type: chrome.settingsPrivate.PrefType,
  19  *   value: *,
  20  *   policySource: (chrome.settingsPrivate.PolicySource|undefined),
  21  *   policyEnforcement: (chrome.settingsPrivate.PolicyEnforcement|undefined),
  22  * }}
  23  */
  24 chrome.settingsPrivate.PrefObject;
  25
  26 /**
  27  * @typedef {function(success)}
  28  */
  29 chrome.settingsPrivate.OnPrefSetCallback;
  30
  31 /**
  32  * @typedef {function(!Array<chrome.settingsPrivate.PrefObject>)}
  33  */
  34 chrome.settingsPrivate.GetAllPrefsCallback;
  35
  36 /**
  37  * @typedef {function(chrome.settingsPrivate.PrefObject)}
  38  */
  39 chrome.settingsPrivate.GetPrefCallback;
  40
  41 /**
  42  * Sets a settings value.
  43  * @param {string} name
  44  * @param {*} value
  45  * @param {string} pageId
  46  * @param {chrome.settingsPrivate.OnPrefSetCallback} callback
  47  */
  48 chrome.settingsPrivate.setPref =
  49     function(name, value, pageId, callback) {};
  50
  51 /**
  52  * Gets all the prefs.
  53  * @param {chrome.settingsPrivate.GetAllPrefsCallback} callback
  54  */
  55 chrome.settingsPrivate.getAllPrefs = function(callback) {};
  56
  57 /**
  58  * Gets the value of a specific pref.
  59  * @param {string} name
  60  * @param {chrome.settingsPrivate.GetPrefCallback} callback
  61  */
  62 chrome.settingsPrivate.getPref = function(name, callback) {};
  63
  64 /** @type {!ChromeEvent} */
  65 chrome.settingsPrivate.onPrefsChanged;