Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(127)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.offscreenTabs.html

Issue 7720002: Chrome Extensions chrome.experimental.offscreenTabs.* API implementation, docs, and test. (Closed) Base URL: http://src.chromium.org/svn/trunk/src/
Patch Set: '' Created 9 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Property Changes:
Added: svn:eol-style
+ LF
OLDNEW
(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="js/api_page_generator.js"></script>
17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <script type="text/javascript" src="js/sidebar.js"></script>
19 <title>chrome.experimental.offscreenTabs - Google Chrome Extensions - Google C ode</title></head>
20 <body> <div id="gc-container" class="labs">
21 <div id="devModeWarning">
22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with -- allow-file-access-from-files.
23 </div>
24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
25 <!-- In particular, sub-templates that recurse, must be used by allowing
26 jstemplate to make a copy of the template in this section which
27 are not operated on by way of the jsskip="true" -->
28 <div style="display:none">
29
30 <!-- VALUE -->
31 <div id="valueTemplate">
32 <dt>
33 <var>paramName</var>
34 <em>
35
36 <!-- TYPE -->
37 <div style="display:inline">
38 (
39 <span class="optional">optional</span>
40 <span class="enum">enumerated</span>
41 <span id="typeTemplate">
42 <span>
43 <a> Type</a>
44 </span>
45 <span>
46 <span>
47 array of <span><span></span></span>
48 </span>
49 <span>paramType</span>
50 <span></span>
51 </span>
52 </span>
53 )
54 </div>
55
56 </em>
57 </dt>
58 <dd class="todo">
59 Undocumented.
60 </dd>
61 <dd>
62 Description of this parameter from the json schema.
63 </dd>
64 <dd>
65 This parameter was added in version
66 <b><span></span></b>.
67 You must omit this parameter in earlier versions,
68 and you may omit it in any version. If you require this
69 parameter, the manifest key
70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
71 can ensure that your extension won't be run in an earlier browser ve rsion.
72 </dd>
73
74 <!-- OBJECT PROPERTIES -->
75 <dd>
76 <dl>
77 <div>
78 <div>
79 </div>
80 </div>
81 </dl>
82 </dd>
83
84 <!-- OBJECT METHODS -->
85 <dd>
86 <div></div>
87 </dd>
88
89 <!-- OBJECT EVENT FIELDS -->
90 <dd>
91 <div></div>
92 </dd>
93
94 <!-- FUNCTION PARAMETERS -->
95 <dd>
96 <div></div>
97 </dd>
98
99 </div> <!-- /VALUE -->
100
101 <div id="functionParametersTemplate">
102 <h5>Parameters</h5>
103 <dl>
104 <div>
105 <div>
106 </div>
107 </div>
108 </dl>
109 </div>
110 </div> <!-- /SUBTEMPLATES -->
111
112 <a id="top"></a>
113 <div id="skipto">
114 <a href="#gc-pagecontent">Skip to page content</a>
115 <a href="#gc-toc">Skip to main navigation</a>
116 </div>
117 <!-- API HEADER -->
118 <table id="header" width="100%" cellspacing="0" border="0">
119 <tbody><tr>
120 <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>
121 <td valign="middle" width="100%" style="padding-left:0.6em;">
122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
123 <div id="gsc-search-box">
124 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
125 <input type="hidden" name="ie" value="UTF-8">
126 <input type="text" name="q" value="" size="55">
127 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
128 <br>
129 <span class="greytext">e.g. "page action" or "tabs"</span>
130 </div>
131 </form>
132
133 <script type="text/javascript" src="http://www.google.com/jsapi"></scr ipt>
134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13 n?form=cse&amp;t13n_langs=en"></script>
136 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&amp;lang=en"></script>
137 </td>
138 </tr>
139 </tbody></table>
140
141 <div id="codesiteContent" class="">
142
143 <a id="gc-topnav-anchor"></a>
144 <div id="gc-topnav">
145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
146 <ul id="home" class="gc-topnav-tabs">
147 <li id="home_link">
148 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
149 </li>
150 <li id="docs_link">
151 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
152 </li>
153 <li id="faq_link">
154 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
155 </li>
156 <li id="samples_link">
157 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
158 </li>
159 <li id="group_link">
160 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
161 </li>
162 </ul>
163 </div> <!-- end gc-topnav -->
164
165 <div class="g-section g-tpl-170">
166 <!-- SIDENAV -->
167 <div class="g-unit g-first" id="gc-toc">
168 <ul>
169 <li><a href="getstarted.html">Getting Started</a></li>
170 <li><a href="overview.html">Overview</a></li>
171 <li><a href="whats_new.html">What's New?</a></li>
172 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
173 <ul>
174 <li>Browser UI
175 <ul>
176 <li><a href="browserAction.html">Browser Actions</a></li>
177 <li><a href="contextMenus.html">Context Menus</a></li>
178 <li><a href="notifications.html">Desktop Notifications</a></li >
179 <li><a href="omnibox.html">Omnibox</a></li>
180 <li><a href="options.html">Options Pages</a></li>
181 <li><a href="override.html">Override Pages</a></li>
182 <li><a href="pageAction.html">Page Actions</a></li>
183 </ul>
184 </li>
185 <li>Browser Interaction
186 <ul>
187 <li><a href="bookmarks.html">Bookmarks</a></li>
188 <li><a href="cookies.html">Cookies</a></li>
189 <li><a href="events.html">Events</a></li>
190 <li><a href="history.html">History</a></li>
191 <li><a href="management.html">Management</a></li>
192 <li><a href="tabs.html">Tabs</a></li>
193 <li><a href="windows.html">Windows</a></li>
194 </ul>
195 </li>
196 <li>Implementation
197 <ul>
198 <li><a href="a11y.html">Accessibility</a></li>
199 <li><a href="background_pages.html">Background Pages</a></li>
200 <li><a href="content_scripts.html">Content Scripts</a></li>
201 <li><a href="xhr.html">Cross-Origin XHR</a></li>
202 <li><a href="i18n.html">Internationalization</a></li>
203 <li><a href="messaging.html">Message Passing</a></li>
204 <li><a href="npapi.html">NPAPI Plugins</a></li>
205 </ul>
206 </li>
207 <li>Finishing
208 <ul>
209 <li><a href="hosting.html">Hosting</a></li>
210 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
211 </ul>
212 </li>
213 </ul>
214 </li>
215 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
216 <li><h2><a href="tutorials.html">Tutorials</a></h2>
217 <ul>
218 <li><a href="tut_debugging.html">Debugging</a></li>
219 <li><a href="tut_analytics.html">Google Analytics</a></li>
220 <li><a href="tut_oauth.html">OAuth</a></li>
221 </ul>
222 </li>
223 <li><h2>Reference</h2>
224 <ul>
225 <li>Formats
226 <ul>
227 <li><a href="manifest.html">Manifest Files</a></li>
228 <li><a href="match_patterns.html">Match Patterns</a></li>
229 </ul>
230 </li>
231 <li><a href="permission_warnings.html">Permission Warnings</a></li >
232 <li><a href="api_index.html">chrome.* APIs</a></li>
233 <li><a href="api_other.html">Other APIs</a></li>
234 </ul>
235 </li>
236 <li><h2><a href="samples.html">Samples</a></h2></li>
237 <div class="line"> </div>
238 <li><h2>More</h2>
239 <ul>
240 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
241 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
242 <li><a href="themes.html">Themes</a></li>
243 </ul>
244 </li>
245 </ul>
246 </div>
247 <script>
248 initToggles();
249 </script>
250
251 <div class="g-unit" id="gc-pagecontent">
252 <div id="pageTitle">
253 <h1 class="page_title">chrome.experimental.offscreenTabs</h1>
254 </div>
255 <!-- TABLE OF CONTENTS -->
256 <div id="toc">
257 <h2>Contents</h2>
258 <ol>
259 <li style="display: none; ">
260 <a>h2Name</a>
261 <ol>
262 <li>
263 <a>h3Name</a>
264 </li>
265 </ol>
266 </li>
267 <li>
268 <a href="#apiReference">API reference: chrome.experimental.offsc reenTabs</a>
269 <ol>
270 <li style="display: none; ">
271 <a href="#properties">Properties</a>
272 <ol>
273 <li>
274 <a href="#property-anchor">propertyName</a>
275 </li>
276 </ol>
277 </li>
278 <li>
279 <a href="#global-methods">Methods</a>
280 <ol>
281 <li>
282 <a href="#method-create">create</a>
283 </li><li>
284 <a href="#method-get">get</a>
285 </li><li>
286 <a href="#method-getAll">getAll</a>
287 </li><li>
288 <a href="#method-remove">remove</a>
289 </li><li>
290 <a href="#method-sendKeyboardEvent">sendKeyboardEvent</a >
291 </li><li>
292 <a href="#method-sendMouseEvent">sendMouseEvent</a>
293 </li><li>
294 <a href="#method-toDataUrl">toDataUrl</a>
295 </li><li>
296 <a href="#method-update">update</a>
297 </li>
298 </ol>
299 </li>
300 <li>
301 <a href="#global-events">Events</a>
302 <ol>
303 <li>
304 <a href="#event-onUpdated">onUpdated</a>
305 </li>
306 </ol>
307 </li>
308 <li>
309 <a href="#types">Types</a>
310 <ol>
311 <li>
312 <a href="#type-OffscreenTab">OffscreenTab</a>
313 </li>
314 </ol>
315 </li>
316 </ol>
317 </li>
318 </ol>
319 </div>
320 <!-- /TABLE OF CONTENTS -->
321
322 <!-- Standard content lead-in for experimental API pages -->
323 <p id="classSummary">
324 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
325 </p>
326
327 <!-- STATIC CONTENT PLACEHOLDER -->
328 <div id="static"></div>
329
330 <!-- API PAGE -->
331 <div class="apiPage">
332 <a name="apiReference"></a>
333 <h2>API reference: chrome.experimental.offscreenTabs</h2>
334
335 <!-- PROPERTIES -->
336 <div class="apiGroup" style="display: none; ">
337 <a name="properties"></a>
338 <h3 id="properties">Properties</h3>
339
340 <div>
341 <a></a>
342 <h4>getLastError</h4>
343 <div class="summary">
344 <!-- Note: intentionally longer 80 columns -->
345 <span>chrome.extension</span><span>lastError</span>
346 </div>
347 <div>
348 </div>
349 </div>
350
351 </div> <!-- /apiGroup -->
352
353 <!-- METHODS -->
354 <div id="methodsTemplate" class="apiGroup">
355 <a name="global-methods"></a>
356 <h3>Methods</h3>
357
358 <!-- iterates over all functions -->
359 <div class="apiItem">
360 <a name="method-create"></a> <!-- method-anchor -->
361 <h4>create</h4>
362
363 <div class="summary"><span style="display: none; ">void</span>
364 <!-- Note: intentionally longer 80 columns -->
365 <span>chrome.experimental.offscreenTabs.create</span>(<span cl ass="null"><span style="display: none; ">, </span><span>object</span>
366 <var><span>createProperties</span></var></span><span class ="optional"><span>, </span><span>function</span>
367 <var><span>callback</span></var></span>)</div>
368
369 <div class="description">
370 <p class="todo" style="display: none; ">Undocumented.</p>
371 <p>Creates a new offscreen tab.</p>
372
373 <!-- PARAMETERS -->
374 <h4>Parameters</h4>
375 <dl>
376 <div>
377 <div>
378 <dt>
379 <var>createProperties</var>
380 <em>
381
382 <!-- TYPE -->
383 <div style="display:inline">
384 (
385 <span class="optional" style="display: none; ">optional</spa n>
386 <span class="enum" style="display: none; ">enumerated</span>
387 <span id="typeTemplate">
388 <span style="display: none; ">
389 <a> Type</a>
390 </span>
391 <span>
392 <span style="display: none; ">
393 array of <span><span></span></span>
394 </span>
395 <span>object</span>
396 <span style="display: none; "></span>
397 </span>
398 </span>
399 )
400 </div>
401
402 </em>
403 </dt>
404 <dd class="todo">
405 Undocumented.
406 </dd>
407 <dd style="display: none; ">
408 Description of this parameter from the json schema.
409 </dd>
410 <dd style="display: none; ">
411 This parameter was added in version
412 <b><span></span></b>.
413 You must omit this parameter in earlier versions,
414 and you may omit it in any version. If you require this
415 parameter, the manifest key
416 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
417 can ensure that your extension won't be run in an earlier browser ve rsion.
418 </dd>
419
420 <!-- OBJECT PROPERTIES -->
421 <dd>
422 <dl>
423 <div>
424 <div>
425 <dt>
426 <var>url</var>
427 <em>
428
429 <!-- TYPE -->
430 <div style="display:inline">
431 (
432 <span class="optional" style="display: none; ">optional</spa n>
433 <span class="enum" style="display: none; ">enumerated</span>
434 <span id="typeTemplate">
435 <span style="display: none; ">
436 <a> Type</a>
437 </span>
438 <span>
439 <span style="display: none; ">
440 array of <span><span></span></span>
441 </span>
442 <span>string</span>
443 <span style="display: none; "></span>
444 </span>
445 </span>
446 )
447 </div>
448
449 </em>
450 </dt>
451 <dd class="todo" style="display: none; ">
452 Undocumented.
453 </dd>
454 <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.</dd>
455 <dd style="display: none; ">
456 This parameter was added in version
457 <b><span></span></b>.
458 You must omit this parameter in earlier versions,
459 and you may omit it in any version. If you require this
460 parameter, the manifest key
461 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
462 can ensure that your extension won't be run in an earlier browser ve rsion.
463 </dd>
464
465 <!-- OBJECT PROPERTIES -->
466 <dd style="display: none; ">
467 <dl>
468 <div>
469 <div>
470 </div>
471 </div>
472 </dl>
473 </dd>
474
475 <!-- OBJECT METHODS -->
476 <dd style="display: none; ">
477 <div></div>
478 </dd>
479
480 <!-- OBJECT EVENT FIELDS -->
481 <dd style="display: none; ">
482 <div></div>
483 </dd>
484
485 <!-- FUNCTION PARAMETERS -->
486 <dd style="display: none; ">
487 <div></div>
488 </dd>
489
490 </div>
491 </div><div>
492 <div>
493 <dt>
494 <var>width</var>
495 <em>
496
497 <!-- TYPE -->
498 <div style="display:inline">
499 (
500 <span class="optional">optional</span>
501 <span class="enum" style="display: none; ">enumerated</span>
502 <span id="typeTemplate">
503 <span style="display: none; ">
504 <a> Type</a>
505 </span>
506 <span>
507 <span style="display: none; ">
508 array of <span><span></span></span>
509 </span>
510 <span>integer</span>
511 <span style="display: none; "></span>
512 </span>
513 </span>
514 )
515 </div>
516
517 </em>
518 </dt>
519 <dd class="todo" style="display: none; ">
520 Undocumented.
521 </dd>
522 <dd>Width of the offscreen tab. Defaults to width of the current tab.< /dd>
523 <dd style="display: none; ">
524 This parameter was added in version
525 <b><span></span></b>.
526 You must omit this parameter in earlier versions,
527 and you may omit it in any version. If you require this
528 parameter, the manifest key
529 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
530 can ensure that your extension won't be run in an earlier browser ve rsion.
531 </dd>
532
533 <!-- OBJECT PROPERTIES -->
534 <dd style="display: none; ">
535 <dl>
536 <div>
537 <div>
538 </div>
539 </div>
540 </dl>
541 </dd>
542
543 <!-- OBJECT METHODS -->
544 <dd style="display: none; ">
545 <div></div>
546 </dd>
547
548 <!-- OBJECT EVENT FIELDS -->
549 <dd style="display: none; ">
550 <div></div>
551 </dd>
552
553 <!-- FUNCTION PARAMETERS -->
554 <dd style="display: none; ">
555 <div></div>
556 </dd>
557
558 </div>
559 </div><div>
560 <div>
561 <dt>
562 <var>height</var>
563 <em>
564
565 <!-- TYPE -->
566 <div style="display:inline">
567 (
568 <span class="optional">optional</span>
569 <span class="enum" style="display: none; ">enumerated</span>
570 <span id="typeTemplate">
571 <span style="display: none; ">
572 <a> Type</a>
573 </span>
574 <span>
575 <span style="display: none; ">
576 array of <span><span></span></span>
577 </span>
578 <span>integer</span>
579 <span style="display: none; "></span>
580 </span>
581 </span>
582 )
583 </div>
584
585 </em>
586 </dt>
587 <dd class="todo" style="display: none; ">
588 Undocumented.
589 </dd>
590 <dd>Height of the offscreen tab. Defaults to height of the current tab .</dd>
591 <dd style="display: none; ">
592 This parameter was added in version
593 <b><span></span></b>.
594 You must omit this parameter in earlier versions,
595 and you may omit it in any version. If you require this
596 parameter, the manifest key
597 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
598 can ensure that your extension won't be run in an earlier browser ve rsion.
599 </dd>
600
601 <!-- OBJECT PROPERTIES -->
602 <dd style="display: none; ">
603 <dl>
604 <div>
605 <div>
606 </div>
607 </div>
608 </dl>
609 </dd>
610
611 <!-- OBJECT METHODS -->
612 <dd style="display: none; ">
613 <div></div>
614 </dd>
615
616 <!-- OBJECT EVENT FIELDS -->
617 <dd style="display: none; ">
618 <div></div>
619 </dd>
620
621 <!-- FUNCTION PARAMETERS -->
622 <dd style="display: none; ">
623 <div></div>
624 </dd>
625
626 </div>
627 </div>
628 </dl>
629 </dd>
630
631 <!-- OBJECT METHODS -->
632 <dd style="display: none; ">
633 <div></div>
634 </dd>
635
636 <!-- OBJECT EVENT FIELDS -->
637 <dd style="display: none; ">
638 <div></div>
639 </dd>
640
641 <!-- FUNCTION PARAMETERS -->
642 <dd style="display: none; ">
643 <div></div>
644 </dd>
645
646 </div>
647 </div><div>
648 <div>
649 <dt>
650 <var>callback</var>
651 <em>
652
653 <!-- TYPE -->
654 <div style="display:inline">
655 (
656 <span class="optional">optional</span>
657 <span class="enum" style="display: none; ">enumerated</span>
658 <span id="typeTemplate">
659 <span style="display: none; ">
660 <a> Type</a>
661 </span>
662 <span>
663 <span style="display: none; ">
664 array of <span><span></span></span>
665 </span>
666 <span>function</span>
667 <span style="display: none; "></span>
668 </span>
669 </span>
670 )
671 </div>
672
673 </em>
674 </dt>
675 <dd class="todo">
676 Undocumented.
677 </dd>
678 <dd style="display: none; ">
679 Description of this parameter from the json schema.
680 </dd>
681 <dd style="display: none; ">
682 This parameter was added in version
683 <b><span></span></b>.
684 You must omit this parameter in earlier versions,
685 and you may omit it in any version. If you require this
686 parameter, the manifest key
687 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
688 can ensure that your extension won't be run in an earlier browser ve rsion.
689 </dd>
690
691 <!-- OBJECT PROPERTIES -->
692 <dd style="display: none; ">
693 <dl>
694 <div>
695 <div>
696 </div>
697 </div>
698 </dl>
699 </dd>
700
701 <!-- OBJECT METHODS -->
702 <dd style="display: none; ">
703 <div></div>
704 </dd>
705
706 <!-- OBJECT EVENT FIELDS -->
707 <dd style="display: none; ">
708 <div></div>
709 </dd>
710
711 <!-- FUNCTION PARAMETERS -->
712 <dd style="display: none; ">
713 <div></div>
714 </dd>
715
716 </div>
717 </div>
718 </dl>
719
720 <!-- RETURNS -->
721 <h4 style="display: none; ">Returns</h4>
722 <dl>
723 <div style="display: none; ">
724 <div>
725 </div>
726 </div>
727 </dl>
728
729 <!-- CALLBACK -->
730 <div>
731 <div>
732 <h4>Callback function</h4>
733 <p style="display: none; ">
734 The callback <em>parameter</em> should specify a function
735 that looks like this:
736 </p>
737 <p>
738 If you specify the <em>callback</em> parameter, it should
739 specify a function that looks like this:
740 </p>
741
742 <!-- Note: intentionally longer 80 columns -->
743 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl ass="subdued">{...}</span>;</pre>
744 <dl>
745 <div>
746 <div>
747 <dt>
748 <var>offscreenTab</var>
749 <em>
750
751 <!-- TYPE -->
752 <div style="display:inline">
753 (
754 <span class="optional">optional</span>
755 <span class="enum" style="display: none; ">enumerated</span>
756 <span id="typeTemplate">
757 <span>
758 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
759 </span>
760 <span style="display: none; ">
761 <span>
762 array of <span><span></span></span>
763 </span>
764 <span>paramType</span>
765 <span></span>
766 </span>
767 </span>
768 )
769 </div>
770
771 </em>
772 </dt>
773 <dd class="todo" style="display: none; ">
774 Undocumented.
775 </dd>
776 <dd>Details of the offscreen tab.</dd>
777 <dd style="display: none; ">
778 This parameter was added in version
779 <b><span></span></b>.
780 You must omit this parameter in earlier versions,
781 and you may omit it in any version. If you require this
782 parameter, the manifest key
783 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
784 can ensure that your extension won't be run in an earlier browser ve rsion.
785 </dd>
786
787 <!-- OBJECT PROPERTIES -->
788 <dd style="display: none; ">
789 <dl>
790 <div>
791 <div>
792 </div>
793 </div>
794 </dl>
795 </dd>
796
797 <!-- OBJECT METHODS -->
798 <dd style="display: none; ">
799 <div></div>
800 </dd>
801
802 <!-- OBJECT EVENT FIELDS -->
803 <dd style="display: none; ">
804 <div></div>
805 </dd>
806
807 <!-- FUNCTION PARAMETERS -->
808 <dd style="display: none; ">
809 <div></div>
810 </dd>
811
812 </div>
813 </div>
814 </dl>
815 </div>
816 </div>
817
818 <!-- MIN_VERSION -->
819 <p style="display: none; ">
820 This function was added in version <b><span></span></b>.
821 If you require this function, the manifest key
822 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
823 can ensure that your extension won't be run in an earlier brow ser version.
824 </p>
825 </div> <!-- /description -->
826
827 </div><div class="apiItem">
828 <a name="method-get"></a> <!-- method-anchor -->
829 <h4>get</h4>
830
831 <div class="summary"><span style="display: none; ">void</span>
832 <!-- Note: intentionally longer 80 columns -->
833 <span>chrome.experimental.offscreenTabs.get</span>(<span class ="null"><span style="display: none; ">, </span><span>integer</span>
834 <var><span>offscreenTabId</span></var></span><span class=" null"><span>, </span><span>function</span>
835 <var><span>callback</span></var></span>)</div>
836
837 <div class="description">
838 <p class="todo" style="display: none; ">Undocumented.</p>
839 <p>Gets details about the specified offscreen tab.</p>
840
841 <!-- PARAMETERS -->
842 <h4>Parameters</h4>
843 <dl>
844 <div>
845 <div>
846 <dt>
847 <var>offscreenTabId</var>
848 <em>
849
850 <!-- TYPE -->
851 <div style="display:inline">
852 (
853 <span class="optional" style="display: none; ">optional</spa n>
854 <span class="enum" style="display: none; ">enumerated</span>
855 <span id="typeTemplate">
856 <span style="display: none; ">
857 <a> Type</a>
858 </span>
859 <span>
860 <span style="display: none; ">
861 array of <span><span></span></span>
862 </span>
863 <span>integer</span>
864 <span style="display: none; "></span>
865 </span>
866 </span>
867 )
868 </div>
869
870 </em>
871 </dt>
872 <dd class="todo" style="display: none; ">
873 Undocumented.
874 </dd>
875 <dd>ID of the offscreen tab.</dd>
876 <dd style="display: none; ">
877 This parameter was added in version
878 <b><span></span></b>.
879 You must omit this parameter in earlier versions,
880 and you may omit it in any version. If you require this
881 parameter, the manifest key
882 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
883 can ensure that your extension won't be run in an earlier browser ve rsion.
884 </dd>
885
886 <!-- OBJECT PROPERTIES -->
887 <dd style="display: none; ">
888 <dl>
889 <div>
890 <div>
891 </div>
892 </div>
893 </dl>
894 </dd>
895
896 <!-- OBJECT METHODS -->
897 <dd style="display: none; ">
898 <div></div>
899 </dd>
900
901 <!-- OBJECT EVENT FIELDS -->
902 <dd style="display: none; ">
903 <div></div>
904 </dd>
905
906 <!-- FUNCTION PARAMETERS -->
907 <dd style="display: none; ">
908 <div></div>
909 </dd>
910
911 </div>
912 </div><div>
913 <div>
914 <dt>
915 <var>callback</var>
916 <em>
917
918 <!-- TYPE -->
919 <div style="display:inline">
920 (
921 <span class="optional" style="display: none; ">optional</spa n>
922 <span class="enum" style="display: none; ">enumerated</span>
923 <span id="typeTemplate">
924 <span style="display: none; ">
925 <a> Type</a>
926 </span>
927 <span>
928 <span style="display: none; ">
929 array of <span><span></span></span>
930 </span>
931 <span>function</span>
932 <span style="display: none; "></span>
933 </span>
934 </span>
935 )
936 </div>
937
938 </em>
939 </dt>
940 <dd class="todo">
941 Undocumented.
942 </dd>
943 <dd style="display: none; ">
944 Description of this parameter from the json schema.
945 </dd>
946 <dd style="display: none; ">
947 This parameter was added in version
948 <b><span></span></b>.
949 You must omit this parameter in earlier versions,
950 and you may omit it in any version. If you require this
951 parameter, the manifest key
952 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
953 can ensure that your extension won't be run in an earlier browser ve rsion.
954 </dd>
955
956 <!-- OBJECT PROPERTIES -->
957 <dd style="display: none; ">
958 <dl>
959 <div>
960 <div>
961 </div>
962 </div>
963 </dl>
964 </dd>
965
966 <!-- OBJECT METHODS -->
967 <dd style="display: none; ">
968 <div></div>
969 </dd>
970
971 <!-- OBJECT EVENT FIELDS -->
972 <dd style="display: none; ">
973 <div></div>
974 </dd>
975
976 <!-- FUNCTION PARAMETERS -->
977 <dd style="display: none; ">
978 <div></div>
979 </dd>
980
981 </div>
982 </div>
983 </dl>
984
985 <!-- RETURNS -->
986 <h4 style="display: none; ">Returns</h4>
987 <dl>
988 <div style="display: none; ">
989 <div>
990 </div>
991 </div>
992 </dl>
993
994 <!-- CALLBACK -->
995 <div>
996 <div>
997 <h4>Callback function</h4>
998 <p>
999 The callback <em>parameter</em> should specify a function
1000 that looks like this:
1001 </p>
1002 <p style="display: none; ">
1003 If you specify the <em>callback</em> parameter, it should
1004 specify a function that looks like this:
1005 </p>
1006
1007 <!-- Note: intentionally longer 80 columns -->
1008 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl ass="subdued">{...}</span>;</pre>
1009 <dl>
1010 <div>
1011 <div>
1012 <dt>
1013 <var>offscreenTab</var>
1014 <em>
1015
1016 <!-- TYPE -->
1017 <div style="display:inline">
1018 (
1019 <span class="optional" style="display: none; ">optional</spa n>
1020 <span class="enum" style="display: none; ">enumerated</span>
1021 <span id="typeTemplate">
1022 <span>
1023 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
1024 </span>
1025 <span style="display: none; ">
1026 <span>
1027 array of <span><span></span></span>
1028 </span>
1029 <span>paramType</span>
1030 <span></span>
1031 </span>
1032 </span>
1033 )
1034 </div>
1035
1036 </em>
1037 </dt>
1038 <dd class="todo" style="display: none; ">
1039 Undocumented.
1040 </dd>
1041 <dd>Details of the offscreen tab.</dd>
1042 <dd style="display: none; ">
1043 This parameter was added in version
1044 <b><span></span></b>.
1045 You must omit this parameter in earlier versions,
1046 and you may omit it in any version. If you require this
1047 parameter, the manifest key
1048 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1049 can ensure that your extension won't be run in an earlier browser ve rsion.
1050 </dd>
1051
1052 <!-- OBJECT PROPERTIES -->
1053 <dd style="display: none; ">
1054 <dl>
1055 <div>
1056 <div>
1057 </div>
1058 </div>
1059 </dl>
1060 </dd>
1061
1062 <!-- OBJECT METHODS -->
1063 <dd style="display: none; ">
1064 <div></div>
1065 </dd>
1066
1067 <!-- OBJECT EVENT FIELDS -->
1068 <dd style="display: none; ">
1069 <div></div>
1070 </dd>
1071
1072 <!-- FUNCTION PARAMETERS -->
1073 <dd style="display: none; ">
1074 <div></div>
1075 </dd>
1076
1077 </div>
1078 </div>
1079 </dl>
1080 </div>
1081 </div>
1082
1083 <!-- MIN_VERSION -->
1084 <p style="display: none; ">
1085 This function was added in version <b><span></span></b>.
1086 If you require this function, the manifest key
1087 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1088 can ensure that your extension won't be run in an earlier brow ser version.
1089 </p>
1090 </div> <!-- /description -->
1091
1092 </div><div class="apiItem">
1093 <a name="method-getAll"></a> <!-- method-anchor -->
1094 <h4>getAll</h4>
1095
1096 <div class="summary"><span style="display: none; ">void</span>
1097 <!-- Note: intentionally longer 80 columns -->
1098 <span>chrome.experimental.offscreenTabs.getAll</span>(<span cl ass="null"><span style="display: none; ">, </span><span>function</span>
1099 <var><span>callback</span></var></span>)</div>
1100
1101 <div class="description">
1102 <p class="todo" style="display: none; ">Undocumented.</p>
1103 <p>Gets an array of all offscreen tabs.</p>
1104
1105 <!-- PARAMETERS -->
1106 <h4>Parameters</h4>
1107 <dl>
1108 <div>
1109 <div>
1110 <dt>
1111 <var>callback</var>
1112 <em>
1113
1114 <!-- TYPE -->
1115 <div style="display:inline">
1116 (
1117 <span class="optional" style="display: none; ">optional</spa n>
1118 <span class="enum" style="display: none; ">enumerated</span>
1119 <span id="typeTemplate">
1120 <span style="display: none; ">
1121 <a> Type</a>
1122 </span>
1123 <span>
1124 <span style="display: none; ">
1125 array of <span><span></span></span>
1126 </span>
1127 <span>function</span>
1128 <span style="display: none; "></span>
1129 </span>
1130 </span>
1131 )
1132 </div>
1133
1134 </em>
1135 </dt>
1136 <dd class="todo">
1137 Undocumented.
1138 </dd>
1139 <dd style="display: none; ">
1140 Description of this parameter from the json schema.
1141 </dd>
1142 <dd style="display: none; ">
1143 This parameter was added in version
1144 <b><span></span></b>.
1145 You must omit this parameter in earlier versions,
1146 and you may omit it in any version. If you require this
1147 parameter, the manifest key
1148 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1149 can ensure that your extension won't be run in an earlier browser ve rsion.
1150 </dd>
1151
1152 <!-- OBJECT PROPERTIES -->
1153 <dd style="display: none; ">
1154 <dl>
1155 <div>
1156 <div>
1157 </div>
1158 </div>
1159 </dl>
1160 </dd>
1161
1162 <!-- OBJECT METHODS -->
1163 <dd style="display: none; ">
1164 <div></div>
1165 </dd>
1166
1167 <!-- OBJECT EVENT FIELDS -->
1168 <dd style="display: none; ">
1169 <div></div>
1170 </dd>
1171
1172 <!-- FUNCTION PARAMETERS -->
1173 <dd style="display: none; ">
1174 <div></div>
1175 </dd>
1176
1177 </div>
1178 </div>
1179 </dl>
1180
1181 <!-- RETURNS -->
1182 <h4 style="display: none; ">Returns</h4>
1183 <dl>
1184 <div style="display: none; ">
1185 <div>
1186 </div>
1187 </div>
1188 </dl>
1189
1190 <!-- CALLBACK -->
1191 <div>
1192 <div>
1193 <h4>Callback function</h4>
1194 <p>
1195 The callback <em>parameter</em> should specify a function
1196 that looks like this:
1197 </p>
1198 <p style="display: none; ">
1199 If you specify the <em>callback</em> parameter, it should
1200 specify a function that looks like this:
1201 </p>
1202
1203 <!-- Note: intentionally longer 80 columns -->
1204 <pre>function(<span>array of OffscreenTab offscreenTabs</span> ) <span class="subdued">{...}</span>;</pre>
1205 <dl>
1206 <div>
1207 <div>
1208 <dt>
1209 <var>offscreenTabs</var>
1210 <em>
1211
1212 <!-- TYPE -->
1213 <div style="display:inline">
1214 (
1215 <span class="optional" style="display: none; ">optional</spa n>
1216 <span class="enum" style="display: none; ">enumerated</span>
1217 <span id="typeTemplate">
1218 <span style="display: none; ">
1219 <a> Type</a>
1220 </span>
1221 <span>
1222 <span>
1223 array of <span><span>
1224 <span>
1225 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
1226 </span>
1227 <span style="display: none; ">
1228 <span>
1229 array of <span><span></span></span>
1230 </span>
1231 <span>paramType</span>
1232 <span></span>
1233 </span>
1234 </span></span>
1235 </span>
1236 <span style="display: none; ">paramType</span>
1237 <span style="display: none; "></span>
1238 </span>
1239 </span>
1240 )
1241 </div>
1242
1243 </em>
1244 </dt>
1245 <dd class="todo">
1246 Undocumented.
1247 </dd>
1248 <dd style="display: none; ">
1249 Description of this parameter from the json schema.
1250 </dd>
1251 <dd style="display: none; ">
1252 This parameter was added in version
1253 <b><span></span></b>.
1254 You must omit this parameter in earlier versions,
1255 and you may omit it in any version. If you require this
1256 parameter, the manifest key
1257 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1258 can ensure that your extension won't be run in an earlier browser ve rsion.
1259 </dd>
1260
1261 <!-- OBJECT PROPERTIES -->
1262 <dd style="display: none; ">
1263 <dl>
1264 <div>
1265 <div>
1266 </div>
1267 </div>
1268 </dl>
1269 </dd>
1270
1271 <!-- OBJECT METHODS -->
1272 <dd style="display: none; ">
1273 <div></div>
1274 </dd>
1275
1276 <!-- OBJECT EVENT FIELDS -->
1277 <dd style="display: none; ">
1278 <div></div>
1279 </dd>
1280
1281 <!-- FUNCTION PARAMETERS -->
1282 <dd style="display: none; ">
1283 <div></div>
1284 </dd>
1285
1286 </div>
1287 </div>
1288 </dl>
1289 </div>
1290 </div>
1291
1292 <!-- MIN_VERSION -->
1293 <p style="display: none; ">
1294 This function was added in version <b><span></span></b>.
1295 If you require this function, the manifest key
1296 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1297 can ensure that your extension won't be run in an earlier brow ser version.
1298 </p>
1299 </div> <!-- /description -->
1300
1301 </div><div class="apiItem">
1302 <a name="method-remove"></a> <!-- method-anchor -->
1303 <h4>remove</h4>
1304
1305 <div class="summary"><span style="display: none; ">void</span>
1306 <!-- Note: intentionally longer 80 columns -->
1307 <span>chrome.experimental.offscreenTabs.remove</span>(<span cl ass="null"><span style="display: none; ">, </span><span>integer</span>
1308 <var><span>offscreenTabId</span></var></span><span class=" optional"><span>, </span><span>function</span>
1309 <var><span>callback</span></var></span>)</div>
1310
1311 <div class="description">
1312 <p class="todo" style="display: none; ">Undocumented.</p>
1313 <p>Removes an offscreen tab.</p>
1314
1315 <!-- PARAMETERS -->
1316 <h4>Parameters</h4>
1317 <dl>
1318 <div>
1319 <div>
1320 <dt>
1321 <var>offscreenTabId</var>
1322 <em>
1323
1324 <!-- TYPE -->
1325 <div style="display:inline">
1326 (
1327 <span class="optional" style="display: none; ">optional</spa n>
1328 <span class="enum" style="display: none; ">enumerated</span>
1329 <span id="typeTemplate">
1330 <span style="display: none; ">
1331 <a> Type</a>
1332 </span>
1333 <span>
1334 <span style="display: none; ">
1335 array of <span><span></span></span>
1336 </span>
1337 <span>integer</span>
1338 <span style="display: none; "></span>
1339 </span>
1340 </span>
1341 )
1342 </div>
1343
1344 </em>
1345 </dt>
1346 <dd class="todo" style="display: none; ">
1347 Undocumented.
1348 </dd>
1349 <dd>ID of the offscreen tab.</dd>
1350 <dd style="display: none; ">
1351 This parameter was added in version
1352 <b><span></span></b>.
1353 You must omit this parameter in earlier versions,
1354 and you may omit it in any version. If you require this
1355 parameter, the manifest key
1356 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1357 can ensure that your extension won't be run in an earlier browser ve rsion.
1358 </dd>
1359
1360 <!-- OBJECT PROPERTIES -->
1361 <dd style="display: none; ">
1362 <dl>
1363 <div>
1364 <div>
1365 </div>
1366 </div>
1367 </dl>
1368 </dd>
1369
1370 <!-- OBJECT METHODS -->
1371 <dd style="display: none; ">
1372 <div></div>
1373 </dd>
1374
1375 <!-- OBJECT EVENT FIELDS -->
1376 <dd style="display: none; ">
1377 <div></div>
1378 </dd>
1379
1380 <!-- FUNCTION PARAMETERS -->
1381 <dd style="display: none; ">
1382 <div></div>
1383 </dd>
1384
1385 </div>
1386 </div><div>
1387 <div>
1388 <dt>
1389 <var>callback</var>
1390 <em>
1391
1392 <!-- TYPE -->
1393 <div style="display:inline">
1394 (
1395 <span class="optional">optional</span>
1396 <span class="enum" style="display: none; ">enumerated</span>
1397 <span id="typeTemplate">
1398 <span style="display: none; ">
1399 <a> Type</a>
1400 </span>
1401 <span>
1402 <span style="display: none; ">
1403 array of <span><span></span></span>
1404 </span>
1405 <span>function</span>
1406 <span style="display: none; "></span>
1407 </span>
1408 </span>
1409 )
1410 </div>
1411
1412 </em>
1413 </dt>
1414 <dd class="todo">
1415 Undocumented.
1416 </dd>
1417 <dd style="display: none; ">
1418 Description of this parameter from the json schema.
1419 </dd>
1420 <dd style="display: none; ">
1421 This parameter was added in version
1422 <b><span></span></b>.
1423 You must omit this parameter in earlier versions,
1424 and you may omit it in any version. If you require this
1425 parameter, the manifest key
1426 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1427 can ensure that your extension won't be run in an earlier browser ve rsion.
1428 </dd>
1429
1430 <!-- OBJECT PROPERTIES -->
1431 <dd style="display: none; ">
1432 <dl>
1433 <div>
1434 <div>
1435 </div>
1436 </div>
1437 </dl>
1438 </dd>
1439
1440 <!-- OBJECT METHODS -->
1441 <dd style="display: none; ">
1442 <div></div>
1443 </dd>
1444
1445 <!-- OBJECT EVENT FIELDS -->
1446 <dd style="display: none; ">
1447 <div></div>
1448 </dd>
1449
1450 <!-- FUNCTION PARAMETERS -->
1451 <dd style="display: none; ">
1452 <div></div>
1453 </dd>
1454
1455 </div>
1456 </div>
1457 </dl>
1458
1459 <!-- RETURNS -->
1460 <h4 style="display: none; ">Returns</h4>
1461 <dl>
1462 <div style="display: none; ">
1463 <div>
1464 </div>
1465 </div>
1466 </dl>
1467
1468 <!-- CALLBACK -->
1469 <div>
1470 <div>
1471 <h4>Callback function</h4>
1472 <p style="display: none; ">
1473 The callback <em>parameter</em> should specify a function
1474 that looks like this:
1475 </p>
1476 <p>
1477 If you specify the <em>callback</em> parameter, it should
1478 specify a function that looks like this:
1479 </p>
1480
1481 <!-- Note: intentionally longer 80 columns -->
1482 <pre>function(<span>null</span>) <span class="subdued">{...}</ span>;</pre>
1483 <dl>
1484 <div style="display: none; ">
1485 <div>
1486 </div>
1487 </div>
1488 </dl>
1489 </div>
1490 </div>
1491
1492 <!-- MIN_VERSION -->
1493 <p style="display: none; ">
1494 This function was added in version <b><span></span></b>.
1495 If you require this function, the manifest key
1496 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1497 can ensure that your extension won't be run in an earlier brow ser version.
1498 </p>
1499 </div> <!-- /description -->
1500
1501 </div><div class="apiItem">
1502 <a name="method-sendKeyboardEvent"></a> <!-- method-anchor -->
1503 <h4>sendKeyboardEvent</h4>
1504
1505 <div class="summary"><span style="display: none; ">void</span>
1506 <!-- Note: intentionally longer 80 columns -->
1507 <span>chrome.experimental.offscreenTabs.sendKeyboardEvent</spa n>(<span class="null"><span style="display: none; ">, </span><span>integer</span >
1508 <var><span>offscreenTabId</span></var></span><span class=" null"><span>, </span><span>any</span>
1509 <var><span>keyboardEvent</span></var></span><span class="o ptional"><span>, </span><span>function</span>
1510 <var><span>callback</span></var></span>)</div>
1511
1512 <div class="description">
1513 <p class="todo" style="display: none; ">Undocumented.</p>
1514 <p>Dispatches a keyboard event in the offscreen tab.</p>
1515
1516 <!-- PARAMETERS -->
1517 <h4>Parameters</h4>
1518 <dl>
1519 <div>
1520 <div>
1521 <dt>
1522 <var>offscreenTabId</var>
1523 <em>
1524
1525 <!-- TYPE -->
1526 <div style="display:inline">
1527 (
1528 <span class="optional" style="display: none; ">optional</spa n>
1529 <span class="enum" style="display: none; ">enumerated</span>
1530 <span id="typeTemplate">
1531 <span style="display: none; ">
1532 <a> Type</a>
1533 </span>
1534 <span>
1535 <span style="display: none; ">
1536 array of <span><span></span></span>
1537 </span>
1538 <span>integer</span>
1539 <span style="display: none; "></span>
1540 </span>
1541 </span>
1542 )
1543 </div>
1544
1545 </em>
1546 </dt>
1547 <dd class="todo" style="display: none; ">
1548 Undocumented.
1549 </dd>
1550 <dd>ID of the offscreen tab.</dd>
1551 <dd style="display: none; ">
1552 This parameter was added in version
1553 <b><span></span></b>.
1554 You must omit this parameter in earlier versions,
1555 and you may omit it in any version. If you require this
1556 parameter, the manifest key
1557 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1558 can ensure that your extension won't be run in an earlier browser ve rsion.
1559 </dd>
1560
1561 <!-- OBJECT PROPERTIES -->
1562 <dd style="display: none; ">
1563 <dl>
1564 <div>
1565 <div>
1566 </div>
1567 </div>
1568 </dl>
1569 </dd>
1570
1571 <!-- OBJECT METHODS -->
1572 <dd style="display: none; ">
1573 <div></div>
1574 </dd>
1575
1576 <!-- OBJECT EVENT FIELDS -->
1577 <dd style="display: none; ">
1578 <div></div>
1579 </dd>
1580
1581 <!-- FUNCTION PARAMETERS -->
1582 <dd style="display: none; ">
1583 <div></div>
1584 </dd>
1585
1586 </div>
1587 </div><div>
1588 <div>
1589 <dt>
1590 <var>keyboardEvent</var>
1591 <em>
1592
1593 <!-- TYPE -->
1594 <div style="display:inline">
1595 (
1596 <span class="optional" style="display: none; ">optional</spa n>
1597 <span class="enum" style="display: none; ">enumerated</span>
1598 <span id="typeTemplate">
1599 <span style="display: none; ">
1600 <a> Type</a>
1601 </span>
1602 <span>
1603 <span style="display: none; ">
1604 array of <span><span></span></span>
1605 </span>
1606 <span>any</span>
1607 <span style="display: none; "></span>
1608 </span>
1609 </span>
1610 )
1611 </div>
1612
1613 </em>
1614 </dt>
1615 <dd class="todo" style="display: none; ">
1616 Undocumented.
1617 </dd>
1618 <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>
1619 <dd style="display: none; ">
1620 This parameter was added in version
1621 <b><span></span></b>.
1622 You must omit this parameter in earlier versions,
1623 and you may omit it in any version. If you require this
1624 parameter, the manifest key
1625 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1626 can ensure that your extension won't be run in an earlier browser ve rsion.
1627 </dd>
1628
1629 <!-- OBJECT PROPERTIES -->
1630 <dd style="display: none; ">
1631 <dl>
1632 <div>
1633 <div>
1634 </div>
1635 </div>
1636 </dl>
1637 </dd>
1638
1639 <!-- OBJECT METHODS -->
1640 <dd style="display: none; ">
1641 <div></div>
1642 </dd>
1643
1644 <!-- OBJECT EVENT FIELDS -->
1645 <dd style="display: none; ">
1646 <div></div>
1647 </dd>
1648
1649 <!-- FUNCTION PARAMETERS -->
1650 <dd style="display: none; ">
1651 <div></div>
1652 </dd>
1653
1654 </div>
1655 </div><div>
1656 <div>
1657 <dt>
1658 <var>callback</var>
1659 <em>
1660
1661 <!-- TYPE -->
1662 <div style="display:inline">
1663 (
1664 <span class="optional">optional</span>
1665 <span class="enum" style="display: none; ">enumerated</span>
1666 <span id="typeTemplate">
1667 <span style="display: none; ">
1668 <a> Type</a>
1669 </span>
1670 <span>
1671 <span style="display: none; ">
1672 array of <span><span></span></span>
1673 </span>
1674 <span>function</span>
1675 <span style="display: none; "></span>
1676 </span>
1677 </span>
1678 )
1679 </div>
1680
1681 </em>
1682 </dt>
1683 <dd class="todo">
1684 Undocumented.
1685 </dd>
1686 <dd style="display: none; ">
1687 Description of this parameter from the json schema.
1688 </dd>
1689 <dd style="display: none; ">
1690 This parameter was added in version
1691 <b><span></span></b>.
1692 You must omit this parameter in earlier versions,
1693 and you may omit it in any version. If you require this
1694 parameter, the manifest key
1695 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1696 can ensure that your extension won't be run in an earlier browser ve rsion.
1697 </dd>
1698
1699 <!-- OBJECT PROPERTIES -->
1700 <dd style="display: none; ">
1701 <dl>
1702 <div>
1703 <div>
1704 </div>
1705 </div>
1706 </dl>
1707 </dd>
1708
1709 <!-- OBJECT METHODS -->
1710 <dd style="display: none; ">
1711 <div></div>
1712 </dd>
1713
1714 <!-- OBJECT EVENT FIELDS -->
1715 <dd style="display: none; ">
1716 <div></div>
1717 </dd>
1718
1719 <!-- FUNCTION PARAMETERS -->
1720 <dd style="display: none; ">
1721 <div></div>
1722 </dd>
1723
1724 </div>
1725 </div>
1726 </dl>
1727
1728 <!-- RETURNS -->
1729 <h4 style="display: none; ">Returns</h4>
1730 <dl>
1731 <div style="display: none; ">
1732 <div>
1733 </div>
1734 </div>
1735 </dl>
1736
1737 <!-- CALLBACK -->
1738 <div>
1739 <div>
1740 <h4>Callback function</h4>
1741 <p style="display: none; ">
1742 The callback <em>parameter</em> should specify a function
1743 that looks like this:
1744 </p>
1745 <p>
1746 If you specify the <em>callback</em> parameter, it should
1747 specify a function that looks like this:
1748 </p>
1749
1750 <!-- Note: intentionally longer 80 columns -->
1751 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl ass="subdued">{...}</span>;</pre>
1752 <dl>
1753 <div>
1754 <div>
1755 <dt>
1756 <var>offscreenTab</var>
1757 <em>
1758
1759 <!-- TYPE -->
1760 <div style="display:inline">
1761 (
1762 <span class="optional" style="display: none; ">optional</spa n>
1763 <span class="enum" style="display: none; ">enumerated</span>
1764 <span id="typeTemplate">
1765 <span>
1766 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
1767 </span>
1768 <span style="display: none; ">
1769 <span>
1770 array of <span><span></span></span>
1771 </span>
1772 <span>paramType</span>
1773 <span></span>
1774 </span>
1775 </span>
1776 )
1777 </div>
1778
1779 </em>
1780 </dt>
1781 <dd class="todo" style="display: none; ">
1782 Undocumented.
1783 </dd>
1784 <dd>Details of the offscreen tab.</dd>
1785 <dd style="display: none; ">
1786 This parameter was added in version
1787 <b><span></span></b>.
1788 You must omit this parameter in earlier versions,
1789 and you may omit it in any version. If you require this
1790 parameter, the manifest key
1791 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1792 can ensure that your extension won't be run in an earlier browser ve rsion.
1793 </dd>
1794
1795 <!-- OBJECT PROPERTIES -->
1796 <dd style="display: none; ">
1797 <dl>
1798 <div>
1799 <div>
1800 </div>
1801 </div>
1802 </dl>
1803 </dd>
1804
1805 <!-- OBJECT METHODS -->
1806 <dd style="display: none; ">
1807 <div></div>
1808 </dd>
1809
1810 <!-- OBJECT EVENT FIELDS -->
1811 <dd style="display: none; ">
1812 <div></div>
1813 </dd>
1814
1815 <!-- FUNCTION PARAMETERS -->
1816 <dd style="display: none; ">
1817 <div></div>
1818 </dd>
1819
1820 </div>
1821 </div>
1822 </dl>
1823 </div>
1824 </div>
1825
1826 <!-- MIN_VERSION -->
1827 <p style="display: none; ">
1828 This function was added in version <b><span></span></b>.
1829 If you require this function, the manifest key
1830 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1831 can ensure that your extension won't be run in an earlier brow ser version.
1832 </p>
1833 </div> <!-- /description -->
1834
1835 </div><div class="apiItem">
1836 <a name="method-sendMouseEvent"></a> <!-- method-anchor -->
1837 <h4>sendMouseEvent</h4>
1838
1839 <div class="summary"><span style="display: none; ">void</span>
1840 <!-- Note: intentionally longer 80 columns -->
1841 <span>chrome.experimental.offscreenTabs.sendMouseEvent</span>( <span class="null"><span style="display: none; ">, </span><span>integer</span>
1842 <var><span>offscreenTabId</span></var></span><span class=" null"><span>, </span><span>any</span>
1843 <var><span>mouseEvent</span></var></span><span class="opti onal"><span>, </span><span>integer</span>
1844 <var><span>x</span></var></span><span class="optional"><sp an>, </span><span>integer</span>
1845 <var><span>y</span></var></span><span class="optional"><sp an>, </span><span>function</span>
1846 <var><span>callback</span></var></span>)</div>
1847
1848 <div class="description">
1849 <p class="todo" style="display: none; ">Undocumented.</p>
1850 <p>Dispatches a mouse event in the offscreen tab.</p>
1851
1852 <!-- PARAMETERS -->
1853 <h4>Parameters</h4>
1854 <dl>
1855 <div>
1856 <div>
1857 <dt>
1858 <var>offscreenTabId</var>
1859 <em>
1860
1861 <!-- TYPE -->
1862 <div style="display:inline">
1863 (
1864 <span class="optional" style="display: none; ">optional</spa n>
1865 <span class="enum" style="display: none; ">enumerated</span>
1866 <span id="typeTemplate">
1867 <span style="display: none; ">
1868 <a> Type</a>
1869 </span>
1870 <span>
1871 <span style="display: none; ">
1872 array of <span><span></span></span>
1873 </span>
1874 <span>integer</span>
1875 <span style="display: none; "></span>
1876 </span>
1877 </span>
1878 )
1879 </div>
1880
1881 </em>
1882 </dt>
1883 <dd class="todo" style="display: none; ">
1884 Undocumented.
1885 </dd>
1886 <dd>ID of the offscreen tab.</dd>
1887 <dd style="display: none; ">
1888 This parameter was added in version
1889 <b><span></span></b>.
1890 You must omit this parameter in earlier versions,
1891 and you may omit it in any version. If you require this
1892 parameter, the manifest key
1893 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1894 can ensure that your extension won't be run in an earlier browser ve rsion.
1895 </dd>
1896
1897 <!-- OBJECT PROPERTIES -->
1898 <dd style="display: none; ">
1899 <dl>
1900 <div>
1901 <div>
1902 </div>
1903 </div>
1904 </dl>
1905 </dd>
1906
1907 <!-- OBJECT METHODS -->
1908 <dd style="display: none; ">
1909 <div></div>
1910 </dd>
1911
1912 <!-- OBJECT EVENT FIELDS -->
1913 <dd style="display: none; ">
1914 <div></div>
1915 </dd>
1916
1917 <!-- FUNCTION PARAMETERS -->
1918 <dd style="display: none; ">
1919 <div></div>
1920 </dd>
1921
1922 </div>
1923 </div><div>
1924 <div>
1925 <dt>
1926 <var>mouseEvent</var>
1927 <em>
1928
1929 <!-- TYPE -->
1930 <div style="display:inline">
1931 (
1932 <span class="optional" style="display: none; ">optional</spa n>
1933 <span class="enum" style="display: none; ">enumerated</span>
1934 <span id="typeTemplate">
1935 <span style="display: none; ">
1936 <a> Type</a>
1937 </span>
1938 <span>
1939 <span style="display: none; ">
1940 array of <span><span></span></span>
1941 </span>
1942 <span>any</span>
1943 <span style="display: none; "></span>
1944 </span>
1945 </span>
1946 )
1947 </div>
1948
1949 </em>
1950 </dt>
1951 <dd class="todo" style="display: none; ">
1952 Undocumented.
1953 </dd>
1954 <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>
1955 <dd style="display: none; ">
1956 This parameter was added in version
1957 <b><span></span></b>.
1958 You must omit this parameter in earlier versions,
1959 and you may omit it in any version. If you require this
1960 parameter, the manifest key
1961 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1962 can ensure that your extension won't be run in an earlier browser ve rsion.
1963 </dd>
1964
1965 <!-- OBJECT PROPERTIES -->
1966 <dd style="display: none; ">
1967 <dl>
1968 <div>
1969 <div>
1970 </div>
1971 </div>
1972 </dl>
1973 </dd>
1974
1975 <!-- OBJECT METHODS -->
1976 <dd style="display: none; ">
1977 <div></div>
1978 </dd>
1979
1980 <!-- OBJECT EVENT FIELDS -->
1981 <dd style="display: none; ">
1982 <div></div>
1983 </dd>
1984
1985 <!-- FUNCTION PARAMETERS -->
1986 <dd style="display: none; ">
1987 <div></div>
1988 </dd>
1989
1990 </div>
1991 </div><div>
1992 <div>
1993 <dt>
1994 <var>x</var>
1995 <em>
1996
1997 <!-- TYPE -->
1998 <div style="display:inline">
1999 (
2000 <span class="optional">optional</span>
2001 <span class="enum" style="display: none; ">enumerated</span>
2002 <span id="typeTemplate">
2003 <span style="display: none; ">
2004 <a> Type</a>
2005 </span>
2006 <span>
2007 <span style="display: none; ">
2008 array of <span><span></span></span>
2009 </span>
2010 <span>integer</span>
2011 <span style="display: none; "></span>
2012 </span>
2013 </span>
2014 )
2015 </div>
2016
2017 </em>
2018 </dt>
2019 <dd class="todo" style="display: none; ">
2020 Undocumented.
2021 </dd>
2022 <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>
2023 <dd style="display: none; ">
2024 This parameter was added in version
2025 <b><span></span></b>.
2026 You must omit this parameter in earlier versions,
2027 and you may omit it in any version. If you require this
2028 parameter, the manifest key
2029 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2030 can ensure that your extension won't be run in an earlier browser ve rsion.
2031 </dd>
2032
2033 <!-- OBJECT PROPERTIES -->
2034 <dd style="display: none; ">
2035 <dl>
2036 <div>
2037 <div>
2038 </div>
2039 </div>
2040 </dl>
2041 </dd>
2042
2043 <!-- OBJECT METHODS -->
2044 <dd style="display: none; ">
2045 <div></div>
2046 </dd>
2047
2048 <!-- OBJECT EVENT FIELDS -->
2049 <dd style="display: none; ">
2050 <div></div>
2051 </dd>
2052
2053 <!-- FUNCTION PARAMETERS -->
2054 <dd style="display: none; ">
2055 <div></div>
2056 </dd>
2057
2058 </div>
2059 </div><div>
2060 <div>
2061 <dt>
2062 <var>y</var>
2063 <em>
2064
2065 <!-- TYPE -->
2066 <div style="display:inline">
2067 (
2068 <span class="optional">optional</span>
2069 <span class="enum" style="display: none; ">enumerated</span>
2070 <span id="typeTemplate">
2071 <span style="display: none; ">
2072 <a> Type</a>
2073 </span>
2074 <span>
2075 <span style="display: none; ">
2076 array of <span><span></span></span>
2077 </span>
2078 <span>integer</span>
2079 <span style="display: none; "></span>
2080 </span>
2081 </span>
2082 )
2083 </div>
2084
2085 </em>
2086 </dt>
2087 <dd class="todo" style="display: none; ">
2088 Undocumented.
2089 </dd>
2090 <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>
2091 <dd style="display: none; ">
2092 This parameter was added in version
2093 <b><span></span></b>.
2094 You must omit this parameter in earlier versions,
2095 and you may omit it in any version. If you require this
2096 parameter, the manifest key
2097 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2098 can ensure that your extension won't be run in an earlier browser ve rsion.
2099 </dd>
2100
2101 <!-- OBJECT PROPERTIES -->
2102 <dd style="display: none; ">
2103 <dl>
2104 <div>
2105 <div>
2106 </div>
2107 </div>
2108 </dl>
2109 </dd>
2110
2111 <!-- OBJECT METHODS -->
2112 <dd style="display: none; ">
2113 <div></div>
2114 </dd>
2115
2116 <!-- OBJECT EVENT FIELDS -->
2117 <dd style="display: none; ">
2118 <div></div>
2119 </dd>
2120
2121 <!-- FUNCTION PARAMETERS -->
2122 <dd style="display: none; ">
2123 <div></div>
2124 </dd>
2125
2126 </div>
2127 </div><div>
2128 <div>
2129 <dt>
2130 <var>callback</var>
2131 <em>
2132
2133 <!-- TYPE -->
2134 <div style="display:inline">
2135 (
2136 <span class="optional">optional</span>
2137 <span class="enum" style="display: none; ">enumerated</span>
2138 <span id="typeTemplate">
2139 <span style="display: none; ">
2140 <a> Type</a>
2141 </span>
2142 <span>
2143 <span style="display: none; ">
2144 array of <span><span></span></span>
2145 </span>
2146 <span>function</span>
2147 <span style="display: none; "></span>
2148 </span>
2149 </span>
2150 )
2151 </div>
2152
2153 </em>
2154 </dt>
2155 <dd class="todo">
2156 Undocumented.
2157 </dd>
2158 <dd style="display: none; ">
2159 Description of this parameter from the json schema.
2160 </dd>
2161 <dd style="display: none; ">
2162 This parameter was added in version
2163 <b><span></span></b>.
2164 You must omit this parameter in earlier versions,
2165 and you may omit it in any version. If you require this
2166 parameter, the manifest key
2167 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2168 can ensure that your extension won't be run in an earlier browser ve rsion.
2169 </dd>
2170
2171 <!-- OBJECT PROPERTIES -->
2172 <dd style="display: none; ">
2173 <dl>
2174 <div>
2175 <div>
2176 </div>
2177 </div>
2178 </dl>
2179 </dd>
2180
2181 <!-- OBJECT METHODS -->
2182 <dd style="display: none; ">
2183 <div></div>
2184 </dd>
2185
2186 <!-- OBJECT EVENT FIELDS -->
2187 <dd style="display: none; ">
2188 <div></div>
2189 </dd>
2190
2191 <!-- FUNCTION PARAMETERS -->
2192 <dd style="display: none; ">
2193 <div></div>
2194 </dd>
2195
2196 </div>
2197 </div>
2198 </dl>
2199
2200 <!-- RETURNS -->
2201 <h4 style="display: none; ">Returns</h4>
2202 <dl>
2203 <div style="display: none; ">
2204 <div>
2205 </div>
2206 </div>
2207 </dl>
2208
2209 <!-- CALLBACK -->
2210 <div>
2211 <div>
2212 <h4>Callback function</h4>
2213 <p style="display: none; ">
2214 The callback <em>parameter</em> should specify a function
2215 that looks like this:
2216 </p>
2217 <p>
2218 If you specify the <em>callback</em> parameter, it should
2219 specify a function that looks like this:
2220 </p>
2221
2222 <!-- Note: intentionally longer 80 columns -->
2223 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl ass="subdued">{...}</span>;</pre>
2224 <dl>
2225 <div>
2226 <div>
2227 <dt>
2228 <var>offscreenTab</var>
2229 <em>
2230
2231 <!-- TYPE -->
2232 <div style="display:inline">
2233 (
2234 <span class="optional" style="display: none; ">optional</spa n>
2235 <span class="enum" style="display: none; ">enumerated</span>
2236 <span id="typeTemplate">
2237 <span>
2238 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
2239 </span>
2240 <span style="display: none; ">
2241 <span>
2242 array of <span><span></span></span>
2243 </span>
2244 <span>paramType</span>
2245 <span></span>
2246 </span>
2247 </span>
2248 )
2249 </div>
2250
2251 </em>
2252 </dt>
2253 <dd class="todo" style="display: none; ">
2254 Undocumented.
2255 </dd>
2256 <dd>Details of the offscreen tab.</dd>
2257 <dd style="display: none; ">
2258 This parameter was added in version
2259 <b><span></span></b>.
2260 You must omit this parameter in earlier versions,
2261 and you may omit it in any version. If you require this
2262 parameter, the manifest key
2263 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2264 can ensure that your extension won't be run in an earlier browser ve rsion.
2265 </dd>
2266
2267 <!-- OBJECT PROPERTIES -->
2268 <dd style="display: none; ">
2269 <dl>
2270 <div>
2271 <div>
2272 </div>
2273 </div>
2274 </dl>
2275 </dd>
2276
2277 <!-- OBJECT METHODS -->
2278 <dd style="display: none; ">
2279 <div></div>
2280 </dd>
2281
2282 <!-- OBJECT EVENT FIELDS -->
2283 <dd style="display: none; ">
2284 <div></div>
2285 </dd>
2286
2287 <!-- FUNCTION PARAMETERS -->
2288 <dd style="display: none; ">
2289 <div></div>
2290 </dd>
2291
2292 </div>
2293 </div>
2294 </dl>
2295 </div>
2296 </div>
2297
2298 <!-- MIN_VERSION -->
2299 <p style="display: none; ">
2300 This function was added in version <b><span></span></b>.
2301 If you require this function, the manifest key
2302 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2303 can ensure that your extension won't be run in an earlier brow ser version.
2304 </p>
2305 </div> <!-- /description -->
2306
2307 </div><div class="apiItem">
2308 <a name="method-toDataUrl"></a> <!-- method-anchor -->
2309 <h4>toDataUrl</h4>
2310
2311 <div class="summary"><span style="display: none; ">void</span>
2312 <!-- Note: intentionally longer 80 columns -->
2313 <span>chrome.experimental.offscreenTabs.toDataUrl</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
2314 <var><span>offscreenTabId</span></var></span><span class=" optional"><span>, </span><span>object</span>
2315 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>
2316 <var><span>callback</span></var></span>)</div>
2317
2318 <div class="description">
2319 <p class="todo" style="display: none; ">Undocumented.</p>
2320 <p>Captures the visible area of an offscreen tab. </p>
2321
2322 <!-- PARAMETERS -->
2323 <h4>Parameters</h4>
2324 <dl>
2325 <div>
2326 <div>
2327 <dt>
2328 <var>offscreenTabId</var>
2329 <em>
2330
2331 <!-- TYPE -->
2332 <div style="display:inline">
2333 (
2334 <span class="optional" style="display: none; ">optional</spa n>
2335 <span class="enum" style="display: none; ">enumerated</span>
2336 <span id="typeTemplate">
2337 <span style="display: none; ">
2338 <a> Type</a>
2339 </span>
2340 <span>
2341 <span style="display: none; ">
2342 array of <span><span></span></span>
2343 </span>
2344 <span>integer</span>
2345 <span style="display: none; "></span>
2346 </span>
2347 </span>
2348 )
2349 </div>
2350
2351 </em>
2352 </dt>
2353 <dd class="todo" style="display: none; ">
2354 Undocumented.
2355 </dd>
2356 <dd>The ID of the offscreen tab.</dd>
2357 <dd style="display: none; ">
2358 This parameter was added in version
2359 <b><span></span></b>.
2360 You must omit this parameter in earlier versions,
2361 and you may omit it in any version. If you require this
2362 parameter, the manifest key
2363 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2364 can ensure that your extension won't be run in an earlier browser ve rsion.
2365 </dd>
2366
2367 <!-- OBJECT PROPERTIES -->
2368 <dd style="display: none; ">
2369 <dl>
2370 <div>
2371 <div>
2372 </div>
2373 </div>
2374 </dl>
2375 </dd>
2376
2377 <!-- OBJECT METHODS -->
2378 <dd style="display: none; ">
2379 <div></div>
2380 </dd>
2381
2382 <!-- OBJECT EVENT FIELDS -->
2383 <dd style="display: none; ">
2384 <div></div>
2385 </dd>
2386
2387 <!-- FUNCTION PARAMETERS -->
2388 <dd style="display: none; ">
2389 <div></div>
2390 </dd>
2391
2392 </div>
2393 </div><div>
2394 <div>
2395 <dt>
2396 <var>options</var>
2397 <em>
2398
2399 <!-- TYPE -->
2400 <div style="display:inline">
2401 (
2402 <span class="optional">optional</span>
2403 <span class="enum" style="display: none; ">enumerated</span>
2404 <span id="typeTemplate">
2405 <span style="display: none; ">
2406 <a> Type</a>
2407 </span>
2408 <span>
2409 <span style="display: none; ">
2410 array of <span><span></span></span>
2411 </span>
2412 <span>object</span>
2413 <span style="display: none; "></span>
2414 </span>
2415 </span>
2416 )
2417 </div>
2418
2419 </em>
2420 </dt>
2421 <dd class="todo" style="display: none; ">
2422 Undocumented.
2423 </dd>
2424 <dd>Set parameters of image capture, such as the format of the resulti ng image.</dd>
2425 <dd style="display: none; ">
2426 This parameter was added in version
2427 <b><span></span></b>.
2428 You must omit this parameter in earlier versions,
2429 and you may omit it in any version. If you require this
2430 parameter, the manifest key
2431 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2432 can ensure that your extension won't be run in an earlier browser ve rsion.
2433 </dd>
2434
2435 <!-- OBJECT PROPERTIES -->
2436 <dd>
2437 <dl>
2438 <div>
2439 <div>
2440 <dt>
2441 <var>format</var>
2442 <em>
2443
2444 <!-- TYPE -->
2445 <div style="display:inline">
2446 (
2447 <span class="optional">optional</span>
2448 <span class="enum">enumerated</span>
2449 <span id="typeTemplate">
2450 <span style="display: none; ">
2451 <a> Type</a>
2452 </span>
2453 <span>
2454 <span style="display: none; ">
2455 array of <span><span></span></span>
2456 </span>
2457 <span>string</span>
2458 <span>["jpeg", "png"]</span>
2459 </span>
2460 </span>
2461 )
2462 </div>
2463
2464 </em>
2465 </dt>
2466 <dd class="todo" style="display: none; ">
2467 Undocumented.
2468 </dd>
2469 <dd>The format of the resulting image. Default is jpeg.</dd>
2470 <dd style="display: none; ">
2471 This parameter was added in version
2472 <b><span></span></b>.
2473 You must omit this parameter in earlier versions,
2474 and you may omit it in any version. If you require this
2475 parameter, the manifest key
2476 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2477 can ensure that your extension won't be run in an earlier browser ve rsion.
2478 </dd>
2479
2480 <!-- OBJECT PROPERTIES -->
2481 <dd style="display: none; ">
2482 <dl>
2483 <div>
2484 <div>
2485 </div>
2486 </div>
2487 </dl>
2488 </dd>
2489
2490 <!-- OBJECT METHODS -->
2491 <dd style="display: none; ">
2492 <div></div>
2493 </dd>
2494
2495 <!-- OBJECT EVENT FIELDS -->
2496 <dd style="display: none; ">
2497 <div></div>
2498 </dd>
2499
2500 <!-- FUNCTION PARAMETERS -->
2501 <dd style="display: none; ">
2502 <div></div>
2503 </dd>
2504
2505 </div>
2506 </div><div>
2507 <div>
2508 <dt>
2509 <var>quality</var>
2510 <em>
2511
2512 <!-- TYPE -->
2513 <div style="display:inline">
2514 (
2515 <span class="optional">optional</span>
2516 <span class="enum" style="display: none; ">enumerated</span>
2517 <span id="typeTemplate">
2518 <span style="display: none; ">
2519 <a> Type</a>
2520 </span>
2521 <span>
2522 <span style="display: none; ">
2523 array of <span><span></span></span>
2524 </span>
2525 <span>integer</span>
2526 <span style="display: none; "></span>
2527 </span>
2528 </span>
2529 )
2530 </div>
2531
2532 </em>
2533 </dt>
2534 <dd class="todo" style="display: none; ">
2535 Undocumented.
2536 </dd>
2537 <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>
2538 <dd style="display: none; ">
2539 This parameter was added in version
2540 <b><span></span></b>.
2541 You must omit this parameter in earlier versions,
2542 and you may omit it in any version. If you require this
2543 parameter, the manifest key
2544 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2545 can ensure that your extension won't be run in an earlier browser ve rsion.
2546 </dd>
2547
2548 <!-- OBJECT PROPERTIES -->
2549 <dd style="display: none; ">
2550 <dl>
2551 <div>
2552 <div>
2553 </div>
2554 </div>
2555 </dl>
2556 </dd>
2557
2558 <!-- OBJECT METHODS -->
2559 <dd style="display: none; ">
2560 <div></div>
2561 </dd>
2562
2563 <!-- OBJECT EVENT FIELDS -->
2564 <dd style="display: none; ">
2565 <div></div>
2566 </dd>
2567
2568 <!-- FUNCTION PARAMETERS -->
2569 <dd style="display: none; ">
2570 <div></div>
2571 </dd>
2572
2573 </div>
2574 </div>
2575 </dl>
2576 </dd>
2577
2578 <!-- OBJECT METHODS -->
2579 <dd style="display: none; ">
2580 <div></div>
2581 </dd>
2582
2583 <!-- OBJECT EVENT FIELDS -->
2584 <dd style="display: none; ">
2585 <div></div>
2586 </dd>
2587
2588 <!-- FUNCTION PARAMETERS -->
2589 <dd style="display: none; ">
2590 <div></div>
2591 </dd>
2592
2593 </div>
2594 </div><div>
2595 <div>
2596 <dt>
2597 <var>callback</var>
2598 <em>
2599
2600 <!-- TYPE -->
2601 <div style="display:inline">
2602 (
2603 <span class="optional" style="display: none; ">optional</spa n>
2604 <span class="enum" style="display: none; ">enumerated</span>
2605 <span id="typeTemplate">
2606 <span style="display: none; ">
2607 <a> Type</a>
2608 </span>
2609 <span>
2610 <span style="display: none; ">
2611 array of <span><span></span></span>
2612 </span>
2613 <span>function</span>
2614 <span style="display: none; "></span>
2615 </span>
2616 </span>
2617 )
2618 </div>
2619
2620 </em>
2621 </dt>
2622 <dd class="todo">
2623 Undocumented.
2624 </dd>
2625 <dd style="display: none; ">
2626 Description of this parameter from the json schema.
2627 </dd>
2628 <dd style="display: none; ">
2629 This parameter was added in version
2630 <b><span></span></b>.
2631 You must omit this parameter in earlier versions,
2632 and you may omit it in any version. If you require this
2633 parameter, the manifest key
2634 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2635 can ensure that your extension won't be run in an earlier browser ve rsion.
2636 </dd>
2637
2638 <!-- OBJECT PROPERTIES -->
2639 <dd style="display: none; ">
2640 <dl>
2641 <div>
2642 <div>
2643 </div>
2644 </div>
2645 </dl>
2646 </dd>
2647
2648 <!-- OBJECT METHODS -->
2649 <dd style="display: none; ">
2650 <div></div>
2651 </dd>
2652
2653 <!-- OBJECT EVENT FIELDS -->
2654 <dd style="display: none; ">
2655 <div></div>
2656 </dd>
2657
2658 <!-- FUNCTION PARAMETERS -->
2659 <dd style="display: none; ">
2660 <div></div>
2661 </dd>
2662
2663 </div>
2664 </div>
2665 </dl>
2666
2667 <!-- RETURNS -->
2668 <h4 style="display: none; ">Returns</h4>
2669 <dl>
2670 <div style="display: none; ">
2671 <div>
2672 </div>
2673 </div>
2674 </dl>
2675
2676 <!-- CALLBACK -->
2677 <div>
2678 <div>
2679 <h4>Callback function</h4>
2680 <p>
2681 The callback <em>parameter</em> should specify a function
2682 that looks like this:
2683 </p>
2684 <p style="display: none; ">
2685 If you specify the <em>callback</em> parameter, it should
2686 specify a function that looks like this:
2687 </p>
2688
2689 <!-- Note: intentionally longer 80 columns -->
2690 <pre>function(<span>string dataUrl</span>) <span class="subdue d">{...}</span>;</pre>
2691 <dl>
2692 <div>
2693 <div>
2694 <dt>
2695 <var>dataUrl</var>
2696 <em>
2697
2698 <!-- TYPE -->
2699 <div style="display:inline">
2700 (
2701 <span class="optional" style="display: none; ">optional</spa n>
2702 <span class="enum" style="display: none; ">enumerated</span>
2703 <span id="typeTemplate">
2704 <span style="display: none; ">
2705 <a> Type</a>
2706 </span>
2707 <span>
2708 <span style="display: none; ">
2709 array of <span><span></span></span>
2710 </span>
2711 <span>string</span>
2712 <span style="display: none; "></span>
2713 </span>
2714 </span>
2715 )
2716 </div>
2717
2718 </em>
2719 </dt>
2720 <dd class="todo" style="display: none; ">
2721 Undocumented.
2722 </dd>
2723 <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>
2724 <dd style="display: none; ">
2725 This parameter was added in version
2726 <b><span></span></b>.
2727 You must omit this parameter in earlier versions,
2728 and you may omit it in any version. If you require this
2729 parameter, the manifest key
2730 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2731 can ensure that your extension won't be run in an earlier browser ve rsion.
2732 </dd>
2733
2734 <!-- OBJECT PROPERTIES -->
2735 <dd style="display: none; ">
2736 <dl>
2737 <div>
2738 <div>
2739 </div>
2740 </div>
2741 </dl>
2742 </dd>
2743
2744 <!-- OBJECT METHODS -->
2745 <dd style="display: none; ">
2746 <div></div>
2747 </dd>
2748
2749 <!-- OBJECT EVENT FIELDS -->
2750 <dd style="display: none; ">
2751 <div></div>
2752 </dd>
2753
2754 <!-- FUNCTION PARAMETERS -->
2755 <dd style="display: none; ">
2756 <div></div>
2757 </dd>
2758
2759 </div>
2760 </div>
2761 </dl>
2762 </div>
2763 </div>
2764
2765 <!-- MIN_VERSION -->
2766 <p style="display: none; ">
2767 This function was added in version <b><span></span></b>.
2768 If you require this function, the manifest key
2769 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2770 can ensure that your extension won't be run in an earlier brow ser version.
2771 </p>
2772 </div> <!-- /description -->
2773
2774 </div><div class="apiItem">
2775 <a name="method-update"></a> <!-- method-anchor -->
2776 <h4>update</h4>
2777
2778 <div class="summary"><span style="display: none; ">void</span>
2779 <!-- Note: intentionally longer 80 columns -->
2780 <span>chrome.experimental.offscreenTabs.update</span>(<span cl ass="null"><span style="display: none; ">, </span><span>integer</span>
2781 <var><span>offscreenTabId</span></var></span><span class=" null"><span>, </span><span>object</span>
2782 <var><span>updateProperties</span></var></span><span class ="optional"><span>, </span><span>function</span>
2783 <var><span>callback</span></var></span>)</div>
2784
2785 <div class="description">
2786 <p class="todo" style="display: none; ">Undocumented.</p>
2787 <p>Modifies the properties of an offscreen tab. Properties that are not specified in updateProperties are not modified.</p>
2788
2789 <!-- PARAMETERS -->
2790 <h4>Parameters</h4>
2791 <dl>
2792 <div>
2793 <div>
2794 <dt>
2795 <var>offscreenTabId</var>
2796 <em>
2797
2798 <!-- TYPE -->
2799 <div style="display:inline">
2800 (
2801 <span class="optional" style="display: none; ">optional</spa n>
2802 <span class="enum" style="display: none; ">enumerated</span>
2803 <span id="typeTemplate">
2804 <span style="display: none; ">
2805 <a> Type</a>
2806 </span>
2807 <span>
2808 <span style="display: none; ">
2809 array of <span><span></span></span>
2810 </span>
2811 <span>integer</span>
2812 <span style="display: none; "></span>
2813 </span>
2814 </span>
2815 )
2816 </div>
2817
2818 </em>
2819 </dt>
2820 <dd class="todo" style="display: none; ">
2821 Undocumented.
2822 </dd>
2823 <dd>The ID of the offscreen tab.</dd>
2824 <dd style="display: none; ">
2825 This parameter was added in version
2826 <b><span></span></b>.
2827 You must omit this parameter in earlier versions,
2828 and you may omit it in any version. If you require this
2829 parameter, the manifest key
2830 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2831 can ensure that your extension won't be run in an earlier browser ve rsion.
2832 </dd>
2833
2834 <!-- OBJECT PROPERTIES -->
2835 <dd style="display: none; ">
2836 <dl>
2837 <div>
2838 <div>
2839 </div>
2840 </div>
2841 </dl>
2842 </dd>
2843
2844 <!-- OBJECT METHODS -->
2845 <dd style="display: none; ">
2846 <div></div>
2847 </dd>
2848
2849 <!-- OBJECT EVENT FIELDS -->
2850 <dd style="display: none; ">
2851 <div></div>
2852 </dd>
2853
2854 <!-- FUNCTION PARAMETERS -->
2855 <dd style="display: none; ">
2856 <div></div>
2857 </dd>
2858
2859 </div>
2860 </div><div>
2861 <div>
2862 <dt>
2863 <var>updateProperties</var>
2864 <em>
2865
2866 <!-- TYPE -->
2867 <div style="display:inline">
2868 (
2869 <span class="optional" style="display: none; ">optional</spa n>
2870 <span class="enum" style="display: none; ">enumerated</span>
2871 <span id="typeTemplate">
2872 <span style="display: none; ">
2873 <a> Type</a>
2874 </span>
2875 <span>
2876 <span style="display: none; ">
2877 array of <span><span></span></span>
2878 </span>
2879 <span>object</span>
2880 <span style="display: none; "></span>
2881 </span>
2882 </span>
2883 )
2884 </div>
2885
2886 </em>
2887 </dt>
2888 <dd class="todo">
2889 Undocumented.
2890 </dd>
2891 <dd style="display: none; ">
2892 Description of this parameter from the json schema.
2893 </dd>
2894 <dd style="display: none; ">
2895 This parameter was added in version
2896 <b><span></span></b>.
2897 You must omit this parameter in earlier versions,
2898 and you may omit it in any version. If you require this
2899 parameter, the manifest key
2900 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2901 can ensure that your extension won't be run in an earlier browser ve rsion.
2902 </dd>
2903
2904 <!-- OBJECT PROPERTIES -->
2905 <dd>
2906 <dl>
2907 <div>
2908 <div>
2909 <dt>
2910 <var>url</var>
2911 <em>
2912
2913 <!-- TYPE -->
2914 <div style="display:inline">
2915 (
2916 <span class="optional">optional</span>
2917 <span class="enum" style="display: none; ">enumerated</span>
2918 <span id="typeTemplate">
2919 <span style="display: none; ">
2920 <a> Type</a>
2921 </span>
2922 <span>
2923 <span style="display: none; ">
2924 array of <span><span></span></span>
2925 </span>
2926 <span>string</span>
2927 <span style="display: none; "></span>
2928 </span>
2929 </span>
2930 )
2931 </div>
2932
2933 </em>
2934 </dt>
2935 <dd class="todo" style="display: none; ">
2936 Undocumented.
2937 </dd>
2938 <dd>The URL the offscreen tab is displaying.</dd>
2939 <dd style="display: none; ">
2940 This parameter was added in version
2941 <b><span></span></b>.
2942 You must omit this parameter in earlier versions,
2943 and you may omit it in any version. If you require this
2944 parameter, the manifest key
2945 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2946 can ensure that your extension won't be run in an earlier browser ve rsion.
2947 </dd>
2948
2949 <!-- OBJECT PROPERTIES -->
2950 <dd style="display: none; ">
2951 <dl>
2952 <div>
2953 <div>
2954 </div>
2955 </div>
2956 </dl>
2957 </dd>
2958
2959 <!-- OBJECT METHODS -->
2960 <dd style="display: none; ">
2961 <div></div>
2962 </dd>
2963
2964 <!-- OBJECT EVENT FIELDS -->
2965 <dd style="display: none; ">
2966 <div></div>
2967 </dd>
2968
2969 <!-- FUNCTION PARAMETERS -->
2970 <dd style="display: none; ">
2971 <div></div>
2972 </dd>
2973
2974 </div>
2975 </div><div>
2976 <div>
2977 <dt>
2978 <var>width</var>
2979 <em>
2980
2981 <!-- TYPE -->
2982 <div style="display:inline">
2983 (
2984 <span class="optional">optional</span>
2985 <span class="enum" style="display: none; ">enumerated</span>
2986 <span id="typeTemplate">
2987 <span style="display: none; ">
2988 <a> Type</a>
2989 </span>
2990 <span>
2991 <span style="display: none; ">
2992 array of <span><span></span></span>
2993 </span>
2994 <span>integer</span>
2995 <span style="display: none; "></span>
2996 </span>
2997 </span>
2998 )
2999 </div>
3000
3001 </em>
3002 </dt>
3003 <dd class="todo" style="display: none; ">
3004 Undocumented.
3005 </dd>
3006 <dd>Width of the window.</dd>
3007 <dd style="display: none; ">
3008 This parameter was added in version
3009 <b><span></span></b>.
3010 You must omit this parameter in earlier versions,
3011 and you may omit it in any version. If you require this
3012 parameter, the manifest key
3013 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3014 can ensure that your extension won't be run in an earlier browser ve rsion.
3015 </dd>
3016
3017 <!-- OBJECT PROPERTIES -->
3018 <dd style="display: none; ">
3019 <dl>
3020 <div>
3021 <div>
3022 </div>
3023 </div>
3024 </dl>
3025 </dd>
3026
3027 <!-- OBJECT METHODS -->
3028 <dd style="display: none; ">
3029 <div></div>
3030 </dd>
3031
3032 <!-- OBJECT EVENT FIELDS -->
3033 <dd style="display: none; ">
3034 <div></div>
3035 </dd>
3036
3037 <!-- FUNCTION PARAMETERS -->
3038 <dd style="display: none; ">
3039 <div></div>
3040 </dd>
3041
3042 </div>
3043 </div><div>
3044 <div>
3045 <dt>
3046 <var>height</var>
3047 <em>
3048
3049 <!-- TYPE -->
3050 <div style="display:inline">
3051 (
3052 <span class="optional">optional</span>
3053 <span class="enum" style="display: none; ">enumerated</span>
3054 <span id="typeTemplate">
3055 <span style="display: none; ">
3056 <a> Type</a>
3057 </span>
3058 <span>
3059 <span style="display: none; ">
3060 array of <span><span></span></span>
3061 </span>
3062 <span>integer</span>
3063 <span style="display: none; "></span>
3064 </span>
3065 </span>
3066 )
3067 </div>
3068
3069 </em>
3070 </dt>
3071 <dd class="todo" style="display: none; ">
3072 Undocumented.
3073 </dd>
3074 <dd>Height of the window.</dd>
3075 <dd style="display: none; ">
3076 This parameter was added in version
3077 <b><span></span></b>.
3078 You must omit this parameter in earlier versions,
3079 and you may omit it in any version. If you require this
3080 parameter, the manifest key
3081 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3082 can ensure that your extension won't be run in an earlier browser ve rsion.
3083 </dd>
3084
3085 <!-- OBJECT PROPERTIES -->
3086 <dd style="display: none; ">
3087 <dl>
3088 <div>
3089 <div>
3090 </div>
3091 </div>
3092 </dl>
3093 </dd>
3094
3095 <!-- OBJECT METHODS -->
3096 <dd style="display: none; ">
3097 <div></div>
3098 </dd>
3099
3100 <!-- OBJECT EVENT FIELDS -->
3101 <dd style="display: none; ">
3102 <div></div>
3103 </dd>
3104
3105 <!-- FUNCTION PARAMETERS -->
3106 <dd style="display: none; ">
3107 <div></div>
3108 </dd>
3109
3110 </div>
3111 </div>
3112 </dl>
3113 </dd>
3114
3115 <!-- OBJECT METHODS -->
3116 <dd style="display: none; ">
3117 <div></div>
3118 </dd>
3119
3120 <!-- OBJECT EVENT FIELDS -->
3121 <dd style="display: none; ">
3122 <div></div>
3123 </dd>
3124
3125 <!-- FUNCTION PARAMETERS -->
3126 <dd style="display: none; ">
3127 <div></div>
3128 </dd>
3129
3130 </div>
3131 </div><div>
3132 <div>
3133 <dt>
3134 <var>callback</var>
3135 <em>
3136
3137 <!-- TYPE -->
3138 <div style="display:inline">
3139 (
3140 <span class="optional">optional</span>
3141 <span class="enum" style="display: none; ">enumerated</span>
3142 <span id="typeTemplate">
3143 <span style="display: none; ">
3144 <a> Type</a>
3145 </span>
3146 <span>
3147 <span style="display: none; ">
3148 array of <span><span></span></span>
3149 </span>
3150 <span>function</span>
3151 <span style="display: none; "></span>
3152 </span>
3153 </span>
3154 )
3155 </div>
3156
3157 </em>
3158 </dt>
3159 <dd class="todo">
3160 Undocumented.
3161 </dd>
3162 <dd style="display: none; ">
3163 Description of this parameter from the json schema.
3164 </dd>
3165 <dd style="display: none; ">
3166 This parameter was added in version
3167 <b><span></span></b>.
3168 You must omit this parameter in earlier versions,
3169 and you may omit it in any version. If you require this
3170 parameter, the manifest key
3171 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3172 can ensure that your extension won't be run in an earlier browser ve rsion.
3173 </dd>
3174
3175 <!-- OBJECT PROPERTIES -->
3176 <dd style="display: none; ">
3177 <dl>
3178 <div>
3179 <div>
3180 </div>
3181 </div>
3182 </dl>
3183 </dd>
3184
3185 <!-- OBJECT METHODS -->
3186 <dd style="display: none; ">
3187 <div></div>
3188 </dd>
3189
3190 <!-- OBJECT EVENT FIELDS -->
3191 <dd style="display: none; ">
3192 <div></div>
3193 </dd>
3194
3195 <!-- FUNCTION PARAMETERS -->
3196 <dd style="display: none; ">
3197 <div></div>
3198 </dd>
3199
3200 </div>
3201 </div>
3202 </dl>
3203
3204 <!-- RETURNS -->
3205 <h4 style="display: none; ">Returns</h4>
3206 <dl>
3207 <div style="display: none; ">
3208 <div>
3209 </div>
3210 </div>
3211 </dl>
3212
3213 <!-- CALLBACK -->
3214 <div>
3215 <div>
3216 <h4>Callback function</h4>
3217 <p style="display: none; ">
3218 The callback <em>parameter</em> should specify a function
3219 that looks like this:
3220 </p>
3221 <p>
3222 If you specify the <em>callback</em> parameter, it should
3223 specify a function that looks like this:
3224 </p>
3225
3226 <!-- Note: intentionally longer 80 columns -->
3227 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl ass="subdued">{...}</span>;</pre>
3228 <dl>
3229 <div>
3230 <div>
3231 <dt>
3232 <var>offscreenTab</var>
3233 <em>
3234
3235 <!-- TYPE -->
3236 <div style="display:inline">
3237 (
3238 <span class="optional" style="display: none; ">optional</spa n>
3239 <span class="enum" style="display: none; ">enumerated</span>
3240 <span id="typeTemplate">
3241 <span>
3242 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
3243 </span>
3244 <span style="display: none; ">
3245 <span>
3246 array of <span><span></span></span>
3247 </span>
3248 <span>paramType</span>
3249 <span></span>
3250 </span>
3251 </span>
3252 )
3253 </div>
3254
3255 </em>
3256 </dt>
3257 <dd class="todo" style="display: none; ">
3258 Undocumented.
3259 </dd>
3260 <dd>Details of the offscreen tab.</dd>
3261 <dd style="display: none; ">
3262 This parameter was added in version
3263 <b><span></span></b>.
3264 You must omit this parameter in earlier versions,
3265 and you may omit it in any version. If you require this
3266 parameter, the manifest key
3267 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3268 can ensure that your extension won't be run in an earlier browser ve rsion.
3269 </dd>
3270
3271 <!-- OBJECT PROPERTIES -->
3272 <dd style="display: none; ">
3273 <dl>
3274 <div>
3275 <div>
3276 </div>
3277 </div>
3278 </dl>
3279 </dd>
3280
3281 <!-- OBJECT METHODS -->
3282 <dd style="display: none; ">
3283 <div></div>
3284 </dd>
3285
3286 <!-- OBJECT EVENT FIELDS -->
3287 <dd style="display: none; ">
3288 <div></div>
3289 </dd>
3290
3291 <!-- FUNCTION PARAMETERS -->
3292 <dd style="display: none; ">
3293 <div></div>
3294 </dd>
3295
3296 </div>
3297 </div>
3298 </dl>
3299 </div>
3300 </div>
3301
3302 <!-- MIN_VERSION -->
3303 <p style="display: none; ">
3304 This function was added in version <b><span></span></b>.
3305 If you require this function, the manifest key
3306 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
3307 can ensure that your extension won't be run in an earlier brow ser version.
3308 </p>
3309 </div> <!-- /description -->
3310
3311 </div> <!-- /apiItem -->
3312
3313 </div> <!-- /apiGroup -->
3314
3315 <!-- EVENTS -->
3316 <div id="eventsTemplate" class="apiGroup">
3317 <a name="global-events"></a>
3318 <h3>Events</h3>
3319 <!-- iterates over all events -->
3320 <div class="apiItem">
3321 <a name="event-onUpdated"></a>
3322 <h4>onUpdated</h4>
3323
3324 <div class="summary">
3325 <!-- Note: intentionally longer 80 columns -->
3326 <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>);
3327 </div>
3328
3329 <div class="description">
3330 <p class="todo" style="display: none; ">Undocumented.</p>
3331 <p>Fires when an offscreen tab is updated. </p>
3332
3333 <!-- LISTENER PARAMETERS -->
3334 <div>
3335 <h4>Listener parameters</h4>
3336 <dl>
3337 <div>
3338 <div>
3339 <dt>
3340 <var>offscreenTabId</var>
3341 <em>
3342
3343 <!-- TYPE -->
3344 <div style="display:inline">
3345 (
3346 <span class="optional" style="display: none; ">optional</spa n>
3347 <span class="enum" style="display: none; ">enumerated</span>
3348 <span id="typeTemplate">
3349 <span style="display: none; ">
3350 <a> Type</a>
3351 </span>
3352 <span>
3353 <span style="display: none; ">
3354 array of <span><span></span></span>
3355 </span>
3356 <span>integer</span>
3357 <span style="display: none; "></span>
3358 </span>
3359 </span>
3360 )
3361 </div>
3362
3363 </em>
3364 </dt>
3365 <dd class="todo" style="display: none; ">
3366 Undocumented.
3367 </dd>
3368 <dd>ID of the updated offscreen tab</dd>
3369 <dd style="display: none; ">
3370 This parameter was added in version
3371 <b><span></span></b>.
3372 You must omit this parameter in earlier versions,
3373 and you may omit it in any version. If you require this
3374 parameter, the manifest key
3375 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3376 can ensure that your extension won't be run in an earlier browser ve rsion.
3377 </dd>
3378
3379 <!-- OBJECT PROPERTIES -->
3380 <dd style="display: none; ">
3381 <dl>
3382 <div>
3383 <div>
3384 </div>
3385 </div>
3386 </dl>
3387 </dd>
3388
3389 <!-- OBJECT METHODS -->
3390 <dd style="display: none; ">
3391 <div></div>
3392 </dd>
3393
3394 <!-- OBJECT EVENT FIELDS -->
3395 <dd style="display: none; ">
3396 <div></div>
3397 </dd>
3398
3399 <!-- FUNCTION PARAMETERS -->
3400 <dd style="display: none; ">
3401 <div></div>
3402 </dd>
3403
3404 </div>
3405 </div><div>
3406 <div>
3407 <dt>
3408 <var>changeInfo</var>
3409 <em>
3410
3411 <!-- TYPE -->
3412 <div style="display:inline">
3413 (
3414 <span class="optional" style="display: none; ">optional</spa n>
3415 <span class="enum" style="display: none; ">enumerated</span>
3416 <span id="typeTemplate">
3417 <span style="display: none; ">
3418 <a> Type</a>
3419 </span>
3420 <span>
3421 <span style="display: none; ">
3422 array of <span><span></span></span>
3423 </span>
3424 <span>object</span>
3425 <span style="display: none; "></span>
3426 </span>
3427 </span>
3428 )
3429 </div>
3430
3431 </em>
3432 </dt>
3433 <dd class="todo" style="display: none; ">
3434 Undocumented.
3435 </dd>
3436 <dd>Lists the changes to the state of the offscreen tab that was updat ed.</dd>
3437 <dd style="display: none; ">
3438 This parameter was added in version
3439 <b><span></span></b>.
3440 You must omit this parameter in earlier versions,
3441 and you may omit it in any version. If you require this
3442 parameter, the manifest key
3443 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3444 can ensure that your extension won't be run in an earlier browser ve rsion.
3445 </dd>
3446
3447 <!-- OBJECT PROPERTIES -->
3448 <dd>
3449 <dl>
3450 <div>
3451 <div>
3452 <dt>
3453 <var>url</var>
3454 <em>
3455
3456 <!-- TYPE -->
3457 <div style="display:inline">
3458 (
3459 <span class="optional">optional</span>
3460 <span class="enum" style="display: none; ">enumerated</span>
3461 <span id="typeTemplate">
3462 <span style="display: none; ">
3463 <a> Type</a>
3464 </span>
3465 <span>
3466 <span style="display: none; ">
3467 array of <span><span></span></span>
3468 </span>
3469 <span>string</span>
3470 <span style="display: none; "></span>
3471 </span>
3472 </span>
3473 )
3474 </div>
3475
3476 </em>
3477 </dt>
3478 <dd class="todo" style="display: none; ">
3479 Undocumented.
3480 </dd>
3481 <dd>The offscreen tab's URL if it has changed.</dd>
3482 <dd style="display: none; ">
3483 This parameter was added in version
3484 <b><span></span></b>.
3485 You must omit this parameter in earlier versions,
3486 and you may omit it in any version. If you require this
3487 parameter, the manifest key
3488 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3489 can ensure that your extension won't be run in an earlier browser ve rsion.
3490 </dd>
3491
3492 <!-- OBJECT PROPERTIES -->
3493 <dd style="display: none; ">
3494 <dl>
3495 <div>
3496 <div>
3497 </div>
3498 </div>
3499 </dl>
3500 </dd>
3501
3502 <!-- OBJECT METHODS -->
3503 <dd style="display: none; ">
3504 <div></div>
3505 </dd>
3506
3507 <!-- OBJECT EVENT FIELDS -->
3508 <dd style="display: none; ">
3509 <div></div>
3510 </dd>
3511
3512 <!-- FUNCTION PARAMETERS -->
3513 <dd style="display: none; ">
3514 <div></div>
3515 </dd>
3516
3517 </div>
3518 </div>
3519 </dl>
3520 </dd>
3521
3522 <!-- OBJECT METHODS -->
3523 <dd style="display: none; ">
3524 <div></div>
3525 </dd>
3526
3527 <!-- OBJECT EVENT FIELDS -->
3528 <dd style="display: none; ">
3529 <div></div>
3530 </dd>
3531
3532 <!-- FUNCTION PARAMETERS -->
3533 <dd style="display: none; ">
3534 <div></div>
3535 </dd>
3536
3537 </div>
3538 </div><div>
3539 <div>
3540 <dt>
3541 <var>offscreenTab</var>
3542 <em>
3543
3544 <!-- TYPE -->
3545 <div style="display:inline">
3546 (
3547 <span class="optional" style="display: none; ">optional</spa n>
3548 <span class="enum" style="display: none; ">enumerated</span>
3549 <span id="typeTemplate">
3550 <span>
3551 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
3552 </span>
3553 <span style="display: none; ">
3554 <span>
3555 array of <span><span></span></span>
3556 </span>
3557 <span>paramType</span>
3558 <span></span>
3559 </span>
3560 </span>
3561 )
3562 </div>
3563
3564 </em>
3565 </dt>
3566 <dd class="todo" style="display: none; ">
3567 Undocumented.
3568 </dd>
3569 <dd>Details of the offscreen tab.</dd>
3570 <dd style="display: none; ">
3571 This parameter was added in version
3572 <b><span></span></b>.
3573 You must omit this parameter in earlier versions,
3574 and you may omit it in any version. If you require this
3575 parameter, the manifest key
3576 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3577 can ensure that your extension won't be run in an earlier browser ve rsion.
3578 </dd>
3579
3580 <!-- OBJECT PROPERTIES -->
3581 <dd style="display: none; ">
3582 <dl>
3583 <div>
3584 <div>
3585 </div>
3586 </div>
3587 </dl>
3588 </dd>
3589
3590 <!-- OBJECT METHODS -->
3591 <dd style="display: none; ">
3592 <div></div>
3593 </dd>
3594
3595 <!-- OBJECT EVENT FIELDS -->
3596 <dd style="display: none; ">
3597 <div></div>
3598 </dd>
3599
3600 <!-- FUNCTION PARAMETERS -->
3601 <dd style="display: none; ">
3602 <div></div>
3603 </dd>
3604
3605 </div>
3606 </div>
3607 </dl>
3608 </div>
3609
3610 <!-- EXTRA PARAMETERS -->
3611 <div style="display: none; ">
3612 <h4>Extra parameters to addListener</h4>
3613 <dl>
3614 <div>
3615 <div>
3616 </div>
3617 </div>
3618 </dl>
3619 </div>
3620
3621 <!-- LISTENER RETURN VALUE -->
3622 <h4 style="display: none; ">Listener returns</h4>
3623 <dl>
3624 <div style="display: none; ">
3625 <div>
3626 </div>
3627 </div>
3628 </dl>
3629
3630 </div> <!-- /description -->
3631 </div> <!-- /apiItem -->
3632
3633 </div> <!-- /apiGroup -->
3634
3635 <!-- TYPES -->
3636 <div class="apiGroup">
3637 <a name="types"></a>
3638 <h3 id="types">Types</h3>
3639
3640 <!-- iterates over all types -->
3641 <div class="apiItem">
3642 <a name="type-OffscreenTab"></a>
3643 <h4>OffscreenTab</h4>
3644
3645 <div>
3646 <dt>
3647 <var style="display: none; ">paramName</var>
3648 <em>
3649
3650 <!-- TYPE -->
3651 <div style="display:inline">
3652 (
3653 <span class="optional" style="display: none; ">optional</spa n>
3654 <span class="enum" style="display: none; ">enumerated</span>
3655 <span id="typeTemplate">
3656 <span style="display: none; ">
3657 <a> Type</a>
3658 </span>
3659 <span>
3660 <span style="display: none; ">
3661 array of <span><span></span></span>
3662 </span>
3663 <span>object</span>
3664 <span style="display: none; "></span>
3665 </span>
3666 </span>
3667 )
3668 </div>
3669
3670 </em>
3671 </dt>
3672 <dd class="todo">
3673 Undocumented.
3674 </dd>
3675 <dd style="display: none; ">
3676 Description of this parameter from the json schema.
3677 </dd>
3678 <dd style="display: none; ">
3679 This parameter was added in version
3680 <b><span></span></b>.
3681 You must omit this parameter in earlier versions,
3682 and you may omit it in any version. If you require this
3683 parameter, the manifest key
3684 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3685 can ensure that your extension won't be run in an earlier browser ve rsion.
3686 </dd>
3687
3688 <!-- OBJECT PROPERTIES -->
3689 <dd>
3690 <dl>
3691 <div>
3692 <div>
3693 <dt>
3694 <var>id</var>
3695 <em>
3696
3697 <!-- TYPE -->
3698 <div style="display:inline">
3699 (
3700 <span class="optional" style="display: none; ">optional</spa n>
3701 <span class="enum" style="display: none; ">enumerated</span>
3702 <span id="typeTemplate">
3703 <span style="display: none; ">
3704 <a> Type</a>
3705 </span>
3706 <span>
3707 <span style="display: none; ">
3708 array of <span><span></span></span>
3709 </span>
3710 <span>integer</span>
3711 <span style="display: none; "></span>
3712 </span>
3713 </span>
3714 )
3715 </div>
3716
3717 </em>
3718 </dt>
3719 <dd class="todo" style="display: none; ">
3720 Undocumented.
3721 </dd>
3722 <dd>The ID of the offscreen tab. Tab IDs are unique within a browser s ession.</dd>
3723 <dd style="display: none; ">
3724 This parameter was added in version
3725 <b><span></span></b>.
3726 You must omit this parameter in earlier versions,
3727 and you may omit it in any version. If you require this
3728 parameter, the manifest key
3729 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3730 can ensure that your extension won't be run in an earlier browser ve rsion.
3731 </dd>
3732
3733 <!-- OBJECT PROPERTIES -->
3734 <dd style="display: none; ">
3735 <dl>
3736 <div>
3737 <div>
3738 </div>
3739 </div>
3740 </dl>
3741 </dd>
3742
3743 <!-- OBJECT METHODS -->
3744 <dd style="display: none; ">
3745 <div></div>
3746 </dd>
3747
3748 <!-- OBJECT EVENT FIELDS -->
3749 <dd style="display: none; ">
3750 <div></div>
3751 </dd>
3752
3753 <!-- FUNCTION PARAMETERS -->
3754 <dd style="display: none; ">
3755 <div></div>
3756 </dd>
3757
3758 </div>
3759 </div><div>
3760 <div>
3761 <dt>
3762 <var>url</var>
3763 <em>
3764
3765 <!-- TYPE -->
3766 <div style="display:inline">
3767 (
3768 <span class="optional" style="display: none; ">optional</spa n>
3769 <span class="enum" style="display: none; ">enumerated</span>
3770 <span id="typeTemplate">
3771 <span style="display: none; ">
3772 <a> Type</a>
3773 </span>
3774 <span>
3775 <span style="display: none; ">
3776 array of <span><span></span></span>
3777 </span>
3778 <span>string</span>
3779 <span style="display: none; "></span>
3780 </span>
3781 </span>
3782 )
3783 </div>
3784
3785 </em>
3786 </dt>
3787 <dd class="todo" style="display: none; ">
3788 Undocumented.
3789 </dd>
3790 <dd>URL of the offscreen tab.</dd>
3791 <dd style="display: none; ">
3792 This parameter was added in version
3793 <b><span></span></b>.
3794 You must omit this parameter in earlier versions,
3795 and you may omit it in any version. If you require this
3796 parameter, the manifest key
3797 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3798 can ensure that your extension won't be run in an earlier browser ve rsion.
3799 </dd>
3800
3801 <!-- OBJECT PROPERTIES -->
3802 <dd style="display: none; ">
3803 <dl>
3804 <div>
3805 <div>
3806 </div>
3807 </div>
3808 </dl>
3809 </dd>
3810
3811 <!-- OBJECT METHODS -->
3812 <dd style="display: none; ">
3813 <div></div>
3814 </dd>
3815
3816 <!-- OBJECT EVENT FIELDS -->
3817 <dd style="display: none; ">
3818 <div></div>
3819 </dd>
3820
3821 <!-- FUNCTION PARAMETERS -->
3822 <dd style="display: none; ">
3823 <div></div>
3824 </dd>
3825
3826 </div>
3827 </div><div>
3828 <div>
3829 <dt>
3830 <var>width</var>
3831 <em>
3832
3833 <!-- TYPE -->
3834 <div style="display:inline">
3835 (
3836 <span class="optional" style="display: none; ">optional</spa n>
3837 <span class="enum" style="display: none; ">enumerated</span>
3838 <span id="typeTemplate">
3839 <span style="display: none; ">
3840 <a> Type</a>
3841 </span>
3842 <span>
3843 <span style="display: none; ">
3844 array of <span><span></span></span>
3845 </span>
3846 <span>integer</span>
3847 <span style="display: none; "></span>
3848 </span>
3849 </span>
3850 )
3851 </div>
3852
3853 </em>
3854 </dt>
3855 <dd class="todo" style="display: none; ">
3856 Undocumented.
3857 </dd>
3858 <dd>Width of the window.</dd>
3859 <dd style="display: none; ">
3860 This parameter was added in version
3861 <b><span></span></b>.
3862 You must omit this parameter in earlier versions,
3863 and you may omit it in any version. If you require this
3864 parameter, the manifest key
3865 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3866 can ensure that your extension won't be run in an earlier browser ve rsion.
3867 </dd>
3868
3869 <!-- OBJECT PROPERTIES -->
3870 <dd style="display: none; ">
3871 <dl>
3872 <div>
3873 <div>
3874 </div>
3875 </div>
3876 </dl>
3877 </dd>
3878
3879 <!-- OBJECT METHODS -->
3880 <dd style="display: none; ">
3881 <div></div>
3882 </dd>
3883
3884 <!-- OBJECT EVENT FIELDS -->
3885 <dd style="display: none; ">
3886 <div></div>
3887 </dd>
3888
3889 <!-- FUNCTION PARAMETERS -->
3890 <dd style="display: none; ">
3891 <div></div>
3892 </dd>
3893
3894 </div>
3895 </div><div>
3896 <div>
3897 <dt>
3898 <var>height</var>
3899 <em>
3900
3901 <!-- TYPE -->
3902 <div style="display:inline">
3903 (
3904 <span class="optional" style="display: none; ">optional</spa n>
3905 <span class="enum" style="display: none; ">enumerated</span>
3906 <span id="typeTemplate">
3907 <span style="display: none; ">
3908 <a> Type</a>
3909 </span>
3910 <span>
3911 <span style="display: none; ">
3912 array of <span><span></span></span>
3913 </span>
3914 <span>integer</span>
3915 <span style="display: none; "></span>
3916 </span>
3917 </span>
3918 )
3919 </div>
3920
3921 </em>
3922 </dt>
3923 <dd class="todo" style="display: none; ">
3924 Undocumented.
3925 </dd>
3926 <dd>Height of the window.</dd>
3927 <dd style="display: none; ">
3928 This parameter was added in version
3929 <b><span></span></b>.
3930 You must omit this parameter in earlier versions,
3931 and you may omit it in any version. If you require this
3932 parameter, the manifest key
3933 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3934 can ensure that your extension won't be run in an earlier browser ve rsion.
3935 </dd>
3936
3937 <!-- OBJECT PROPERTIES -->
3938 <dd style="display: none; ">
3939 <dl>
3940 <div>
3941 <div>
3942 </div>
3943 </div>
3944 </dl>
3945 </dd>
3946
3947 <!-- OBJECT METHODS -->
3948 <dd style="display: none; ">
3949 <div></div>
3950 </dd>
3951
3952 <!-- OBJECT EVENT FIELDS -->
3953 <dd style="display: none; ">
3954 <div></div>
3955 </dd>
3956
3957 <!-- FUNCTION PARAMETERS -->
3958 <dd style="display: none; ">
3959 <div></div>
3960 </dd>
3961
3962 </div>
3963 </div>
3964 </dl>
3965 </dd>
3966
3967 <!-- OBJECT METHODS -->
3968 <dd style="display: none; ">
3969 <div></div>
3970 </dd>
3971
3972 <!-- OBJECT EVENT FIELDS -->
3973 <dd style="display: none; ">
3974 <div></div>
3975 </dd>
3976
3977 <!-- FUNCTION PARAMETERS -->
3978 <dd style="display: none; ">
3979 <div></div>
3980 </dd>
3981
3982 </div>
3983
3984 </div> <!-- /apiItem -->
3985
3986 </div> <!-- /apiGroup -->
3987
3988 </div> <!-- /apiPage -->
3989 </div> <!-- /gc-pagecontent -->
3990 </div> <!-- /g-section -->
3991 </div> <!-- /codesiteContent -->
3992 <div id="gc-footer" --="">
3993 <div class="text">
3994 <p>
3995 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
3996 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
3997 Attribution 3.0 License</a>, and code samples are licensed under the
3998 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
3999 </p>
4000 <p>
4001 ©2011 Google
4002 </p>
4003
4004 <!-- begin analytics -->
4005 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
4006 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
4007
4008 <script type="text/javascript">
4009 // chrome doc tracking
4010 try {
4011 var engdocs = _gat._getTracker("YT-10763712-2");
4012 engdocs._trackPageview();
4013 } catch(err) {}
4014
4015 // code.google.com site-wide tracking
4016 try {
4017 _uacct="UA-18071-1";
4018 _uanchor=1;
4019 _uff=0;
4020 urchinTracker();
4021 }
4022 catch(e) {/* urchinTracker not available. */}
4023 </script>
4024 <!-- end analytics -->
4025 </div>
4026 </div> <!-- /gc-footer -->
4027 </div> <!-- /gc-container -->
4028 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698