Add a subtle reminder that chrome_extensions.js is overwritten.

third_party/closure_compiler/externs/chrome_extensions.js

+//    SSSSSSSSSSSSSSS TTTTTTTTTTTTTTTTTTTTTTT     OOOOOOOOO     PPPPPPPPPPPPPPPPP
+//  SS:::::::::::::::ST:::::::::::::::::::::T   OO:::::::::OO   P::::::::::::::::P
+// S:::::SSSSSS::::::ST:::::::::::::::::::::T OO:::::::::::::OO P::::::PPPPPP:::::P
+// S:::::S     SSSSSSST:::::TT:::::::TT:::::TO:::::::OOO:::::::OPP:::::P     P:::::P
+// S:::::S            TTTTTT  T:::::T  TTTTTTO::::::O   O::::::O  P::::P     P:::::P
+// S:::::S                    T:::::T        O:::::O     O:::::O  P::::P     P:::::P
+//  S::::SSSS                                                     P::::PPPPPP:::::P
+//   SS::::::SSSSS       This file is generated. To update it,    P:::::::::::::PP
+//     SSS::::::::SS          run bump_compiler_version.          P::::PPPPPPPPP
+//        SSSSSS::::S                                             P::::P
+//             S:::::S        T:::::T        O:::::O     O:::::O  P::::P
+//             S:::::S        T:::::T        O::::::O   O::::::O  P::::P
+// SSSSSSS     S:::::S      TT:::::::TT      O:::::::OOO:::::::OPP::::::PP
+// S::::::SSSSSS:::::S      T:::::::::T       OO:::::::::::::OO P::::::::P
+// S:::::::::::::::SS       T:::::::::T         OO:::::::::OO   P::::::::P
+//  SSSSSSSSSSSSSSS         TTTTTTTTTTT           OOOOOOOOO     PPPPPPPPPP
 /*
  * Copyright 2009 The Closure Compiler Authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
@@ skipping 540 matching lines @@
 
 
 /**
  * @type {!ChromeEvent}
  * @see http://developer.chrome.com/apps/app.window.html#event-onRestored
  */
 chrome.app.window.onRestored;
 
 
 /**
+ * Private API.
+ *
+ * @const
+ * @see https://code.google.com/p/chromium/codesearch#chromium/src/chrome/common/extensions/api/audio_modem.idl
+ * @see go/chrome-modem
+ */
+chrome.audioModem = {};
+
+
+/**
+ * @typedef {?{
+ *   tokenLength: number,
+ *   crc: (boolean|undefined),
+ *   parity: (boolean|undefined)
+ * }}
+ */
+chrome.audioModem.TokenEncoding;
+
+
+/**
+ * @typedef {?{
+ *   timeoutMillis: number,
+ *   band: string,
+ *   encoding: !chrome.audioModem.TokenEncoding
+ * }}
+ */
+chrome.audioModem.RequestParams;
+
+
+/** @constructor */
+chrome.audioModem.ReceivedToken = function() {};
+
+
+/** @type {!ArrayBuffer} */
+chrome.audioModem.ReceivedToken.prototype.token;
+
+
+/** @type {string} */
+chrome.audioModem.ReceivedToken.prototype.band;
+
+
+/**
+ * @param {!chrome.audioModem.RequestParams} params
+ * @param {!ArrayBuffer} token
+ * @param {function(string)} callback
+ */
+chrome.audioModem.transmit = function(params, token, callback) {};
+
+
+/**
+ * @param {string} band
+ * @param {function(string)} callback
+ */
+chrome.audioModem.stopTransmit = function(band, callback) {};
+
+
+/**
+ * @param {!chrome.audioModem.RequestParams} params
+ * @param {function(string)} callback
+ */
+chrome.audioModem.receive = function(params, callback) {};
+
+
+/**
+ * @param {string} band
+ * @param {function(string)} callback
+ */
+chrome.audioModem.stopReceive = function(band, callback) {};
+
+
+/** @constructor */
+chrome.audioModem.ReceivedEvent = function() {};
+
+
+/**
+ * @param {function(!Array<!chrome.audioModem.ReceivedToken>)} callback
+ */
+chrome.audioModem.ReceivedEvent.prototype.addListener = function(callback) {};
+
+
+/**
+ * @param {function(!Array<!chrome.audioModem.ReceivedToken>)} callback
+ */
+chrome.audioModem.ReceivedEvent.prototype.removeListener =
+    function(callback) {};
+
+
+/**
+ * @param {function(!Array<!chrome.audioModem.ReceivedToken>)} callback
+ * @return {boolean}
+ */
+chrome.audioModem.ReceivedEvent.prototype.hasListener = function(callback) {};
+
+
+/**
+ * @return {boolean}
+ */
+chrome.audioModem.ReceivedEvent.prototype.hasListeners = function() {};
+
+
+/** @type {!chrome.audioModem.ReceivedEvent} */
+chrome.audioModem.onReceived;
+
+
+/** @type {!ChromeStringEvent} */
+chrome.audioModem.onTransmitFail;
+
+
+/**
  * @const
  * @see https://developer.chrome.com/apps/bluetooth
  */
 chrome.bluetooth = function() {};
 
 
 
 /**
  * @constructor
  * @see https://developer.chrome.com/apps/bluetooth#type-AdapterState
@@ skipping 621 matching lines @@
 
 
 /** @type {string|undefined} */
 chrome.bluetoothLowEnergy.Service.prototype.deviceAddress;
 
 
 /**
  * @constructor
  * @see https://developer.chrome.com/apps/bluetoothLowEnergy#type-Characteristic
  */
