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 // This file was generated by:
   6 //   ./tools/json_schema_compiler/compiler.py.
   7 // NOTE: The format of types has changed. 'FooType' is now
   8 //   'chrome.settingsPrivate.FooType'.
   9 // Please run the closure compiler before committing changes.
  10 // See https://code.google.com/p/chromium/wiki/ClosureCompilation.
  11
  12 /** @fileoverview Externs generated from namespace: settingsPrivate */
  13
  14 /**
  15  * @const
  16  */
  17 chrome.settingsPrivate = {};
  18
  19 /**
  20  * @enum {string}
  21  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PrefType
  22  */
  23 chrome.settingsPrivate.PrefType = {
  24   BOOLEAN: 'BOOLEAN',
  25   NUMBER: 'NUMBER',
  26   STRING: 'STRING',
  27   URL: 'URL',
  28   LIST: 'LIST',
  29 };
  30
  31 /**
  32  * @enum {string}
  33  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PolicySource
  34  */
  35 chrome.settingsPrivate.PolicySource = {
  36   DEVICE: 'DEVICE',
  37   USER: 'USER',
  38 };
  39
  40 /**
  41  * @enum {string}
  42  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PolicyEnforcement
  43  */
  44 chrome.settingsPrivate.PolicyEnforcement = {
  45   ENFORCED: 'ENFORCED',
  46   RECOMMENDED: 'RECOMMENDED',
  47 };
  48
  49 /**
  50  * @typedef {{
  51  *   key: string,
  52  *   type: !chrome.settingsPrivate.PrefType,
  53  *   value: *,
  54  *   policySource: (!chrome.settingsPrivate.PolicySource|undefined),
  55  *   policyEnforcement: (!chrome.settingsPrivate.PolicyEnforcement|undefined)
  56  * }}
  57  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PrefObject
  58  */
  59 chrome.settingsPrivate.PrefObject;
  60
  61 /**
  62  * Sets a settings value.
  63  * @param {string} name The name of the pref.
  64  * @param {*} value The new value of the pref.
  65  * @param {string} pageId The user metrics identifier or null.
  66  * @param {function(boolean):void} callback The callback for whether the pref
  67  *     was set or not.
  68  * @see https://developer.chrome.com/extensions/settingsPrivate#method-setPref
  69  */
  70 chrome.settingsPrivate.setPref = function(name, value, pageId, callback) {};
  71
  72 /**
  73  * Gets an array of all the prefs.
  74  * @param {function(!Array<!chrome.settingsPrivate.PrefObject>):void} callback
  75  * @see https://developer.chrome.com/extensions/settingsPrivate#method-getAllPrefs
  76  */
  77 chrome.settingsPrivate.getAllPrefs = function(callback) {};
  78
  79 /**
  80  * Gets the value of a specific pref.
  81  * @param {string} name
  82  * @param {function(!chrome.settingsPrivate.PrefObject):void} callback
  83  * @see https://developer.chrome.com/extensions/settingsPrivate#method-getPref
  84  */
  85 chrome.settingsPrivate.getPref = function(name, callback) {};
  86
  87 /**
  88  * <p>Fired when a set of prefs has changed.</p><p>|prefs| The prefs that
  89  * changed.</p>
  90  * @type {!ChromeEvent}
  91  * @see https://developer.chrome.com/extensions/settingsPrivate#event-onPrefsChanged
  92  */
  93 chrome.settingsPrivate.onPrefsChanged;