remoting/webapp/js_proto/chrome_proto.js

   1 // Copyright (c) 2012 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 contains various hacks needed to inform JSCompiler of various
   6 // WebKit- and Chrome-specific properties and methods. It is used only with
   7 // JSCompiler to verify the type-correctness of our code.
   8
   9 /** @type {Object} */
  10 chrome.app = {};
  11
  12 /** @type {Object} */
  13 chrome.app.runtime = {
  14   /** @type {chrome.Event} */
  15   onLaunched: null
  16 };
  17
  18
  19 /** @type {Object} */
  20 chrome.app.window = {
  21   /**
  22    * @param {string} name
  23    * @param {Object} parameters
  24    * @param {function(AppWindow)=} opt_callback
  25    */
  26   create: function(name, parameters, opt_callback) {},
  27   /**
  28    * @return {AppWindow}
  29    */
  30   current: function() {},
  31   /**
  32    * @param {string} id
  33    * @return {AppWindow}
  34    */
  35   get: function(id) {},
  36   /**
  37    * @return {Array<AppWindow>}
  38    */
  39   getAll: function() {}
  40 };
  41
  42
  43 /** @type {Object} */
  44 chrome.runtime = {
  45   /** @type {Object} */
  46   lastError: {
  47     /** @type {string} */
  48     message: ''
  49   },
  50   /** @type {string} */
  51   id: '',
  52   /** @return {{name: string, version: string, app: {background: Object}}} */
  53   getManifest: function() {},
  54   /** @param {function(Window):void} callback */
  55   getBackgroundPage: function(callback) {},
  56   /** @type {chrome.Event} */
  57   onSuspend: null,
  58   /** @type {chrome.Event} */
  59   onSuspendCanceled: null,
  60   /** @type {chrome.Event} */
  61   onConnect: null,
  62   /** @type {chrome.Event} */
  63   onConnectExternal: null,
  64   /** @type {chrome.Event} */
  65   onMessage: null,
  66   /** @type {chrome.Event} */
  67   onMessageExternal: null
  68 };
  69
  70 /**
  71  * @type {?function(string):chrome.runtime.Port}
  72  */
  73 chrome.runtime.connectNative = function(name) {};
  74
  75 /**
  76  * @param {{ name: string}} config
  77  * @return {chrome.runtime.Port}
  78  */
  79 chrome.runtime.connect = function(config) {};
  80
  81 /**
  82  * @param {string?} extensionId
  83  * @param {*} message
  84  * @param {Object=} opt_options
  85  * @param {function(*)=} opt_callback
  86  */
  87 chrome.runtime.sendMessage = function(
  88     extensionId, message, opt_options, opt_callback) {};
  89
  90 /** @constructor */
  91 chrome.runtime.MessageSender = function(){
  92   /** @type {chrome.Tab} */
  93   this.tab = null;
  94   /** @type {string} */
  95   this.id = '';
  96   /** @type {string} */
  97   this.url = '';
  98 };
  99
 100 /** @constructor */
 101 chrome.runtime.Port = function() {
 102   this.onMessage = new chrome.Event();
 103   this.onDisconnect = new chrome.Event();
 104
 105   /** @type {string} */
 106   this.name = '';
 107
 108   /** @type {chrome.runtime.MessageSender} */
 109   this.sender = null;
 110 };
 111
 112 /** @type {chrome.Event} */
 113 chrome.runtime.Port.prototype.onMessage = null;
 114
 115 /** @type {chrome.Event} */
 116 chrome.runtime.Port.prototype.onDisconnect = null;
 117
 118 chrome.runtime.Port.prototype.disconnect = function() {};
 119
 120 /**
 121  * @param {Object} message
 122  */
 123 chrome.runtime.Port.prototype.postMessage = function(message) {};
 124
 125
 126 /** @type {Object} */
 127 chrome.extension = {};
 128
 129 /**
 130  * @param {*} message
 131  * @param {function(*)=} opt_callback
 132  */
 133 chrome.extension.sendMessage = function(message, opt_callback) {};
 134
 135 /** @type {chrome.Event} */
 136 chrome.extension.onMessage;
 137
 138
 139 /** @type {Object} */
 140 chrome.i18n = {};
 141
 142 /**
 143  * @param {string} messageName
 144  * @param {(string|Array<string>)=} opt_args
 145  * @return {string}
 146  */
 147 chrome.i18n.getMessage = function(messageName, opt_args) {};
 148
 149 /**
 150  * @return {string}
 151  */
 152 chrome.i18n.getUILanguage = function() {};
 153
 154
 155 /** @type {Object} */
 156 chrome.storage = {};
 157
 158 /** @type {chrome.Storage} */
 159 chrome.storage.local;
 160
 161 /** @type {chrome.Storage} */
 162 chrome.storage.sync;
 163
 164 /** @constructor */
 165 chrome.Storage = function() {};
 166
 167 /**
 168  * @param {string|Array<string>|Object<string>} items
 169  * @param {function(Object<string>):void} callback
 170  * @return {void}
 171  */
 172 chrome.Storage.prototype.get = function(items, callback) {};
 173
 174 /**
 175  * @param {Object<string>} items
 176  * @param {function():void=} opt_callback
 177  * @return {void}
 178  */
 179 chrome.Storage.prototype.set = function(items, opt_callback) {};
 180
 181 /**
 182  * @param {string|Array<string>} items
 183  * @param {function():void=} opt_callback
 184  * @return {void}
 185  */
 186 chrome.Storage.prototype.remove = function(items, opt_callback) {};
 187
 188 /**
 189  * @param {function():void=} opt_callback
 190  * @return {void}
 191  */
 192 chrome.Storage.prototype.clear = function(opt_callback) {};
 193
 194
 195 /**
 196  * @type {Object}
 197  * src/chrome/common/extensions/api/context_menus.json
 198  */
 199 chrome.contextMenus = {};
 200 /** @type {chrome.Event} */
 201 chrome.contextMenus.onClicked;
 202 /**
 203  * @param {!Object} createProperties
 204  * @param {function()=} opt_callback
 205  */
 206 chrome.contextMenus.create = function(createProperties, opt_callback) {};
 207 /**
 208  * @param {string|number} id
 209  * @param {!Object} updateProperties
 210  * @param {function()=} opt_callback
 211  */
 212 chrome.contextMenus.update = function(id, updateProperties, opt_callback) {};
 213 /**
 214  * @param {string|number} menuItemId
 215  * @param {function()=} opt_callback
 216  */
 217 chrome.contextMenus.remove = function(menuItemId, opt_callback) {};
 218 /**
 219  * @param {function()=} opt_callback
 220  */
 221 chrome.contextMenus.removeAll = function(opt_callback) {};
 222
 223 /** @constructor */
 224 function OnClickData() {};
 225 /** @type {string|number} */
 226 OnClickData.prototype.menuItemId;
 227 /** @type {string|number} */
 228 OnClickData.prototype.parentMenuItemId;
 229 /** @type {string} */
 230 OnClickData.prototype.mediaType;
 231 /** @type {string} */
 232 OnClickData.prototype.linkUrl;
 233 /** @type {string} */
 234 OnClickData.prototype.srcUrl;
 235 /** @type {string} */
 236 OnClickData.prototype.pageUrl;
 237 /** @type {string} */
 238 OnClickData.prototype.frameUrl;
 239 /** @type {string} */
 240 OnClickData.prototype.selectionText;
 241 /** @type {boolean} */
 242 OnClickData.prototype.editable;
 243 /** @type {boolean} */
 244 OnClickData.prototype.wasChecked;
 245 /** @type {boolean} */
 246 OnClickData.prototype.checked;
 247
 248
 249 /** @type {Object} */
 250 chrome.fileSystem = {
 251   /**
 252    * @param {Object<string>?} options
 253    * @param {function(Entry, Array<FileEntry>):void} callback
 254    */
 255   chooseEntry: function(options, callback) {},
 256   /**
 257    * @param {Entry} entry
 258    * @param {function(string):void} callback
 259    */
 260   getDisplayPath: function(entry, callback) {}
 261 };
 262
 263 /** @param {function(FileWriter):void} callback */
 264 Entry.prototype.createWriter = function(callback) {};
 265
 266 /** @type {Object} */
 267 chrome.identity = {
 268   /**
 269    * @param {Object<string>} parameters
 270    * @param {function(string):void} callback
 271    */
 272   getAuthToken: function(parameters, callback) {},
 273   /**
 274    * @param {Object<string>} parameters
 275    * @param {function():void} callback
 276    */
 277   removeCachedAuthToken: function(parameters, callback) {},
 278   /**
 279    * @param {Object<string>} parameters
 280    * @param {function(string):void} callback
 281    */
 282   launchWebAuthFlow: function(parameters, callback) {}
 283 };
 284
 285
 286 /** @type {Object} */
 287 chrome.permissions = {
 288   /**
 289    * @param {Object<string>} permissions
 290    * @param {function(boolean):void} callback
 291    */
 292   contains: function(permissions, callback) {},
 293   /**
 294    * @param {Object<string>} permissions
 295    * @param {function(boolean):void} callback
 296    */
 297   request: function(permissions, callback) {}
 298 };
 299
 300
 301 /** @type {Object} */
 302 chrome.tabs = {};
 303
 304 /** @param {function(chrome.Tab):void} callback */
 305 chrome.tabs.getCurrent = function(callback) {};
 306
 307 /**
 308  * @param {Object?} options
 309  * @param {function(chrome.Tab)=} opt_callback
 310  */
 311 chrome.tabs.create = function(options, opt_callback) {};
 312
 313 /**
 314  * @param {string} id
 315  * @param {function(chrome.Tab)} callback
 316  */
 317 chrome.tabs.get = function(id, callback) {};
 318
 319 /**
 320  * @param {string} id
 321  * @param {function(*=):void=} opt_callback
 322  */
 323 chrome.tabs.remove = function(id, opt_callback) {};
 324
 325
 326 /** @constructor */
 327 chrome.Tab = function() {
 328   /** @type {boolean} */
 329   this.pinned = false;
 330   /** @type {number} */
 331   this.windowId = 0;
 332   /** @type {string} */
 333   this.id = '';
 334 };
 335
 336
 337 /** @type {Object} */
 338 chrome.windows = {};
 339
 340 /** @param {number} id
 341  *  @param {Object?} getInfo
 342  *  @param {function(chrome.Window):void} callback */
 343 chrome.windows.get = function(id, getInfo, callback) {};
 344
 345 /** @constructor */
 346 chrome.Window = function() {
 347   /** @type {string} */
 348   this.state = '';
 349   /** @type {string} */
 350   this.type = '';
 351 };
 352
 353 /** @constructor */
 354 var AppWindow = function() {
 355   /** @type {Window} */
 356   this.contentWindow = null;
 357   /** @type {chrome.Event} */
 358   this.onClosed = null;
 359   /** @type {chrome.Event} */
 360   this.onRestored = null;
 361   /** @type {chrome.Event} */
 362   this.onMaximized = null;
 363   /** @type {chrome.Event} */
 364   this.onMinimized = null;
 365   /** @type {chrome.Event} */
 366   this.onFullscreened = null;
 367   /** @type {string} */
 368   this.id = '';
 369   /** @type {Bounds} */
 370   this.outerBounds = null;
 371   /** @type {Bounds} */
 372   this.innerBounds = null;
 373 };
 374
 375 AppWindow.prototype.close = function() {};
 376 AppWindow.prototype.drawAttention = function() {};
 377 AppWindow.prototype.focus = function() {};
 378 AppWindow.prototype.maximize = function() {};
 379 AppWindow.prototype.minimize = function() {};
 380 /**
 381  * @param {number} left
 382  * @param {number} top
 383  */
 384 AppWindow.prototype.moveTo = function(left, top) {};
 385 /**
 386  * @param {number} width
 387  * @param {number} height
 388  */
 389 AppWindow.prototype.resizeTo = function(width, height) {};
 390
 391 AppWindow.prototype.restore = function() {};
 392 AppWindow.prototype.show = function() {};
 393 /** @return {boolean} */
 394 AppWindow.prototype.isMinimized = function() {};
 395 AppWindow.prototype.fullscreen = function() {};
 396 /** @return {boolean} */
 397 AppWindow.prototype.isFullscreen = function() {};
 398 /** @return {boolean} */
 399 AppWindow.prototype.isMaximized = function() {};
 400
 401 /**
 402  * @param {{rects: Array<ClientRect>}} rects
 403  */
 404 AppWindow.prototype.setShape = function(rects) {};
 405
 406 /**
 407  * @param {{rects: Array<ClientRect>}} rects
 408  */
 409 AppWindow.prototype.setInputRegion = function(rects) {};
 410
 411 /** @constructor */
 412 var LaunchData = function() {
 413   /** @type {string} */
 414   this.id = '';
 415   /** @type {Array<{type: string, entry: FileEntry}>} */
 416   this.items = [];
 417 };
 418
 419 /** @constructor */
 420 function Bounds() {
 421   /** @type {number} */
 422   this.left = 0;
 423   /** @type {number} */
 424   this.top = 0;
 425   /** @type {number} */
 426   this.width = 0;
 427   /** @type {number} */
 428   this.height = 0;
 429 }
 430
 431 /** @type {Object} */
 432 chrome.sockets = {};
 433
 434 /** @type {Object} */
 435 chrome.sockets.tcp = {};
 436
 437 /** @constructor */
 438 chrome.sockets.tcp.CreateInfo = function() {
 439   /** @type {number} */
 440   this.socketId = 0;
 441 }
 442
 443 /**
 444  * @param {Object} properties
 445  * @param {function(chrome.sockets.tcp.CreateInfo):void} callback
 446  */
 447 chrome.sockets.tcp.create = function(properties, callback) {};
 448
 449
 450 /** @constructor */
 451 chrome.sockets.tcp.ConnectInfo = function() {
 452   /** @type {number} */
 453   this.result = 0;
 454 }
 455
 456 /**
 457  * @param {number} socketId
 458  * @param {string} peerAddress
 459  * @param {number} peerPort
 460  * @param {function(chrome.sockets.tcp.ConnectInfo):void} callback
 461  */
 462 chrome.sockets.tcp.connect =
 463     function(socketId, peerAddress, peerPort, callback) {};
 464
 465
 466 /** @constructor */
 467 chrome.sockets.tcp.SendInfo = function() {
 468   /** @type {number} */
 469   this.resultCode = 0;
 470
 471   /** @type {number} */
 472   this.bytesSent = 0;
 473 }
 474
 475 /**
 476  * @param {number} socketId
 477  * @param {ArrayBuffer} data
 478  * @param {function(chrome.sockets.tcp.SendInfo):void} callback
 479  */
 480 chrome.sockets.tcp.send = function(socketId, data, callback) {};
 481
 482
 483 /**
 484  * @param {number} socketId
 485  */
 486 chrome.sockets.tcp.close = function(socketId) {};
 487
 488 /**
 489  * @param {number} socketId
 490  * @param {Object} options
 491  * @param {function(number):void} callback
 492  */
 493 chrome.sockets.tcp.secure = function(socketId, options, callback) {};
 494
 495 /** @constructor */
 496 chrome.sockets.tcp.ReceiveInfo = function() {
 497   /** @type {number} */
 498   this.socketId = 0;
 499
 500   /** @type {ArrayBuffer} */
 501   this.data = null;
 502 }
 503
 504 /** @type {chrome.Event} */
 505 chrome.sockets.tcp.onReceive = null;
 506
 507 /** @constructor */
 508 chrome.sockets.tcp.ReceiveErrorInfo = function() {
 509   /** @type {number} */
 510   this.socketId = 0;
 511
 512   /** @type {number} */
 513   this.resultCode = 0;
 514 }
 515
 516 /** @type {chrome.Event} */
 517 chrome.sockets.tcp.onReceiveError = null;
 518
 519 /** @type {Object} */
 520 chrome.socket = {};
 521
 522 /** @constructor */
 523 chrome.socket.CreateInfo = function() {
 524   /** @type {number} */
 525   this.socketId = 0;
 526 }
 527
 528 /**
 529  * @param {string} socketType
 530  * @param {Object} options
 531  * @param {function(chrome.socket.CreateInfo):void} callback
 532  */
 533 chrome.socket.create = function(socketType, options, callback) {};
 534
 535 /**
 536  * @param {number} socketId
 537  * @param {string} hostname
 538  * @param {number} port
 539  * @param {function(number):void} callback
 540  */
 541 chrome.socket.connect =
 542     function(socketId, hostname, port, callback) {};
 543
 544 /** @constructor */
 545 chrome.socket.WriteInfo = function() {
 546   /** @type {number} */
 547   this.bytesWritten = 0;
 548 }
 549
 550 /**
 551  * @param {number} socketId
 552  * @param {ArrayBuffer} data
 553  * @param {function(chrome.socket.WriteInfo):void} callback
 554  */
 555 chrome.socket.write = function(socketId, data, callback) {};
 556
 557 /** @constructor */
 558 chrome.socket.ReadInfo = function() {
 559   /** @type {number} */
 560   this.resultCode = 0;
 561
 562   /** @type {ArrayBuffer} */
 563   this.data = null;
 564 }
 565
 566 /**
 567  * @param {number} socketId
 568  * @param {function(chrome.socket.ReadInfo):void} callback
 569  */
 570 chrome.socket.read = function(socketId, callback) {};
 571
 572 /**
 573  * @param {number} socketId
 574  */
 575 chrome.socket.destroy = function(socketId) {};
 576
 577 /**
 578  * @param {number} socketId
 579  * @param {Object} options
 580  * @param {function(number):void} callback
 581  */
 582 chrome.socket.secure = function(socketId, options, callback) {};