-chrome.bluetoothLowEnergy.Characteristic;
+chrome.bluetoothLowEnergy.Characteristic = function() {};
 
 
 /** @type {string} */
 chrome.bluetoothLowEnergy.Characteristic.prototype.uuid;
 
 
 /** @type {!chrome.bluetoothLowEnergy.Service} */
 chrome.bluetoothLowEnergy.Characteristic.prototype.service;
 
 
 /** @type {!Array.<string>} */
 chrome.bluetoothLowEnergy.Characteristic.prototype.properties;
 
 
 /** @type {string|undefined} */
 chrome.bluetoothLowEnergy.Characteristic.prototype.instanceId;
 
 
 /** @type {!ArrayBuffer|undefined} */
 chrome.bluetoothLowEnergy.Characteristic.prototype.value;
 
 
 /**
  * @constructor
  * @see https://developer.chrome.com/apps/bluetoothLowEnergy#type-Descriptor
  */
-chrome.bluetoothLowEnergy.Descriptor;
+chrome.bluetoothLowEnergy.Descriptor = function() {};
 
 /** @type {string} */
 chrome.bluetoothLowEnergy.Descriptor.prototype.uuid;
 
 
 /** @type {!chrome.bluetoothLowEnergy.Characteristic} */
 chrome.bluetoothLowEnergy.Descriptor.prototype.characteristic;
 
 
 /** @type {string|undefined} */
@@ skipping 156 matching lines @@
   function(descriptorId, value, callback) {};
 
 
 /**
  * Event whose listeners take a Service parameter.
  * @constructor
  */
 chrome.bluetoothLowEnergy.ServiceEvent = function() {};
 
 
-/** @param {function(!chrome.bluetoothLowEnergy.ServiceEvent): void} callback */
+/** @param {function(!chrome.bluetoothLowEnergy.Service): void} callback */
 chrome.bluetoothLowEnergy.ServiceEvent.prototype.addListener =
     function(callback) {};
 
 
-/** @param {function(!chrome.bluetoothLowEnergy.ServiceEvent): void} callback */
+/** @param {function(!chrome.bluetoothLowEnergy.Service): void} callback */
 chrome.bluetoothLowEnergy.ServiceEvent.prototype.removeListener =
     function(callback) {};
 
 /**
- * @param {function(!chrome.bluetoothLowEnergy.ServiceEvent): void} callback
+ * @param {function(!chrome.bluetoothLowEnergy.Service): void} callback
  * @return {boolean}
  */
 chrome.bluetoothLowEnergy.ServiceEvent.prototype.hasListener =
     function(callback) {};
 
 
 /** @return {boolean} */
 chrome.bluetoothLowEnergy.ServiceEvent.prototype.hasListeners =
     function() {};
 
