third_party/closure_compiler/externs/developer_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 /** @fileoverview Externs generated from namespace: developerPrivate */
   6
   7 // Note: hand-modified to change Array to !Array in ItemInfo typedef, and add
   8 // typedef {string} for idl enums.
   9
  10 /**
  11  * @typedef {string}
  12  */
  13 var ItemType;
  14
  15 /**
  16  * @typedef {{
  17  *   path: string,
  18  *   render_process_id: number,
  19  *   render_view_id: number,
  20  *   incognito: boolean,
  21  *   generatedBackgroundPage: boolean
  22  * }}
  23  */
  24 var ItemInspectView;
  25
  26 /**
  27  * @typedef {{
  28  *   message: string
  29  * }}
  30  */
  31 var InstallWarning;
  32
  33 /**
  34  * @typedef {{
  35  *   id: string,
  36  *   name: string,
  37  *   version: string,
  38  *   description: string,
  39  *   may_disable: boolean,
  40  *   enabled: boolean,
  41  *   disabled_reason: (string|undefined),
  42  *   isApp: boolean,
  43  *   type: ItemType,
  44  *   allow_activity: boolean,
  45  *   allow_file_access: boolean,
  46  *   wants_file_access: boolean,
  47  *   incognito_enabled: boolean,
  48  *   is_unpacked: boolean,
  49  *   allow_reload: boolean,
  50  *   terminated: boolean,
  51  *   allow_incognito: boolean,
  52  *   icon_url: string,
  53  *   path: (string|undefined),
  54  *   options_url: (string|undefined),
  55  *   app_launch_url: (string|undefined),
  56  *   homepage_url: (string|undefined),
  57  *   update_url: (string|undefined),
  58  *   install_warnings: !Array,
  59  *   manifest_errors: !Array,
  60  *   runtime_errors: !Array,
  61  *   offline_enabled: boolean,
  62  *   views: !Array
  63  * }}
  64  */
  65 var ItemInfo;
  66
  67 /**
  68  * @typedef {{
  69  *   extension_id: string,
  70  *   render_process_id: string,
  71  *   render_view_id: string,
  72  *   incognito: boolean
  73  * }}
  74  */
  75 var InspectOptions;
  76
  77 /**
  78  * @typedef {{
  79  *   failQuietly: boolean
  80  * }}
  81  */
  82 var ReloadOptions;
  83
  84 /**
  85  * @typedef {string}
  86  */
  87 var PackStatus;
  88
  89 /**
  90  * @typedef {string}
  91  */
  92 var FileType;
  93
  94 /**
  95  * @typedef {string}
  96  */
  97 var SelectType;
  98
  99 /**
 100  * @typedef {string}
 101  */
 102 var EventType;
 103
 104 /**
 105  * @typedef {{
 106  *   message: string,
 107  *   item_path: string,
 108  *   pem_path: string,
 109  *   override_flags: number,
 110  *   status: PackStatus
 111  * }}
 112  */
 113 var PackDirectoryResponse;
 114
 115 /**
 116  * @typedef {{
 117  *   name: string
 118  * }}
 119  */
 120 var ProjectInfo;
 121
 122 /**
 123  * @typedef {{
 124  *   event_type: EventType,
 125  *   item_id: string
 126  * }}
 127  */
 128 var EventData;
 129
 130 /**
 131  * @typedef {{
 132  *   extensionId: string,
 133  *   pathSuffix: string,
 134  *   message: string,
 135  *   manifestKey: (string|undefined),
 136  *   manifestSpecific: (string|undefined),
 137  *   lineNumber: (number|undefined)
 138  * }}
 139  */
 140 var RequestFileSourceProperties;
 141
 142 /**
 143  * @typedef {{
 144  *   highlight: string,
 145  *   beforeHighlight: string,
 146  *   afterHighlight: string,
 147  *   title: string,
 148  *   message: string
 149  * }}
 150  */
 151 var RequestFileSourceResponse;
 152
 153 /**
 154  * @typedef {{
 155  *   renderViewId: number,
 156  *   renderProcessId: number,
 157  *   url: (string|undefined),
 158  *   lineNumber: (number|undefined),
 159  *   columnNumber: (number|undefined)
 160  * }}
 161  */
 162 var OpenDevToolsProperties;
 163
 164 /**
 165  * @const
 166  */
 167 chrome.developerPrivate = {};
 168
 169 /**
 170  * Runs auto update for extensions and apps immediately.
 171  * @param {Function=} callback Called with the boolean result, true if
 172  * autoUpdate is successful.
 173  */
 174 chrome.developerPrivate.autoUpdate = function(callback) {};
 175
 176 /**
 177  * Returns information of all the extensions and apps installed.
 178  * @param {boolean} includeDisabled include disabled items.
 179  * @param {boolean} includeTerminated include terminated items.
 180  * @param {Function} callback Called with items info.
 181  */
 182 chrome.developerPrivate.getItemsInfo = function(includeDisabled, includeTerminated, callback) {};
 183
 184 /**
 185  * Opens a permissions dialog.
 186  * @param {string} extensionId The id of the extension to show permissions for.
 187  * @param {Function=} callback
 188  */
 189 chrome.developerPrivate.showPermissionsDialog = function(extensionId, callback) {};
 190
 191 /**
 192  * Opens a developer tools inspection window.
 193  * @param {InspectOptions} options The details about the inspection.
 194  * @param {Function=} callback
 195  */
 196 chrome.developerPrivate.inspect = function(options, callback) {};
 197
 198 /**
 199  * Enables / Disables file access for an extension.
 200  * @param {string} extensionId The id of the extension to set file access for.
 201  * @param {boolean} allow Whether or not to allow file access for the
 202  * extension.
 203  * @param {Function=} callback
 204  */
 205 chrome.developerPrivate.allowFileAccess = function(extensionId, allow, callback) {};
 206
 207 /**
 208  * Reloads a given extension.
 209  * @param {string} extensionId The id of the extension to reload.
 210  * @param {ReloadOptions=} options Additional configuration parameters.
 211  * @param {Function=} callback
 212  */
 213 chrome.developerPrivate.reload = function(extensionId, options, callback) {};
 214
 215 /**
 216  * Enables / Disables a given extension.
 217  * @param {string} extensionId The id of the extension to enable/disable.
 218  * @param {boolean} enable Whether the extension should be enabled.
 219  * @param {Function=} callback
 220  */
 221 chrome.developerPrivate.enable = function(extensionId, enable, callback) {};
 222
 223 /**
 224  * Allows / Disallows an extension to run in incognito mode.
 225  * @param {string} extensionId The id of the extension.
 226  * @param {boolean} allow Whether or not the extension should be allowed
 227  * incognito.
 228  * @param {Function=} callback
 229  */
 230 chrome.developerPrivate.allowIncognito = function(extensionId, allow, callback) {};
 231
 232 /**
 233  * Loads a user-selected unpacked item.
 234  * @param {Function=} callback
 235  */
 236 chrome.developerPrivate.loadUnpacked = function(callback) {};
 237
 238 /**
 239  * Loads an extension / app.
 240  * @param {Object} directory The directory to load the extension from.
 241  * @param {Function} callback
 242  */
 243 chrome.developerPrivate.loadDirectory = function(directory, callback) {};
 244
 245 /**
 246  * Open Dialog to browse to an entry.
 247  * @param {SelectType} selectType Select a file or a folder.
 248  * @param {FileType} fileType Required file type. For example, pem type is for
 249  * private key and load type is for an unpacked item.
 250  * @param {Function} callback called with selected item's path.
 251  */
 252 chrome.developerPrivate.choosePath = function(selectType, fileType, callback) {};
 253
 254 /**
 255  * Pack an extension.
 256  * @param {string} path
 257  * @param {string=} privateKeyPath The path of the private key, if one is
 258  * given.
 259  * @param {number=} flags Special flags to apply to the loading process, if
 260  * any.
 261  * @param {Function=} callback called with the success result string.
 262  */
 263 chrome.developerPrivate.packDirectory = function(path, privateKeyPath, flags, callback) {};
 264
 265 /**
 266  * Returns true if the profile is managed.
 267  * @param {Function} callback
 268  */
 269 chrome.developerPrivate.isProfileManaged = function(callback) {};
 270
 271 /**
 272  * Reads and returns the contents of a file related to an extension which
 273  * caused an error.
 274  * @param {RequestFileSourceProperties} properties
 275  * @param {Function} callback
 276  */
 277 chrome.developerPrivate.requestFileSource = function(properties, callback) {};
 278
 279 /**
 280  * Open the developer tools to focus on a particular error.
 281  * @param {OpenDevToolsProperties} properties
 282  */
 283 chrome.developerPrivate.openDevTools = function(properties) {};
 284
 285 /** @type {!ChromeEvent} */
 286 chrome.developerPrivate.onItemStateChanged;