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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 3061041: Add the definition of the webRequest and webNavigation APIs. (Closed)
Patch Set: updates Created 10 years, 4 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
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/experimental.webRequest.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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 <title>chrome.experimental.webNavigation - Google Chrome Extensions - Google C ode</title></head>
19 <body> <div id="gc-container" class="labs">
20 <div id="devModeWarning">
21 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.
22 </div>
23 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
24 <!-- In particular, sub-templates that recurse, must be used by allowing
25 jstemplate to make a copy of the template in this section which
26 are not operated on by way of the jsskip="true" -->
27 <div style="display:none">
28
29 <!-- VALUE -->
30 <div id="valueTemplate">
31 <dt>
32 <var>paramName</var>
33 <em>
34
35 <!-- TYPE -->
36 <div style="display:inline">
37 (
38 <span class="optional">optional</span>
39 <span class="enum">enumerated</span>
40 <span id="typeTemplate">
41 <span>
42 <a> Type</a>
43 </span>
44 <span>
45 <span>
46 array of <span><span></span></span>
47 </span>
48 <span>paramType</span>
49 <span></span>
50 </span>
51 </span>
52 )
53 </div>
54
55 </em>
56 </dt>
57 <dd class="todo">
58 Undocumented.
59 </dd>
60 <dd>
61 Description of this parameter from the json schema.
62 </dd>
63 <dd>
64 This parameter was added in version
65 <b><span></span></b>.
66 You must omit this parameter in earlier versions,
67 and you may omit it in any version. If you require this
68 parameter, the manifest key
69 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
70 can ensure that your extension won't be run in an earlier browser ve rsion.
71 </dd>
72
73 <!-- OBJECT PROPERTIES -->
74 <dd>
75 <dl>
76 <div>
77 <div>
78 </div>
79 </div>
80 </dl>
81 </dd>
82 </div> <!-- /VALUE -->
83
84 </div> <!-- /SUBTEMPLATES -->
85
86 <a id="top"></a>
87 <div id="skipto">
88 <a href="#gc-pagecontent">Skip to page content</a>
89 <a href="#gc-toc">Skip to main navigation</a>
90 </div>
91 <!-- API HEADER -->
92 <table id="header" width="100%" cellspacing="0" border="0">
93 <tbody><tr>
94 <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>
95 <td valign="middle" width="100%" style="padding-left:0.6em;">
96 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
97 <div id="gsc-search-box">
98 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
99 <input type="hidden" name="ie" value="UTF-8">
100 <input type="text" name="q" value="" size="55">
101 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
102 <br>
103 <span class="greytext">e.g. "page action" or "tabs"</span>
104 </div>
105 </form>
106
107 <script type="text/javascript" src="http://www.google.com/jsapi"></scr ipt>
108 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
109 <script type="text/javascript" src="http://www.google.com/coop/cse/t13 n?form=cse&amp;t13n_langs=en"></script>
110 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&amp;lang=en"></script>
111 </td>
112 </tr>
113 </tbody></table>
114
115 <div id="codesiteContent" class="">
116
117 <a id="gc-topnav-anchor"></a>
118 <div id="gc-topnav">
119 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
120 <ul id="home" class="gc-topnav-tabs">
121 <li id="home_link">
122 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
123 </li>
124 <li id="docs_link">
125 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
126 </li>
127 <li id="faq_link">
128 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
129 </li>
130 <li id="samples_link">
131 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
132 </li>
133 <li id="group_link">
134 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
135 </li>
136 </ul>
137 </div> <!-- end gc-topnav -->
138
139 <div class="g-section g-tpl-170">
140 <!-- SIDENAV -->
141 <div class="g-unit g-first" id="gc-toc">
142 <ul>
143 <li><a href="getstarted.html">Getting Started</a></li>
144 <li><a href="overview.html">Overview</a></li>
145 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
146 <ul>
147 <li>Browser UI
148 <ul>
149 <li><a href="browserAction.html">Browser Actions</a></li>
150 <li><a href="contextMenus.html">Context Menus</a></li>
151 <li><a href="notifications.html">Desktop Notifications</a></li >
152 <li><a href="options.html">Options Pages</a></li>
153 <li><a href="override.html">Override Pages</a></li>
154 <li><a href="pageAction.html">Page Actions</a></li>
155 <li><a href="themes.html">Themes</a></li>
156 </ul>
157 </li>
158 <li>Browser Interaction
159 <ul>
160 <li><a href="bookmarks.html">Bookmarks</a></li>
161 <li><a href="cookies.html">Cookies</a></li>
162 <li><a href="events.html">Events</a></li>
163 <li><a href="history.html">History</a></li>
164 <li><a href="tabs.html">Tabs</a></li>
165 <li><a href="windows.html">Windows</a></li>
166 </ul>
167 </li>
168 <li>Implementation
169 <ul>
170 <li><a href="a11y.html">Accessibility</a></li>
171 <li><a href="background_pages.html">Background Pages</a></li>
172 <li><a href="content_scripts.html">Content Scripts</a></li>
173 <li><a href="xhr.html">Cross-Origin XHR</a></li>
174 <li><a href="idle.html">Idle</a></li>
175 <li><a href="i18n.html">Internationalization</a></li>
176 <li><a href="messaging.html">Message Passing</a></li>
177 <li><a href="npapi.html">NPAPI Plugins</a></li>
178 </ul>
179 </li>
180 <li>Finishing
181 <ul>
182 <li><a href="hosting.html">Hosting</a></li>
183 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
184 </ul>
185 </li>
186 </ul>
187 </li>
188 <li><h2><a href="tutorials.html">Tutorials</a></h2>
189 <ul>
190 <li><a href="tut_debugging.html">Debugging</a></li>
191 <li><a href="tut_analytics.html">Google Analytics</a></li>
192 <li><a href="tut_oauth.html">OAuth</a></li>
193 </ul>
194 </li>
195 <li><h2>Reference</h2>
196 <ul>
197 <li>Formats
198 <ul>
199 <li><a href="manifest.html">Manifest Files</a></li>
200 <li><a href="match_patterns.html">Match Patterns</a></li>
201 <!-- <li>Packages (.crx)</li> -->
202 </ul>
203 </li>
204 <li><a href="api_index.html">chrome.* APIs</a></li>
205 <li><a href="api_other.html">Other APIs</a></li>
206 </ul>
207 </li>
208 <li><h2><a href="samples.html">Samples</a></h2></li>
209 </ul>
210 </div>
211
212 <div class="g-unit" id="gc-pagecontent">
213 <div id="pageTitle">
214 <h1 class="page_title">chrome.experimental.webNavigation</h1>
215 </div>
216 <!-- TABLE OF CONTENTS -->
217 <div id="toc">
218 <h2>Contents</h2>
219 <ol>
220 <li style="display: none; ">
221 <a>h2Name</a>
222 <ol>
223 <li>
224 <a>h3Name</a>
225 </li>
226 </ol>
227 </li>
228 <li>
229 <a href="#apiReference">API reference: chrome.experimental.webNa vigation</a>
230 <ol>
231 <li style="display: none; ">
232 <a href="#properties">Properties</a>
233 <ol>
234 <li>
235 <a href="#property-anchor">propertyName</a>
236 </li>
237 </ol>
238 </li>
239 <li style="display: none; ">
240 <a href="#methods">Methods</a>
241 <ol>
242 <li>
243 <a href="#method-anchor">methodName</a>
244 </li>
245 </ol>
246 </li>
247 <li>
248 <a href="#events">Events</a>
249 <ol>
250 <li>
251 <a href="#event-onBeforeNavigate">onBeforeNavigate</a>
252 </li><li>
253 <a href="#event-onBeforeRetarget">onBeforeRetarget</a>
254 </li><li>
255 <a href="#event-onCommitted">onCommitted</a>
256 </li><li>
257 <a href="#event-onCompleted">onCompleted</a>
258 </li><li>
259 <a href="#event-onDOMContentLoaded">onDOMContentLoaded</ a>
260 </li><li>
261 <a href="#event-onErrorOccurred">onErrorOccurred</a>
262 </li>
263 </ol>
264 </li>
265 <li style="display: none; ">
266 <a href="#types">Types</a>
267 <ol>
268 <li>
269 <a href="#id-anchor">id</a>
270 </li>
271 </ol>
272 </li>
273 </ol>
274 </li>
275 </ol>
276 </div>
277 <!-- /TABLE OF CONTENTS -->
278
279 <!-- Standard content lead-in for experimental API pages -->
280 <p id="classSummary">
281 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
282 </p>
283
284 <!-- STATIC CONTENT PLACEHOLDER -->
285 <div id="static"></div>
286
287 <!-- API PAGE -->
288 <div class="apiPage">
289 <a name="apiReference"></a>
290 <h2>API reference: chrome.experimental.webNavigation</h2>
291
292 <!-- PROPERTIES -->
293 <div class="apiGroup" style="display: none; ">
294 <a name="properties"></a>
295 <h3 id="properties">Properties</h3>
296
297 <div>
298 <a></a>
299 <h4>getLastError</h4>
300 <div class="summary">
301 <!-- Note: intentionally longer 80 columns -->
302 <span>chrome.extension</span><span>lastError</span>
303 </div>
304 <div>
305 </div>
306 </div>
307
308 </div> <!-- /apiGroup -->
309
310 <!-- METHODS -->
311 <div class="apiGroup" id="methods" style="display: none; ">
312 <a name="methods"></a>
313 <h3>Methods</h3>
314
315 <!-- iterates over all functions -->
316 <div class="apiItem">
317 <a></a> <!-- method-anchor -->
318 <h4>method name</h4>
319
320 <div class="summary"><span>void</span>
321 <!-- Note: intentionally longer 80 columns -->
322 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
323 <var><span></span></var></span>)</div>
324
325 <div class="description">
326 <p class="todo">Undocumented.</p>
327 <p>
328 A description from the json schema def of the function goes he re.
329 </p>
330
331 <!-- PARAMETERS -->
332 <h4>Parameters</h4>
333 <dl>
334 <div>
335 <div>
336 </div>
337 </div>
338 </dl>
339
340 <!-- RETURNS -->
341 <h4>Returns</h4>
342 <dl>
343 <div>
344 <div>
345 </div>
346 </div>
347 </dl>
348
349 <!-- CALLBACK -->
350 <div>
351 <div>
352 <h4>Callback function</h4>
353 <p>
354 The callback <em>parameter</em> should specify a function
355 that looks like this:
356 </p>
357 <p>
358 If you specify the <em>callback</em> parameter, it should
359 specify a function that looks like this:
360 </p>
361
362 <!-- Note: intentionally longer 80 columns -->
363 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
364 <dl>
365 <div>
366 <div>
367 </div>
368 </div>
369 </dl>
370 </div>
371 </div>
372
373 <!-- MIN_VERSION -->
374 <p>
375 This function was added in version <b><span></span></b>.
376 If you require this function, the manifest key
377 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
378 can ensure that your extension won't be run in an earlier brow ser version.
379 </p>
380 </div> <!-- /description -->
381
382 </div> <!-- /apiItem -->
383
384 </div> <!-- /apiGroup -->
385
386 <!-- EVENTS -->
387 <div class="apiGroup">
388 <a name="events"></a>
389 <h3 id="events">Events</h3>
390
391 <!-- iterates over all events -->
392 <div class="apiItem">
393 <a name="event-onBeforeNavigate"></a>
394 <h4>onBeforeNavigate</h4>
395
396 <div class="summary">
397 <!-- Note: intentionally longer 80 columns -->
398 <span class="subdued">chrome.experimental.webNavigation.</span>< span>onBeforeNavigate</span><span class="subdued">.addListener</span>(function(< span>object details</span>) <span class="subdued">{...}</span>);
399 </div>
400
401 <div class="description">
402 <p class="todo" style="display: none; ">Undocumented.</p>
403 <p>Fires when a navigation is about to occur.</p>
404
405 <!-- PARAMETERS -->
406 <h4>Parameters</h4>
407 <dl>
408 <div>
409 <div>
410 <dt>
411 <var>details</var>
412 <em>
413
414 <!-- TYPE -->
415 <div style="display:inline">
416 (
417 <span class="optional" style="display: none; ">optional</spa n>
418 <span class="enum" style="display: none; ">enumerated</span>
419 <span id="typeTemplate">
420 <span style="display: none; ">
421 <a> Type</a>
422 </span>
423 <span>
424 <span style="display: none; ">
425 array of <span><span></span></span>
426 </span>
427 <span>object</span>
428 <span style="display: none; "></span>
429 </span>
430 </span>
431 )
432 </div>
433
434 </em>
435 </dt>
436 <dd class="todo">
437 Undocumented.
438 </dd>
439 <dd style="display: none; ">
440 Description of this parameter from the json schema.
441 </dd>
442 <dd style="display: none; ">
443 This parameter was added in version
444 <b><span></span></b>.
445 You must omit this parameter in earlier versions,
446 and you may omit it in any version. If you require this
447 parameter, the manifest key
448 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
449 can ensure that your extension won't be run in an earlier browser ve rsion.
450 </dd>
451
452 <!-- OBJECT PROPERTIES -->
453 <dd>
454 <dl>
455 <div>
456 <div>
457 <dt>
458 <var>tabId</var>
459 <em>
460
461 <!-- TYPE -->
462 <div style="display:inline">
463 (
464 <span class="optional" style="display: none; ">optional</spa n>
465 <span class="enum" style="display: none; ">enumerated</span>
466 <span id="typeTemplate">
467 <span style="display: none; ">
468 <a> Type</a>
469 </span>
470 <span>
471 <span style="display: none; ">
472 array of <span><span></span></span>
473 </span>
474 <span>integer</span>
475 <span style="display: none; "></span>
476 </span>
477 </span>
478 )
479 </div>
480
481 </em>
482 </dt>
483 <dd class="todo" style="display: none; ">
484 Undocumented.
485 </dd>
486 <dd>The ID of the tab in which the navigation is about to occur.</dd>
487 <dd style="display: none; ">
488 This parameter was added in version
489 <b><span></span></b>.
490 You must omit this parameter in earlier versions,
491 and you may omit it in any version. If you require this
492 parameter, the manifest key
493 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
494 can ensure that your extension won't be run in an earlier browser ve rsion.
495 </dd>
496
497 <!-- OBJECT PROPERTIES -->
498 <dd style="display: none; ">
499 <dl>
500 <div>
501 <div>
502 </div>
503 </div>
504 </dl>
505 </dd>
506 </div>
507 </div><div>
508 <div>
509 <dt>
510 <var>url</var>
511 <em>
512
513 <!-- TYPE -->
514 <div style="display:inline">
515 (
516 <span class="optional" style="display: none; ">optional</spa n>
517 <span class="enum" style="display: none; ">enumerated</span>
518 <span id="typeTemplate">
519 <span style="display: none; ">
520 <a> Type</a>
521 </span>
522 <span>
523 <span style="display: none; ">
524 array of <span><span></span></span>
525 </span>
526 <span>string</span>
527 <span style="display: none; "></span>
528 </span>
529 </span>
530 )
531 </div>
532
533 </em>
534 </dt>
535 <dd class="todo">
536 Undocumented.
537 </dd>
538 <dd style="display: none; ">
539 Description of this parameter from the json schema.
540 </dd>
541 <dd style="display: none; ">
542 This parameter was added in version
543 <b><span></span></b>.
544 You must omit this parameter in earlier versions,
545 and you may omit it in any version. If you require this
546 parameter, the manifest key
547 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
548 can ensure that your extension won't be run in an earlier browser ve rsion.
549 </dd>
550
551 <!-- OBJECT PROPERTIES -->
552 <dd style="display: none; ">
553 <dl>
554 <div>
555 <div>
556 </div>
557 </div>
558 </dl>
559 </dd>
560 </div>
561 </div><div>
562 <div>
563 <dt>
564 <var>frameId</var>
565 <em>
566
567 <!-- TYPE -->
568 <div style="display:inline">
569 (
570 <span class="optional" style="display: none; ">optional</spa n>
571 <span class="enum" style="display: none; ">enumerated</span>
572 <span id="typeTemplate">
573 <span style="display: none; ">
574 <a> Type</a>
575 </span>
576 <span>
577 <span style="display: none; ">
578 array of <span><span></span></span>
579 </span>
580 <span>integer</span>
581 <span style="display: none; "></span>
582 </span>
583 </span>
584 )
585 </div>
586
587 </em>
588 </dt>
589 <dd class="todo" style="display: none; ">
590 Undocumented.
591 </dd>
592 <dd>0 indicates the navigation happens in the tab content window; posi tive value indicates navigation in a subframe. Frame IDs are unique within a tab .</dd>
593 <dd style="display: none; ">
594 This parameter was added in version
595 <b><span></span></b>.
596 You must omit this parameter in earlier versions,
597 and you may omit it in any version. If you require this
598 parameter, the manifest key
599 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
600 can ensure that your extension won't be run in an earlier browser ve rsion.
601 </dd>
602
603 <!-- OBJECT PROPERTIES -->
604 <dd style="display: none; ">
605 <dl>
606 <div>
607 <div>
608 </div>
609 </div>
610 </dl>
611 </dd>
612 </div>
613 </div><div>
614 <div>
615 <dt>
616 <var>requestId</var>
617 <em>
618
619 <!-- TYPE -->
620 <div style="display:inline">
621 (
622 <span class="optional" style="display: none; ">optional</spa n>
623 <span class="enum" style="display: none; ">enumerated</span>
624 <span id="typeTemplate">
625 <span style="display: none; ">
626 <a> Type</a>
627 </span>
628 <span>
629 <span style="display: none; ">
630 array of <span><span></span></span>
631 </span>
632 <span>integer</span>
633 <span style="display: none; "></span>
634 </span>
635 </span>
636 )
637 </div>
638
639 </em>
640 </dt>
641 <dd class="todo" style="display: none; ">
642 Undocumented.
643 </dd>
644 <dd>The ID of the request to retrieve the document of this navigation. Note that this event is fired prior to the corresponding chrome.experimental.we bRequest.onBeforeRequest.</dd>
645 <dd style="display: none; ">
646 This parameter was added in version
647 <b><span></span></b>.
648 You must omit this parameter in earlier versions,
649 and you may omit it in any version. If you require this
650 parameter, the manifest key
651 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
652 can ensure that your extension won't be run in an earlier browser ve rsion.
653 </dd>
654
655 <!-- OBJECT PROPERTIES -->
656 <dd style="display: none; ">
657 <dl>
658 <div>
659 <div>
660 </div>
661 </div>
662 </dl>
663 </dd>
664 </div>
665 </div><div>
666 <div>
667 <dt>
668 <var>timeStamp</var>
669 <em>
670
671 <!-- TYPE -->
672 <div style="display:inline">
673 (
674 <span class="optional" style="display: none; ">optional</spa n>
675 <span class="enum" style="display: none; ">enumerated</span>
676 <span id="typeTemplate">
677 <span style="display: none; ">
678 <a> Type</a>
679 </span>
680 <span>
681 <span style="display: none; ">
682 array of <span><span></span></span>
683 </span>
684 <span>number</span>
685 <span style="display: none; "></span>
686 </span>
687 </span>
688 )
689 </div>
690
691 </em>
692 </dt>
693 <dd class="todo" style="display: none; ">
694 Undocumented.
695 </dd>
696 <dd>The time when the browser was about to start the navigation, in mi lliseconds since the epoch.</dd>
697 <dd style="display: none; ">
698 This parameter was added in version
699 <b><span></span></b>.
700 You must omit this parameter in earlier versions,
701 and you may omit it in any version. If you require this
702 parameter, the manifest key
703 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
704 can ensure that your extension won't be run in an earlier browser ve rsion.
705 </dd>
706
707 <!-- OBJECT PROPERTIES -->
708 <dd style="display: none; ">
709 <dl>
710 <div>
711 <div>
712 </div>
713 </div>
714 </dl>
715 </dd>
716 </div>
717 </div>
718 </dl>
719 </dd>
720 </div>
721 </div>
722 </dl>
723
724 </div> <!-- /decription -->
725
726 </div><div class="apiItem">
727 <a name="event-onBeforeRetarget"></a>
728 <h4>onBeforeRetarget</h4>
729
730 <div class="summary">
731 <!-- Note: intentionally longer 80 columns -->
732 <span class="subdued">chrome.experimental.webNavigation.</span>< span>onBeforeRetarget</span><span class="subdued">.addListener</span>(function(< span>object details</span>) <span class="subdued">{...}</span>);
733 </div>
734
735 <div class="description">
736 <p class="todo" style="display: none; ">Undocumented.</p>
737 <p>Fires when a new window, or a new tab in an existing window, is about to be created to host a navigation.</p>
738
739 <!-- PARAMETERS -->
740 <h4>Parameters</h4>
741 <dl>
742 <div>
743 <div>
744 <dt>
745 <var>details</var>
746 <em>
747
748 <!-- TYPE -->
749 <div style="display:inline">
750 (
751 <span class="optional" style="display: none; ">optional</spa n>
752 <span class="enum" style="display: none; ">enumerated</span>
753 <span id="typeTemplate">
754 <span style="display: none; ">
755 <a> Type</a>
756 </span>
757 <span>
758 <span style="display: none; ">
759 array of <span><span></span></span>
760 </span>
761 <span>object</span>
762 <span style="display: none; "></span>
763 </span>
764 </span>
765 )
766 </div>
767
768 </em>
769 </dt>
770 <dd class="todo">
771 Undocumented.
772 </dd>
773 <dd style="display: none; ">
774 Description of this parameter from the json schema.
775 </dd>
776 <dd style="display: none; ">
777 This parameter was added in version
778 <b><span></span></b>.
779 You must omit this parameter in earlier versions,
780 and you may omit it in any version. If you require this
781 parameter, the manifest key
782 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
783 can ensure that your extension won't be run in an earlier browser ve rsion.
784 </dd>
785
786 <!-- OBJECT PROPERTIES -->
787 <dd>
788 <dl>
789 <div>
790 <div>
791 <dt>
792 <var>sourceTabId</var>
793 <em>
794
795 <!-- TYPE -->
796 <div style="display:inline">
797 (
798 <span class="optional" style="display: none; ">optional</spa n>
799 <span class="enum" style="display: none; ">enumerated</span>
800 <span id="typeTemplate">
801 <span style="display: none; ">
802 <a> Type</a>
803 </span>
804 <span>
805 <span style="display: none; ">
806 array of <span><span></span></span>
807 </span>
808 <span>integer</span>
809 <span style="display: none; "></span>
810 </span>
811 </span>
812 )
813 </div>
814
815 </em>
816 </dt>
817 <dd class="todo" style="display: none; ">
818 Undocumented.
819 </dd>
820 <dd>The ID of the tab in which the navigation is triggered.</dd>
821 <dd style="display: none; ">
822 This parameter was added in version
823 <b><span></span></b>.
824 You must omit this parameter in earlier versions,
825 and you may omit it in any version. If you require this
826 parameter, the manifest key
827 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
828 can ensure that your extension won't be run in an earlier browser ve rsion.
829 </dd>
830
831 <!-- OBJECT PROPERTIES -->
832 <dd style="display: none; ">
833 <dl>
834 <div>
835 <div>
836 </div>
837 </div>
838 </dl>
839 </dd>
840 </div>
841 </div><div>
842 <div>
843 <dt>
844 <var>sourceUrl</var>
845 <em>
846
847 <!-- TYPE -->
848 <div style="display:inline">
849 (
850 <span class="optional" style="display: none; ">optional</spa n>
851 <span class="enum" style="display: none; ">enumerated</span>
852 <span id="typeTemplate">
853 <span style="display: none; ">
854 <a> Type</a>
855 </span>
856 <span>
857 <span style="display: none; ">
858 array of <span><span></span></span>
859 </span>
860 <span>string</span>
861 <span style="display: none; "></span>
862 </span>
863 </span>
864 )
865 </div>
866
867 </em>
868 </dt>
869 <dd class="todo" style="display: none; ">
870 Undocumented.
871 </dd>
872 <dd>The URL of the document that is opening the new window.</dd>
873 <dd style="display: none; ">
874 This parameter was added in version
875 <b><span></span></b>.
876 You must omit this parameter in earlier versions,
877 and you may omit it in any version. If you require this
878 parameter, the manifest key
879 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
880 can ensure that your extension won't be run in an earlier browser ve rsion.
881 </dd>
882
883 <!-- OBJECT PROPERTIES -->
884 <dd style="display: none; ">
885 <dl>
886 <div>
887 <div>
888 </div>
889 </div>
890 </dl>
891 </dd>
892 </div>
893 </div><div>
894 <div>
895 <dt>
896 <var>targetUrl</var>
897 <em>
898
899 <!-- TYPE -->
900 <div style="display:inline">
901 (
902 <span class="optional" style="display: none; ">optional</spa n>
903 <span class="enum" style="display: none; ">enumerated</span>
904 <span id="typeTemplate">
905 <span style="display: none; ">
906 <a> Type</a>
907 </span>
908 <span>
909 <span style="display: none; ">
910 array of <span><span></span></span>
911 </span>
912 <span>string</span>
913 <span style="display: none; "></span>
914 </span>
915 </span>
916 )
917 </div>
918
919 </em>
920 </dt>
921 <dd class="todo" style="display: none; ">
922 Undocumented.
923 </dd>
924 <dd>The URL to be opened in the new window.</dd>
925 <dd style="display: none; ">
926 This parameter was added in version
927 <b><span></span></b>.
928 You must omit this parameter in earlier versions,
929 and you may omit it in any version. If you require this
930 parameter, the manifest key
931 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
932 can ensure that your extension won't be run in an earlier browser ve rsion.
933 </dd>
934
935 <!-- OBJECT PROPERTIES -->
936 <dd style="display: none; ">
937 <dl>
938 <div>
939 <div>
940 </div>
941 </div>
942 </dl>
943 </dd>
944 </div>
945 </div><div>
946 <div>
947 <dt>
948 <var>timeStamp</var>
949 <em>
950
951 <!-- TYPE -->
952 <div style="display:inline">
953 (
954 <span class="optional" style="display: none; ">optional</spa n>
955 <span class="enum" style="display: none; ">enumerated</span>
956 <span id="typeTemplate">
957 <span style="display: none; ">
958 <a> Type</a>
959 </span>
960 <span>
961 <span style="display: none; ">
962 array of <span><span></span></span>
963 </span>
964 <span>number</span>
965 <span style="display: none; "></span>
966 </span>
967 </span>
968 )
969 </div>
970
971 </em>
972 </dt>
973 <dd class="todo" style="display: none; ">
974 Undocumented.
975 </dd>
976 <dd>The time when the browser was about to create a new view, in milli seconds since the epoch.</dd>
977 <dd style="display: none; ">
978 This parameter was added in version
979 <b><span></span></b>.
980 You must omit this parameter in earlier versions,
981 and you may omit it in any version. If you require this
982 parameter, the manifest key
983 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
984 can ensure that your extension won't be run in an earlier browser ve rsion.
985 </dd>
986
987 <!-- OBJECT PROPERTIES -->
988 <dd style="display: none; ">
989 <dl>
990 <div>
991 <div>
992 </div>
993 </div>
994 </dl>
995 </dd>
996 </div>
997 </div>
998 </dl>
999 </dd>
1000 </div>
1001 </div>
1002 </dl>
1003
1004 </div> <!-- /decription -->
1005
1006 </div><div class="apiItem">
1007 <a name="event-onCommitted"></a>
1008 <h4>onCommitted</h4>
1009
1010 <div class="summary">
1011 <!-- Note: intentionally longer 80 columns -->
1012 <span class="subdued">chrome.experimental.webNavigation.</span>< span>onCommitted</span><span class="subdued">.addListener</span>(function(<span> object details</span>) <span class="subdued">{...}</span>);
1013 </div>
1014
1015 <div class="description">
1016 <p class="todo" style="display: none; ">Undocumented.</p>
1017 <p>Fires when a navigation is committed. The document (and the r esources it refers to, such as images and subframes) might still be downloading, but at least part of the document has been received from the server and the bro wser has decided to switch to the new document.</p>
1018
1019 <!-- PARAMETERS -->
1020 <h4>Parameters</h4>
1021 <dl>
1022 <div>
1023 <div>
1024 <dt>
1025 <var>details</var>
1026 <em>
1027
1028 <!-- TYPE -->
1029 <div style="display:inline">
1030 (
1031 <span class="optional" style="display: none; ">optional</spa n>
1032 <span class="enum" style="display: none; ">enumerated</span>
1033 <span id="typeTemplate">
1034 <span style="display: none; ">
1035 <a> Type</a>
1036 </span>
1037 <span>
1038 <span style="display: none; ">
1039 array of <span><span></span></span>
1040 </span>
1041 <span>object</span>
1042 <span style="display: none; "></span>
1043 </span>
1044 </span>
1045 )
1046 </div>
1047
1048 </em>
1049 </dt>
1050 <dd class="todo">
1051 Undocumented.
1052 </dd>
1053 <dd style="display: none; ">
1054 Description of this parameter from the json schema.
1055 </dd>
1056 <dd style="display: none; ">
1057 This parameter was added in version
1058 <b><span></span></b>.
1059 You must omit this parameter in earlier versions,
1060 and you may omit it in any version. If you require this
1061 parameter, the manifest key
1062 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1063 can ensure that your extension won't be run in an earlier browser ve rsion.
1064 </dd>
1065
1066 <!-- OBJECT PROPERTIES -->
1067 <dd>
1068 <dl>
1069 <div>
1070 <div>
1071 <dt>
1072 <var>tabId</var>
1073 <em>
1074
1075 <!-- TYPE -->
1076 <div style="display:inline">
1077 (
1078 <span class="optional" style="display: none; ">optional</spa n>
1079 <span class="enum" style="display: none; ">enumerated</span>
1080 <span id="typeTemplate">
1081 <span style="display: none; ">
1082 <a> Type</a>
1083 </span>
1084 <span>
1085 <span style="display: none; ">
1086 array of <span><span></span></span>
1087 </span>
1088 <span>integer</span>
1089 <span style="display: none; "></span>
1090 </span>
1091 </span>
1092 )
1093 </div>
1094
1095 </em>
1096 </dt>
1097 <dd class="todo" style="display: none; ">
1098 Undocumented.
1099 </dd>
1100 <dd>The ID of the tab in which the navigation occurs.</dd>
1101 <dd style="display: none; ">
1102 This parameter was added in version
1103 <b><span></span></b>.
1104 You must omit this parameter in earlier versions,
1105 and you may omit it in any version. If you require this
1106 parameter, the manifest key
1107 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1108 can ensure that your extension won't be run in an earlier browser ve rsion.
1109 </dd>
1110
1111 <!-- OBJECT PROPERTIES -->
1112 <dd style="display: none; ">
1113 <dl>
1114 <div>
1115 <div>
1116 </div>
1117 </div>
1118 </dl>
1119 </dd>
1120 </div>
1121 </div><div>
1122 <div>
1123 <dt>
1124 <var>url</var>
1125 <em>
1126
1127 <!-- TYPE -->
1128 <div style="display:inline">
1129 (
1130 <span class="optional" style="display: none; ">optional</spa n>
1131 <span class="enum" style="display: none; ">enumerated</span>
1132 <span id="typeTemplate">
1133 <span style="display: none; ">
1134 <a> Type</a>
1135 </span>
1136 <span>
1137 <span style="display: none; ">
1138 array of <span><span></span></span>
1139 </span>
1140 <span>string</span>
1141 <span style="display: none; "></span>
1142 </span>
1143 </span>
1144 )
1145 </div>
1146
1147 </em>
1148 </dt>
1149 <dd class="todo">
1150 Undocumented.
1151 </dd>
1152 <dd style="display: none; ">
1153 Description of this parameter from the json schema.
1154 </dd>
1155 <dd style="display: none; ">
1156 This parameter was added in version
1157 <b><span></span></b>.
1158 You must omit this parameter in earlier versions,
1159 and you may omit it in any version. If you require this
1160 parameter, the manifest key
1161 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1162 can ensure that your extension won't be run in an earlier browser ve rsion.
1163 </dd>
1164
1165 <!-- OBJECT PROPERTIES -->
1166 <dd style="display: none; ">
1167 <dl>
1168 <div>
1169 <div>
1170 </div>
1171 </div>
1172 </dl>
1173 </dd>
1174 </div>
1175 </div><div>
1176 <div>
1177 <dt>
1178 <var>frameId</var>
1179 <em>
1180
1181 <!-- TYPE -->
1182 <div style="display:inline">
1183 (
1184 <span class="optional" style="display: none; ">optional</spa n>
1185 <span class="enum" style="display: none; ">enumerated</span>
1186 <span id="typeTemplate">
1187 <span style="display: none; ">
1188 <a> Type</a>
1189 </span>
1190 <span>
1191 <span style="display: none; ">
1192 array of <span><span></span></span>
1193 </span>
1194 <span>integer</span>
1195 <span style="display: none; "></span>
1196 </span>
1197 </span>
1198 )
1199 </div>
1200
1201 </em>
1202 </dt>
1203 <dd class="todo" style="display: none; ">
1204 Undocumented.
1205 </dd>
1206 <dd>0 indicates the navigation happens in the tab content window; posi tive value indicates navigation in a subframe.</dd>
1207 <dd style="display: none; ">
1208 This parameter was added in version
1209 <b><span></span></b>.
1210 You must omit this parameter in earlier versions,
1211 and you may omit it in any version. If you require this
1212 parameter, the manifest key
1213 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1214 can ensure that your extension won't be run in an earlier browser ve rsion.
1215 </dd>
1216
1217 <!-- OBJECT PROPERTIES -->
1218 <dd style="display: none; ">
1219 <dl>
1220 <div>
1221 <div>
1222 </div>
1223 </div>
1224 </dl>
1225 </dd>
1226 </div>
1227 </div><div>
1228 <div>
1229 <dt>
1230 <var>transitionType</var>
1231 <em>
1232
1233 <!-- TYPE -->
1234 <div style="display:inline">
1235 (
1236 <span class="optional" style="display: none; ">optional</spa n>
1237 <span class="enum">enumerated</span>
1238 <span id="typeTemplate">
1239 <span style="display: none; ">
1240 <a> Type</a>
1241 </span>
1242 <span>
1243 <span style="display: none; ">
1244 array of <span><span></span></span>
1245 </span>
1246 <span>string</span>
1247 <span>["link", "user_browser", "redirect_meta_refresh", "redirect_onload", "forward_back", "redirect_javascript", "new_window", "reload" , "other"]</span>
1248 </span>
1249 </span>
1250 )
1251 </div>
1252
1253 </em>
1254 </dt>
1255 <dd class="todo" style="display: none; ">
1256 Undocumented.
1257 </dd>
1258 <dd>Cause of the navigation. Set to null for subframe navigations.</dd >
1259 <dd style="display: none; ">
1260 This parameter was added in version
1261 <b><span></span></b>.
1262 You must omit this parameter in earlier versions,
1263 and you may omit it in any version. If you require this
1264 parameter, the manifest key
1265 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1266 can ensure that your extension won't be run in an earlier browser ve rsion.
1267 </dd>
1268
1269 <!-- OBJECT PROPERTIES -->
1270 <dd style="display: none; ">
1271 <dl>
1272 <div>
1273 <div>
1274 </div>
1275 </div>
1276 </dl>
1277 </dd>
1278 </div>
1279 </div><div>
1280 <div>
1281 <dt>
1282 <var>timeStamp</var>
1283 <em>
1284
1285 <!-- TYPE -->
1286 <div style="display:inline">
1287 (
1288 <span class="optional" style="display: none; ">optional</spa n>
1289 <span class="enum" style="display: none; ">enumerated</span>
1290 <span id="typeTemplate">
1291 <span style="display: none; ">
1292 <a> Type</a>
1293 </span>
1294 <span>
1295 <span style="display: none; ">
1296 array of <span><span></span></span>
1297 </span>
1298 <span>number</span>
1299 <span style="display: none; "></span>
1300 </span>
1301 </span>
1302 )
1303 </div>
1304
1305 </em>
1306 </dt>
1307 <dd class="todo" style="display: none; ">
1308 Undocumented.
1309 </dd>
1310 <dd>The time when the navigation was committed, in milliseconds since the epoch.</dd>
1311 <dd style="display: none; ">
1312 This parameter was added in version
1313 <b><span></span></b>.
1314 You must omit this parameter in earlier versions,
1315 and you may omit it in any version. If you require this
1316 parameter, the manifest key
1317 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1318 can ensure that your extension won't be run in an earlier browser ve rsion.
1319 </dd>
1320
1321 <!-- OBJECT PROPERTIES -->
1322 <dd style="display: none; ">
1323 <dl>
1324 <div>
1325 <div>
1326 </div>
1327 </div>
1328 </dl>
1329 </dd>
1330 </div>
1331 </div>
1332 </dl>
1333 </dd>
1334 </div>
1335 </div>
1336 </dl>
1337
1338 </div> <!-- /decription -->
1339
1340 </div><div class="apiItem">
1341 <a name="event-onCompleted"></a>
1342 <h4>onCompleted</h4>
1343
1344 <div class="summary">
1345 <!-- Note: intentionally longer 80 columns -->
1346 <span class="subdued">chrome.experimental.webNavigation.</span>< span>onCompleted</span><span class="subdued">.addListener</span>(function(<span> object details</span>) <span class="subdued">{...}</span>);
1347 </div>
1348
1349 <div class="description">
1350 <p class="todo" style="display: none; ">Undocumented.</p>
1351 <p>Fires when a document, including the resources it refers to, is completely loaded and initialized.</p>
1352
1353 <!-- PARAMETERS -->
1354 <h4>Parameters</h4>
1355 <dl>
1356 <div>
1357 <div>
1358 <dt>
1359 <var>details</var>
1360 <em>
1361
1362 <!-- TYPE -->
1363 <div style="display:inline">
1364 (
1365 <span class="optional" style="display: none; ">optional</spa n>
1366 <span class="enum" style="display: none; ">enumerated</span>
1367 <span id="typeTemplate">
1368 <span style="display: none; ">
1369 <a> Type</a>
1370 </span>
1371 <span>
1372 <span style="display: none; ">
1373 array of <span><span></span></span>
1374 </span>
1375 <span>object</span>
1376 <span style="display: none; "></span>
1377 </span>
1378 </span>
1379 )
1380 </div>
1381
1382 </em>
1383 </dt>
1384 <dd class="todo">
1385 Undocumented.
1386 </dd>
1387 <dd style="display: none; ">
1388 Description of this parameter from the json schema.
1389 </dd>
1390 <dd style="display: none; ">
1391 This parameter was added in version
1392 <b><span></span></b>.
1393 You must omit this parameter in earlier versions,
1394 and you may omit it in any version. If you require this
1395 parameter, the manifest key
1396 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1397 can ensure that your extension won't be run in an earlier browser ve rsion.
1398 </dd>
1399
1400 <!-- OBJECT PROPERTIES -->
1401 <dd>
1402 <dl>
1403 <div>
1404 <div>
1405 <dt>
1406 <var>tabId</var>
1407 <em>
1408
1409 <!-- TYPE -->
1410 <div style="display:inline">
1411 (
1412 <span class="optional" style="display: none; ">optional</spa n>
1413 <span class="enum" style="display: none; ">enumerated</span>
1414 <span id="typeTemplate">
1415 <span style="display: none; ">
1416 <a> Type</a>
1417 </span>
1418 <span>
1419 <span style="display: none; ">
1420 array of <span><span></span></span>
1421 </span>
1422 <span>integer</span>
1423 <span style="display: none; "></span>
1424 </span>
1425 </span>
1426 )
1427 </div>
1428
1429 </em>
1430 </dt>
1431 <dd class="todo" style="display: none; ">
1432 Undocumented.
1433 </dd>
1434 <dd>The ID of the tab in which the navigation occurs.</dd>
1435 <dd style="display: none; ">
1436 This parameter was added in version
1437 <b><span></span></b>.
1438 You must omit this parameter in earlier versions,
1439 and you may omit it in any version. If you require this
1440 parameter, the manifest key
1441 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1442 can ensure that your extension won't be run in an earlier browser ve rsion.
1443 </dd>
1444
1445 <!-- OBJECT PROPERTIES -->
1446 <dd style="display: none; ">
1447 <dl>
1448 <div>
1449 <div>
1450 </div>
1451 </div>
1452 </dl>
1453 </dd>
1454 </div>
1455 </div><div>
1456 <div>
1457 <dt>
1458 <var>url</var>
1459 <em>
1460
1461 <!-- TYPE -->
1462 <div style="display:inline">
1463 (
1464 <span class="optional" style="display: none; ">optional</spa n>
1465 <span class="enum" style="display: none; ">enumerated</span>
1466 <span id="typeTemplate">
1467 <span style="display: none; ">
1468 <a> Type</a>
1469 </span>
1470 <span>
1471 <span style="display: none; ">
1472 array of <span><span></span></span>
1473 </span>
1474 <span>string</span>
1475 <span style="display: none; "></span>
1476 </span>
1477 </span>
1478 )
1479 </div>
1480
1481 </em>
1482 </dt>
1483 <dd class="todo">
1484 Undocumented.
1485 </dd>
1486 <dd style="display: none; ">
1487 Description of this parameter from the json schema.
1488 </dd>
1489 <dd style="display: none; ">
1490 This parameter was added in version
1491 <b><span></span></b>.
1492 You must omit this parameter in earlier versions,
1493 and you may omit it in any version. If you require this
1494 parameter, the manifest key
1495 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1496 can ensure that your extension won't be run in an earlier browser ve rsion.
1497 </dd>
1498
1499 <!-- OBJECT PROPERTIES -->
1500 <dd style="display: none; ">
1501 <dl>
1502 <div>
1503 <div>
1504 </div>
1505 </div>
1506 </dl>
1507 </dd>
1508 </div>
1509 </div><div>
1510 <div>
1511 <dt>
1512 <var>frameId</var>
1513 <em>
1514
1515 <!-- TYPE -->
1516 <div style="display:inline">
1517 (
1518 <span class="optional" style="display: none; ">optional</spa n>
1519 <span class="enum" style="display: none; ">enumerated</span>
1520 <span id="typeTemplate">
1521 <span style="display: none; ">
1522 <a> Type</a>
1523 </span>
1524 <span>
1525 <span style="display: none; ">
1526 array of <span><span></span></span>
1527 </span>
1528 <span>integer</span>
1529 <span style="display: none; "></span>
1530 </span>
1531 </span>
1532 )
1533 </div>
1534
1535 </em>
1536 </dt>
1537 <dd class="todo" style="display: none; ">
1538 Undocumented.
1539 </dd>
1540 <dd>0 indicates the navigation happens in the tab content window; posi tive value indicates navigation in a subframe.</dd>
1541 <dd style="display: none; ">
1542 This parameter was added in version
1543 <b><span></span></b>.
1544 You must omit this parameter in earlier versions,
1545 and you may omit it in any version. If you require this
1546 parameter, the manifest key
1547 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1548 can ensure that your extension won't be run in an earlier browser ve rsion.
1549 </dd>
1550
1551 <!-- OBJECT PROPERTIES -->
1552 <dd style="display: none; ">
1553 <dl>
1554 <div>
1555 <div>
1556 </div>
1557 </div>
1558 </dl>
1559 </dd>
1560 </div>
1561 </div><div>
1562 <div>
1563 <dt>
1564 <var>timeStamp</var>
1565 <em>
1566
1567 <!-- TYPE -->
1568 <div style="display:inline">
1569 (
1570 <span class="optional" style="display: none; ">optional</spa n>
1571 <span class="enum" style="display: none; ">enumerated</span>
1572 <span id="typeTemplate">
1573 <span style="display: none; ">
1574 <a> Type</a>
1575 </span>
1576 <span>
1577 <span style="display: none; ">
1578 array of <span><span></span></span>
1579 </span>
1580 <span>number</span>
1581 <span style="display: none; "></span>
1582 </span>
1583 </span>
1584 )
1585 </div>
1586
1587 </em>
1588 </dt>
1589 <dd class="todo" style="display: none; ">
1590 Undocumented.
1591 </dd>
1592 <dd>The time when the document finished loading, in milliseconds since the epoch.</dd>
1593 <dd style="display: none; ">
1594 This parameter was added in version
1595 <b><span></span></b>.
1596 You must omit this parameter in earlier versions,
1597 and you may omit it in any version. If you require this
1598 parameter, the manifest key
1599 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1600 can ensure that your extension won't be run in an earlier browser ve rsion.
1601 </dd>
1602
1603 <!-- OBJECT PROPERTIES -->
1604 <dd style="display: none; ">
1605 <dl>
1606 <div>
1607 <div>
1608 </div>
1609 </div>
1610 </dl>
1611 </dd>
1612 </div>
1613 </div>
1614 </dl>
1615 </dd>
1616 </div>
1617 </div>
1618 </dl>
1619
1620 </div> <!-- /decription -->
1621
1622 </div><div class="apiItem">
1623 <a name="event-onDOMContentLoaded"></a>
1624 <h4>onDOMContentLoaded</h4>
1625
1626 <div class="summary">
1627 <!-- Note: intentionally longer 80 columns -->
1628 <span class="subdued">chrome.experimental.webNavigation.</span>< span>onDOMContentLoaded</span><span class="subdued">.addListener</span>(function (<span>object details</span>) <span class="subdued">{...}</span>);
1629 </div>
1630
1631 <div class="description">
1632 <p class="todo" style="display: none; ">Undocumented.</p>
1633 <p>Fires when the page's DOM is fully constructed, but the refer enced resources may not finish loading.</p>
1634
1635 <!-- PARAMETERS -->
1636 <h4>Parameters</h4>
1637 <dl>
1638 <div>
1639 <div>
1640 <dt>
1641 <var>details</var>
1642 <em>
1643
1644 <!-- TYPE -->
1645 <div style="display:inline">
1646 (
1647 <span class="optional" style="display: none; ">optional</spa n>
1648 <span class="enum" style="display: none; ">enumerated</span>
1649 <span id="typeTemplate">
1650 <span style="display: none; ">
1651 <a> Type</a>
1652 </span>
1653 <span>
1654 <span style="display: none; ">
1655 array of <span><span></span></span>
1656 </span>
1657 <span>object</span>
1658 <span style="display: none; "></span>
1659 </span>
1660 </span>
1661 )
1662 </div>
1663
1664 </em>
1665 </dt>
1666 <dd class="todo">
1667 Undocumented.
1668 </dd>
1669 <dd style="display: none; ">
1670 Description of this parameter from the json schema.
1671 </dd>
1672 <dd style="display: none; ">
1673 This parameter was added in version
1674 <b><span></span></b>.
1675 You must omit this parameter in earlier versions,
1676 and you may omit it in any version. If you require this
1677 parameter, the manifest key
1678 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1679 can ensure that your extension won't be run in an earlier browser ve rsion.
1680 </dd>
1681
1682 <!-- OBJECT PROPERTIES -->
1683 <dd>
1684 <dl>
1685 <div>
1686 <div>
1687 <dt>
1688 <var>tabId</var>
1689 <em>
1690
1691 <!-- TYPE -->
1692 <div style="display:inline">
1693 (
1694 <span class="optional" style="display: none; ">optional</spa n>
1695 <span class="enum" style="display: none; ">enumerated</span>
1696 <span id="typeTemplate">
1697 <span style="display: none; ">
1698 <a> Type</a>
1699 </span>
1700 <span>
1701 <span style="display: none; ">
1702 array of <span><span></span></span>
1703 </span>
1704 <span>integer</span>
1705 <span style="display: none; "></span>
1706 </span>
1707 </span>
1708 )
1709 </div>
1710
1711 </em>
1712 </dt>
1713 <dd class="todo" style="display: none; ">
1714 Undocumented.
1715 </dd>
1716 <dd>The ID of the tab in which the navigation occurs.</dd>
1717 <dd style="display: none; ">
1718 This parameter was added in version
1719 <b><span></span></b>.
1720 You must omit this parameter in earlier versions,
1721 and you may omit it in any version. If you require this
1722 parameter, the manifest key
1723 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1724 can ensure that your extension won't be run in an earlier browser ve rsion.
1725 </dd>
1726
1727 <!-- OBJECT PROPERTIES -->
1728 <dd style="display: none; ">
1729 <dl>
1730 <div>
1731 <div>
1732 </div>
1733 </div>
1734 </dl>
1735 </dd>
1736 </div>
1737 </div><div>
1738 <div>
1739 <dt>
1740 <var>url</var>
1741 <em>
1742
1743 <!-- TYPE -->
1744 <div style="display:inline">
1745 (
1746 <span class="optional" style="display: none; ">optional</spa n>
1747 <span class="enum" style="display: none; ">enumerated</span>
1748 <span id="typeTemplate">
1749 <span style="display: none; ">
1750 <a> Type</a>
1751 </span>
1752 <span>
1753 <span style="display: none; ">
1754 array of <span><span></span></span>
1755 </span>
1756 <span>string</span>
1757 <span style="display: none; "></span>
1758 </span>
1759 </span>
1760 )
1761 </div>
1762
1763 </em>
1764 </dt>
1765 <dd class="todo">
1766 Undocumented.
1767 </dd>
1768 <dd style="display: none; ">
1769 Description of this parameter from the json schema.
1770 </dd>
1771 <dd style="display: none; ">
1772 This parameter was added in version
1773 <b><span></span></b>.
1774 You must omit this parameter in earlier versions,
1775 and you may omit it in any version. If you require this
1776 parameter, the manifest key
1777 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1778 can ensure that your extension won't be run in an earlier browser ve rsion.
1779 </dd>
1780
1781 <!-- OBJECT PROPERTIES -->
1782 <dd style="display: none; ">
1783 <dl>
1784 <div>
1785 <div>
1786 </div>
1787 </div>
1788 </dl>
1789 </dd>
1790 </div>
1791 </div><div>
1792 <div>
1793 <dt>
1794 <var>frameId</var>
1795 <em>
1796
1797 <!-- TYPE -->
1798 <div style="display:inline">
1799 (
1800 <span class="optional" style="display: none; ">optional</spa n>
1801 <span class="enum" style="display: none; ">enumerated</span>
1802 <span id="typeTemplate">
1803 <span style="display: none; ">
1804 <a> Type</a>
1805 </span>
1806 <span>
1807 <span style="display: none; ">
1808 array of <span><span></span></span>
1809 </span>
1810 <span>integer</span>
1811 <span style="display: none; "></span>
1812 </span>
1813 </span>
1814 )
1815 </div>
1816
1817 </em>
1818 </dt>
1819 <dd class="todo" style="display: none; ">
1820 Undocumented.
1821 </dd>
1822 <dd>0 indicates the navigation happens in the tab content window; posi tive value indicates navigation in a subframe.</dd>
1823 <dd style="display: none; ">
1824 This parameter was added in version
1825 <b><span></span></b>.
1826 You must omit this parameter in earlier versions,
1827 and you may omit it in any version. If you require this
1828 parameter, the manifest key
1829 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1830 can ensure that your extension won't be run in an earlier browser ve rsion.
1831 </dd>
1832
1833 <!-- OBJECT PROPERTIES -->
1834 <dd style="display: none; ">
1835 <dl>
1836 <div>
1837 <div>
1838 </div>
1839 </div>
1840 </dl>
1841 </dd>
1842 </div>
1843 </div><div>
1844 <div>
1845 <dt>
1846 <var>timeStamp</var>
1847 <em>
1848
1849 <!-- TYPE -->
1850 <div style="display:inline">
1851 (
1852 <span class="optional" style="display: none; ">optional</spa n>
1853 <span class="enum" style="display: none; ">enumerated</span>
1854 <span id="typeTemplate">
1855 <span style="display: none; ">
1856 <a> Type</a>
1857 </span>
1858 <span>
1859 <span style="display: none; ">
1860 array of <span><span></span></span>
1861 </span>
1862 <span>number</span>
1863 <span style="display: none; "></span>
1864 </span>
1865 </span>
1866 )
1867 </div>
1868
1869 </em>
1870 </dt>
1871 <dd class="todo" style="display: none; ">
1872 Undocumented.
1873 </dd>
1874 <dd>The time when the page's DOM was fully constructed, in millisecond s since the epoch.</dd>
1875 <dd style="display: none; ">
1876 This parameter was added in version
1877 <b><span></span></b>.
1878 You must omit this parameter in earlier versions,
1879 and you may omit it in any version. If you require this
1880 parameter, the manifest key
1881 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1882 can ensure that your extension won't be run in an earlier browser ve rsion.
1883 </dd>
1884
1885 <!-- OBJECT PROPERTIES -->
1886 <dd style="display: none; ">
1887 <dl>
1888 <div>
1889 <div>
1890 </div>
1891 </div>
1892 </dl>
1893 </dd>
1894 </div>
1895 </div>
1896 </dl>
1897 </dd>
1898 </div>
1899 </div>
1900 </dl>
1901
1902 </div> <!-- /decription -->
1903
1904 </div><div class="apiItem">
1905 <a name="event-onErrorOccurred"></a>
1906 <h4>onErrorOccurred</h4>
1907
1908 <div class="summary">
1909 <!-- Note: intentionally longer 80 columns -->
1910 <span class="subdued">chrome.experimental.webNavigation.</span>< span>onErrorOccurred</span><span class="subdued">.addListener</span>(function(<s pan>object details</span>) <span class="subdued">{...}</span>);
1911 </div>
1912
1913 <div class="description">
1914 <p class="todo" style="display: none; ">Undocumented.</p>
1915 <p>Fires when an error occurs.</p>
1916
1917 <!-- PARAMETERS -->
1918 <h4>Parameters</h4>
1919 <dl>
1920 <div>
1921 <div>
1922 <dt>
1923 <var>details</var>
1924 <em>
1925
1926 <!-- TYPE -->
1927 <div style="display:inline">
1928 (
1929 <span class="optional" style="display: none; ">optional</spa n>
1930 <span class="enum" style="display: none; ">enumerated</span>
1931 <span id="typeTemplate">
1932 <span style="display: none; ">
1933 <a> Type</a>
1934 </span>
1935 <span>
1936 <span style="display: none; ">
1937 array of <span><span></span></span>
1938 </span>
1939 <span>object</span>
1940 <span style="display: none; "></span>
1941 </span>
1942 </span>
1943 )
1944 </div>
1945
1946 </em>
1947 </dt>
1948 <dd class="todo">
1949 Undocumented.
1950 </dd>
1951 <dd style="display: none; ">
1952 Description of this parameter from the json schema.
1953 </dd>
1954 <dd style="display: none; ">
1955 This parameter was added in version
1956 <b><span></span></b>.
1957 You must omit this parameter in earlier versions,
1958 and you may omit it in any version. If you require this
1959 parameter, the manifest key
1960 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1961 can ensure that your extension won't be run in an earlier browser ve rsion.
1962 </dd>
1963
1964 <!-- OBJECT PROPERTIES -->
1965 <dd>
1966 <dl>
1967 <div>
1968 <div>
1969 <dt>
1970 <var>tabId</var>
1971 <em>
1972
1973 <!-- TYPE -->
1974 <div style="display:inline">
1975 (
1976 <span class="optional" style="display: none; ">optional</spa n>
1977 <span class="enum" style="display: none; ">enumerated</span>
1978 <span id="typeTemplate">
1979 <span style="display: none; ">
1980 <a> Type</a>
1981 </span>
1982 <span>
1983 <span style="display: none; ">
1984 array of <span><span></span></span>
1985 </span>
1986 <span>integer</span>
1987 <span style="display: none; "></span>
1988 </span>
1989 </span>
1990 )
1991 </div>
1992
1993 </em>
1994 </dt>
1995 <dd class="todo" style="display: none; ">
1996 Undocumented.
1997 </dd>
1998 <dd>The ID of the tab in which the navigation occurs.</dd>
1999 <dd style="display: none; ">
2000 This parameter was added in version
2001 <b><span></span></b>.
2002 You must omit this parameter in earlier versions,
2003 and you may omit it in any version. If you require this
2004 parameter, the manifest key
2005 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2006 can ensure that your extension won't be run in an earlier browser ve rsion.
2007 </dd>
2008
2009 <!-- OBJECT PROPERTIES -->
2010 <dd style="display: none; ">
2011 <dl>
2012 <div>
2013 <div>
2014 </div>
2015 </div>
2016 </dl>
2017 </dd>
2018 </div>
2019 </div><div>
2020 <div>
2021 <dt>
2022 <var>url</var>
2023 <em>
2024
2025 <!-- TYPE -->
2026 <div style="display:inline">
2027 (
2028 <span class="optional" style="display: none; ">optional</spa n>
2029 <span class="enum" style="display: none; ">enumerated</span>
2030 <span id="typeTemplate">
2031 <span style="display: none; ">
2032 <a> Type</a>
2033 </span>
2034 <span>
2035 <span style="display: none; ">
2036 array of <span><span></span></span>
2037 </span>
2038 <span>string</span>
2039 <span style="display: none; "></span>
2040 </span>
2041 </span>
2042 )
2043 </div>
2044
2045 </em>
2046 </dt>
2047 <dd class="todo">
2048 Undocumented.
2049 </dd>
2050 <dd style="display: none; ">
2051 Description of this parameter from the json schema.
2052 </dd>
2053 <dd style="display: none; ">
2054 This parameter was added in version
2055 <b><span></span></b>.
2056 You must omit this parameter in earlier versions,
2057 and you may omit it in any version. If you require this
2058 parameter, the manifest key
2059 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2060 can ensure that your extension won't be run in an earlier browser ve rsion.
2061 </dd>
2062
2063 <!-- OBJECT PROPERTIES -->
2064 <dd style="display: none; ">
2065 <dl>
2066 <div>
2067 <div>
2068 </div>
2069 </div>
2070 </dl>
2071 </dd>
2072 </div>
2073 </div><div>
2074 <div>
2075 <dt>
2076 <var>frameId</var>
2077 <em>
2078
2079 <!-- TYPE -->
2080 <div style="display:inline">
2081 (
2082 <span class="optional" style="display: none; ">optional</spa n>
2083 <span class="enum" style="display: none; ">enumerated</span>
2084 <span id="typeTemplate">
2085 <span style="display: none; ">
2086 <a> Type</a>
2087 </span>
2088 <span>
2089 <span style="display: none; ">
2090 array of <span><span></span></span>
2091 </span>
2092 <span>integer</span>
2093 <span style="display: none; "></span>
2094 </span>
2095 </span>
2096 )
2097 </div>
2098
2099 </em>
2100 </dt>
2101 <dd class="todo" style="display: none; ">
2102 Undocumented.
2103 </dd>
2104 <dd>0 indicates the navigation happens in the tab content window; posi tive value indicates navigation in a subframe.</dd>
2105 <dd style="display: none; ">
2106 This parameter was added in version
2107 <b><span></span></b>.
2108 You must omit this parameter in earlier versions,
2109 and you may omit it in any version. If you require this
2110 parameter, the manifest key
2111 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2112 can ensure that your extension won't be run in an earlier browser ve rsion.
2113 </dd>
2114
2115 <!-- OBJECT PROPERTIES -->
2116 <dd style="display: none; ">
2117 <dl>
2118 <div>
2119 <div>
2120 </div>
2121 </div>
2122 </dl>
2123 </dd>
2124 </div>
2125 </div><div>
2126 <div>
2127 <dt>
2128 <var>error</var>
2129 <em>
2130
2131 <!-- TYPE -->
2132 <div style="display:inline">
2133 (
2134 <span class="optional" style="display: none; ">optional</spa n>
2135 <span class="enum" style="display: none; ">enumerated</span>
2136 <span id="typeTemplate">
2137 <span style="display: none; ">
2138 <a> Type</a>
2139 </span>
2140 <span>
2141 <span style="display: none; ">
2142 array of <span><span></span></span>
2143 </span>
2144 <span>string</span>
2145 <span style="display: none; "></span>
2146 </span>
2147 </span>
2148 )
2149 </div>
2150
2151 </em>
2152 </dt>
2153 <dd class="todo" style="display: none; ">
2154 Undocumented.
2155 </dd>
2156 <dd>The error description.</dd>
2157 <dd style="display: none; ">
2158 This parameter was added in version
2159 <b><span></span></b>.
2160 You must omit this parameter in earlier versions,
2161 and you may omit it in any version. If you require this
2162 parameter, the manifest key
2163 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2164 can ensure that your extension won't be run in an earlier browser ve rsion.
2165 </dd>
2166
2167 <!-- OBJECT PROPERTIES -->
2168 <dd style="display: none; ">
2169 <dl>
2170 <div>
2171 <div>
2172 </div>
2173 </div>
2174 </dl>
2175 </dd>
2176 </div>
2177 </div><div>
2178 <div>
2179 <dt>
2180 <var>timeStamp</var>
2181 <em>
2182
2183 <!-- TYPE -->
2184 <div style="display:inline">
2185 (
2186 <span class="optional" style="display: none; ">optional</spa n>
2187 <span class="enum" style="display: none; ">enumerated</span>
2188 <span id="typeTemplate">
2189 <span style="display: none; ">
2190 <a> Type</a>
2191 </span>
2192 <span>
2193 <span style="display: none; ">
2194 array of <span><span></span></span>
2195 </span>
2196 <span>number</span>
2197 <span style="display: none; "></span>
2198 </span>
2199 </span>
2200 )
2201 </div>
2202
2203 </em>
2204 </dt>
2205 <dd class="todo" style="display: none; ">
2206 Undocumented.
2207 </dd>
2208 <dd>The time when the error occurred, in milliseconds since the epoch. </dd>
2209 <dd style="display: none; ">
2210 This parameter was added in version
2211 <b><span></span></b>.
2212 You must omit this parameter in earlier versions,
2213 and you may omit it in any version. If you require this
2214 parameter, the manifest key
2215 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2216 can ensure that your extension won't be run in an earlier browser ve rsion.
2217 </dd>
2218
2219 <!-- OBJECT PROPERTIES -->
2220 <dd style="display: none; ">
2221 <dl>
2222 <div>
2223 <div>
2224 </div>
2225 </div>
2226 </dl>
2227 </dd>
2228 </div>
2229 </div>
2230 </dl>
2231 </dd>
2232 </div>
2233 </div>
2234 </dl>
2235
2236 </div> <!-- /decription -->
2237
2238 </div> <!-- /apiItem -->
2239
2240 </div> <!-- /apiGroup -->
2241
2242 <!-- TYPES -->
2243 <div class="apiGroup" style="display: none; ">
2244 <a name="types"></a>
2245 <h3 id="types">Types</h3>
2246
2247 <!-- iterates over all types -->
2248 <div class="apiItem">
2249 <a></a>
2250 <h4>type name</h4>
2251
2252 <div>
2253 </div>
2254
2255 </div> <!-- /apiItem -->
2256
2257 </div> <!-- /apiGroup -->
2258
2259 </div> <!-- /apiPage -->
2260 </div> <!-- /gc-pagecontent -->
2261 </div> <!-- /g-section -->
2262 </div> <!-- /codesiteContent -->
2263 <div id="gc-footer" --="">
2264 <div class="text">
2265 <p>
2266 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
2267 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
2268 Attribution 3.0 License</a>, and code samples are licensed under the
2269 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
2270 </p>
2271 <p>
2272 ©2010 Google
2273 </p>
2274
2275 <!-- begin analytics -->
2276 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
2277 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
2278
2279 <script type="text/javascript">
2280 // chrome doc tracking
2281 try {
2282 var engdocs = _gat._getTracker("YT-10763712-2");
2283 engdocs._trackPageview();
2284 } catch(err) {}
2285
2286 // code.google.com site-wide tracking
2287 try {
2288 _uacct="UA-18071-1";
2289 _uanchor=1;
2290 _uff=0;
2291 urchinTracker();
2292 }
2293 catch(e) {/* urchinTracker not available. */}
2294 </script>
2295 <!-- end analytics -->
2296 </div>
2297 </div> <!-- /gc-footer -->
2298 </div> <!-- /gc-container -->
2299 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/experimental.webRequest.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698