@@ skipping 19 matching lines @@
 
 
 /**
  * Event whose listeners take a Characteristic parameter.
  * @constructor
  */
 chrome.bluetoothLowEnergy.CharacteristicEvent = function() {};
 
 
 /**
- * @param {function(!chrome.bluetoothLowEnergy.CharacteristicEvent): void}
+ * @param {function(!chrome.bluetoothLowEnergy.Characteristic): void}
  *     callback
  */
 chrome.bluetoothLowEnergy.CharacteristicEvent.prototype.addListener =
     function(callback) {};
 
 
 /**
- * @param {function(!chrome.bluetoothLowEnergy.CharacteristicEvent): void}
+ * @param {function(!chrome.bluetoothLowEnergy.Characteristic): void}
  *     callback
  */
 chrome.bluetoothLowEnergy.CharacteristicEvent.prototype.removeListener =
     function(callback) {};
 
 
 /**
- * @param {function(!chrome.bluetoothLowEnergy.CharacteristicEvent): void}
+ * @param {function(!chrome.bluetoothLowEnergy.Characteristic): void}
  *     callback
  * @return {boolean}
  */
 chrome.bluetoothLowEnergy.CharacteristicEvent.prototype.hasListener =
     function(callback) {};
 
 
 /** @return {boolean} */
 chrome.bluetoothLowEnergy.CharacteristicEvent.prototype.hasListeners =
     function() {};
 
 
 /**
  * @type {!chrome.bluetoothLowEnergy.CharacteristicEvent}
  * @see https://developer.chrome.com/apps/bluetoothLowEnergy#event-onCharacteristicValueChanged
  */
 chrome.bluetoothLowEnergy.onCharacteristicValueChanged;
 
 
 /**
  * Event whose listeners take a Characteristic parameter.
  * @constructor
  */
 chrome.bluetoothLowEnergy.DescriptorEvent = function() {};
 
 
 /**
- * @param {function(!chrome.bluetoothLowEnergy.DescriptorEvent): void}
+ * @param {function(!chrome.bluetoothLowEnergy.Descriptor): void}
  *     callback
  */
 chrome.bluetoothLowEnergy.DescriptorEvent.prototype.addListener =
     function(callback) {};
 
 
 /**
- * @param {function(!chrome.bluetoothLowEnergy.DescriptorEvent): void}
+ * @param {function(!chrome.bluetoothLowEnergy.Descriptor): void}
  *     callback
  */
 chrome.bluetoothLowEnergy.DescriptorEvent.prototype.removeListener =
     function(callback) {};
 
 
 /**
- * @param {function(!chrome.bluetoothLowEnergy.DescriptorEvent): void} callback
+ * @param {function(!chrome.bluetoothLowEnergy.Descriptor): void} callback
  * @return {boolean}
  */
 chrome.bluetoothLowEnergy.DescriptorEvent.prototype.hasListener =
     function(callback) {};
 
 
 /** @return {boolean} */
 chrome.bluetoothLowEnergy.DescriptorEvent.prototype.hasListeners =
     function() {};
 
@@ skipping 957 matching lines @@
 
 
 /**
  * @type {!ChromeEvent}
  * @deprecated Please use tabs.onActivated.
  */
 chrome.tabs.onSelectionChanged;
 
 
 /**
+ * @see https://developer.chrome.com/extensions/topSites
+ * @const
+ */
+chrome.topSites = {};
+
+
+
+/**
+ * @constructor
+ * @see https://developer.chrome.com/extensions/topSites#type-MostVisitedURL
+ */
+chrome.topSites.MostVisitedURL = function() {};
+
+
+/** @type {string} */
+chrome.topSites.MostVisitedURL.prototype.url;
+
+
+/** @type {string} */
+chrome.topSites.MostVisitedURL.prototype.title;
+
+
+/**
+ * Gets a list of top sites.
+ * @param {function(!Array<!chrome.topSites.MostVisitedURL>)} callback Invoked
+ *     with a list of most visited URLs.
+ * @see https://developer.chrome.com/extensions/topSites#method-get
+ */
+chrome.topSites.get = function(callback) {};
+
+
+/**
  * @const
  * @see https://developer.chrome.com/extensions/windows.html
  */
 chrome.windows = {};
 
 
 /**
  * @param {Object=} opt_createData May have many keys to specify parameters.
  *     Or the callback.
  * @param {function(ChromeWindow): void=} opt_callback Callback.
@@ skipping 4364 matching lines @@
  * @return {string} The ID that can be passed to restoreEntry to regain access
  *     to the given file entry.
  * @see http://developer.chrome.com/apps/fileSystem.html#method-retainEntry
  */
 chrome.fileSystem.retainEntry = function(entry) {};
 
 
 /**
  * @param {!chrome.fileSystem.RequestFileSystemOptions} options Options for the
  *     request.
- * @param {!function(FileSystem)} callback A completion callback.
+ * @param {function(!FileSystem=)} callback A completion callback.
  * @see http://developer.chrome.com/apps/fileSystem.html#method-requestFileSystem
  */
 chrome.fileSystem.requestFileSystem = function(options, callback) {};
 
 
 /**
  * @const
  * @see https://developer.chrome.com/apps/syncFileSystem
  */
 chrome.syncFileSystem = {};
