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/jstemplate_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>WebNavigation API - Google Chrome Extensions - Google Code</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_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 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/code_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_cvzfqtno"> 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="Search"> 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"></script> 134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 136 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&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/">Labs</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 documentation">Docs</a> 152 </li> 153 <li id="faq_link"> 154 <a href="faq.html" title="Answers to frequently asked questions about 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-extensions" 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="idle.html">Idle</a></li> 203 <li><a href="i18n.html">Internationalization</a></li> 204 <li><a href="messaging.html">Message Passing</a></li> 205 <li><a href="npapi.html">NPAPI Plugins</a></li> 206 </ul> 207 </li> 208 <li>Finishing 209 <ul> 210 <li><a href="hosting.html">Hosting</a></li> 211 <li><a href="external_extensions.html">Other Deployment Options</a></li> 212 </ul> 213 </li> 214 </ul> 215 </li> 216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 217 <li><h2><a href="tutorials.html">Tutorials</a></h2> 218 <ul> 219 <li><a href="tut_debugging.html">Debugging</a></li> 220 <li><a href="tut_analytics.html">Google Analytics</a></li> 221 <li><a href="tut_oauth.html">OAuth</a></li> 222 </ul> 223 </li> 224 <li><h2>Reference</h2> 225 <ul> 226 <li>Formats 227 <ul> 228 <li><a href="manifest.html">Manifest Files</a></li> 229 <li><a href="match_patterns.html">Match Patterns</a></li> 230 </ul> 231 </li> 232 <li><a href="permission_warnings.html">Permission Warnings</a></li> 233 <li><a href="api_index.html">chrome.* APIs</a></li> 234 <li><a href="api_other.html">Other APIs</a></li> 235 </ul> 236 </li> 237 <li><h2><a href="samples.html">Samples</a></h2></li> 238 <div class="line"> </div> 239 <li><h2>More</h2> 240 <ul> 241 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 242 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 243 <li><a href="themes.html">Themes</a></li> 244 </ul> 245 </li> 246 </ul> 247 </div> 248 <script> 249 initToggles(); 250 </script> 251 252 <div class="g-unit" id="gc-pagecontent"> 253 <div id="pageTitle"> 254 <h1 class="page_title">WebNavigation API</h1> 255 </div> 256 <!-- TABLE OF CONTENTS --> 257 <div id="toc"> 258 <h2>Contents</h2> 259 <ol> 260 <li> 261 <a href="#H2-0">A note about timestamps</a> 262 <ol> 263 <li style="display: none; "> 264 <a>h3Name</a> 265 </li> 266 </ol> 267 </li> 268 <li> 269 <a href="#apiReference">API reference: chrome.experimental.webNavigation</a> 270 <ol> 271 <li style="display: none; "> 272 <a href="#properties">Properties</a> 273 <ol> 274 <li> 275 <a href="#property-anchor">propertyName</a> 276 </li> 277 </ol> 278 </li> 279 <li style="display: none; "> 280 <a>Methods</a> 281 <ol> 282 <li> 283 <a href="#method-anchor">methodName</a> 284 </li> 285 </ol> 286 </li> 287 <li> 288 <a href="#global-events">Events</a> 289 <ol> 290 <li> 291 <a href="#event-onBeforeNavigate">onBeforeNavigate</a> 292 </li><li> 293 <a href="#event-onBeforeRetarget">onBeforeRetarget</a> 294 </li><li> 295 <a href="#event-onCommitted">onCommitted</a> 296 </li><li> 297 <a href="#event-onCompleted">onCompleted</a> 298 </li><li> 299 <a href="#event-onDOMContentLoaded">onDOMContentLoaded</a> 300 </li><li> 301 <a href="#event-onErrorOccurred">onErrorOccurred</a> 302 </li> 303 </ol> 304 </li> 305 <li style="display: none; "> 306 <a href="#types">Types</a> 307 <ol> 308 <li> 309 <a href="#id-anchor">id</a> 310 </li> 311 </ol> 312 </li> 313 </ol> 314 </li> 315 </ol> 316 </div> 317 <!-- /TABLE OF CONTENTS --> 318 319 <!-- Standard content lead-in for experimental API pages --> 320 <p id="classSummary" style="display: none; "> 321 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 322 </p> 323 324 <!-- STATIC CONTENT PLACEHOLDER --> 325 <div id="static"><div id="pageData-name" class="pageData">WebNavigation API</div> 326 327<!-- BEGIN AUTHORED CONTENT --> 328<p id="classSummary"> 329Use the <code>chrome.experimental.webNavigation</code> module to recieve 330notifications about the status of navigations requests in-flight. This 331module is still very much experimental. For information on how to use 332experimental APIs, see the <a href="experimental.html">chrome.experimental.* 333APIs</a> page. 334</p> 335 336<a name="H2-0"></a><h2>A note about timestamps</h2> 337<p> 338It's important to note that some technical oddities in the OS's handling 339of distinct Chrome processes can cause the clock to be skewed between the 340browser itself and extension processes. That means that WebNavigation's events' 341<code>timeStamp</code> property is only guaranteed to be <i>internally</i> 342consistent. Comparing one event to another event will give you the correct 343offset between them, but comparing them to the current time inside the 344extension (via <code>(new Date()).getTime()</code>, for instance) might give 345unexpected results. 346</p> 347<!-- END AUTHORED CONTENT --> 348</div> 349 350 <!-- API PAGE --> 351 <div class="apiPage"> 352 <a name="apiReference"></a> 353 <h2>API reference: chrome.experimental.webNavigation</h2> 354 355 <!-- PROPERTIES --> 356 <div class="apiGroup" style="display: none; "> 357 <a name="properties"></a> 358 <h3 id="properties">Properties</h3> 359 360 <div> 361 <a></a> 362 <h4>getLastError</h4> 363 <div class="summary"> 364 <!-- Note: intentionally longer 80 columns --> 365 <span>chrome.extension</span><span>lastError</span> 366 </div> 367 <div> 368 </div> 369 </div> 370 371 </div> <!-- /apiGroup --> 372 373 <!-- METHODS --> 374 <div id="methodsTemplate" class="apiGroup" style="display: none; "> 375 <a></a> 376 <h3>Methods</h3> 377 378 <!-- iterates over all functions --> 379 <div class="apiItem"> 380 <a></a> <!-- method-anchor --> 381 <h4>method name</h4> 382 383 <div class="summary"><span>void</span> 384 <!-- Note: intentionally longer 80 columns --> 385 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 386 <var><span></span></var></span>)</div> 387 388 <div class="description"> 389 <p class="todo">Undocumented.</p> 390 <p> 391 A description from the json schema def of the function goes here. 392 </p> 393 394 <!-- PARAMETERS --> 395 <h4>Parameters</h4> 396 <dl> 397 <div> 398 <div> 399 </div> 400 </div> 401 </dl> 402 403 <!-- RETURNS --> 404 <h4>Returns</h4> 405 <dl> 406 <div> 407 <div> 408 </div> 409 </div> 410 </dl> 411 412 <!-- CALLBACK --> 413 <div> 414 <div> 415 <h4>Callback function</h4> 416 <p> 417 The callback <em>parameter</em> should specify a function 418 that looks like this: 419 </p> 420 <p> 421 If you specify the <em>callback</em> parameter, it should 422 specify a function that looks like this: 423 </p> 424 425 <!-- Note: intentionally longer 80 columns --> 426 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 427 <dl> 428 <div> 429 <div> 430 </div> 431 </div> 432 </dl> 433 </div> 434 </div> 435 436 <!-- MIN_VERSION --> 437 <p> 438 This function was added in version <b><span></span></b>. 439 If you require this function, the manifest key 440 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 441 can ensure that your extension won't be run in an earlier browser version. 442 </p> 443 </div> <!-- /description --> 444 445 </div> <!-- /apiItem --> 446 447 </div> <!-- /apiGroup --> 448 449 <!-- EVENTS --> 450 <div id="eventsTemplate" class="apiGroup"> 451 <a name="global-events"></a> 452 <h3>Events</h3> 453 <!-- iterates over all events --> 454 <div class="apiItem"> 455 <a name="event-onBeforeNavigate"></a> 456 <h4>onBeforeNavigate</h4> 457 458 <div class="summary"> 459 <!-- Note: intentionally longer 80 columns --> 460 <span class="subdued">chrome.experimental.webNavigation.</span><span>onBeforeNavigate</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 461 </div> 462 463 <div class="description"> 464 <p class="todo" style="display: none; ">Undocumented.</p> 465 <p>Fires when a navigation is about to occur.</p> 466 467 <!-- PARAMETERS --> 468 <div> 469 <h4>Parameters</h4> 470 <dl> 471 <div> 472 <div> 473 <dt> 474 <var>details</var> 475 <em> 476 477 <!-- TYPE --> 478 <div style="display:inline"> 479 ( 480 <span class="optional" style="display: none; ">optional</span> 481 <span class="enum" style="display: none; ">enumerated</span> 482 <span id="typeTemplate"> 483 <span style="display: none; "> 484 <a> Type</a> 485 </span> 486 <span> 487 <span style="display: none; "> 488 array of <span><span></span></span> 489 </span> 490 <span>object</span> 491 <span style="display: none; "></span> 492 </span> 493 </span> 494 ) 495 </div> 496 497 </em> 498 </dt> 499 <dd class="todo"> 500 Undocumented. 501 </dd> 502 <dd style="display: none; "> 503 Description of this parameter from the json schema. 504 </dd> 505 <dd style="display: none; "> 506 This parameter was added in version 507 <b><span></span></b>. 508 You must omit this parameter in earlier versions, 509 and you may omit it in any version. If you require this 510 parameter, the manifest key 511 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 512 can ensure that your extension won't be run in an earlier browser version. 513 </dd> 514 515 <!-- OBJECT PROPERTIES --> 516 <dd> 517 <dl> 518 <div> 519 <div> 520 <dt> 521 <var>tabId</var> 522 <em> 523 524 <!-- TYPE --> 525 <div style="display:inline"> 526 ( 527 <span class="optional" style="display: none; ">optional</span> 528 <span class="enum" style="display: none; ">enumerated</span> 529 <span id="typeTemplate"> 530 <span style="display: none; "> 531 <a> Type</a> 532 </span> 533 <span> 534 <span style="display: none; "> 535 array of <span><span></span></span> 536 </span> 537 <span>integer</span> 538 <span style="display: none; "></span> 539 </span> 540 </span> 541 ) 542 </div> 543 544 </em> 545 </dt> 546 <dd class="todo" style="display: none; "> 547 Undocumented. 548 </dd> 549 <dd>The ID of the tab in which the navigation is about to occur.</dd> 550 <dd style="display: none; "> 551 This parameter was added in version 552 <b><span></span></b>. 553 You must omit this parameter in earlier versions, 554 and you may omit it in any version. If you require this 555 parameter, the manifest key 556 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 557 can ensure that your extension won't be run in an earlier browser version. 558 </dd> 559 560 <!-- OBJECT PROPERTIES --> 561 <dd style="display: none; "> 562 <dl> 563 <div> 564 <div> 565 </div> 566 </div> 567 </dl> 568 </dd> 569 570 <!-- OBJECT METHODS --> 571 <dd style="display: none; "> 572 <div></div> 573 </dd> 574 575 <!-- OBJECT EVENT FIELDS --> 576 <dd style="display: none; "> 577 <div></div> 578 </dd> 579 580 <!-- FUNCTION PARAMETERS --> 581 <dd style="display: none; "> 582 <div></div> 583 </dd> 584 585 </div> 586 </div><div> 587 <div> 588 <dt> 589 <var>url</var> 590 <em> 591 592 <!-- TYPE --> 593 <div style="display:inline"> 594 ( 595 <span class="optional" style="display: none; ">optional</span> 596 <span class="enum" style="display: none; ">enumerated</span> 597 <span id="typeTemplate"> 598 <span style="display: none; "> 599 <a> Type</a> 600 </span> 601 <span> 602 <span style="display: none; "> 603 array of <span><span></span></span> 604 </span> 605 <span>string</span> 606 <span style="display: none; "></span> 607 </span> 608 </span> 609 ) 610 </div> 611 612 </em> 613 </dt> 614 <dd class="todo"> 615 Undocumented. 616 </dd> 617 <dd style="display: none; "> 618 Description of this parameter from the json schema. 619 </dd> 620 <dd style="display: none; "> 621 This parameter was added in version 622 <b><span></span></b>. 623 You must omit this parameter in earlier versions, 624 and you may omit it in any version. If you require this 625 parameter, the manifest key 626 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 627 can ensure that your extension won't be run in an earlier browser version. 628 </dd> 629 630 <!-- OBJECT PROPERTIES --> 631 <dd style="display: none; "> 632 <dl> 633 <div> 634 <div> 635 </div> 636 </div> 637 </dl> 638 </dd> 639 640 <!-- OBJECT METHODS --> 641 <dd style="display: none; "> 642 <div></div> 643 </dd> 644 645 <!-- OBJECT EVENT FIELDS --> 646 <dd style="display: none; "> 647 <div></div> 648 </dd> 649 650 <!-- FUNCTION PARAMETERS --> 651 <dd style="display: none; "> 652 <div></div> 653 </dd> 654 655 </div> 656 </div><div> 657 <div> 658 <dt> 659 <var>frameId</var> 660 <em> 661 662 <!-- TYPE --> 663 <div style="display:inline"> 664 ( 665 <span class="optional" style="display: none; ">optional</span> 666 <span class="enum" style="display: none; ">enumerated</span> 667 <span id="typeTemplate"> 668 <span style="display: none; "> 669 <a> Type</a> 670 </span> 671 <span> 672 <span style="display: none; "> 673 array of <span><span></span></span> 674 </span> 675 <span>integer</span> 676 <span style="display: none; "></span> 677 </span> 678 </span> 679 ) 680 </div> 681 682 </em> 683 </dt> 684 <dd class="todo" style="display: none; "> 685 Undocumented. 686 </dd> 687 <dd>0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe. Frame IDs are unique within a tab.</dd> 688 <dd style="display: none; "> 689 This parameter was added in version 690 <b><span></span></b>. 691 You must omit this parameter in earlier versions, 692 and you may omit it in any version. If you require this 693 parameter, the manifest key 694 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 695 can ensure that your extension won't be run in an earlier browser version. 696 </dd> 697 698 <!-- OBJECT PROPERTIES --> 699 <dd style="display: none; "> 700 <dl> 701 <div> 702 <div> 703 </div> 704 </div> 705 </dl> 706 </dd> 707 708 <!-- OBJECT METHODS --> 709 <dd style="display: none; "> 710 <div></div> 711 </dd> 712 713 <!-- OBJECT EVENT FIELDS --> 714 <dd style="display: none; "> 715 <div></div> 716 </dd> 717 718 <!-- FUNCTION PARAMETERS --> 719 <dd style="display: none; "> 720 <div></div> 721 </dd> 722 723 </div> 724 </div><div> 725 <div> 726 <dt> 727 <var>requestId</var> 728 <em> 729 730 <!-- TYPE --> 731 <div style="display:inline"> 732 ( 733 <span class="optional" style="display: none; ">optional</span> 734 <span class="enum" style="display: none; ">enumerated</span> 735 <span id="typeTemplate"> 736 <span style="display: none; "> 737 <a> Type</a> 738 </span> 739 <span> 740 <span style="display: none; "> 741 array of <span><span></span></span> 742 </span> 743 <span>string</span> 744 <span style="display: none; "></span> 745 </span> 746 </span> 747 ) 748 </div> 749 750 </em> 751 </dt> 752 <dd class="todo" style="display: none; "> 753 Undocumented. 754 </dd> 755 <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.webRequest.onBeforeRequest.</dd> 756 <dd style="display: none; "> 757 This parameter was added in version 758 <b><span></span></b>. 759 You must omit this parameter in earlier versions, 760 and you may omit it in any version. If you require this 761 parameter, the manifest key 762 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 763 can ensure that your extension won't be run in an earlier browser version. 764 </dd> 765 766 <!-- OBJECT PROPERTIES --> 767 <dd style="display: none; "> 768 <dl> 769 <div> 770 <div> 771 </div> 772 </div> 773 </dl> 774 </dd> 775 776 <!-- OBJECT METHODS --> 777 <dd style="display: none; "> 778 <div></div> 779 </dd> 780 781 <!-- OBJECT EVENT FIELDS --> 782 <dd style="display: none; "> 783 <div></div> 784 </dd> 785 786 <!-- FUNCTION PARAMETERS --> 787 <dd style="display: none; "> 788 <div></div> 789 </dd> 790 791 </div> 792 </div><div> 793 <div> 794 <dt> 795 <var>timeStamp</var> 796 <em> 797 798 <!-- TYPE --> 799 <div style="display:inline"> 800 ( 801 <span class="optional" style="display: none; ">optional</span> 802 <span class="enum" style="display: none; ">enumerated</span> 803 <span id="typeTemplate"> 804 <span style="display: none; "> 805 <a> Type</a> 806 </span> 807 <span> 808 <span style="display: none; "> 809 array of <span><span></span></span> 810 </span> 811 <span>number</span> 812 <span style="display: none; "></span> 813 </span> 814 </span> 815 ) 816 </div> 817 818 </em> 819 </dt> 820 <dd class="todo" style="display: none; "> 821 Undocumented. 822 </dd> 823 <dd>The time when the browser was about to start the navigation, in milliseconds since the epoch.</dd> 824 <dd style="display: none; "> 825 This parameter was added in version 826 <b><span></span></b>. 827 You must omit this parameter in earlier versions, 828 and you may omit it in any version. If you require this 829 parameter, the manifest key 830 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 831 can ensure that your extension won't be run in an earlier browser version. 832 </dd> 833 834 <!-- OBJECT PROPERTIES --> 835 <dd style="display: none; "> 836 <dl> 837 <div> 838 <div> 839 </div> 840 </div> 841 </dl> 842 </dd> 843 844 <!-- OBJECT METHODS --> 845 <dd style="display: none; "> 846 <div></div> 847 </dd> 848 849 <!-- OBJECT EVENT FIELDS --> 850 <dd style="display: none; "> 851 <div></div> 852 </dd> 853 854 <!-- FUNCTION PARAMETERS --> 855 <dd style="display: none; "> 856 <div></div> 857 </dd> 858 859 </div> 860 </div> 861 </dl> 862 </dd> 863 864 <!-- OBJECT METHODS --> 865 <dd style="display: none; "> 866 <div></div> 867 </dd> 868 869 <!-- OBJECT EVENT FIELDS --> 870 <dd style="display: none; "> 871 <div></div> 872 </dd> 873 874 <!-- FUNCTION PARAMETERS --> 875 <dd style="display: none; "> 876 <div></div> 877 </dd> 878 879 </div> 880 </div> 881 </dl> 882 </div> 883 </div> <!-- /decription --> 884 885 </div><div class="apiItem"> 886 <a name="event-onBeforeRetarget"></a> 887 <h4>onBeforeRetarget</h4> 888 889 <div class="summary"> 890 <!-- Note: intentionally longer 80 columns --> 891 <span class="subdued">chrome.experimental.webNavigation.</span><span>onBeforeRetarget</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 892 </div> 893 894 <div class="description"> 895 <p class="todo" style="display: none; ">Undocumented.</p> 896 <p>Fires when a new window, or a new tab in an existing window, is about to be created to host a navigation.</p> 897 898 <!-- PARAMETERS --> 899 <div> 900 <h4>Parameters</h4> 901 <dl> 902 <div> 903 <div> 904 <dt> 905 <var>details</var> 906 <em> 907 908 <!-- TYPE --> 909 <div style="display:inline"> 910 ( 911 <span class="optional" style="display: none; ">optional</span> 912 <span class="enum" style="display: none; ">enumerated</span> 913 <span id="typeTemplate"> 914 <span style="display: none; "> 915 <a> Type</a> 916 </span> 917 <span> 918 <span style="display: none; "> 919 array of <span><span></span></span> 920 </span> 921 <span>object</span> 922 <span style="display: none; "></span> 923 </span> 924 </span> 925 ) 926 </div> 927 928 </em> 929 </dt> 930 <dd class="todo"> 931 Undocumented. 932 </dd> 933 <dd style="display: none; "> 934 Description of this parameter from the json schema. 935 </dd> 936 <dd style="display: none; "> 937 This parameter was added in version 938 <b><span></span></b>. 939 You must omit this parameter in earlier versions, 940 and you may omit it in any version. If you require this 941 parameter, the manifest key 942 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 943 can ensure that your extension won't be run in an earlier browser version. 944 </dd> 945 946 <!-- OBJECT PROPERTIES --> 947 <dd> 948 <dl> 949 <div> 950 <div> 951 <dt> 952 <var>sourceTabId</var> 953 <em> 954 955 <!-- TYPE --> 956 <div style="display:inline"> 957 ( 958 <span class="optional" style="display: none; ">optional</span> 959 <span class="enum" style="display: none; ">enumerated</span> 960 <span id="typeTemplate"> 961 <span style="display: none; "> 962 <a> Type</a> 963 </span> 964 <span> 965 <span style="display: none; "> 966 array of <span><span></span></span> 967 </span> 968 <span>integer</span> 969 <span style="display: none; "></span> 970 </span> 971 </span> 972 ) 973 </div> 974 975 </em> 976 </dt> 977 <dd class="todo" style="display: none; "> 978 Undocumented. 979 </dd> 980 <dd>The ID of the tab in which the navigation is triggered.</dd> 981 <dd style="display: none; "> 982 This parameter was added in version 983 <b><span></span></b>. 984 You must omit this parameter in earlier versions, 985 and you may omit it in any version. If you require this 986 parameter, the manifest key 987 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 988 can ensure that your extension won't be run in an earlier browser version. 989 </dd> 990 991 <!-- OBJECT PROPERTIES --> 992 <dd style="display: none; "> 993 <dl> 994 <div> 995 <div> 996 </div> 997 </div> 998 </dl> 999 </dd> 1000 1001 <!-- OBJECT METHODS --> 1002 <dd style="display: none; "> 1003 <div></div> 1004 </dd> 1005 1006 <!-- OBJECT EVENT FIELDS --> 1007 <dd style="display: none; "> 1008 <div></div> 1009 </dd> 1010 1011 <!-- FUNCTION PARAMETERS --> 1012 <dd style="display: none; "> 1013 <div></div> 1014 </dd> 1015 1016 </div> 1017 </div><div> 1018 <div> 1019 <dt> 1020 <var>sourceUrl</var> 1021 <em> 1022 1023 <!-- TYPE --> 1024 <div style="display:inline"> 1025 ( 1026 <span class="optional" style="display: none; ">optional</span> 1027 <span class="enum" style="display: none; ">enumerated</span> 1028 <span id="typeTemplate"> 1029 <span style="display: none; "> 1030 <a> Type</a> 1031 </span> 1032 <span> 1033 <span style="display: none; "> 1034 array of <span><span></span></span> 1035 </span> 1036 <span>string</span> 1037 <span style="display: none; "></span> 1038 </span> 1039 </span> 1040 ) 1041 </div> 1042 1043 </em> 1044 </dt> 1045 <dd class="todo" style="display: none; "> 1046 Undocumented. 1047 </dd> 1048 <dd>The URL of the document that is opening the new window.</dd> 1049 <dd style="display: none; "> 1050 This parameter was added in version 1051 <b><span></span></b>. 1052 You must omit this parameter in earlier versions, 1053 and you may omit it in any version. If you require this 1054 parameter, the manifest key 1055 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1056 can ensure that your extension won't be run in an earlier browser version. 1057 </dd> 1058 1059 <!-- OBJECT PROPERTIES --> 1060 <dd style="display: none; "> 1061 <dl> 1062 <div> 1063 <div> 1064 </div> 1065 </div> 1066 </dl> 1067 </dd> 1068 1069 <!-- OBJECT METHODS --> 1070 <dd style="display: none; "> 1071 <div></div> 1072 </dd> 1073 1074 <!-- OBJECT EVENT FIELDS --> 1075 <dd style="display: none; "> 1076 <div></div> 1077 </dd> 1078 1079 <!-- FUNCTION PARAMETERS --> 1080 <dd style="display: none; "> 1081 <div></div> 1082 </dd> 1083 1084 </div> 1085 </div><div> 1086 <div> 1087 <dt> 1088 <var>url</var> 1089 <em> 1090 1091 <!-- TYPE --> 1092 <div style="display:inline"> 1093 ( 1094 <span class="optional" style="display: none; ">optional</span> 1095 <span class="enum" style="display: none; ">enumerated</span> 1096 <span id="typeTemplate"> 1097 <span style="display: none; "> 1098 <a> Type</a> 1099 </span> 1100 <span> 1101 <span style="display: none; "> 1102 array of <span><span></span></span> 1103 </span> 1104 <span>string</span> 1105 <span style="display: none; "></span> 1106 </span> 1107 </span> 1108 ) 1109 </div> 1110 1111 </em> 1112 </dt> 1113 <dd class="todo" style="display: none; "> 1114 Undocumented. 1115 </dd> 1116 <dd>The URL to be opened in the new window.</dd> 1117 <dd style="display: none; "> 1118 This parameter was added in version 1119 <b><span></span></b>. 1120 You must omit this parameter in earlier versions, 1121 and you may omit it in any version. If you require this 1122 parameter, the manifest key 1123 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1124 can ensure that your extension won't be run in an earlier browser version. 1125 </dd> 1126 1127 <!-- OBJECT PROPERTIES --> 1128 <dd style="display: none; "> 1129 <dl> 1130 <div> 1131 <div> 1132 </div> 1133 </div> 1134 </dl> 1135 </dd> 1136 1137 <!-- OBJECT METHODS --> 1138 <dd style="display: none; "> 1139 <div></div> 1140 </dd> 1141 1142 <!-- OBJECT EVENT FIELDS --> 1143 <dd style="display: none; "> 1144 <div></div> 1145 </dd> 1146 1147 <!-- FUNCTION PARAMETERS --> 1148 <dd style="display: none; "> 1149 <div></div> 1150 </dd> 1151 1152 </div> 1153 </div><div> 1154 <div> 1155 <dt> 1156 <var>timeStamp</var> 1157 <em> 1158 1159 <!-- TYPE --> 1160 <div style="display:inline"> 1161 ( 1162 <span class="optional" style="display: none; ">optional</span> 1163 <span class="enum" style="display: none; ">enumerated</span> 1164 <span id="typeTemplate"> 1165 <span style="display: none; "> 1166 <a> Type</a> 1167 </span> 1168 <span> 1169 <span style="display: none; "> 1170 array of <span><span></span></span> 1171 </span> 1172 <span>number</span> 1173 <span style="display: none; "></span> 1174 </span> 1175 </span> 1176 ) 1177 </div> 1178 1179 </em> 1180 </dt> 1181 <dd class="todo" style="display: none; "> 1182 Undocumented. 1183 </dd> 1184 <dd>The time when the browser was about to create a new view, in milliseconds since the epoch.</dd> 1185 <dd style="display: none; "> 1186 This parameter was added in version 1187 <b><span></span></b>. 1188 You must omit this parameter in earlier versions, 1189 and you may omit it in any version. If you require this 1190 parameter, the manifest key 1191 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1192 can ensure that your extension won't be run in an earlier browser version. 1193 </dd> 1194 1195 <!-- OBJECT PROPERTIES --> 1196 <dd style="display: none; "> 1197 <dl> 1198 <div> 1199 <div> 1200 </div> 1201 </div> 1202 </dl> 1203 </dd> 1204 1205 <!-- OBJECT METHODS --> 1206 <dd style="display: none; "> 1207 <div></div> 1208 </dd> 1209 1210 <!-- OBJECT EVENT FIELDS --> 1211 <dd style="display: none; "> 1212 <div></div> 1213 </dd> 1214 1215 <!-- FUNCTION PARAMETERS --> 1216 <dd style="display: none; "> 1217 <div></div> 1218 </dd> 1219 1220 </div> 1221 </div> 1222 </dl> 1223 </dd> 1224 1225 <!-- OBJECT METHODS --> 1226 <dd style="display: none; "> 1227 <div></div> 1228 </dd> 1229 1230 <!-- OBJECT EVENT FIELDS --> 1231 <dd style="display: none; "> 1232 <div></div> 1233 </dd> 1234 1235 <!-- FUNCTION PARAMETERS --> 1236 <dd style="display: none; "> 1237 <div></div> 1238 </dd> 1239 1240 </div> 1241 </div> 1242 </dl> 1243 </div> 1244 </div> <!-- /decription --> 1245 1246 </div><div class="apiItem"> 1247 <a name="event-onCommitted"></a> 1248 <h4>onCommitted</h4> 1249 1250 <div class="summary"> 1251 <!-- Note: intentionally longer 80 columns --> 1252 <span class="subdued">chrome.experimental.webNavigation.</span><span>onCommitted</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 1253 </div> 1254 1255 <div class="description"> 1256 <p class="todo" style="display: none; ">Undocumented.</p> 1257 <p>Fires when a navigation is committed. The document (and the resources 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 browser has decided to switch to the new document.</p> 1258 1259 <!-- PARAMETERS --> 1260 <div> 1261 <h4>Parameters</h4> 1262 <dl> 1263 <div> 1264 <div> 1265 <dt> 1266 <var>details</var> 1267 <em> 1268 1269 <!-- TYPE --> 1270 <div style="display:inline"> 1271 ( 1272 <span class="optional" style="display: none; ">optional</span> 1273 <span class="enum" style="display: none; ">enumerated</span> 1274 <span id="typeTemplate"> 1275 <span style="display: none; "> 1276 <a> Type</a> 1277 </span> 1278 <span> 1279 <span style="display: none; "> 1280 array of <span><span></span></span> 1281 </span> 1282 <span>object</span> 1283 <span style="display: none; "></span> 1284 </span> 1285 </span> 1286 ) 1287 </div> 1288 1289 </em> 1290 </dt> 1291 <dd class="todo"> 1292 Undocumented. 1293 </dd> 1294 <dd style="display: none; "> 1295 Description of this parameter from the json schema. 1296 </dd> 1297 <dd style="display: none; "> 1298 This parameter was added in version 1299 <b><span></span></b>. 1300 You must omit this parameter in earlier versions, 1301 and you may omit it in any version. If you require this 1302 parameter, the manifest key 1303 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1304 can ensure that your extension won't be run in an earlier browser version. 1305 </dd> 1306 1307 <!-- OBJECT PROPERTIES --> 1308 <dd> 1309 <dl> 1310 <div> 1311 <div> 1312 <dt> 1313 <var>tabId</var> 1314 <em> 1315 1316 <!-- TYPE --> 1317 <div style="display:inline"> 1318 ( 1319 <span class="optional" style="display: none; ">optional</span> 1320 <span class="enum" style="display: none; ">enumerated</span> 1321 <span id="typeTemplate"> 1322 <span style="display: none; "> 1323 <a> Type</a> 1324 </span> 1325 <span> 1326 <span style="display: none; "> 1327 array of <span><span></span></span> 1328 </span> 1329 <span>integer</span> 1330 <span style="display: none; "></span> 1331 </span> 1332 </span> 1333 ) 1334 </div> 1335 1336 </em> 1337 </dt> 1338 <dd class="todo" style="display: none; "> 1339 Undocumented. 1340 </dd> 1341 <dd>The ID of the tab in which the navigation occurs.</dd> 1342 <dd style="display: none; "> 1343 This parameter was added in version 1344 <b><span></span></b>. 1345 You must omit this parameter in earlier versions, 1346 and you may omit it in any version. If you require this 1347 parameter, the manifest key 1348 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1349 can ensure that your extension won't be run in an earlier browser version. 1350 </dd> 1351 1352 <!-- OBJECT PROPERTIES --> 1353 <dd style="display: none; "> 1354 <dl> 1355 <div> 1356 <div> 1357 </div> 1358 </div> 1359 </dl> 1360 </dd> 1361 1362 <!-- OBJECT METHODS --> 1363 <dd style="display: none; "> 1364 <div></div> 1365 </dd> 1366 1367 <!-- OBJECT EVENT FIELDS --> 1368 <dd style="display: none; "> 1369 <div></div> 1370 </dd> 1371 1372 <!-- FUNCTION PARAMETERS --> 1373 <dd style="display: none; "> 1374 <div></div> 1375 </dd> 1376 1377 </div> 1378 </div><div> 1379 <div> 1380 <dt> 1381 <var>url</var> 1382 <em> 1383 1384 <!-- TYPE --> 1385 <div style="display:inline"> 1386 ( 1387 <span class="optional" style="display: none; ">optional</span> 1388 <span class="enum" style="display: none; ">enumerated</span> 1389 <span id="typeTemplate"> 1390 <span style="display: none; "> 1391 <a> Type</a> 1392 </span> 1393 <span> 1394 <span style="display: none; "> 1395 array of <span><span></span></span> 1396 </span> 1397 <span>string</span> 1398 <span style="display: none; "></span> 1399 </span> 1400 </span> 1401 ) 1402 </div> 1403 1404 </em> 1405 </dt> 1406 <dd class="todo"> 1407 Undocumented. 1408 </dd> 1409 <dd style="display: none; "> 1410 Description of this parameter from the json schema. 1411 </dd> 1412 <dd style="display: none; "> 1413 This parameter was added in version 1414 <b><span></span></b>. 1415 You must omit this parameter in earlier versions, 1416 and you may omit it in any version. If you require this 1417 parameter, the manifest key 1418 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1419 can ensure that your extension won't be run in an earlier browser version. 1420 </dd> 1421 1422 <!-- OBJECT PROPERTIES --> 1423 <dd style="display: none; "> 1424 <dl> 1425 <div> 1426 <div> 1427 </div> 1428 </div> 1429 </dl> 1430 </dd> 1431 1432 <!-- OBJECT METHODS --> 1433 <dd style="display: none; "> 1434 <div></div> 1435 </dd> 1436 1437 <!-- OBJECT EVENT FIELDS --> 1438 <dd style="display: none; "> 1439 <div></div> 1440 </dd> 1441 1442 <!-- FUNCTION PARAMETERS --> 1443 <dd style="display: none; "> 1444 <div></div> 1445 </dd> 1446 1447 </div> 1448 </div><div> 1449 <div> 1450 <dt> 1451 <var>frameId</var> 1452 <em> 1453 1454 <!-- TYPE --> 1455 <div style="display:inline"> 1456 ( 1457 <span class="optional" style="display: none; ">optional</span> 1458 <span class="enum" style="display: none; ">enumerated</span> 1459 <span id="typeTemplate"> 1460 <span style="display: none; "> 1461 <a> Type</a> 1462 </span> 1463 <span> 1464 <span style="display: none; "> 1465 array of <span><span></span></span> 1466 </span> 1467 <span>integer</span> 1468 <span style="display: none; "></span> 1469 </span> 1470 </span> 1471 ) 1472 </div> 1473 1474 </em> 1475 </dt> 1476 <dd class="todo" style="display: none; "> 1477 Undocumented. 1478 </dd> 1479 <dd>0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe.</dd> 1480 <dd style="display: none; "> 1481 This parameter was added in version 1482 <b><span></span></b>. 1483 You must omit this parameter in earlier versions, 1484 and you may omit it in any version. If you require this 1485 parameter, the manifest key 1486 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1487 can ensure that your extension won't be run in an earlier browser version. 1488 </dd> 1489 1490 <!-- OBJECT PROPERTIES --> 1491 <dd style="display: none; "> 1492 <dl> 1493 <div> 1494 <div> 1495 </div> 1496 </div> 1497 </dl> 1498 </dd> 1499 1500 <!-- OBJECT METHODS --> 1501 <dd style="display: none; "> 1502 <div></div> 1503 </dd> 1504 1505 <!-- OBJECT EVENT FIELDS --> 1506 <dd style="display: none; "> 1507 <div></div> 1508 </dd> 1509 1510 <!-- FUNCTION PARAMETERS --> 1511 <dd style="display: none; "> 1512 <div></div> 1513 </dd> 1514 1515 </div> 1516 </div><div> 1517 <div> 1518 <dt> 1519 <var>transitionType</var> 1520 <em> 1521 1522 <!-- TYPE --> 1523 <div style="display:inline"> 1524 ( 1525 <span class="optional" style="display: none; ">optional</span> 1526 <span class="enum">enumerated</span> 1527 <span id="typeTemplate"> 1528 <span style="display: none; "> 1529 <a> Type</a> 1530 </span> 1531 <span> 1532 <span style="display: none; "> 1533 array of <span><span></span></span> 1534 </span> 1535 <span>string</span> 1536 <span>["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"]</span> 1537 </span> 1538 </span> 1539 ) 1540 </div> 1541 1542 </em> 1543 </dt> 1544 <dd class="todo" style="display: none; "> 1545 Undocumented. 1546 </dd> 1547 <dd>Cause of the navigation. The same transition types as defined in the history API are used.</dd> 1548 <dd style="display: none; "> 1549 This parameter was added in version 1550 <b><span></span></b>. 1551 You must omit this parameter in earlier versions, 1552 and you may omit it in any version. If you require this 1553 parameter, the manifest key 1554 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1555 can ensure that your extension won't be run in an earlier browser version. 1556 </dd> 1557 1558 <!-- OBJECT PROPERTIES --> 1559 <dd style="display: none; "> 1560 <dl> 1561 <div> 1562 <div> 1563 </div> 1564 </div> 1565 </dl> 1566 </dd> 1567 1568 <!-- OBJECT METHODS --> 1569 <dd style="display: none; "> 1570 <div></div> 1571 </dd> 1572 1573 <!-- OBJECT EVENT FIELDS --> 1574 <dd style="display: none; "> 1575 <div></div> 1576 </dd> 1577 1578 <!-- FUNCTION PARAMETERS --> 1579 <dd style="display: none; "> 1580 <div></div> 1581 </dd> 1582 1583 </div> 1584 </div><div> 1585 <div> 1586 <dt> 1587 <var>transitionQualifiers</var> 1588 <em> 1589 1590 <!-- TYPE --> 1591 <div style="display:inline"> 1592 ( 1593 <span class="optional" style="display: none; ">optional</span> 1594 <span class="enum" style="display: none; ">enumerated</span> 1595 <span id="typeTemplate"> 1596 <span style="display: none; "> 1597 <a> Type</a> 1598 </span> 1599 <span> 1600 <span> 1601 array of <span style="display: none; "><span></span></span> 1602 </span> 1603 <span style="display: none; ">paramType</span> 1604 <span style="display: none; "></span> 1605 </span> 1606 </span> 1607 ) 1608 </div> 1609 1610 </em> 1611 </dt> 1612 <dd class="todo" style="display: none; "> 1613 Undocumented. 1614 </dd> 1615 <dd>A list of transition qualifiers.</dd> 1616 <dd style="display: none; "> 1617 This parameter was added in version 1618 <b><span></span></b>. 1619 You must omit this parameter in earlier versions, 1620 and you may omit it in any version. If you require this 1621 parameter, the manifest key 1622 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1623 can ensure that your extension won't be run in an earlier browser version. 1624 </dd> 1625 1626 <!-- OBJECT PROPERTIES --> 1627 <dd style="display: none; "> 1628 <dl> 1629 <div> 1630 <div> 1631 </div> 1632 </div> 1633 </dl> 1634 </dd> 1635 1636 <!-- OBJECT METHODS --> 1637 <dd style="display: none; "> 1638 <div></div> 1639 </dd> 1640 1641 <!-- OBJECT EVENT FIELDS --> 1642 <dd style="display: none; "> 1643 <div></div> 1644 </dd> 1645 1646 <!-- FUNCTION PARAMETERS --> 1647 <dd style="display: none; "> 1648 <div></div> 1649 </dd> 1650 1651 </div> 1652 </div><div> 1653 <div> 1654 <dt> 1655 <var>timeStamp</var> 1656 <em> 1657 1658 <!-- TYPE --> 1659 <div style="display:inline"> 1660 ( 1661 <span class="optional" style="display: none; ">optional</span> 1662 <span class="enum" style="display: none; ">enumerated</span> 1663 <span id="typeTemplate"> 1664 <span style="display: none; "> 1665 <a> Type</a> 1666 </span> 1667 <span> 1668 <span style="display: none; "> 1669 array of <span><span></span></span> 1670 </span> 1671 <span>number</span> 1672 <span style="display: none; "></span> 1673 </span> 1674 </span> 1675 ) 1676 </div> 1677 1678 </em> 1679 </dt> 1680 <dd class="todo" style="display: none; "> 1681 Undocumented. 1682 </dd> 1683 <dd>The time when the navigation was committed, in milliseconds since the epoch.</dd> 1684 <dd style="display: none; "> 1685 This parameter was added in version 1686 <b><span></span></b>. 1687 You must omit this parameter in earlier versions, 1688 and you may omit it in any version. If you require this 1689 parameter, the manifest key 1690 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1691 can ensure that your extension won't be run in an earlier browser version. 1692 </dd> 1693 1694 <!-- OBJECT PROPERTIES --> 1695 <dd style="display: none; "> 1696 <dl> 1697 <div> 1698 <div> 1699 </div> 1700 </div> 1701 </dl> 1702 </dd> 1703 1704 <!-- OBJECT METHODS --> 1705 <dd style="display: none; "> 1706 <div></div> 1707 </dd> 1708 1709 <!-- OBJECT EVENT FIELDS --> 1710 <dd style="display: none; "> 1711 <div></div> 1712 </dd> 1713 1714 <!-- FUNCTION PARAMETERS --> 1715 <dd style="display: none; "> 1716 <div></div> 1717 </dd> 1718 1719 </div> 1720 </div> 1721 </dl> 1722 </dd> 1723 1724 <!-- OBJECT METHODS --> 1725 <dd style="display: none; "> 1726 <div></div> 1727 </dd> 1728 1729 <!-- OBJECT EVENT FIELDS --> 1730 <dd style="display: none; "> 1731 <div></div> 1732 </dd> 1733 1734 <!-- FUNCTION PARAMETERS --> 1735 <dd style="display: none; "> 1736 <div></div> 1737 </dd> 1738 1739 </div> 1740 </div> 1741 </dl> 1742 </div> 1743 </div> <!-- /decription --> 1744 1745 </div><div class="apiItem"> 1746 <a name="event-onCompleted"></a> 1747 <h4>onCompleted</h4> 1748 1749 <div class="summary"> 1750 <!-- Note: intentionally longer 80 columns --> 1751 <span class="subdued">chrome.experimental.webNavigation.</span><span>onCompleted</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 1752 </div> 1753 1754 <div class="description"> 1755 <p class="todo" style="display: none; ">Undocumented.</p> 1756 <p>Fires when a document, including the resources it refers to, is completely loaded and initialized.</p> 1757 1758 <!-- PARAMETERS --> 1759 <div> 1760 <h4>Parameters</h4> 1761 <dl> 1762 <div> 1763 <div> 1764 <dt> 1765 <var>details</var> 1766 <em> 1767 1768 <!-- TYPE --> 1769 <div style="display:inline"> 1770 ( 1771 <span class="optional" style="display: none; ">optional</span> 1772 <span class="enum" style="display: none; ">enumerated</span> 1773 <span id="typeTemplate"> 1774 <span style="display: none; "> 1775 <a> Type</a> 1776 </span> 1777 <span> 1778 <span style="display: none; "> 1779 array of <span><span></span></span> 1780 </span> 1781 <span>object</span> 1782 <span style="display: none; "></span> 1783 </span> 1784 </span> 1785 ) 1786 </div> 1787 1788 </em> 1789 </dt> 1790 <dd class="todo"> 1791 Undocumented. 1792 </dd> 1793 <dd style="display: none; "> 1794 Description of this parameter from the json schema. 1795 </dd> 1796 <dd style="display: none; "> 1797 This parameter was added in version 1798 <b><span></span></b>. 1799 You must omit this parameter in earlier versions, 1800 and you may omit it in any version. If you require this 1801 parameter, the manifest key 1802 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1803 can ensure that your extension won't be run in an earlier browser version. 1804 </dd> 1805 1806 <!-- OBJECT PROPERTIES --> 1807 <dd> 1808 <dl> 1809 <div> 1810 <div> 1811 <dt> 1812 <var>tabId</var> 1813 <em> 1814 1815 <!-- TYPE --> 1816 <div style="display:inline"> 1817 ( 1818 <span class="optional" style="display: none; ">optional</span> 1819 <span class="enum" style="display: none; ">enumerated</span> 1820 <span id="typeTemplate"> 1821 <span style="display: none; "> 1822 <a> Type</a> 1823 </span> 1824 <span> 1825 <span style="display: none; "> 1826 array of <span><span></span></span> 1827 </span> 1828 <span>integer</span> 1829 <span style="display: none; "></span> 1830 </span> 1831 </span> 1832 ) 1833 </div> 1834 1835 </em> 1836 </dt> 1837 <dd class="todo" style="display: none; "> 1838 Undocumented. 1839 </dd> 1840 <dd>The ID of the tab in which the navigation occurs.</dd> 1841 <dd style="display: none; "> 1842 This parameter was added in version 1843 <b><span></span></b>. 1844 You must omit this parameter in earlier versions, 1845 and you may omit it in any version. If you require this 1846 parameter, the manifest key 1847 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1848 can ensure that your extension won't be run in an earlier browser version. 1849 </dd> 1850 1851 <!-- OBJECT PROPERTIES --> 1852 <dd style="display: none; "> 1853 <dl> 1854 <div> 1855 <div> 1856 </div> 1857 </div> 1858 </dl> 1859 </dd> 1860 1861 <!-- OBJECT METHODS --> 1862 <dd style="display: none; "> 1863 <div></div> 1864 </dd> 1865 1866 <!-- OBJECT EVENT FIELDS --> 1867 <dd style="display: none; "> 1868 <div></div> 1869 </dd> 1870 1871 <!-- FUNCTION PARAMETERS --> 1872 <dd style="display: none; "> 1873 <div></div> 1874 </dd> 1875 1876 </div> 1877 </div><div> 1878 <div> 1879 <dt> 1880 <var>url</var> 1881 <em> 1882 1883 <!-- TYPE --> 1884 <div style="display:inline"> 1885 ( 1886 <span class="optional" style="display: none; ">optional</span> 1887 <span class="enum" style="display: none; ">enumerated</span> 1888 <span id="typeTemplate"> 1889 <span style="display: none; "> 1890 <a> Type</a> 1891 </span> 1892 <span> 1893 <span style="display: none; "> 1894 array of <span><span></span></span> 1895 </span> 1896 <span>string</span> 1897 <span style="display: none; "></span> 1898 </span> 1899 </span> 1900 ) 1901 </div> 1902 1903 </em> 1904 </dt> 1905 <dd class="todo"> 1906 Undocumented. 1907 </dd> 1908 <dd style="display: none; "> 1909 Description of this parameter from the json schema. 1910 </dd> 1911 <dd style="display: none; "> 1912 This parameter was added in version 1913 <b><span></span></b>. 1914 You must omit this parameter in earlier versions, 1915 and you may omit it in any version. If you require this 1916 parameter, the manifest key 1917 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1918 can ensure that your extension won't be run in an earlier browser version. 1919 </dd> 1920 1921 <!-- OBJECT PROPERTIES --> 1922 <dd style="display: none; "> 1923 <dl> 1924 <div> 1925 <div> 1926 </div> 1927 </div> 1928 </dl> 1929 </dd> 1930 1931 <!-- OBJECT METHODS --> 1932 <dd style="display: none; "> 1933 <div></div> 1934 </dd> 1935 1936 <!-- OBJECT EVENT FIELDS --> 1937 <dd style="display: none; "> 1938 <div></div> 1939 </dd> 1940 1941 <!-- FUNCTION PARAMETERS --> 1942 <dd style="display: none; "> 1943 <div></div> 1944 </dd> 1945 1946 </div> 1947 </div><div> 1948 <div> 1949 <dt> 1950 <var>frameId</var> 1951 <em> 1952 1953 <!-- TYPE --> 1954 <div style="display:inline"> 1955 ( 1956 <span class="optional" style="display: none; ">optional</span> 1957 <span class="enum" style="display: none; ">enumerated</span> 1958 <span id="typeTemplate"> 1959 <span style="display: none; "> 1960 <a> Type</a> 1961 </span> 1962 <span> 1963 <span style="display: none; "> 1964 array of <span><span></span></span> 1965 </span> 1966 <span>integer</span> 1967 <span style="display: none; "></span> 1968 </span> 1969 </span> 1970 ) 1971 </div> 1972 1973 </em> 1974 </dt> 1975 <dd class="todo" style="display: none; "> 1976 Undocumented. 1977 </dd> 1978 <dd>0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe.</dd> 1979 <dd style="display: none; "> 1980 This parameter was added in version 1981 <b><span></span></b>. 1982 You must omit this parameter in earlier versions, 1983 and you may omit it in any version. If you require this 1984 parameter, the manifest key 1985 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1986 can ensure that your extension won't be run in an earlier browser version. 1987 </dd> 1988 1989 <!-- OBJECT PROPERTIES --> 1990 <dd style="display: none; "> 1991 <dl> 1992 <div> 1993 <div> 1994 </div> 1995 </div> 1996 </dl> 1997 </dd> 1998 1999 <!-- OBJECT METHODS --> 2000 <dd style="display: none; "> 2001 <div></div> 2002 </dd> 2003 2004 <!-- OBJECT EVENT FIELDS --> 2005 <dd style="display: none; "> 2006 <div></div> 2007 </dd> 2008 2009 <!-- FUNCTION PARAMETERS --> 2010 <dd style="display: none; "> 2011 <div></div> 2012 </dd> 2013 2014 </div> 2015 </div><div> 2016 <div> 2017 <dt> 2018 <var>timeStamp</var> 2019 <em> 2020 2021 <!-- TYPE --> 2022 <div style="display:inline"> 2023 ( 2024 <span class="optional" style="display: none; ">optional</span> 2025 <span class="enum" style="display: none; ">enumerated</span> 2026 <span id="typeTemplate"> 2027 <span style="display: none; "> 2028 <a> Type</a> 2029 </span> 2030 <span> 2031 <span style="display: none; "> 2032 array of <span><span></span></span> 2033 </span> 2034 <span>number</span> 2035 <span style="display: none; "></span> 2036 </span> 2037 </span> 2038 ) 2039 </div> 2040 2041 </em> 2042 </dt> 2043 <dd class="todo" style="display: none; "> 2044 Undocumented. 2045 </dd> 2046 <dd>The time when the document finished loading, in milliseconds since the epoch.</dd> 2047 <dd style="display: none; "> 2048 This parameter was added in version 2049 <b><span></span></b>. 2050 You must omit this parameter in earlier versions, 2051 and you may omit it in any version. If you require this 2052 parameter, the manifest key 2053 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2054 can ensure that your extension won't be run in an earlier browser version. 2055 </dd> 2056 2057 <!-- OBJECT PROPERTIES --> 2058 <dd style="display: none; "> 2059 <dl> 2060 <div> 2061 <div> 2062 </div> 2063 </div> 2064 </dl> 2065 </dd> 2066 2067 <!-- OBJECT METHODS --> 2068 <dd style="display: none; "> 2069 <div></div> 2070 </dd> 2071 2072 <!-- OBJECT EVENT FIELDS --> 2073 <dd style="display: none; "> 2074 <div></div> 2075 </dd> 2076 2077 <!-- FUNCTION PARAMETERS --> 2078 <dd style="display: none; "> 2079 <div></div> 2080 </dd> 2081 2082 </div> 2083 </div> 2084 </dl> 2085 </dd> 2086 2087 <!-- OBJECT METHODS --> 2088 <dd style="display: none; "> 2089 <div></div> 2090 </dd> 2091 2092 <!-- OBJECT EVENT FIELDS --> 2093 <dd style="display: none; "> 2094 <div></div> 2095 </dd> 2096 2097 <!-- FUNCTION PARAMETERS --> 2098 <dd style="display: none; "> 2099 <div></div> 2100 </dd> 2101 2102 </div> 2103 </div> 2104 </dl> 2105 </div> 2106 </div> <!-- /decription --> 2107 2108 </div><div class="apiItem"> 2109 <a name="event-onDOMContentLoaded"></a> 2110 <h4>onDOMContentLoaded</h4> 2111 2112 <div class="summary"> 2113 <!-- Note: intentionally longer 80 columns --> 2114 <span class="subdued">chrome.experimental.webNavigation.</span><span>onDOMContentLoaded</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 2115 </div> 2116 2117 <div class="description"> 2118 <p class="todo" style="display: none; ">Undocumented.</p> 2119 <p>Fires when the page's DOM is fully constructed, but the referenced resources may not finish loading.</p> 2120 2121 <!-- PARAMETERS --> 2122 <div> 2123 <h4>Parameters</h4> 2124 <dl> 2125 <div> 2126 <div> 2127 <dt> 2128 <var>details</var> 2129 <em> 2130 2131 <!-- TYPE --> 2132 <div style="display:inline"> 2133 ( 2134 <span class="optional" style="display: none; ">optional</span> 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>object</span> 2145 <span style="display: none; "></span> 2146 </span> 2147 </span> 2148 ) 2149 </div> 2150 2151 </em> 2152 </dt> 2153 <dd class="todo"> 2154 Undocumented. 2155 </dd> 2156 <dd style="display: none; "> 2157 Description of this parameter from the json schema. 2158 </dd> 2159 <dd style="display: none; "> 2160 This parameter was added in version 2161 <b><span></span></b>. 2162 You must omit this parameter in earlier versions, 2163 and you may omit it in any version. If you require this 2164 parameter, the manifest key 2165 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2166 can ensure that your extension won't be run in an earlier browser version. 2167 </dd> 2168 2169 <!-- OBJECT PROPERTIES --> 2170 <dd> 2171 <dl> 2172 <div> 2173 <div> 2174 <dt> 2175 <var>tabId</var> 2176 <em> 2177 2178 <!-- TYPE --> 2179 <div style="display:inline"> 2180 ( 2181 <span class="optional" style="display: none; ">optional</span> 2182 <span class="enum" style="display: none; ">enumerated</span> 2183 <span id="typeTemplate"> 2184 <span style="display: none; "> 2185 <a> Type</a> 2186 </span> 2187 <span> 2188 <span style="display: none; "> 2189 array of <span><span></span></span> 2190 </span> 2191 <span>integer</span> 2192 <span style="display: none; "></span> 2193 </span> 2194 </span> 2195 ) 2196 </div> 2197 2198 </em> 2199 </dt> 2200 <dd class="todo" style="display: none; "> 2201 Undocumented. 2202 </dd> 2203 <dd>The ID of the tab in which the navigation occurs.</dd> 2204 <dd style="display: none; "> 2205 This parameter was added in version 2206 <b><span></span></b>. 2207 You must omit this parameter in earlier versions, 2208 and you may omit it in any version. If you require this 2209 parameter, the manifest key 2210 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2211 can ensure that your extension won't be run in an earlier browser version. 2212 </dd> 2213 2214 <!-- OBJECT PROPERTIES --> 2215 <dd style="display: none; "> 2216 <dl> 2217 <div> 2218 <div> 2219 </div> 2220 </div> 2221 </dl> 2222 </dd> 2223 2224 <!-- OBJECT METHODS --> 2225 <dd style="display: none; "> 2226 <div></div> 2227 </dd> 2228 2229 <!-- OBJECT EVENT FIELDS --> 2230 <dd style="display: none; "> 2231 <div></div> 2232 </dd> 2233 2234 <!-- FUNCTION PARAMETERS --> 2235 <dd style="display: none; "> 2236 <div></div> 2237 </dd> 2238 2239 </div> 2240 </div><div> 2241 <div> 2242 <dt> 2243 <var>url</var> 2244 <em> 2245 2246 <!-- TYPE --> 2247 <div style="display:inline"> 2248 ( 2249 <span class="optional" style="display: none; ">optional</span> 2250 <span class="enum" style="display: none; ">enumerated</span> 2251 <span id="typeTemplate"> 2252 <span style="display: none; "> 2253 <a> Type</a> 2254 </span> 2255 <span> 2256 <span style="display: none; "> 2257 array of <span><span></span></span> 2258 </span> 2259 <span>string</span> 2260 <span style="display: none; "></span> 2261 </span> 2262 </span> 2263 ) 2264 </div> 2265 2266 </em> 2267 </dt> 2268 <dd class="todo"> 2269 Undocumented. 2270 </dd> 2271 <dd style="display: none; "> 2272 Description of this parameter from the json schema. 2273 </dd> 2274 <dd style="display: none; "> 2275 This parameter was added in version 2276 <b><span></span></b>. 2277 You must omit this parameter in earlier versions, 2278 and you may omit it in any version. If you require this 2279 parameter, the manifest key 2280 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2281 can ensure that your extension won't be run in an earlier browser version. 2282 </dd> 2283 2284 <!-- OBJECT PROPERTIES --> 2285 <dd style="display: none; "> 2286 <dl> 2287 <div> 2288 <div> 2289 </div> 2290 </div> 2291 </dl> 2292 </dd> 2293 2294 <!-- OBJECT METHODS --> 2295 <dd style="display: none; "> 2296 <div></div> 2297 </dd> 2298 2299 <!-- OBJECT EVENT FIELDS --> 2300 <dd style="display: none; "> 2301 <div></div> 2302 </dd> 2303 2304 <!-- FUNCTION PARAMETERS --> 2305 <dd style="display: none; "> 2306 <div></div> 2307 </dd> 2308 2309 </div> 2310 </div><div> 2311 <div> 2312 <dt> 2313 <var>frameId</var> 2314 <em> 2315 2316 <!-- TYPE --> 2317 <div style="display:inline"> 2318 ( 2319 <span class="optional" style="display: none; ">optional</span> 2320 <span class="enum" style="display: none; ">enumerated</span> 2321 <span id="typeTemplate"> 2322 <span style="display: none; "> 2323 <a> Type</a> 2324 </span> 2325 <span> 2326 <span style="display: none; "> 2327 array of <span><span></span></span> 2328 </span> 2329 <span>integer</span> 2330 <span style="display: none; "></span> 2331 </span> 2332 </span> 2333 ) 2334 </div> 2335 2336 </em> 2337 </dt> 2338 <dd class="todo" style="display: none; "> 2339 Undocumented. 2340 </dd> 2341 <dd>0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe.</dd> 2342 <dd style="display: none; "> 2343 This parameter was added in version 2344 <b><span></span></b>. 2345 You must omit this parameter in earlier versions, 2346 and you may omit it in any version. If you require this 2347 parameter, the manifest key 2348 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2349 can ensure that your extension won't be run in an earlier browser version. 2350 </dd> 2351 2352 <!-- OBJECT PROPERTIES --> 2353 <dd style="display: none; "> 2354 <dl> 2355 <div> 2356 <div> 2357 </div> 2358 </div> 2359 </dl> 2360 </dd> 2361 2362 <!-- OBJECT METHODS --> 2363 <dd style="display: none; "> 2364 <div></div> 2365 </dd> 2366 2367 <!-- OBJECT EVENT FIELDS --> 2368 <dd style="display: none; "> 2369 <div></div> 2370 </dd> 2371 2372 <!-- FUNCTION PARAMETERS --> 2373 <dd style="display: none; "> 2374 <div></div> 2375 </dd> 2376 2377 </div> 2378 </div><div> 2379 <div> 2380 <dt> 2381 <var>timeStamp</var> 2382 <em> 2383 2384 <!-- TYPE --> 2385 <div style="display:inline"> 2386 ( 2387 <span class="optional" style="display: none; ">optional</span> 2388 <span class="enum" style="display: none; ">enumerated</span> 2389 <span id="typeTemplate"> 2390 <span style="display: none; "> 2391 <a> Type</a> 2392 </span> 2393 <span> 2394 <span style="display: none; "> 2395 array of <span><span></span></span> 2396 </span> 2397 <span>number</span> 2398 <span style="display: none; "></span> 2399 </span> 2400 </span> 2401 ) 2402 </div> 2403 2404 </em> 2405 </dt> 2406 <dd class="todo" style="display: none; "> 2407 Undocumented. 2408 </dd> 2409 <dd>The time when the page's DOM was fully constructed, in milliseconds since the epoch.</dd> 2410 <dd style="display: none; "> 2411 This parameter was added in version 2412 <b><span></span></b>. 2413 You must omit this parameter in earlier versions, 2414 and you may omit it in any version. If you require this 2415 parameter, the manifest key 2416 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2417 can ensure that your extension won't be run in an earlier browser version. 2418 </dd> 2419 2420 <!-- OBJECT PROPERTIES --> 2421 <dd style="display: none; "> 2422 <dl> 2423 <div> 2424 <div> 2425 </div> 2426 </div> 2427 </dl> 2428 </dd> 2429 2430 <!-- OBJECT METHODS --> 2431 <dd style="display: none; "> 2432 <div></div> 2433 </dd> 2434 2435 <!-- OBJECT EVENT FIELDS --> 2436 <dd style="display: none; "> 2437 <div></div> 2438 </dd> 2439 2440 <!-- FUNCTION PARAMETERS --> 2441 <dd style="display: none; "> 2442 <div></div> 2443 </dd> 2444 2445 </div> 2446 </div> 2447 </dl> 2448 </dd> 2449 2450 <!-- OBJECT METHODS --> 2451 <dd style="display: none; "> 2452 <div></div> 2453 </dd> 2454 2455 <!-- OBJECT EVENT FIELDS --> 2456 <dd style="display: none; "> 2457 <div></div> 2458 </dd> 2459 2460 <!-- FUNCTION PARAMETERS --> 2461 <dd style="display: none; "> 2462 <div></div> 2463 </dd> 2464 2465 </div> 2466 </div> 2467 </dl> 2468 </div> 2469 </div> <!-- /decription --> 2470 2471 </div><div class="apiItem"> 2472 <a name="event-onErrorOccurred"></a> 2473 <h4>onErrorOccurred</h4> 2474 2475 <div class="summary"> 2476 <!-- Note: intentionally longer 80 columns --> 2477 <span class="subdued">chrome.experimental.webNavigation.</span><span>onErrorOccurred</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 2478 </div> 2479 2480 <div class="description"> 2481 <p class="todo" style="display: none; ">Undocumented.</p> 2482 <p>Fires when an error occurs.</p> 2483 2484 <!-- PARAMETERS --> 2485 <div> 2486 <h4>Parameters</h4> 2487 <dl> 2488 <div> 2489 <div> 2490 <dt> 2491 <var>details</var> 2492 <em> 2493 2494 <!-- TYPE --> 2495 <div style="display:inline"> 2496 ( 2497 <span class="optional" style="display: none; ">optional</span> 2498 <span class="enum" style="display: none; ">enumerated</span> 2499 <span id="typeTemplate"> 2500 <span style="display: none; "> 2501 <a> Type</a> 2502 </span> 2503 <span> 2504 <span style="display: none; "> 2505 array of <span><span></span></span> 2506 </span> 2507 <span>object</span> 2508 <span style="display: none; "></span> 2509 </span> 2510 </span> 2511 ) 2512 </div> 2513 2514 </em> 2515 </dt> 2516 <dd class="todo"> 2517 Undocumented. 2518 </dd> 2519 <dd style="display: none; "> 2520 Description of this parameter from the json schema. 2521 </dd> 2522 <dd style="display: none; "> 2523 This parameter was added in version 2524 <b><span></span></b>. 2525 You must omit this parameter in earlier versions, 2526 and you may omit it in any version. If you require this 2527 parameter, the manifest key 2528 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2529 can ensure that your extension won't be run in an earlier browser version. 2530 </dd> 2531 2532 <!-- OBJECT PROPERTIES --> 2533 <dd> 2534 <dl> 2535 <div> 2536 <div> 2537 <dt> 2538 <var>tabId</var> 2539 <em> 2540 2541 <!-- TYPE --> 2542 <div style="display:inline"> 2543 ( 2544 <span class="optional" style="display: none; ">optional</span> 2545 <span class="enum" style="display: none; ">enumerated</span> 2546 <span id="typeTemplate"> 2547 <span style="display: none; "> 2548 <a> Type</a> 2549 </span> 2550 <span> 2551 <span style="display: none; "> 2552 array of <span><span></span></span> 2553 </span> 2554 <span>integer</span> 2555 <span style="display: none; "></span> 2556 </span> 2557 </span> 2558 ) 2559 </div> 2560 2561 </em> 2562 </dt> 2563 <dd class="todo" style="display: none; "> 2564 Undocumented. 2565 </dd> 2566 <dd>The ID of the tab in which the navigation occurs.</dd> 2567 <dd style="display: none; "> 2568 This parameter was added in version 2569 <b><span></span></b>. 2570 You must omit this parameter in earlier versions, 2571 and you may omit it in any version. If you require this 2572 parameter, the manifest key 2573 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2574 can ensure that your extension won't be run in an earlier browser version. 2575 </dd> 2576 2577 <!-- OBJECT PROPERTIES --> 2578 <dd style="display: none; "> 2579 <dl> 2580 <div> 2581 <div> 2582 </div> 2583 </div> 2584 </dl> 2585 </dd> 2586 2587 <!-- OBJECT METHODS --> 2588 <dd style="display: none; "> 2589 <div></div> 2590 </dd> 2591 2592 <!-- OBJECT EVENT FIELDS --> 2593 <dd style="display: none; "> 2594 <div></div> 2595 </dd> 2596 2597 <!-- FUNCTION PARAMETERS --> 2598 <dd style="display: none; "> 2599 <div></div> 2600 </dd> 2601 2602 </div> 2603 </div><div> 2604 <div> 2605 <dt> 2606 <var>url</var> 2607 <em> 2608 2609 <!-- TYPE --> 2610 <div style="display:inline"> 2611 ( 2612 <span class="optional" style="display: none; ">optional</span> 2613 <span class="enum" style="display: none; ">enumerated</span> 2614 <span id="typeTemplate"> 2615 <span style="display: none; "> 2616 <a> Type</a> 2617 </span> 2618 <span> 2619 <span style="display: none; "> 2620 array of <span><span></span></span> 2621 </span> 2622 <span>string</span> 2623 <span style="display: none; "></span> 2624 </span> 2625 </span> 2626 ) 2627 </div> 2628 2629 </em> 2630 </dt> 2631 <dd class="todo"> 2632 Undocumented. 2633 </dd> 2634 <dd style="display: none; "> 2635 Description of this parameter from the json schema. 2636 </dd> 2637 <dd style="display: none; "> 2638 This parameter was added in version 2639 <b><span></span></b>. 2640 You must omit this parameter in earlier versions, 2641 and you may omit it in any version. If you require this 2642 parameter, the manifest key 2643 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2644 can ensure that your extension won't be run in an earlier browser version. 2645 </dd> 2646 2647 <!-- OBJECT PROPERTIES --> 2648 <dd style="display: none; "> 2649 <dl> 2650 <div> 2651 <div> 2652 </div> 2653 </div> 2654 </dl> 2655 </dd> 2656 2657 <!-- OBJECT METHODS --> 2658 <dd style="display: none; "> 2659 <div></div> 2660 </dd> 2661 2662 <!-- OBJECT EVENT FIELDS --> 2663 <dd style="display: none; "> 2664 <div></div> 2665 </dd> 2666 2667 <!-- FUNCTION PARAMETERS --> 2668 <dd style="display: none; "> 2669 <div></div> 2670 </dd> 2671 2672 </div> 2673 </div><div> 2674 <div> 2675 <dt> 2676 <var>frameId</var> 2677 <em> 2678 2679 <!-- TYPE --> 2680 <div style="display:inline"> 2681 ( 2682 <span class="optional" style="display: none; ">optional</span> 2683 <span class="enum" style="display: none; ">enumerated</span> 2684 <span id="typeTemplate"> 2685 <span style="display: none; "> 2686 <a> Type</a> 2687 </span> 2688 <span> 2689 <span style="display: none; "> 2690 array of <span><span></span></span> 2691 </span> 2692 <span>integer</span> 2693 <span style="display: none; "></span> 2694 </span> 2695 </span> 2696 ) 2697 </div> 2698 2699 </em> 2700 </dt> 2701 <dd class="todo" style="display: none; "> 2702 Undocumented. 2703 </dd> 2704 <dd>0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe.</dd> 2705 <dd style="display: none; "> 2706 This parameter was added in version 2707 <b><span></span></b>. 2708 You must omit this parameter in earlier versions, 2709 and you may omit it in any version. If you require this 2710 parameter, the manifest key 2711 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2712 can ensure that your extension won't be run in an earlier browser version. 2713 </dd> 2714 2715 <!-- OBJECT PROPERTIES --> 2716 <dd style="display: none; "> 2717 <dl> 2718 <div> 2719 <div> 2720 </div> 2721 </div> 2722 </dl> 2723 </dd> 2724 2725 <!-- OBJECT METHODS --> 2726 <dd style="display: none; "> 2727 <div></div> 2728 </dd> 2729 2730 <!-- OBJECT EVENT FIELDS --> 2731 <dd style="display: none; "> 2732 <div></div> 2733 </dd> 2734 2735 <!-- FUNCTION PARAMETERS --> 2736 <dd style="display: none; "> 2737 <div></div> 2738 </dd> 2739 2740 </div> 2741 </div><div> 2742 <div> 2743 <dt> 2744 <var>error</var> 2745 <em> 2746 2747 <!-- TYPE --> 2748 <div style="display:inline"> 2749 ( 2750 <span class="optional" style="display: none; ">optional</span> 2751 <span class="enum" style="display: none; ">enumerated</span> 2752 <span id="typeTemplate"> 2753 <span style="display: none; "> 2754 <a> Type</a> 2755 </span> 2756 <span> 2757 <span style="display: none; "> 2758 array of <span><span></span></span> 2759 </span> 2760 <span>string</span> 2761 <span style="display: none; "></span> 2762 </span> 2763 </span> 2764 ) 2765 </div> 2766 2767 </em> 2768 </dt> 2769 <dd class="todo" style="display: none; "> 2770 Undocumented. 2771 </dd> 2772 <dd>The error description.</dd> 2773 <dd style="display: none; "> 2774 This parameter was added in version 2775 <b><span></span></b>. 2776 You must omit this parameter in earlier versions, 2777 and you may omit it in any version. If you require this 2778 parameter, the manifest key 2779 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2780 can ensure that your extension won't be run in an earlier browser version. 2781 </dd> 2782 2783 <!-- OBJECT PROPERTIES --> 2784 <dd style="display: none; "> 2785 <dl> 2786 <div> 2787 <div> 2788 </div> 2789 </div> 2790 </dl> 2791 </dd> 2792 2793 <!-- OBJECT METHODS --> 2794 <dd style="display: none; "> 2795 <div></div> 2796 </dd> 2797 2798 <!-- OBJECT EVENT FIELDS --> 2799 <dd style="display: none; "> 2800 <div></div> 2801 </dd> 2802 2803 <!-- FUNCTION PARAMETERS --> 2804 <dd style="display: none; "> 2805 <div></div> 2806 </dd> 2807 2808 </div> 2809 </div><div> 2810 <div> 2811 <dt> 2812 <var>timeStamp</var> 2813 <em> 2814 2815 <!-- TYPE --> 2816 <div style="display:inline"> 2817 ( 2818 <span class="optional" style="display: none; ">optional</span> 2819 <span class="enum" style="display: none; ">enumerated</span> 2820 <span id="typeTemplate"> 2821 <span style="display: none; "> 2822 <a> Type</a> 2823 </span> 2824 <span> 2825 <span style="display: none; "> 2826 array of <span><span></span></span> 2827 </span> 2828 <span>number</span> 2829 <span style="display: none; "></span> 2830 </span> 2831 </span> 2832 ) 2833 </div> 2834 2835 </em> 2836 </dt> 2837 <dd class="todo" style="display: none; "> 2838 Undocumented. 2839 </dd> 2840 <dd>The time when the error occurred, in milliseconds since the epoch.</dd> 2841 <dd style="display: none; "> 2842 This parameter was added in version 2843 <b><span></span></b>. 2844 You must omit this parameter in earlier versions, 2845 and you may omit it in any version. If you require this 2846 parameter, the manifest key 2847 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2848 can ensure that your extension won't be run in an earlier browser version. 2849 </dd> 2850 2851 <!-- OBJECT PROPERTIES --> 2852 <dd style="display: none; "> 2853 <dl> 2854 <div> 2855 <div> 2856 </div> 2857 </div> 2858 </dl> 2859 </dd> 2860 2861 <!-- OBJECT METHODS --> 2862 <dd style="display: none; "> 2863 <div></div> 2864 </dd> 2865 2866 <!-- OBJECT EVENT FIELDS --> 2867 <dd style="display: none; "> 2868 <div></div> 2869 </dd> 2870 2871 <!-- FUNCTION PARAMETERS --> 2872 <dd style="display: none; "> 2873 <div></div> 2874 </dd> 2875 2876 </div> 2877 </div> 2878 </dl> 2879 </dd> 2880 2881 <!-- OBJECT METHODS --> 2882 <dd style="display: none; "> 2883 <div></div> 2884 </dd> 2885 2886 <!-- OBJECT EVENT FIELDS --> 2887 <dd style="display: none; "> 2888 <div></div> 2889 </dd> 2890 2891 <!-- FUNCTION PARAMETERS --> 2892 <dd style="display: none; "> 2893 <div></div> 2894 </dd> 2895 2896 </div> 2897 </div> 2898 </dl> 2899 </div> 2900 </div> <!-- /decription --> 2901 2902 </div> <!-- /apiItem --> 2903 2904 </div> <!-- /apiGroup --> 2905 2906 <!-- TYPES --> 2907 <div class="apiGroup" style="display: none; "> 2908 <a name="types"></a> 2909 <h3 id="types">Types</h3> 2910 2911 <!-- iterates over all types --> 2912 <div class="apiItem"> 2913 <a></a> 2914 <h4>type name</h4> 2915 2916 <div> 2917 </div> 2918 2919 </div> <!-- /apiItem --> 2920 2921 </div> <!-- /apiGroup --> 2922 2923 </div> <!-- /apiPage --> 2924 </div> <!-- /gc-pagecontent --> 2925 </div> <!-- /g-section --> 2926 </div> <!-- /codesiteContent --> 2927 <div id="gc-footer" --=""> 2928 <div class="text"> 2929 <p> 2930 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 2931 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 2932 Attribution 3.0 License</a>, and code samples are licensed under the 2933 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 2934 </p> 2935 <p> 2936 ©2011 Google 2937 </p> 2938 2939<!-- begin analytics --> 2940<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 2941<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 2942 2943<script type="text/javascript"> 2944 // chrome doc tracking 2945 try { 2946 var engdocs = _gat._getTracker("YT-10763712-2"); 2947 engdocs._trackPageview(); 2948 } catch(err) {} 2949 2950 // code.google.com site-wide tracking 2951 try { 2952 _uacct="UA-18071-1"; 2953 _uanchor=1; 2954 _uff=0; 2955 urchinTracker(); 2956 } 2957 catch(e) {/* urchinTracker not available. */} 2958</script> 2959<!-- end analytics --> 2960 </div> 2961 </div> <!-- /gc-footer --> 2962 </div> <!-- /gc-container --> 2963</body></html> 2964
