third_party/closure_compiler/externs/settings_private.js

   1 /** @fileoverview Externs generated from namespace: settingsPrivate */
   2
   3 /**
   4  * @const
   5  */
   6 chrome.settingsPrivate = {};
   7
   8 /**
   9  * @enum {string}
  10  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PrefType
  11  */
  12 chrome.settingsPrivate.PrefType = {
  13   BOOLEAN: 'BOOLEAN',
  14   NUMBER: 'NUMBER',
  15   STRING: 'STRING',
  16   URL: 'URL',
  17   LIST: 'LIST',
  18 };
  19
  20 /**
  21  * @enum {string}
  22  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PolicySource
  23  */
  24 chrome.settingsPrivate.PolicySource = {
  25   DEVICE: 'DEVICE',
  26   USER: 'USER',
  27 };
  28
  29 /**
  30  * @enum {string}
  31  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PolicyEnforcement
  32  */
  33 chrome.settingsPrivate.PolicyEnforcement = {
  34   ENFORCED: 'ENFORCED',
  35   RECOMMENDED: 'RECOMMENDED',
  36 };
  37
  38 /**
  39  * @typedef {{
  40  *   key: string,
  41  *   type: !chrome.settingsPrivate.PrefType,
  42  *   value: *,
  43  *   policySource: (!chrome.settingsPrivate.PolicySource|undefined),
  44  *   policyEnforcement: (!chrome.settingsPrivate.PolicyEnforcement|undefined)
  45  * }}
  46  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PrefObject
  47  */
  48 var PrefObject;
  49
  50 /**
  51  * Sets a settings value.
  52  * @param {string} name The name of the pref.
  53  * @param {*} value The new value of the pref.
  54  * @param {string} pageId The user metrics identifier or null.
  55  * @param {function(boolean):void} callback The callback for whether the pref
  56  *     was set or not.
  57  * @see https://developer.chrome.com/extensions/settingsPrivate#method-setPref
  58  */
  59 chrome.settingsPrivate.setPref = function(name, value, pageId, callback) {};
  60
  61 /**
  62  * Gets an array of all the prefs.
  63  * @param {function(!Array<PrefObject>):void} callback
  64  * @see https://developer.chrome.com/extensions/settingsPrivate#method-getAllPrefs
  65  */
  66 chrome.settingsPrivate.getAllPrefs = function(callback) {};
  67
  68 /**
  69  * Gets the value of a specific pref.
  70  * @param {string} name
  71  * @param {function(PrefObject):void} callback
  72  * @see https://developer.chrome.com/extensions/settingsPrivate#method-getPref
  73  */
  74 chrome.settingsPrivate.getPref = function(name, callback) {};
  75
  76 /**
  77  * <p>Fired when a set of prefs has changed.</p><p>|prefs| The prefs that
  78  * changed.</p>
  79  * @type {!ChromeEvent}
  80  * @see https://developer.chrome.com/extensions/settingsPrivate#event-onPrefsChanged
  81  */
  82 chrome.settingsPrivate.onPrefsChanged;