@@ skipping 161 matching lines @@
  * Gets an array of all the alarms.
  * @param {function(!Array.<!chrome.alarms.Alarm>)} callback
  * @see http://developer.chrome.com/extensions/alarms.html#method-getAll
  */
 chrome.alarms.getAll = function(callback) {};
 
 
 /**
  * Clears the alarm with the given name.
  * @param {string=} opt_name
+ * @param {function(boolean)=} opt_callback A callback that will be called with
+ *     a boolean for whether the alarm was cleared.
  * @see http://developer.chrome.com/extensions/alarms.html#method-clear
  */
-chrome.alarms.clear = function(opt_name) {};
+chrome.alarms.clear = function(opt_name, opt_callback) {};
 
 
 /**
  * Clears all alarms.
+ * @param {function(boolean)=} opt_callback A callback that will be called with
+ *     a boolean for whether the alarms were cleared.
  * @see http://developer.chrome.com/extensions/alarms.html#method-clearAll
  */
-chrome.alarms.clearAll = function() {};
+chrome.alarms.clearAll = function(opt_callback) {};
 
 
 /**
  * Fired when an alarm has elapsed. Useful for event pages.
  * @type {!chrome.alarms.AlarmEvent}
  * @see http://developer.chrome.com/extensions/alarms.html#event-onAlarm
  */
 chrome.alarms.onAlarm;
 
 
@@ skipping 1296 matching lines @@
 
 /**
  * @param {string} guid
  * @param {function()=} opt_callback
  */
 chrome.networkingPrivate.startDisconnect = function(guid, opt_callback) {};
 
 
 /**
  * @param {string} guid
- * @param {string} opt_carrier
+ * @param {(string|function())=} opt_carrierOrCallback
  * @param {function()=} opt_callback
  */
 chrome.networkingPrivate.startActivate =
-  function(guid, opt_carrier, opt_callback) {};
+  function(guid, opt_carrierOrCallback, opt_callback) {};
 
 
 /**
  * @param {!chrome.networkingPrivate.VerificationProperties} verificationInfo
  * @param {function(boolean)} callback
  */
 chrome.networkingPrivate.verifyDestination =
     function(verificationInfo, callback) {};
 
 
@@ skipping 168 matching lines @@
  * not be done while connected to the device's network. Callback is called
  * with true if wifi password was cached and false if it was unavailable.
  * @param {string} ssid
  * @param {function(boolean): void} callback
  */
 chrome.gcdPrivate.prefetchWifiPassword = function(ssid, callback) {};
 
 
 /**
  * Establish the session.
+ * TODO(user): Deprecated. Remove after app updated to use createSession.
  * @param {string} ipAddress
  * @param {number} port
  * @param {function(number, string, !Array.<string>): void}
  *     callback Called when the session is established or on error. 1st param,
  *     |sessionId|, is the session ID (identifies the session for future calls).
  *     2nd param, |status|, is the status (success or type of error). 3rd param,
  *     |pairingTypes|, is a list of pairing types supported by this device.
  */
 chrome.gcdPrivate.establishSession = function(ipAddress, port, callback) {};
 
 
 /**
+ * Create new pairing session.
+ * @param {string} serviceName The mDNS service name of the device.
+ * @param {function(number, string, !Array.<string>): void}
+ *     callback Called when the session is established or on error. 1st param,
+ *     |sessionId|, is the session ID (identifies the session for future calls).
+ *     2nd param, |status|, is the status (success or type of error). 3rd param,
+ *     |pairingTypes|, is a list of pairing types supported by this device.
+ */
+chrome.gcdPrivate.createSession = function(serviceName, callback) {};
+
+
+/**
  * Start pairing with the selected method.
  * @param {number} sessionId
  * @param {string} pairingType
  * @param {function(string): void} callback
  */
 chrome.gcdPrivate.startPairing = function(sessionId, pairingType, callback) {};
 
 
 /**
  * Confirm pairing code.
@@ skipping 232 matching lines @@
 
 
 /**
  * Installs the given app ID.
  * @param {string} id
  * @param {function(string, string): void=} opt_callback Response callback that
  *     returns two string: (1) an error string (or empty string on success) and
  *     (2) an error code in case of error
  */
 chrome.inlineInstallPrivate.install = function(id, opt_callback) {};