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_POLICY: 'DEVICE_POLICY',
  37   USER_POLICY: 'USER_POLICY',
  38   OWNER: 'OWNER',
  39   PRIMARY_USER: 'PRIMARY_USER',
  40   EXTENSION: 'EXTENSION',
  41 };
  42
  43 /**
  44  * @enum {string}
  45  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PolicyEnforcement
  46  */
  47 chrome.settingsPrivate.PolicyEnforcement = {
  48   ENFORCED: 'ENFORCED',
  49   RECOMMENDED: 'RECOMMENDED',
  50 };
  51
  52 /**
  53  * @typedef {{
  54  *   key: string,
  55  *   type: !chrome.settingsPrivate.PrefType,
  56  *   value: *,
  57  *   policySource: (!chrome.settingsPrivate.PolicySource|undefined),
  58  *   policyEnforcement: (!chrome.settingsPrivate.PolicyEnforcement|undefined),
  59  *   recommendedValue: (*|undefined),
  60  *   extensionId: (string|undefined),
  61  *   readOnly: (boolean|undefined)
  62  * }}
  63  * @see https://developer.chrome.com/extensions/settingsPrivate#type-PrefObject
  64  */
  65 chrome.settingsPrivate.PrefObject;
  66
  67 /**
  68  * Sets a settings value.
  69  * @param {string} name The name of the pref.
  70  * @param {*} value The new value of the pref.
  71  * @param {string} pageId The user metrics identifier or null.
  72  * @param {function(boolean):void} callback The callback for whether the pref
  73  *     was set or not.
  74  * @see https://developer.chrome.com/extensions/settingsPrivate#method-setPref
  75  */
  76 chrome.settingsPrivate.setPref = function(name, value, pageId, callback) {};
  77
  78 /**
  79  * Gets an array of all the prefs.
  80  * @param {function(!Array<!chrome.settingsPrivate.PrefObject>):void} callback
  81  * @see https://developer.chrome.com/extensions/settingsPrivate#method-getAllPrefs
  82  */
  83 chrome.settingsPrivate.getAllPrefs = function(callback) {};
  84
  85 /**
  86  * Gets the value of a specific pref.
  87  * @param {string} name
  88  * @param {function(!chrome.settingsPrivate.PrefObject):void} callback
  89  * @see https://developer.chrome.com/extensions/settingsPrivate#method-getPref
  90  */
  91 chrome.settingsPrivate.getPref = function(name, callback) {};
  92
  93 /**
  94  * <p>Fired when a set of prefs has changed.</p><p>|prefs| The prefs that
  95  * changed.</p>
  96  * @type {!ChromeEvent}
  97  * @see https://developer.chrome.com/extensions/settingsPrivate#event-onPrefsChanged
  98  */
  99 chrome.settingsPrivate.onPrefsChanged;