| OLD | NEW |
| (Empty) | |
| 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: |
| 2 1) The <head> information in this page is significant, should be uniform |
| 3 across api docs and should be edited only with knowledge of the |
| 4 templating mechanism. |
| 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a |
| 6 browser, it will be re-generated from the template, json schema and |
| 7 authored overview content. |
| 8 4) The <body>.innerHTML is also generated by an offline step so that this |
| 9 page may easily be indexed by search engines. |
| 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> |
| 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> |
| 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> |
| 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla
te_compiled.js"> |
| 15 </script> |
| 16 <script type="text/javascript" src="../../../../third_party/json_minify/mini
fy-sans-regexp.js"> |
| 17 </script> |
| 18 <script type="text/javascript" src="js/api_page_generator.js"></script> |
| 19 <script type="text/javascript" src="js/bootstrap.js"></script> |
| 20 <script type="text/javascript" src="js/sidebar.js"></script> |
| 21 <meta name="description" content="Documentation for the chrome.experimental.of
fscreenTabs module, which is part of the Google Chrome extension APIs."><title>
chrome.experimental.offscreenTabs - Google Chrome Extensions - Google Code</titl
e></head> |
| 22 <body> <div id="devModeWarning" class="displayModeWarning"> |
| 23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp
ecting to see local changes when you refresh? You'll need run chrome with --allo
w-file-access-from-files. |
| 24 </div> |
| 25 <div id="branchWarning" class="displayModeWarning"> |
| 26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. |
| 27 It may not work with the stable release of Chrome.</span> |
| 28 <select id="branchChooser"> |
| 29 <option>Choose a different version... |
| 30 </option><option value="">Stable |
| 31 </option><option value="beta">Beta |
| 32 </option><option value="dev">Dev |
| 33 </option><option value="trunk">Trunk |
| 34 </option></select> |
| 35 </div> |
| 36 <div id="unofficialWarning" class="displayModeWarning"> |
| 37 <span>WARNING: This is unofficial documentation. It may not work with the |
| 38 current release of Chrome.</span> |
| 39 <button id="goToOfficialDocs">Go to the official docs</button> |
| 40 </div> |
| 41 <div id="gc-container" class="labs"> |
| 42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> |
| 43 <!-- In particular, sub-templates that recurse, must be used by allowing |
| 44 jstemplate to make a copy of the template in this section which |
| 45 are not operated on by way of the jsskip="true" --> |
| 46 <!-- /SUBTEMPLATES --> |
| 47 <a id="top"></a> |
| 48 <div id="skipto"> |
| 49 <a href="#gc-pagecontent">Skip to page content</a> |
| 50 <a href="#gc-toc">Skip to main navigation</a> |
| 51 </div> |
| 52 <!-- API HEADER --> |
| 53 <table id="header" width="100%" cellspacing="0" border="0"> |
| 54 <tbody><tr> |
| 55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c
ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:
0; margin:0;"></a></td> |
| 56 <td valign="middle" width="100%" style="padding-left:0.6em;"> |
| 57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.
5em"> |
| 58 <div id="gsc-search-box"> |
| 59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz
fqtno"> |
| 60 <input type="hidden" name="ie" value="UTF-8"> |
| 61 <input type="text" name="q" value="" size="55"> |
| 62 <input class="gsc-search-button" type="submit" name="sa" value="Se
arch"> |
| 63 <br> |
| 64 <span class="greytext">e.g. "page action" or "tabs"</span> |
| 65 </div> |
| 66 </form> |
| 67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc
ript> |
| 68 <script type="text/javascript">google.load("elements", "1", {packages:
"transliteration"});</script> |
| 69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1
3n?form=cse&t13n_langs=en"></script> |
| 70 <script type="text/javascript" src="https://www.google.com/coop/cse/br
and?form=cse&lang=en"></script> |
| 71 </td> |
| 72 </tr> |
| 73 </tbody></table> |
| 74 <div id="codesiteContent" class=""> |
| 75 <a id="gc-topnav-anchor"></a> |
| 76 <div id="gc-topnav"> |
| 77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab
s</a>)</h1> |
| 78 <ul id="home" class="gc-topnav-tabs"> |
| 79 <li id="home_link"> |
| 80 <a href="index.html" title="Google Chrome Extensions home page">Home
</a> |
| 81 </li> |
| 82 <li id="docs_link"> |
| 83 <a href="docs.html" title="Official Google Chrome Extensions documen
tation">Docs</a> |
| 84 </li> |
| 85 <li id="faq_link"> |
| 86 <a href="faq.html" title="Answers to frequently asked questions abou
t Google Chrome Extensions">FAQ</a> |
| 87 </li> |
| 88 <li id="samples_link"> |
| 89 <a href="samples.html" title="Sample extensions (with source code)">
Samples</a> |
| 90 </li> |
| 91 <li id="group_link"> |
| 92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte
nsions" title="Google Chrome Extensions developer forum">Group</a> |
| 93 </li> |
| 94 <li id="so_link"> |
| 95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext
ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a> |
| 96 </li> |
| 97 </ul> |
| 98 </div> <!-- end gc-topnav --> |
| 99 <div class="g-section g-tpl-170"> |
| 100 <!-- SIDENAV --> |
| 101 <div class="g-unit g-first" id="gc-toc"> |
| 102 <ul> |
| 103 <li><a href="getstarted.html">Getting Started</a></li> |
| 104 <li><a href="overview.html">Overview</a></li> |
| 105 <li><a href="whats_new.html">What's New?</a></li> |
| 106 <li><h2><a href="devguide.html">Developer's Guide</a></h2> |
| 107 <ul> |
| 108 <li>Browser UI |
| 109 <ul> |
| 110 <li><a href="browserAction.html">Browser Actions</a></li> |
| 111 <li><a href="contextMenus.html">Context Menus</a></li> |
| 112 <li><a href="notifications.html">Desktop Notifications</a></li
> |
| 113 <li><a href="omnibox.html">Omnibox</a></li> |
| 114 <li><a href="options.html">Options Pages</a></li> |
| 115 <li><a href="override.html">Override Pages</a></li> |
| 116 <li><a href="pageAction.html">Page Actions</a></li> |
| 117 </ul> |
| 118 </li> |
| 119 <li>Browser Interaction |
| 120 <ul> |
| 121 <li><a href="bookmarks.html">Bookmarks</a></li> |
| 122 <li><a href="cookies.html">Cookies</a></li> |
| 123 <li><a href="devtools.html">Developer Tools</a></li> |
| 124 <li><a href="events.html">Events</a></li> |
| 125 <li><a href="history.html">History</a></li> |
| 126 <li><a href="management.html">Management</a></li> |
| 127 <li><a href="tabs.html">Tabs</a></li> |
| 128 <li><a href="windows.html">Windows</a></li> |
| 129 </ul> |
| 130 </li> |
| 131 <li>Implementation |
| 132 <ul> |
| 133 <li><a href="a11y.html">Accessibility</a></li> |
| 134 <li><a href="background_pages.html">Background Pages</a></li> |
| 135 <li><a href="content_scripts.html">Content Scripts</a></li> |
| 136 <li><a href="xhr.html">Cross-Origin XHR</a></li> |
| 137 <li><a href="i18n.html">Internationalization</a></li> |
| 138 <li><a href="messaging.html">Message Passing</a></li> |
| 139 <li><a href="permissions.html">Optional Permissions</a></li> |
| 140 <li><a href="npapi.html">NPAPI Plugins</a></li> |
| 141 </ul> |
| 142 </li> |
| 143 <li>Finishing |
| 144 <ul> |
| 145 <li><a href="hosting.html">Hosting</a></li> |
| 146 <li><a href="external_extensions.html">Other Deployment Option
s</a></li> |
| 147 </ul> |
| 148 </li> |
| 149 </ul> |
| 150 </li> |
| 151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> |
| 152 <li><h2><a href="tutorials.html">Tutorials</a></h2> |
| 153 <ul> |
| 154 <li><a href="tut_debugging.html">Debugging</a></li> |
| 155 <li><a href="tut_analytics.html">Google Analytics</a></li> |
| 156 <li><a href="tut_oauth.html">OAuth</a></li> |
| 157 </ul> |
| 158 </li> |
| 159 <li><h2>Reference</h2> |
| 160 <ul> |
| 161 <li>Formats |
| 162 <ul> |
| 163 <li><a href="manifest.html">Manifest Files</a></li> |
| 164 <li><a href="match_patterns.html">Match Patterns</a></li> |
| 165 </ul> |
| 166 </li> |
| 167 <li><a href="permission_warnings.html">Permission Warnings</a></li
> |
| 168 <li><a href="api_index.html">chrome.* APIs</a></li> |
| 169 <li><a href="api_other.html">Other APIs</a></li> |
| 170 </ul> |
| 171 </li> |
| 172 <li><h2><a href="samples.html">Samples</a></h2></li> |
| 173 <div class="line"> </div> |
| 174 <li><h2>More</h2> |
| 175 <ul> |
| 176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm
l">Chrome Web Store</a></li> |
| 177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu
ide.html">Hosted Apps</a></li> |
| 178 <li><a href="themes.html">Themes</a></li> |
| 179 </ul> |
| 180 </li> |
| 181 </ul> |
| 182 </div> |
| 183 <script> |
| 184 initToggles(); |
| 185 </script> |
| 186 <div class="g-unit" id="gc-pagecontent"> |
| 187 <div id="pageTitle"> |
| 188 <h1 class="page_title">chrome.experimental.offscreenTabs</h1> |
| 189 </div> |
| 190 <!-- TABLE OF CONTENTS --> |
| 191 <div id="toc"> |
| 192 <h2>Contents</h2> |
| 193 <ol> |
| 194 <li> |
| 195 <a href="#apiReference">API reference: chrome.experimental.offsc
reenTabs</a> |
| 196 <ol> |
| 197 <li> |
| 198 <a href="#global-methods">Methods</a> |
| 199 <ol> |
| 200 <li> |
| 201 <a href="#method-create">create</a> |
| 202 </li><li> |
| 203 <a href="#method-get">get</a> |
| 204 </li><li> |
| 205 <a href="#method-getAll">getAll</a> |
| 206 </li><li> |
| 207 <a href="#method-remove">remove</a> |
| 208 </li><li> |
| 209 <a href="#method-sendKeyboardEvent">sendKeyboardEvent</a> |
| 210 </li><li> |
| 211 <a href="#method-sendMouseEvent">sendMouseEvent</a> |
| 212 </li><li> |
| 213 <a href="#method-toDataUrl">toDataUrl</a> |
| 214 </li><li> |
| 215 <a href="#method-update">update</a> |
| 216 </li> |
| 217 </ol> |
| 218 </li> |
| 219 <li> |
| 220 <a href="#global-events">Events</a> |
| 221 <ol> |
| 222 <li> |
| 223 <a href="#event-onUpdated">onUpdated</a> |
| 224 </li> |
| 225 </ol> |
| 226 </li> |
| 227 <li> |
| 228 <a href="#types">Types</a> |
| 229 <ol> |
| 230 <li> |
| 231 <a href="#type-OffscreenTab">OffscreenTab</a> |
| 232 <ol> |
| 233 </ol> |
| 234 </li> |
| 235 </ol> |
| 236 </li> |
| 237 </ol> |
| 238 </li> |
| 239 </ol> |
| 240 </div> |
| 241 <!-- /TABLE OF CONTENTS --> |
| 242 <!-- Standard content lead-in for experimental API pages --> |
| 243 <p id="classSummary"> |
| 244 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. |
| 245 </p> |
| 246 <!-- STATIC CONTENT PLACEHOLDER --> |
| 247 <div id="static"></div> |
| 248 <!-- API PAGE --> |
| 249 <div class="apiPage"> |
| 250 <a name="apiReference"></a> |
| 251 <h2>API reference: chrome.experimental.offscreenTabs</h2> |
| 252 <!-- PROPERTIES --> |
| 253 <!-- /apiGroup --> |
| 254 <!-- METHODS --> |
| 255 <div id="methodsTemplate" class="apiGroup"> |
| 256 <a name="global-methods"></a> |
| 257 <h3>Methods</h3> |
| 258 <!-- iterates over all functions --> |
| 259 <div class="apiItem"> |
| 260 <a name="method-create"></a> <!-- method-anchor --> |
| 261 <h4>create</h4> |
| 262 <div class="summary"> |
| 263 <!-- Note: intentionally longer 80 columns --> |
| 264 <span>chrome.experimental.offscreenTabs.create</span>(<span cl
ass="null"><span>object</span> |
| 265 <var><span>createProperties</span></var></span><span class
="optional"><span>, </span><span>function</span> |
| 266 <var><span>callback</span></var></span>)</div> |
| 267 <div class="description"> |
| 268 <p>Creates a new offscreen tab.</p> |
| 269 <!-- PARAMETERS --> |
| 270 <h4>Parameters</h4> |
| 271 <dl> |
| 272 <div> |
| 273 <div> |
| 274 <dt> |
| 275 <var>createProperties</var> |
| 276 <em> |
| 277 <!-- TYPE --> |
| 278 <div style="display:inline"> |
| 279 ( |
| 280 <span id="typeTemplate"> |
| 281 <span> |
| 282 <span>object</span> |
| 283 </span> |
| 284 </span> |
| 285 ) |
| 286 </div> |
| 287 </em> |
| 288 </dt> |
| 289 <dd class="todo"> |
| 290 Undocumented. |
| 291 </dd> |
| 292 <!-- OBJECT PROPERTIES --> |
| 293 <dd> |
| 294 <dl> |
| 295 <div> |
| 296 <div> |
| 297 <dt> |
| 298 <var>url</var> |
| 299 <em> |
| 300 <!-- TYPE --> |
| 301 <div style="display:inline"> |
| 302 ( |
| 303 <span id="typeTemplate"> |
| 304 <span> |
| 305 <span>string</span> |
| 306 </span> |
| 307 </span> |
| 308 ) |
| 309 </div> |
| 310 </em> |
| 311 </dt> |
| 312 <dd>The URL to navigate the offscreen tab to initially. Fully-qualifie
d URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'
). Relative URLs will be relative to the current page within the extension. Note
that you can't create offscreen tabs from background pages. The lifetime of the
offscreen tab is tied to the context of its creator (tab, browser action, etc.)
.</dd> |
| 313 <!-- OBJECT PROPERTIES --> |
| 314 <!-- OBJECT METHODS --> |
| 315 <!-- OBJECT EVENT FIELDS --> |
| 316 <!-- FUNCTION PARAMETERS --> |
| 317 </div> |
| 318 </div><div> |
| 319 <div> |
| 320 <dt> |
| 321 <var>width</var> |
| 322 <em> |
| 323 <!-- TYPE --> |
| 324 <div style="display:inline"> |
| 325 ( |
| 326 <span class="optional">optional</span> |
| 327 <span id="typeTemplate"> |
| 328 <span> |
| 329 <span>integer</span> |
| 330 </span> |
| 331 </span> |
| 332 ) |
| 333 </div> |
| 334 </em> |
| 335 </dt> |
| 336 <dd>Width of the offscreen tab. Defaults to width of the current tab.<
/dd> |
| 337 <!-- OBJECT PROPERTIES --> |
| 338 <!-- OBJECT METHODS --> |
| 339 <!-- OBJECT EVENT FIELDS --> |
| 340 <!-- FUNCTION PARAMETERS --> |
| 341 </div> |
| 342 </div><div> |
| 343 <div> |
| 344 <dt> |
| 345 <var>height</var> |
| 346 <em> |
| 347 <!-- TYPE --> |
| 348 <div style="display:inline"> |
| 349 ( |
| 350 <span class="optional">optional</span> |
| 351 <span id="typeTemplate"> |
| 352 <span> |
| 353 <span>integer</span> |
| 354 </span> |
| 355 </span> |
| 356 ) |
| 357 </div> |
| 358 </em> |
| 359 </dt> |
| 360 <dd>Height of the offscreen tab. Defaults to height of the current tab
.</dd> |
| 361 <!-- OBJECT PROPERTIES --> |
| 362 <!-- OBJECT METHODS --> |
| 363 <!-- OBJECT EVENT FIELDS --> |
| 364 <!-- FUNCTION PARAMETERS --> |
| 365 </div> |
| 366 </div> |
| 367 </dl> |
| 368 </dd> |
| 369 <!-- OBJECT METHODS --> |
| 370 <!-- OBJECT EVENT FIELDS --> |
| 371 <!-- FUNCTION PARAMETERS --> |
| 372 </div> |
| 373 </div><div> |
| 374 <div> |
| 375 <dt> |
| 376 <var>callback</var> |
| 377 <em> |
| 378 <!-- TYPE --> |
| 379 <div style="display:inline"> |
| 380 ( |
| 381 <span class="optional">optional</span> |
| 382 <span id="typeTemplate"> |
| 383 <span> |
| 384 <span>function</span> |
| 385 </span> |
| 386 </span> |
| 387 ) |
| 388 </div> |
| 389 </em> |
| 390 </dt> |
| 391 <dd class="todo"> |
| 392 Undocumented. |
| 393 </dd> |
| 394 <!-- OBJECT PROPERTIES --> |
| 395 <!-- OBJECT METHODS --> |
| 396 <!-- OBJECT EVENT FIELDS --> |
| 397 <!-- FUNCTION PARAMETERS --> |
| 398 </div> |
| 399 </div> |
| 400 </dl> |
| 401 <!-- RETURNS --> |
| 402 <dl> |
| 403 </dl> |
| 404 <!-- CALLBACK --> |
| 405 <div> |
| 406 <div> |
| 407 <h4>Callback function</h4> |
| 408 <p> |
| 409 If you specify the <em>callback</em> parameter, it should |
| 410 specify a function that looks like this: |
| 411 </p> |
| 412 <!-- Note: intentionally longer 80 columns --> |
| 413 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl
ass="subdued">{...}</span>;</pre> |
| 414 <dl> |
| 415 <div> |
| 416 <div> |
| 417 <dt> |
| 418 <var>offscreenTab</var> |
| 419 <em> |
| 420 <!-- TYPE --> |
| 421 <div style="display:inline"> |
| 422 ( |
| 423 <span class="optional">optional</span> |
| 424 <span id="typeTemplate"> |
| 425 <span> |
| 426 <a href="experimental.offscreenTabs.html#type-OffscreenT
ab">OffscreenTab</a> |
| 427 </span> |
| 428 </span> |
| 429 ) |
| 430 </div> |
| 431 </em> |
| 432 </dt> |
| 433 <dd>Details of the offscreen tab.</dd> |
| 434 <!-- OBJECT PROPERTIES --> |
| 435 <!-- OBJECT METHODS --> |
| 436 <!-- OBJECT EVENT FIELDS --> |
| 437 <!-- FUNCTION PARAMETERS --> |
| 438 </div> |
| 439 </div> |
| 440 </dl> |
| 441 </div> |
| 442 </div> |
| 443 <!-- MIN_VERSION --> |
| 444 </div> <!-- /description --> |
| 445 </div><div class="apiItem"> |
| 446 <a name="method-get"></a> <!-- method-anchor --> |
| 447 <h4>get</h4> |
| 448 <div class="summary"> |
| 449 <!-- Note: intentionally longer 80 columns --> |
| 450 <span>chrome.experimental.offscreenTabs.get</span>(<span class
="null"><span>integer</span> |
| 451 <var><span>offscreenTabId</span></var></span><span class="
null"><span>, </span><span>function</span> |
| 452 <var><span>callback</span></var></span>)</div> |
| 453 <div class="description"> |
| 454 <p>Gets details about the specified offscreen tab.</p> |
| 455 <!-- PARAMETERS --> |
| 456 <h4>Parameters</h4> |
| 457 <dl> |
| 458 <div> |
| 459 <div> |
| 460 <dt> |
| 461 <var>offscreenTabId</var> |
| 462 <em> |
| 463 <!-- TYPE --> |
| 464 <div style="display:inline"> |
| 465 ( |
| 466 <span id="typeTemplate"> |
| 467 <span> |
| 468 <span>integer</span> |
| 469 </span> |
| 470 </span> |
| 471 ) |
| 472 </div> |
| 473 </em> |
| 474 </dt> |
| 475 <dd>ID of the offscreen tab.</dd> |
| 476 <!-- OBJECT PROPERTIES --> |
| 477 <!-- OBJECT METHODS --> |
| 478 <!-- OBJECT EVENT FIELDS --> |
| 479 <!-- FUNCTION PARAMETERS --> |
| 480 </div> |
| 481 </div><div> |
| 482 <div> |
| 483 <dt> |
| 484 <var>callback</var> |
| 485 <em> |
| 486 <!-- TYPE --> |
| 487 <div style="display:inline"> |
| 488 ( |
| 489 <span id="typeTemplate"> |
| 490 <span> |
| 491 <span>function</span> |
| 492 </span> |
| 493 </span> |
| 494 ) |
| 495 </div> |
| 496 </em> |
| 497 </dt> |
| 498 <dd class="todo"> |
| 499 Undocumented. |
| 500 </dd> |
| 501 <!-- OBJECT PROPERTIES --> |
| 502 <!-- OBJECT METHODS --> |
| 503 <!-- OBJECT EVENT FIELDS --> |
| 504 <!-- FUNCTION PARAMETERS --> |
| 505 </div> |
| 506 </div> |
| 507 </dl> |
| 508 <!-- RETURNS --> |
| 509 <dl> |
| 510 </dl> |
| 511 <!-- CALLBACK --> |
| 512 <div> |
| 513 <div> |
| 514 <h4>Callback function</h4> |
| 515 <p> |
| 516 The callback <em>parameter</em> should specify a function |
| 517 that looks like this: |
| 518 </p> |
| 519 <!-- Note: intentionally longer 80 columns --> |
| 520 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl
ass="subdued">{...}</span>;</pre> |
| 521 <dl> |
| 522 <div> |
| 523 <div> |
| 524 <dt> |
| 525 <var>offscreenTab</var> |
| 526 <em> |
| 527 <!-- TYPE --> |
| 528 <div style="display:inline"> |
| 529 ( |
| 530 <span id="typeTemplate"> |
| 531 <span> |
| 532 <a href="experimental.offscreenTabs.html#type-OffscreenT
ab">OffscreenTab</a> |
| 533 </span> |
| 534 </span> |
| 535 ) |
| 536 </div> |
| 537 </em> |
| 538 </dt> |
| 539 <dd>Details of the offscreen tab.</dd> |
| 540 <!-- OBJECT PROPERTIES --> |
| 541 <!-- OBJECT METHODS --> |
| 542 <!-- OBJECT EVENT FIELDS --> |
| 543 <!-- FUNCTION PARAMETERS --> |
| 544 </div> |
| 545 </div> |
| 546 </dl> |
| 547 </div> |
| 548 </div> |
| 549 <!-- MIN_VERSION --> |
| 550 </div> <!-- /description --> |
| 551 </div><div class="apiItem"> |
| 552 <a name="method-getAll"></a> <!-- method-anchor --> |
| 553 <h4>getAll</h4> |
| 554 <div class="summary"> |
| 555 <!-- Note: intentionally longer 80 columns --> |
| 556 <span>chrome.experimental.offscreenTabs.getAll</span>(<span cl
ass="null"><span>function</span> |
| 557 <var><span>callback</span></var></span>)</div> |
| 558 <div class="description"> |
| 559 <p>Gets an array of all offscreen tabs.</p> |
| 560 <!-- PARAMETERS --> |
| 561 <h4>Parameters</h4> |
| 562 <dl> |
| 563 <div> |
| 564 <div> |
| 565 <dt> |
| 566 <var>callback</var> |
| 567 <em> |
| 568 <!-- TYPE --> |
| 569 <div style="display:inline"> |
| 570 ( |
| 571 <span id="typeTemplate"> |
| 572 <span> |
| 573 <span>function</span> |
| 574 </span> |
| 575 </span> |
| 576 ) |
| 577 </div> |
| 578 </em> |
| 579 </dt> |
| 580 <dd class="todo"> |
| 581 Undocumented. |
| 582 </dd> |
| 583 <!-- OBJECT PROPERTIES --> |
| 584 <!-- OBJECT METHODS --> |
| 585 <!-- OBJECT EVENT FIELDS --> |
| 586 <!-- FUNCTION PARAMETERS --> |
| 587 </div> |
| 588 </div> |
| 589 </dl> |
| 590 <!-- RETURNS --> |
| 591 <dl> |
| 592 </dl> |
| 593 <!-- CALLBACK --> |
| 594 <div> |
| 595 <div> |
| 596 <h4>Callback function</h4> |
| 597 <p> |
| 598 The callback <em>parameter</em> should specify a function |
| 599 that looks like this: |
| 600 </p> |
| 601 <!-- Note: intentionally longer 80 columns --> |
| 602 <pre>function(<span>array of OffscreenTab offscreenTabs</span>
) <span class="subdued">{...}</span>;</pre> |
| 603 <dl> |
| 604 <div> |
| 605 <div> |
| 606 <dt> |
| 607 <var>offscreenTabs</var> |
| 608 <em> |
| 609 <!-- TYPE --> |
| 610 <div style="display:inline"> |
| 611 ( |
| 612 <span id="typeTemplate"> |
| 613 <span> |
| 614 <span> |
| 615 array of <span><span> |
| 616 <span> |
| 617 <a href="experimental.offscreenTabs.html#type-OffscreenT
ab">OffscreenTab</a> |
| 618 </span> |
| 619 </span></span> |
| 620 </span> |
| 621 </span> |
| 622 </span> |
| 623 ) |
| 624 </div> |
| 625 </em> |
| 626 </dt> |
| 627 <dd class="todo"> |
| 628 Undocumented. |
| 629 </dd> |
| 630 <!-- OBJECT PROPERTIES --> |
| 631 <!-- OBJECT METHODS --> |
| 632 <!-- OBJECT EVENT FIELDS --> |
| 633 <!-- FUNCTION PARAMETERS --> |
| 634 </div> |
| 635 </div> |
| 636 </dl> |
| 637 </div> |
| 638 </div> |
| 639 <!-- MIN_VERSION --> |
| 640 </div> <!-- /description --> |
| 641 </div><div class="apiItem"> |
| 642 <a name="method-remove"></a> <!-- method-anchor --> |
| 643 <h4>remove</h4> |
| 644 <div class="summary"> |
| 645 <!-- Note: intentionally longer 80 columns --> |
| 646 <span>chrome.experimental.offscreenTabs.remove</span>(<span cl
ass="null"><span>integer</span> |
| 647 <var><span>offscreenTabId</span></var></span><span class="
optional"><span>, </span><span>function</span> |
| 648 <var><span>callback</span></var></span>)</div> |
| 649 <div class="description"> |
| 650 <p>Removes an offscreen tab.</p> |
| 651 <!-- PARAMETERS --> |
| 652 <h4>Parameters</h4> |
| 653 <dl> |
| 654 <div> |
| 655 <div> |
| 656 <dt> |
| 657 <var>offscreenTabId</var> |
| 658 <em> |
| 659 <!-- TYPE --> |
| 660 <div style="display:inline"> |
| 661 ( |
| 662 <span id="typeTemplate"> |
| 663 <span> |
| 664 <span>integer</span> |
| 665 </span> |
| 666 </span> |
| 667 ) |
| 668 </div> |
| 669 </em> |
| 670 </dt> |
| 671 <dd>ID of the offscreen tab.</dd> |
| 672 <!-- OBJECT PROPERTIES --> |
| 673 <!-- OBJECT METHODS --> |
| 674 <!-- OBJECT EVENT FIELDS --> |
| 675 <!-- FUNCTION PARAMETERS --> |
| 676 </div> |
| 677 </div><div> |
| 678 <div> |
| 679 <dt> |
| 680 <var>callback</var> |
| 681 <em> |
| 682 <!-- TYPE --> |
| 683 <div style="display:inline"> |
| 684 ( |
| 685 <span class="optional">optional</span> |
| 686 <span id="typeTemplate"> |
| 687 <span> |
| 688 <span>function</span> |
| 689 </span> |
| 690 </span> |
| 691 ) |
| 692 </div> |
| 693 </em> |
| 694 </dt> |
| 695 <dd class="todo"> |
| 696 Undocumented. |
| 697 </dd> |
| 698 <!-- OBJECT PROPERTIES --> |
| 699 <!-- OBJECT METHODS --> |
| 700 <!-- OBJECT EVENT FIELDS --> |
| 701 <!-- FUNCTION PARAMETERS --> |
| 702 </div> |
| 703 </div> |
| 704 </dl> |
| 705 <!-- RETURNS --> |
| 706 <dl> |
| 707 </dl> |
| 708 <!-- CALLBACK --> |
| 709 <div> |
| 710 <div> |
| 711 <h4>Callback function</h4> |
| 712 <p> |
| 713 If you specify the <em>callback</em> parameter, it should |
| 714 specify a function that looks like this: |
| 715 </p> |
| 716 <!-- Note: intentionally longer 80 columns --> |
| 717 <pre>function(<span>null</span>) <span class="subdued">{...}</
span>;</pre> |
| 718 <dl> |
| 719 </dl> |
| 720 </div> |
| 721 </div> |
| 722 <!-- MIN_VERSION --> |
| 723 </div> <!-- /description --> |
| 724 </div><div class="apiItem"> |
| 725 <a name="method-sendKeyboardEvent"></a> <!-- method-anchor --> |
| 726 <h4>sendKeyboardEvent</h4> |
| 727 <div class="summary"> |
| 728 <!-- Note: intentionally longer 80 columns --> |
| 729 <span>chrome.experimental.offscreenTabs.sendKeyboardEvent</spa
n>(<span class="null"><span>integer</span> |
| 730 <var><span>offscreenTabId</span></var></span><span class="
null"><span>, </span><span>any</span> |
| 731 <var><span>keyboardEvent</span></var></span><span class="o
ptional"><span>, </span><span>function</span> |
| 732 <var><span>callback</span></var></span>)</div> |
| 733 <div class="description"> |
| 734 <p>Dispatches a keyboard event in the offscreen tab.</p> |
| 735 <!-- PARAMETERS --> |
| 736 <h4>Parameters</h4> |
| 737 <dl> |
| 738 <div> |
| 739 <div> |
| 740 <dt> |
| 741 <var>offscreenTabId</var> |
| 742 <em> |
| 743 <!-- TYPE --> |
| 744 <div style="display:inline"> |
| 745 ( |
| 746 <span id="typeTemplate"> |
| 747 <span> |
| 748 <span>integer</span> |
| 749 </span> |
| 750 </span> |
| 751 ) |
| 752 </div> |
| 753 </em> |
| 754 </dt> |
| 755 <dd>ID of the offscreen tab.</dd> |
| 756 <!-- OBJECT PROPERTIES --> |
| 757 <!-- OBJECT METHODS --> |
| 758 <!-- OBJECT EVENT FIELDS --> |
| 759 <!-- FUNCTION PARAMETERS --> |
| 760 </div> |
| 761 </div><div> |
| 762 <div> |
| 763 <dt> |
| 764 <var>keyboardEvent</var> |
| 765 <em> |
| 766 <!-- TYPE --> |
| 767 <div style="display:inline"> |
| 768 ( |
| 769 <span id="typeTemplate"> |
| 770 <span> |
| 771 <span>any</span> |
| 772 </span> |
| 773 </span> |
| 774 ) |
| 775 </div> |
| 776 </em> |
| 777 </dt> |
| 778 <dd>A JavaScript KeyboardEvent object. Supported event types: <i>keydo
wn</i>, <i>keyup</i>, <i>keypress</i>. Note, only <i>keypress</i> produces a vis
ible result on screen.</dd> |
| 779 <!-- OBJECT PROPERTIES --> |
| 780 <!-- OBJECT METHODS --> |
| 781 <!-- OBJECT EVENT FIELDS --> |
| 782 <!-- FUNCTION PARAMETERS --> |
| 783 </div> |
| 784 </div><div> |
| 785 <div> |
| 786 <dt> |
| 787 <var>callback</var> |
| 788 <em> |
| 789 <!-- TYPE --> |
| 790 <div style="display:inline"> |
| 791 ( |
| 792 <span class="optional">optional</span> |
| 793 <span id="typeTemplate"> |
| 794 <span> |
| 795 <span>function</span> |
| 796 </span> |
| 797 </span> |
| 798 ) |
| 799 </div> |
| 800 </em> |
| 801 </dt> |
| 802 <dd class="todo"> |
| 803 Undocumented. |
| 804 </dd> |
| 805 <!-- OBJECT PROPERTIES --> |
| 806 <!-- OBJECT METHODS --> |
| 807 <!-- OBJECT EVENT FIELDS --> |
| 808 <!-- FUNCTION PARAMETERS --> |
| 809 </div> |
| 810 </div> |
| 811 </dl> |
| 812 <!-- RETURNS --> |
| 813 <dl> |
| 814 </dl> |
| 815 <!-- CALLBACK --> |
| 816 <div> |
| 817 <div> |
| 818 <h4>Callback function</h4> |
| 819 <p> |
| 820 If you specify the <em>callback</em> parameter, it should |
| 821 specify a function that looks like this: |
| 822 </p> |
| 823 <!-- Note: intentionally longer 80 columns --> |
| 824 <pre>function(<span></span>) <span class="subdued">{...}</span
>;</pre> |
| 825 <dl> |
| 826 </dl> |
| 827 </div> |
| 828 </div> |
| 829 <!-- MIN_VERSION --> |
| 830 </div> <!-- /description --> |
| 831 </div><div class="apiItem"> |
| 832 <a name="method-sendMouseEvent"></a> <!-- method-anchor --> |
| 833 <h4>sendMouseEvent</h4> |
| 834 <div class="summary"> |
| 835 <!-- Note: intentionally longer 80 columns --> |
| 836 <span>chrome.experimental.offscreenTabs.sendMouseEvent</span>(
<span class="null"><span>integer</span> |
| 837 <var><span>offscreenTabId</span></var></span><span class="
null"><span>, </span><span>any</span> |
| 838 <var><span>mouseEvent</span></var></span><span class="opti
onal"><span>, </span><span>integer</span> |
| 839 <var><span>x</span></var></span><span class="optional"><sp
an>, </span><span>integer</span> |
| 840 <var><span>y</span></var></span><span class="optional"><sp
an>, </span><span>function</span> |
| 841 <var><span>callback</span></var></span>)</div> |
| 842 <div class="description"> |
| 843 <p>Dispatches a mouse event in the offscreen tab.</p> |
| 844 <!-- PARAMETERS --> |
| 845 <h4>Parameters</h4> |
| 846 <dl> |
| 847 <div> |
| 848 <div> |
| 849 <dt> |
| 850 <var>offscreenTabId</var> |
| 851 <em> |
| 852 <!-- TYPE --> |
| 853 <div style="display:inline"> |
| 854 ( |
| 855 <span id="typeTemplate"> |
| 856 <span> |
| 857 <span>integer</span> |
| 858 </span> |
| 859 </span> |
| 860 ) |
| 861 </div> |
| 862 </em> |
| 863 </dt> |
| 864 <dd>ID of the offscreen tab.</dd> |
| 865 <!-- OBJECT PROPERTIES --> |
| 866 <!-- OBJECT METHODS --> |
| 867 <!-- OBJECT EVENT FIELDS --> |
| 868 <!-- FUNCTION PARAMETERS --> |
| 869 </div> |
| 870 </div><div> |
| 871 <div> |
| 872 <dt> |
| 873 <var>mouseEvent</var> |
| 874 <em> |
| 875 <!-- TYPE --> |
| 876 <div style="display:inline"> |
| 877 ( |
| 878 <span id="typeTemplate"> |
| 879 <span> |
| 880 <span>any</span> |
| 881 </span> |
| 882 </span> |
| 883 ) |
| 884 </div> |
| 885 </em> |
| 886 </dt> |
| 887 <dd>A JavaScript MouseEvent object. Supported event types: <i>mousedow
n</i>, <i>mouseup</i>, <i>click</i>, <i>mousemove</i>, <i>mousewheel</i>.</dd> |
| 888 <!-- OBJECT PROPERTIES --> |
| 889 <!-- OBJECT METHODS --> |
| 890 <!-- OBJECT EVENT FIELDS --> |
| 891 <!-- FUNCTION PARAMETERS --> |
| 892 </div> |
| 893 </div><div> |
| 894 <div> |
| 895 <dt> |
| 896 <var>x</var> |
| 897 <em> |
| 898 <!-- TYPE --> |
| 899 <div style="display:inline"> |
| 900 ( |
| 901 <span class="optional">optional</span> |
| 902 <span id="typeTemplate"> |
| 903 <span> |
| 904 <span>integer</span> |
| 905 </span> |
| 906 </span> |
| 907 ) |
| 908 </div> |
| 909 </em> |
| 910 </dt> |
| 911 <dd>X position of where the mouse event should be dispatched on the of
fscreen web page. Not required in the case of a mousewheel event.</dd> |
| 912 <!-- OBJECT PROPERTIES --> |
| 913 <!-- OBJECT METHODS --> |
| 914 <!-- OBJECT EVENT FIELDS --> |
| 915 <!-- FUNCTION PARAMETERS --> |
| 916 </div> |
| 917 </div><div> |
| 918 <div> |
| 919 <dt> |
| 920 <var>y</var> |
| 921 <em> |
| 922 <!-- TYPE --> |
| 923 <div style="display:inline"> |
| 924 ( |
| 925 <span class="optional">optional</span> |
| 926 <span id="typeTemplate"> |
| 927 <span> |
| 928 <span>integer</span> |
| 929 </span> |
| 930 </span> |
| 931 ) |
| 932 </div> |
| 933 </em> |
| 934 </dt> |
| 935 <dd>Y position of where the mouse event should be dispatched on the of
fscreen web page. Not required in the case of a mousewheel event.</dd> |
| 936 <!-- OBJECT PROPERTIES --> |
| 937 <!-- OBJECT METHODS --> |
| 938 <!-- OBJECT EVENT FIELDS --> |
| 939 <!-- FUNCTION PARAMETERS --> |
| 940 </div> |
| 941 </div><div> |
| 942 <div> |
| 943 <dt> |
| 944 <var>callback</var> |
| 945 <em> |
| 946 <!-- TYPE --> |
| 947 <div style="display:inline"> |
| 948 ( |
| 949 <span class="optional">optional</span> |
| 950 <span id="typeTemplate"> |
| 951 <span> |
| 952 <span>function</span> |
| 953 </span> |
| 954 </span> |
| 955 ) |
| 956 </div> |
| 957 </em> |
| 958 </dt> |
| 959 <dd class="todo"> |
| 960 Undocumented. |
| 961 </dd> |
| 962 <!-- OBJECT PROPERTIES --> |
| 963 <!-- OBJECT METHODS --> |
| 964 <!-- OBJECT EVENT FIELDS --> |
| 965 <!-- FUNCTION PARAMETERS --> |
| 966 </div> |
| 967 </div> |
| 968 </dl> |
| 969 <!-- RETURNS --> |
| 970 <dl> |
| 971 </dl> |
| 972 <!-- CALLBACK --> |
| 973 <div> |
| 974 <div> |
| 975 <h4>Callback function</h4> |
| 976 <p> |
| 977 If you specify the <em>callback</em> parameter, it should |
| 978 specify a function that looks like this: |
| 979 </p> |
| 980 <!-- Note: intentionally longer 80 columns --> |
| 981 <pre>function(<span></span>) <span class="subdued">{...}</span
>;</pre> |
| 982 <dl> |
| 983 </dl> |
| 984 </div> |
| 985 </div> |
| 986 <!-- MIN_VERSION --> |
| 987 </div> <!-- /description --> |
| 988 </div><div class="apiItem"> |
| 989 <a name="method-toDataUrl"></a> <!-- method-anchor --> |
| 990 <h4>toDataUrl</h4> |
| 991 <div class="summary"> |
| 992 <!-- Note: intentionally longer 80 columns --> |
| 993 <span>chrome.experimental.offscreenTabs.toDataUrl</span>(<span
class="null"><span>integer</span> |
| 994 <var><span>offscreenTabId</span></var></span><span class="
optional"><span>, </span><span>object</span> |
| 995 <var><span>options</span></var></span><span class="null"><
span>, </span><span>function</span> |
| 996 <var><span>callback</span></var></span>)</div> |
| 997 <div class="description"> |
| 998 <p>Captures the visible area of an offscreen tab. </p> |
| 999 <!-- PARAMETERS --> |
| 1000 <h4>Parameters</h4> |
| 1001 <dl> |
| 1002 <div> |
| 1003 <div> |
| 1004 <dt> |
| 1005 <var>offscreenTabId</var> |
| 1006 <em> |
| 1007 <!-- TYPE --> |
| 1008 <div style="display:inline"> |
| 1009 ( |
| 1010 <span id="typeTemplate"> |
| 1011 <span> |
| 1012 <span>integer</span> |
| 1013 </span> |
| 1014 </span> |
| 1015 ) |
| 1016 </div> |
| 1017 </em> |
| 1018 </dt> |
| 1019 <dd>The ID of the offscreen tab.</dd> |
| 1020 <!-- OBJECT PROPERTIES --> |
| 1021 <!-- OBJECT METHODS --> |
| 1022 <!-- OBJECT EVENT FIELDS --> |
| 1023 <!-- FUNCTION PARAMETERS --> |
| 1024 </div> |
| 1025 </div><div> |
| 1026 <div> |
| 1027 <dt> |
| 1028 <var>options</var> |
| 1029 <em> |
| 1030 <!-- TYPE --> |
| 1031 <div style="display:inline"> |
| 1032 ( |
| 1033 <span class="optional">optional</span> |
| 1034 <span id="typeTemplate"> |
| 1035 <span> |
| 1036 <span>object</span> |
| 1037 </span> |
| 1038 </span> |
| 1039 ) |
| 1040 </div> |
| 1041 </em> |
| 1042 </dt> |
| 1043 <dd>Set parameters of image capture, such as the format of the resulti
ng image.</dd> |
| 1044 <!-- OBJECT PROPERTIES --> |
| 1045 <dd> |
| 1046 <dl> |
| 1047 <div> |
| 1048 <div> |
| 1049 <dt> |
| 1050 <var>format</var> |
| 1051 <em> |
| 1052 <!-- TYPE --> |
| 1053 <div style="display:inline"> |
| 1054 ( |
| 1055 <span class="optional">optional</span> |
| 1056 <span class="enum">enumerated</span> |
| 1057 <span id="typeTemplate"> |
| 1058 <span> |
| 1059 <span>string</span> |
| 1060 <span>["jpeg", "png"]</span> |
| 1061 </span> |
| 1062 </span> |
| 1063 ) |
| 1064 </div> |
| 1065 </em> |
| 1066 </dt> |
| 1067 <dd>The format of the resulting image. Default is jpeg.</dd> |
| 1068 <!-- OBJECT PROPERTIES --> |
| 1069 <!-- OBJECT METHODS --> |
| 1070 <!-- OBJECT EVENT FIELDS --> |
| 1071 <!-- FUNCTION PARAMETERS --> |
| 1072 </div> |
| 1073 </div><div> |
| 1074 <div> |
| 1075 <dt> |
| 1076 <var>quality</var> |
| 1077 <em> |
| 1078 <!-- TYPE --> |
| 1079 <div style="display:inline"> |
| 1080 ( |
| 1081 <span class="optional">optional</span> |
| 1082 <span id="typeTemplate"> |
| 1083 <span> |
| 1084 <span>integer</span> |
| 1085 </span> |
| 1086 </span> |
| 1087 ) |
| 1088 </div> |
| 1089 </em> |
| 1090 </dt> |
| 1091 <dd>When format is 'jpeg', controls the quality of the resulting image
. This value is ignored for PNG images. As quality is decreased, the resulting i
mage will have more visual artifacts, and the number of bytes needed to store it
will decrease.</dd> |
| 1092 <!-- OBJECT PROPERTIES --> |
| 1093 <!-- OBJECT METHODS --> |
| 1094 <!-- OBJECT EVENT FIELDS --> |
| 1095 <!-- FUNCTION PARAMETERS --> |
| 1096 </div> |
| 1097 </div> |
| 1098 </dl> |
| 1099 </dd> |
| 1100 <!-- OBJECT METHODS --> |
| 1101 <!-- OBJECT EVENT FIELDS --> |
| 1102 <!-- FUNCTION PARAMETERS --> |
| 1103 </div> |
| 1104 </div><div> |
| 1105 <div> |
| 1106 <dt> |
| 1107 <var>callback</var> |
| 1108 <em> |
| 1109 <!-- TYPE --> |
| 1110 <div style="display:inline"> |
| 1111 ( |
| 1112 <span id="typeTemplate"> |
| 1113 <span> |
| 1114 <span>function</span> |
| 1115 </span> |
| 1116 </span> |
| 1117 ) |
| 1118 </div> |
| 1119 </em> |
| 1120 </dt> |
| 1121 <dd class="todo"> |
| 1122 Undocumented. |
| 1123 </dd> |
| 1124 <!-- OBJECT PROPERTIES --> |
| 1125 <!-- OBJECT METHODS --> |
| 1126 <!-- OBJECT EVENT FIELDS --> |
| 1127 <!-- FUNCTION PARAMETERS --> |
| 1128 </div> |
| 1129 </div> |
| 1130 </dl> |
| 1131 <!-- RETURNS --> |
| 1132 <dl> |
| 1133 </dl> |
| 1134 <!-- CALLBACK --> |
| 1135 <div> |
| 1136 <div> |
| 1137 <h4>Callback function</h4> |
| 1138 <p> |
| 1139 The callback <em>parameter</em> should specify a function |
| 1140 that looks like this: |
| 1141 </p> |
| 1142 <!-- Note: intentionally longer 80 columns --> |
| 1143 <pre>function(<span>string dataUrl</span>) <span class="subdue
d">{...}</span>;</pre> |
| 1144 <dl> |
| 1145 <div> |
| 1146 <div> |
| 1147 <dt> |
| 1148 <var>dataUrl</var> |
| 1149 <em> |
| 1150 <!-- TYPE --> |
| 1151 <div style="display:inline"> |
| 1152 ( |
| 1153 <span id="typeTemplate"> |
| 1154 <span> |
| 1155 <span>string</span> |
| 1156 </span> |
| 1157 </span> |
| 1158 ) |
| 1159 </div> |
| 1160 </em> |
| 1161 </dt> |
| 1162 <dd>A data URL which encodes an image of the visible area of the captu
red offscreen tab. May be assigned to the 'src' property of an HTML Image elemen
t or WebGL texture source for display.</dd> |
| 1163 <!-- OBJECT PROPERTIES --> |
| 1164 <!-- OBJECT METHODS --> |
| 1165 <!-- OBJECT EVENT FIELDS --> |
| 1166 <!-- FUNCTION PARAMETERS --> |
| 1167 </div> |
| 1168 </div> |
| 1169 </dl> |
| 1170 </div> |
| 1171 </div> |
| 1172 <!-- MIN_VERSION --> |
| 1173 </div> <!-- /description --> |
| 1174 </div><div class="apiItem"> |
| 1175 <a name="method-update"></a> <!-- method-anchor --> |
| 1176 <h4>update</h4> |
| 1177 <div class="summary"> |
| 1178 <!-- Note: intentionally longer 80 columns --> |
| 1179 <span>chrome.experimental.offscreenTabs.update</span>(<span cl
ass="null"><span>integer</span> |
| 1180 <var><span>offscreenTabId</span></var></span><span class="
null"><span>, </span><span>object</span> |
| 1181 <var><span>updateProperties</span></var></span><span class
="optional"><span>, </span><span>function</span> |
| 1182 <var><span>callback</span></var></span>)</div> |
| 1183 <div class="description"> |
| 1184 <p>Modifies the properties of an offscreen tab. Properties that
are not specified in updateProperties are not modified.</p> |
| 1185 <!-- PARAMETERS --> |
| 1186 <h4>Parameters</h4> |
| 1187 <dl> |
| 1188 <div> |
| 1189 <div> |
| 1190 <dt> |
| 1191 <var>offscreenTabId</var> |
| 1192 <em> |
| 1193 <!-- TYPE --> |
| 1194 <div style="display:inline"> |
| 1195 ( |
| 1196 <span id="typeTemplate"> |
| 1197 <span> |
| 1198 <span>integer</span> |
| 1199 </span> |
| 1200 </span> |
| 1201 ) |
| 1202 </div> |
| 1203 </em> |
| 1204 </dt> |
| 1205 <dd>The ID of the offscreen tab.</dd> |
| 1206 <!-- OBJECT PROPERTIES --> |
| 1207 <!-- OBJECT METHODS --> |
| 1208 <!-- OBJECT EVENT FIELDS --> |
| 1209 <!-- FUNCTION PARAMETERS --> |
| 1210 </div> |
| 1211 </div><div> |
| 1212 <div> |
| 1213 <dt> |
| 1214 <var>updateProperties</var> |
| 1215 <em> |
| 1216 <!-- TYPE --> |
| 1217 <div style="display:inline"> |
| 1218 ( |
| 1219 <span id="typeTemplate"> |
| 1220 <span> |
| 1221 <span>object</span> |
| 1222 </span> |
| 1223 </span> |
| 1224 ) |
| 1225 </div> |
| 1226 </em> |
| 1227 </dt> |
| 1228 <dd class="todo"> |
| 1229 Undocumented. |
| 1230 </dd> |
| 1231 <!-- OBJECT PROPERTIES --> |
| 1232 <dd> |
| 1233 <dl> |
| 1234 <div> |
| 1235 <div> |
| 1236 <dt> |
| 1237 <var>url</var> |
| 1238 <em> |
| 1239 <!-- TYPE --> |
| 1240 <div style="display:inline"> |
| 1241 ( |
| 1242 <span class="optional">optional</span> |
| 1243 <span id="typeTemplate"> |
| 1244 <span> |
| 1245 <span>string</span> |
| 1246 </span> |
| 1247 </span> |
| 1248 ) |
| 1249 </div> |
| 1250 </em> |
| 1251 </dt> |
| 1252 <dd>The URL the offscreen tab is displaying.</dd> |
| 1253 <!-- OBJECT PROPERTIES --> |
| 1254 <!-- OBJECT METHODS --> |
| 1255 <!-- OBJECT EVENT FIELDS --> |
| 1256 <!-- FUNCTION PARAMETERS --> |
| 1257 </div> |
| 1258 </div><div> |
| 1259 <div> |
| 1260 <dt> |
| 1261 <var>width</var> |
| 1262 <em> |
| 1263 <!-- TYPE --> |
| 1264 <div style="display:inline"> |
| 1265 ( |
| 1266 <span class="optional">optional</span> |
| 1267 <span id="typeTemplate"> |
| 1268 <span> |
| 1269 <span>integer</span> |
| 1270 </span> |
| 1271 </span> |
| 1272 ) |
| 1273 </div> |
| 1274 </em> |
| 1275 </dt> |
| 1276 <dd>Width of the window.</dd> |
| 1277 <!-- OBJECT PROPERTIES --> |
| 1278 <!-- OBJECT METHODS --> |
| 1279 <!-- OBJECT EVENT FIELDS --> |
| 1280 <!-- FUNCTION PARAMETERS --> |
| 1281 </div> |
| 1282 </div><div> |
| 1283 <div> |
| 1284 <dt> |
| 1285 <var>height</var> |
| 1286 <em> |
| 1287 <!-- TYPE --> |
| 1288 <div style="display:inline"> |
| 1289 ( |
| 1290 <span class="optional">optional</span> |
| 1291 <span id="typeTemplate"> |
| 1292 <span> |
| 1293 <span>integer</span> |
| 1294 </span> |
| 1295 </span> |
| 1296 ) |
| 1297 </div> |
| 1298 </em> |
| 1299 </dt> |
| 1300 <dd>Height of the window.</dd> |
| 1301 <!-- OBJECT PROPERTIES --> |
| 1302 <!-- OBJECT METHODS --> |
| 1303 <!-- OBJECT EVENT FIELDS --> |
| 1304 <!-- FUNCTION PARAMETERS --> |
| 1305 </div> |
| 1306 </div> |
| 1307 </dl> |
| 1308 </dd> |
| 1309 <!-- OBJECT METHODS --> |
| 1310 <!-- OBJECT EVENT FIELDS --> |
| 1311 <!-- FUNCTION PARAMETERS --> |
| 1312 </div> |
| 1313 </div><div> |
| 1314 <div> |
| 1315 <dt> |
| 1316 <var>callback</var> |
| 1317 <em> |
| 1318 <!-- TYPE --> |
| 1319 <div style="display:inline"> |
| 1320 ( |
| 1321 <span class="optional">optional</span> |
| 1322 <span id="typeTemplate"> |
| 1323 <span> |
| 1324 <span>function</span> |
| 1325 </span> |
| 1326 </span> |
| 1327 ) |
| 1328 </div> |
| 1329 </em> |
| 1330 </dt> |
| 1331 <dd class="todo"> |
| 1332 Undocumented. |
| 1333 </dd> |
| 1334 <!-- OBJECT PROPERTIES --> |
| 1335 <!-- OBJECT METHODS --> |
| 1336 <!-- OBJECT EVENT FIELDS --> |
| 1337 <!-- FUNCTION PARAMETERS --> |
| 1338 </div> |
| 1339 </div> |
| 1340 </dl> |
| 1341 <!-- RETURNS --> |
| 1342 <dl> |
| 1343 </dl> |
| 1344 <!-- CALLBACK --> |
| 1345 <div> |
| 1346 <div> |
| 1347 <h4>Callback function</h4> |
| 1348 <p> |
| 1349 If you specify the <em>callback</em> parameter, it should |
| 1350 specify a function that looks like this: |
| 1351 </p> |
| 1352 <!-- Note: intentionally longer 80 columns --> |
| 1353 <pre>function(<span></span>) <span class="subdued">{...}</span
>;</pre> |
| 1354 <dl> |
| 1355 </dl> |
| 1356 </div> |
| 1357 </div> |
| 1358 <!-- MIN_VERSION --> |
| 1359 </div> <!-- /description --> |
| 1360 </div> <!-- /apiItem --> |
| 1361 </div> <!-- /apiGroup --> |
| 1362 <!-- EVENTS --> |
| 1363 <div id="eventsTemplate" class="apiGroup"> |
| 1364 <a name="global-events"></a> |
| 1365 <h3>Events</h3> |
| 1366 <!-- iterates over all events --> |
| 1367 <div class="apiItem"> |
| 1368 <a name="event-onUpdated"></a> |
| 1369 <h4>onUpdated</h4> |
| 1370 <div class="summary"> |
| 1371 <!-- Note: intentionally longer 80 columns --> |
| 1372 <span class="subdued">chrome.experimental.offscreenTabs.</span><
span>onUpdated</span><span class="subdued">.addListener</span>(function(<span>in
teger offscreenTabId, object changeInfo, OffscreenTab offscreenTab</span>) <span
class="subdued">{...}</span><span></span>); |
| 1373 </div> |
| 1374 <div class="description"> |
| 1375 <p>Fires when an offscreen tab is updated. </p> |
| 1376 <!-- LISTENER PARAMETERS --> |
| 1377 <div> |
| 1378 <h4>Listener parameters</h4> |
| 1379 <dl> |
| 1380 <div> |
| 1381 <div> |
| 1382 <dt> |
| 1383 <var>offscreenTabId</var> |
| 1384 <em> |
| 1385 <!-- TYPE --> |
| 1386 <div style="display:inline"> |
| 1387 ( |
| 1388 <span id="typeTemplate"> |
| 1389 <span> |
| 1390 <span>integer</span> |
| 1391 </span> |
| 1392 </span> |
| 1393 ) |
| 1394 </div> |
| 1395 </em> |
| 1396 </dt> |
| 1397 <dd>ID of the updated offscreen tab</dd> |
| 1398 <!-- OBJECT PROPERTIES --> |
| 1399 <!-- OBJECT METHODS --> |
| 1400 <!-- OBJECT EVENT FIELDS --> |
| 1401 <!-- FUNCTION PARAMETERS --> |
| 1402 </div> |
| 1403 </div><div> |
| 1404 <div> |
| 1405 <dt> |
| 1406 <var>changeInfo</var> |
| 1407 <em> |
| 1408 <!-- TYPE --> |
| 1409 <div style="display:inline"> |
| 1410 ( |
| 1411 <span id="typeTemplate"> |
| 1412 <span> |
| 1413 <span>object</span> |
| 1414 </span> |
| 1415 </span> |
| 1416 ) |
| 1417 </div> |
| 1418 </em> |
| 1419 </dt> |
| 1420 <dd>Lists the changes to the state of the offscreen tab that was updat
ed.</dd> |
| 1421 <!-- OBJECT PROPERTIES --> |
| 1422 <dd> |
| 1423 <dl> |
| 1424 <div> |
| 1425 <div> |
| 1426 <dt> |
| 1427 <var>url</var> |
| 1428 <em> |
| 1429 <!-- TYPE --> |
| 1430 <div style="display:inline"> |
| 1431 ( |
| 1432 <span class="optional">optional</span> |
| 1433 <span id="typeTemplate"> |
| 1434 <span> |
| 1435 <span>string</span> |
| 1436 </span> |
| 1437 </span> |
| 1438 ) |
| 1439 </div> |
| 1440 </em> |
| 1441 </dt> |
| 1442 <dd>The offscreen tab's URL if it has changed.</dd> |
| 1443 <!-- OBJECT PROPERTIES --> |
| 1444 <!-- OBJECT METHODS --> |
| 1445 <!-- OBJECT EVENT FIELDS --> |
| 1446 <!-- FUNCTION PARAMETERS --> |
| 1447 </div> |
| 1448 </div> |
| 1449 </dl> |
| 1450 </dd> |
| 1451 <!-- OBJECT METHODS --> |
| 1452 <!-- OBJECT EVENT FIELDS --> |
| 1453 <!-- FUNCTION PARAMETERS --> |
| 1454 </div> |
| 1455 </div><div> |
| 1456 <div> |
| 1457 <dt> |
| 1458 <var>offscreenTab</var> |
| 1459 <em> |
| 1460 <!-- TYPE --> |
| 1461 <div style="display:inline"> |
| 1462 ( |
| 1463 <span id="typeTemplate"> |
| 1464 <span> |
| 1465 <a href="experimental.offscreenTabs.html#type-OffscreenT
ab">OffscreenTab</a> |
| 1466 </span> |
| 1467 </span> |
| 1468 ) |
| 1469 </div> |
| 1470 </em> |
| 1471 </dt> |
| 1472 <dd>Details of the offscreen tab.</dd> |
| 1473 <!-- OBJECT PROPERTIES --> |
| 1474 <!-- OBJECT METHODS --> |
| 1475 <!-- OBJECT EVENT FIELDS --> |
| 1476 <!-- FUNCTION PARAMETERS --> |
| 1477 </div> |
| 1478 </div> |
| 1479 </dl> |
| 1480 </div> |
| 1481 <!-- EXTRA PARAMETERS --> |
| 1482 <!-- LISTENER RETURN VALUE --> |
| 1483 <dl> |
| 1484 </dl> |
| 1485 </div> <!-- /description --> |
| 1486 </div> <!-- /apiItem --> |
| 1487 </div> <!-- /apiGroup --> |
| 1488 <!-- TYPES --> |
| 1489 <div class="apiGroup"> |
| 1490 <a name="types"></a> |
| 1491 <h3 id="types">Types</h3> |
| 1492 <!-- iterates over all types --> |
| 1493 <div class="apiItem"> |
| 1494 <a name="type-OffscreenTab"></a> |
| 1495 <h4>OffscreenTab</h4> |
| 1496 <div> |
| 1497 <dt> |
| 1498 <em> |
| 1499 <!-- TYPE --> |
| 1500 <div style="display:inline"> |
| 1501 ( |
| 1502 <span id="typeTemplate"> |
| 1503 <span> |
| 1504 <span>object</span> |
| 1505 </span> |
| 1506 </span> |
| 1507 ) |
| 1508 </div> |
| 1509 </em> |
| 1510 </dt> |
| 1511 <dd class="todo"> |
| 1512 Undocumented. |
| 1513 </dd> |
| 1514 <!-- OBJECT PROPERTIES --> |
| 1515 <dd> |
| 1516 <dl> |
| 1517 <div> |
| 1518 <div> |
| 1519 <dt> |
| 1520 <var>id</var> |
| 1521 <em> |
| 1522 <!-- TYPE --> |
| 1523 <div style="display:inline"> |
| 1524 ( |
| 1525 <span id="typeTemplate"> |
| 1526 <span> |
| 1527 <span>integer</span> |
| 1528 </span> |
| 1529 </span> |
| 1530 ) |
| 1531 </div> |
| 1532 </em> |
| 1533 </dt> |
| 1534 <dd>The ID of the offscreen tab. Tab IDs are unique within a browser s
ession.</dd> |
| 1535 <!-- OBJECT PROPERTIES --> |
| 1536 <!-- OBJECT METHODS --> |
| 1537 <!-- OBJECT EVENT FIELDS --> |
| 1538 <!-- FUNCTION PARAMETERS --> |
| 1539 </div> |
| 1540 </div><div> |
| 1541 <div> |
| 1542 <dt> |
| 1543 <var>url</var> |
| 1544 <em> |
| 1545 <!-- TYPE --> |
| 1546 <div style="display:inline"> |
| 1547 ( |
| 1548 <span id="typeTemplate"> |
| 1549 <span> |
| 1550 <span>string</span> |
| 1551 </span> |
| 1552 </span> |
| 1553 ) |
| 1554 </div> |
| 1555 </em> |
| 1556 </dt> |
| 1557 <dd>URL of the offscreen tab.</dd> |
| 1558 <!-- OBJECT PROPERTIES --> |
| 1559 <!-- OBJECT METHODS --> |
| 1560 <!-- OBJECT EVENT FIELDS --> |
| 1561 <!-- FUNCTION PARAMETERS --> |
| 1562 </div> |
| 1563 </div><div> |
| 1564 <div> |
| 1565 <dt> |
| 1566 <var>width</var> |
| 1567 <em> |
| 1568 <!-- TYPE --> |
| 1569 <div style="display:inline"> |
| 1570 ( |
| 1571 <span id="typeTemplate"> |
| 1572 <span> |
| 1573 <span>integer</span> |
| 1574 </span> |
| 1575 </span> |
| 1576 ) |
| 1577 </div> |
| 1578 </em> |
| 1579 </dt> |
| 1580 <dd>Width of the window.</dd> |
| 1581 <!-- OBJECT PROPERTIES --> |
| 1582 <!-- OBJECT METHODS --> |
| 1583 <!-- OBJECT EVENT FIELDS --> |
| 1584 <!-- FUNCTION PARAMETERS --> |
| 1585 </div> |
| 1586 </div><div> |
| 1587 <div> |
| 1588 <dt> |
| 1589 <var>height</var> |
| 1590 <em> |
| 1591 <!-- TYPE --> |
| 1592 <div style="display:inline"> |
| 1593 ( |
| 1594 <span id="typeTemplate"> |
| 1595 <span> |
| 1596 <span>integer</span> |
| 1597 </span> |
| 1598 </span> |
| 1599 ) |
| 1600 </div> |
| 1601 </em> |
| 1602 </dt> |
| 1603 <dd>Height of the window.</dd> |
| 1604 <!-- OBJECT PROPERTIES --> |
| 1605 <!-- OBJECT METHODS --> |
| 1606 <!-- OBJECT EVENT FIELDS --> |
| 1607 <!-- FUNCTION PARAMETERS --> |
| 1608 </div> |
| 1609 </div> |
| 1610 </dl> |
| 1611 </dd> |
| 1612 <!-- OBJECT METHODS --> |
| 1613 <!-- OBJECT EVENT FIELDS --> |
| 1614 <!-- FUNCTION PARAMETERS --> |
| 1615 </div> |
| 1616 </div> <!-- /apiItem --> |
| 1617 </div> <!-- /apiGroup --> |
| 1618 </div> <!-- /apiPage --> |
| 1619 </div> <!-- /gc-pagecontent --> |
| 1620 </div> <!-- /g-section --> |
| 1621 </div> <!-- /codesiteContent --> |
| 1622 <div id="gc-footer" --=""> |
| 1623 <div class="text"> |
| 1624 <p> |
| 1625 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, |
| 1626 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons |
| 1627 Attribution 3.0 License</a>, and code samples are licensed under the |
| 1628 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. |
| 1629 </p> |
| 1630 <p> |
| 1631 ©2011 Google |
| 1632 </p> |
| 1633 <!-- begin analytics --> |
| 1634 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript">
</script> |
| 1635 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc
ript> |
| 1636 <script type="text/javascript"> |
| 1637 // chrome doc tracking |
| 1638 try { |
| 1639 var engdocs = _gat._getTracker("YT-10763712-2"); |
| 1640 engdocs._trackPageview(); |
| 1641 } catch(err) {} |
| 1642 // code.google.com site-wide tracking |
| 1643 try { |
| 1644 _uacct="UA-18071-1"; |
| 1645 _uanchor=1; |
| 1646 _uff=0; |
| 1647 urchinTracker(); |
| 1648 } |
| 1649 catch(e) {/* urchinTracker not available. */} |
| 1650 </script> |
| 1651 <!-- end analytics --> |
| 1652 </div> |
| 1653 </div> <!-- /gc-footer --> |
| 1654 </div> <!-- /gc-container --> |
| 1655 </body></html> |
| OLD | NEW |