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>chrome.history - 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 class="leftNavSelected">History</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">chrome.history</h1> 255 </div> 256 <!-- TABLE OF CONTENTS --> 257 <div id="toc"> 258 <h2>Contents</h2> 259 <ol> 260 <li> 261 <a href="#manifest">Manifest</a> 262 <ol> 263 <li style="display: none; "> 264 <a>h3Name</a> 265 </li> 266 </ol> 267 </li><li> 268 <a href="#transition_types">Transition types</a> 269 <ol> 270 <li style="display: none; "> 271 <a>h3Name</a> 272 </li> 273 </ol> 274 </li><li> 275 <a href="#examples">Examples</a> 276 <ol> 277 <li style="display: none; "> 278 <a>h3Name</a> 279 </li> 280 </ol> 281 </li> 282 <li> 283 <a href="#apiReference">API reference: chrome.history</a> 284 <ol> 285 <li style="display: none; "> 286 <a href="#properties">Properties</a> 287 <ol> 288 <li> 289 <a href="#property-anchor">propertyName</a> 290 </li> 291 </ol> 292 </li> 293 <li> 294 <a href="#global-methods">Methods</a> 295 <ol> 296 <li> 297 <a href="#method-addUrl">addUrl</a> 298 </li><li> 299 <a href="#method-deleteAll">deleteAll</a> 300 </li><li> 301 <a href="#method-deleteRange">deleteRange</a> 302 </li><li> 303 <a href="#method-deleteUrl">deleteUrl</a> 304 </li><li> 305 <a href="#method-getVisits">getVisits</a> 306 </li><li> 307 <a href="#method-search">search</a> 308 </li> 309 </ol> 310 </li> 311 <li> 312 <a href="#global-events">Events</a> 313 <ol> 314 <li> 315 <a href="#event-onVisitRemoved">onVisitRemoved</a> 316 </li><li> 317 <a href="#event-onVisited">onVisited</a> 318 </li> 319 </ol> 320 </li> 321 <li> 322 <a href="#types">Types</a> 323 <ol> 324 <li> 325 <a href="#type-HistoryItem">HistoryItem</a> 326 </li><li> 327 <a href="#type-VisitItem">VisitItem</a> 328 </li> 329 </ol> 330 </li> 331 </ol> 332 </li> 333 </ol> 334 </div> 335 <!-- /TABLE OF CONTENTS --> 336 337 <!-- Standard content lead-in for experimental API pages --> 338 <p id="classSummary" style="display: none; "> 339 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 340 </p> 341 342 <!-- STATIC CONTENT PLACEHOLDER --> 343 <div id="static"><!-- BEGIN AUTHORED CONTENT --> 344<p id="classSummary"> 345Use the <code>chrome.history</code> module to interact with the 346browser's record of visited pages. You can add, remove, and query 347for URLs in the browser's history. 348To override the history page with your own version, see 349<a href="override.html">Override Pages</a>. 350</p> 351 352<h2 id="manifest">Manifest</h2> 353 354<p>You must declare the "history" permission 355in the <a href="manifest.html">extension manifest</a> 356to use the history API. 357For example:</p> 358<pre>{ 359 "name": "My extension", 360 ... 361 <b>"permissions": [ 362 "history" 363 ]</b>, 364 ... 365}</pre> 366 367<h2 id="transition_types">Transition types</h2> 368 369<p> 370The history API uses a <em>transition type</em> to describe 371how the browser navigated to a particular URL 372on a particular visit. 373For example, if a user visits a page 374by clicking a link on another page, 375the transition type is "link". 376</p> 377 378<p> 379The following table describes each transition type. 380</p> 381 382<table> 383<tbody><tr> 384 <th> Transition type </th> <th> Description </th> 385</tr> 386<tr id="tt_link"> 387 <td>"link"</td> 388 <td> 389 The user got to this page by clicking a link on another page. 390 </td> 391</tr> 392<tr id="tt_typed"> 393 <td>"typed"</td> 394 <td> 395 The user got this page by typing the URL in the address bar. 396 Also used for other explicit navigation actions. 397 See also <a href="#tt_generated">generated</a>, 398 which is used for cases where the user selected a choice 399 that didn't look at all like a URL. 400 </td> 401</tr> 402<tr id="tt_auto_bookmark"> 403 <td>"auto_bookmark"</td> 404 <td> 405 The user got to this page through a suggestion in the UI — 406 for example, through a menu item. 407 </td> 408</tr> 409<tr id="tt_auto_subframe"> 410 <td>"auto_subframe"</td> 411 <td> 412 Subframe navigation. 413 This is any content that is automatically 414 loaded in a non-top-level frame. 415 For example, if a page consists of 416 several frames containing ads, 417 those ad URLs have this transition type. 418 The user may not even realize the content in these pages 419 is a separate frame, and so may not care about the URL 420 (see also <a href="#tt_manual_subframe">manual_subframe</a>). 421 </td> 422</tr> 423<tr id="tt_manual_subframe"> 424 <td>"manual_subframe"</td> 425 <td> 426 For subframe navigations that are explicitly requested by the user 427 and generate new navigation entries in the back/forward list. 428 An explicitly requested frame is probably more important than 429 an automatically loaded frame 430 because the user probably cares about the fact that 431 the requested frame was loaded. 432 </td> 433</tr> 434<tr id="tt_generated"> 435 <td>"generated"</td> 436 <td> 437 The user got to this page by typing in the address bar 438 and selecting an entry that did not look like a URL. 439 For example, a match might have the URL of a Google search result page, 440 but it might appear to the user as "Search Google for ...". 441 These are not quite the same as <a href="#tt_typed">typed</a> navigations 442 because the user didn't type or see the destination URL. 443 See also <a href="#tt_keyword">keyword</a>. 444 </td> 445</tr> 446<tr id="tt_start_page"> 447 <td>"start_page"</td> 448 <td> 449 The page was specified in the command line or is the start page. 450 </td> 451</tr> 452<tr id="tt_form_submit"> 453 <td>"form_submit"</td> 454 <td> 455 The user filled out values in a form and submitted it. 456 Note that in some situations — 457 such as when a form uses script to submit contents — 458 submitting a form does not result in this transition type. 459 </td> 460</tr> 461<tr id="tt_reload"> 462 <td>"reload"</td> 463 <td> 464 The user reloaded the page, 465 either by clicking the reload button 466 or by pressing Enter in the address bar. 467 Session restore and Reopen closed tab use this transition type, too. 468 </td> 469</tr> 470<tr id="tt_keyword"> 471 <td>"keyword"</td> 472 <td> 473 The URL was generated from a replaceable keyword 474 other than the default search provider. 475 See also 476 <a href="#tt_keyword_generated">keyword_generated</a>. 477 </td> 478</tr> 479<tr id="tt_keyword_generated"> 480 <td>"keyword_generated"</td> 481 <td> 482 Corresponds to a visit generated for a keyword. 483 See also <a href="#tt_keyword">keyword</a>. 484 </td> 485</tr> 486</tbody></table> 487 488<h2 id="examples">Examples</h2> 489 490<p> 491For examples of using this API, see the 492<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/history/">history sample directory</a> and the 493<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/test/data/extensions/api_test/history/">history API test directory</a>. 494For other examples and for help in viewing the source code, see 495<a href="samples.html">Samples</a>. 496</p> 497 498<!-- END AUTHORED CONTENT --> 499</div> 500 501 <!-- API PAGE --> 502 <div class="apiPage"> 503 <a name="apiReference"></a> 504 <h2>API reference: chrome.history</h2> 505 506 <!-- PROPERTIES --> 507 <div class="apiGroup" style="display: none; "> 508 <a name="properties"></a> 509 <h3 id="properties">Properties</h3> 510 511 <div> 512 <a></a> 513 <h4>getLastError</h4> 514 <div class="summary"> 515 <!-- Note: intentionally longer 80 columns --> 516 <span>chrome.extension</span><span>lastError</span> 517 </div> 518 <div> 519 </div> 520 </div> 521 522 </div> <!-- /apiGroup --> 523 524 <!-- METHODS --> 525 <div id="methodsTemplate" class="apiGroup"> 526 <a name="global-methods"></a> 527 <h3>Methods</h3> 528 529 <!-- iterates over all functions --> 530 <div class="apiItem"> 531 <a name="method-addUrl"></a> <!-- method-anchor --> 532 <h4>addUrl</h4> 533 534 <div class="summary"><span style="display: none; ">void</span> 535 <!-- Note: intentionally longer 80 columns --> 536 <span>chrome.history.addUrl</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 537 <var><span>details</span></var></span>)</div> 538 539 <div class="description"> 540 <p class="todo" style="display: none; ">Undocumented.</p> 541 <p>Adds a URL to the history at the current time with a <a href="#transition_types">transition type</a> of "link".</p> 542 543 <!-- PARAMETERS --> 544 <h4>Parameters</h4> 545 <dl> 546 <div> 547 <div> 548 <dt> 549 <var>details</var> 550 <em> 551 552 <!-- TYPE --> 553 <div style="display:inline"> 554 ( 555 <span class="optional" style="display: none; ">optional</span> 556 <span class="enum" style="display: none; ">enumerated</span> 557 <span id="typeTemplate"> 558 <span style="display: none; "> 559 <a> Type</a> 560 </span> 561 <span> 562 <span style="display: none; "> 563 array of <span><span></span></span> 564 </span> 565 <span>object</span> 566 <span style="display: none; "></span> 567 </span> 568 </span> 569 ) 570 </div> 571 572 </em> 573 </dt> 574 <dd class="todo"> 575 Undocumented. 576 </dd> 577 <dd style="display: none; "> 578 Description of this parameter from the json schema. 579 </dd> 580 <dd style="display: none; "> 581 This parameter was added in version 582 <b><span></span></b>. 583 You must omit this parameter in earlier versions, 584 and you may omit it in any version. If you require this 585 parameter, the manifest key 586 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 587 can ensure that your extension won't be run in an earlier browser version. 588 </dd> 589 590 <!-- OBJECT PROPERTIES --> 591 <dd> 592 <dl> 593 <div> 594 <div> 595 <dt> 596 <var>url</var> 597 <em> 598 599 <!-- TYPE --> 600 <div style="display:inline"> 601 ( 602 <span class="optional" style="display: none; ">optional</span> 603 <span class="enum" style="display: none; ">enumerated</span> 604 <span id="typeTemplate"> 605 <span style="display: none; "> 606 <a> Type</a> 607 </span> 608 <span> 609 <span style="display: none; "> 610 array of <span><span></span></span> 611 </span> 612 <span>string</span> 613 <span style="display: none; "></span> 614 </span> 615 </span> 616 ) 617 </div> 618 619 </em> 620 </dt> 621 <dd class="todo" style="display: none; "> 622 Undocumented. 623 </dd> 624 <dd>The URL to add.</dd> 625 <dd style="display: none; "> 626 This parameter was added in version 627 <b><span></span></b>. 628 You must omit this parameter in earlier versions, 629 and you may omit it in any version. If you require this 630 parameter, the manifest key 631 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 632 can ensure that your extension won't be run in an earlier browser version. 633 </dd> 634 635 <!-- OBJECT PROPERTIES --> 636 <dd style="display: none; "> 637 <dl> 638 <div> 639 <div> 640 </div> 641 </div> 642 </dl> 643 </dd> 644 645 <!-- OBJECT METHODS --> 646 <dd style="display: none; "> 647 <div></div> 648 </dd> 649 650 <!-- OBJECT EVENT FIELDS --> 651 <dd style="display: none; "> 652 <div></div> 653 </dd> 654 655 <!-- FUNCTION PARAMETERS --> 656 <dd style="display: none; "> 657 <div></div> 658 </dd> 659 660 </div> 661 </div> 662 </dl> 663 </dd> 664 665 <!-- OBJECT METHODS --> 666 <dd style="display: none; "> 667 <div></div> 668 </dd> 669 670 <!-- OBJECT EVENT FIELDS --> 671 <dd style="display: none; "> 672 <div></div> 673 </dd> 674 675 <!-- FUNCTION PARAMETERS --> 676 <dd style="display: none; "> 677 <div></div> 678 </dd> 679 680 </div> 681 </div> 682 </dl> 683 684 <!-- RETURNS --> 685 <h4 style="display: none; ">Returns</h4> 686 <dl> 687 <div style="display: none; "> 688 <div> 689 </div> 690 </div> 691 </dl> 692 693 <!-- CALLBACK --> 694 <div style="display: none; "> 695 <div> 696 <h4>Callback function</h4> 697 <p> 698 The callback <em>parameter</em> should specify a function 699 that looks like this: 700 </p> 701 <p> 702 If you specify the <em>callback</em> parameter, it should 703 specify a function that looks like this: 704 </p> 705 706 <!-- Note: intentionally longer 80 columns --> 707 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 708 <dl> 709 <div> 710 <div> 711 </div> 712 </div> 713 </dl> 714 </div> 715 </div> 716 717 <!-- MIN_VERSION --> 718 <p style="display: none; "> 719 This function was added in version <b><span></span></b>. 720 If you require this function, the manifest key 721 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 722 can ensure that your extension won't be run in an earlier browser version. 723 </p> 724 </div> <!-- /description --> 725 726 </div><div class="apiItem"> 727 <a name="method-deleteAll"></a> <!-- method-anchor --> 728 <h4>deleteAll</h4> 729 730 <div class="summary"><span style="display: none; ">void</span> 731 <!-- Note: intentionally longer 80 columns --> 732 <span>chrome.history.deleteAll</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> 733 <var><span>callback</span></var></span>)</div> 734 735 <div class="description"> 736 <p class="todo" style="display: none; ">Undocumented.</p> 737 <p>Deletes all items from the history.</p> 738 739 <!-- PARAMETERS --> 740 <h4>Parameters</h4> 741 <dl> 742 <div> 743 <div> 744 <dt> 745 <var>callback</var> 746 <em> 747 748 <!-- TYPE --> 749 <div style="display:inline"> 750 ( 751 <span class="optional" style="display: none; ">optional</span> 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>function</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_version</a> 783 can ensure that your extension won't be run in an earlier browser version. 784 </dd> 785 786 <!-- OBJECT PROPERTIES --> 787 <dd style="display: none; "> 788 <dl> 789 <div> 790 <div> 791 </div> 792 </div> 793 </dl> 794 </dd> 795 796 <!-- OBJECT METHODS --> 797 <dd style="display: none; "> 798 <div></div> 799 </dd> 800 801 <!-- OBJECT EVENT FIELDS --> 802 <dd style="display: none; "> 803 <div></div> 804 </dd> 805 806 <!-- FUNCTION PARAMETERS --> 807 <dd style="display: none; "> 808 <div></div> 809 </dd> 810 811 </div> 812 </div> 813 </dl> 814 815 <!-- RETURNS --> 816 <h4 style="display: none; ">Returns</h4> 817 <dl> 818 <div style="display: none; "> 819 <div> 820 </div> 821 </div> 822 </dl> 823 824 <!-- CALLBACK --> 825 <div> 826 <div> 827 <h4>Callback function</h4> 828 <p> 829 The callback <em>parameter</em> should specify a function 830 that looks like this: 831 </p> 832 <p style="display: none; "> 833 If you specify the <em>callback</em> parameter, it should 834 specify a function that looks like this: 835 </p> 836 837 <!-- Note: intentionally longer 80 columns --> 838 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 839 <dl> 840 <div style="display: none; "> 841 <div> 842 </div> 843 </div> 844 </dl> 845 </div> 846 </div> 847 848 <!-- MIN_VERSION --> 849 <p style="display: none; "> 850 This function was added in version <b><span></span></b>. 851 If you require this function, the manifest key 852 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 853 can ensure that your extension won't be run in an earlier browser version. 854 </p> 855 </div> <!-- /description --> 856 857 </div><div class="apiItem"> 858 <a name="method-deleteRange"></a> <!-- method-anchor --> 859 <h4>deleteRange</h4> 860 861 <div class="summary"><span style="display: none; ">void</span> 862 <!-- Note: intentionally longer 80 columns --> 863 <span>chrome.history.deleteRange</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 864 <var><span>range</span></var></span><span class="null"><span>, </span><span>function</span> 865 <var><span>callback</span></var></span>)</div> 866 867 <div class="description"> 868 <p class="todo" style="display: none; ">Undocumented.</p> 869 <p>Removes all items within the specified date range from the history. Pages will not be removed from the history unless all visits fall within the range.</p> 870 871 <!-- PARAMETERS --> 872 <h4>Parameters</h4> 873 <dl> 874 <div> 875 <div> 876 <dt> 877 <var>range</var> 878 <em> 879 880 <!-- TYPE --> 881 <div style="display:inline"> 882 ( 883 <span class="optional" style="display: none; ">optional</span> 884 <span class="enum" style="display: none; ">enumerated</span> 885 <span id="typeTemplate"> 886 <span style="display: none; "> 887 <a> Type</a> 888 </span> 889 <span> 890 <span style="display: none; "> 891 array of <span><span></span></span> 892 </span> 893 <span>object</span> 894 <span style="display: none; "></span> 895 </span> 896 </span> 897 ) 898 </div> 899 900 </em> 901 </dt> 902 <dd class="todo"> 903 Undocumented. 904 </dd> 905 <dd style="display: none; "> 906 Description of this parameter from the json schema. 907 </dd> 908 <dd style="display: none; "> 909 This parameter was added in version 910 <b><span></span></b>. 911 You must omit this parameter in earlier versions, 912 and you may omit it in any version. If you require this 913 parameter, the manifest key 914 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 915 can ensure that your extension won't be run in an earlier browser version. 916 </dd> 917 918 <!-- OBJECT PROPERTIES --> 919 <dd> 920 <dl> 921 <div> 922 <div> 923 <dt> 924 <var>startTime</var> 925 <em> 926 927 <!-- TYPE --> 928 <div style="display:inline"> 929 ( 930 <span class="optional" style="display: none; ">optional</span> 931 <span class="enum" style="display: none; ">enumerated</span> 932 <span id="typeTemplate"> 933 <span style="display: none; "> 934 <a> Type</a> 935 </span> 936 <span> 937 <span style="display: none; "> 938 array of <span><span></span></span> 939 </span> 940 <span>number</span> 941 <span style="display: none; "></span> 942 </span> 943 </span> 944 ) 945 </div> 946 947 </em> 948 </dt> 949 <dd class="todo" style="display: none; "> 950 Undocumented. 951 </dd> 952 <dd>Items added to history after this date, represented in milliseconds since the epoch.</dd> 953 <dd style="display: none; "> 954 This parameter was added in version 955 <b><span></span></b>. 956 You must omit this parameter in earlier versions, 957 and you may omit it in any version. If you require this 958 parameter, the manifest key 959 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 960 can ensure that your extension won't be run in an earlier browser version. 961 </dd> 962 963 <!-- OBJECT PROPERTIES --> 964 <dd style="display: none; "> 965 <dl> 966 <div> 967 <div> 968 </div> 969 </div> 970 </dl> 971 </dd> 972 973 <!-- OBJECT METHODS --> 974 <dd style="display: none; "> 975 <div></div> 976 </dd> 977 978 <!-- OBJECT EVENT FIELDS --> 979 <dd style="display: none; "> 980 <div></div> 981 </dd> 982 983 <!-- FUNCTION PARAMETERS --> 984 <dd style="display: none; "> 985 <div></div> 986 </dd> 987 988 </div> 989 </div><div> 990 <div> 991 <dt> 992 <var>endTime</var> 993 <em> 994 995 <!-- TYPE --> 996 <div style="display:inline"> 997 ( 998 <span class="optional" style="display: none; ">optional</span> 999 <span class="enum" style="display: none; ">enumerated</span> 1000 <span id="typeTemplate"> 1001 <span style="display: none; "> 1002 <a> Type</a> 1003 </span> 1004 <span> 1005 <span style="display: none; "> 1006 array of <span><span></span></span> 1007 </span> 1008 <span>number</span> 1009 <span style="display: none; "></span> 1010 </span> 1011 </span> 1012 ) 1013 </div> 1014 1015 </em> 1016 </dt> 1017 <dd class="todo" style="display: none; "> 1018 Undocumented. 1019 </dd> 1020 <dd>Items added to history before this date, represented in milliseconds since the epoch.</dd> 1021 <dd style="display: none; "> 1022 This parameter was added in version 1023 <b><span></span></b>. 1024 You must omit this parameter in earlier versions, 1025 and you may omit it in any version. If you require this 1026 parameter, the manifest key 1027 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1028 can ensure that your extension won't be run in an earlier browser version. 1029 </dd> 1030 1031 <!-- OBJECT PROPERTIES --> 1032 <dd style="display: none; "> 1033 <dl> 1034 <div> 1035 <div> 1036 </div> 1037 </div> 1038 </dl> 1039 </dd> 1040 1041 <!-- OBJECT METHODS --> 1042 <dd style="display: none; "> 1043 <div></div> 1044 </dd> 1045 1046 <!-- OBJECT EVENT FIELDS --> 1047 <dd style="display: none; "> 1048 <div></div> 1049 </dd> 1050 1051 <!-- FUNCTION PARAMETERS --> 1052 <dd style="display: none; "> 1053 <div></div> 1054 </dd> 1055 1056 </div> 1057 </div> 1058 </dl> 1059 </dd> 1060 1061 <!-- OBJECT METHODS --> 1062 <dd style="display: none; "> 1063 <div></div> 1064 </dd> 1065 1066 <!-- OBJECT EVENT FIELDS --> 1067 <dd style="display: none; "> 1068 <div></div> 1069 </dd> 1070 1071 <!-- FUNCTION PARAMETERS --> 1072 <dd style="display: none; "> 1073 <div></div> 1074 </dd> 1075 1076 </div> 1077 </div><div> 1078 <div> 1079 <dt> 1080 <var>callback</var> 1081 <em> 1082 1083 <!-- TYPE --> 1084 <div style="display:inline"> 1085 ( 1086 <span class="optional" style="display: none; ">optional</span> 1087 <span class="enum" style="display: none; ">enumerated</span> 1088 <span id="typeTemplate"> 1089 <span style="display: none; "> 1090 <a> Type</a> 1091 </span> 1092 <span> 1093 <span style="display: none; "> 1094 array of <span><span></span></span> 1095 </span> 1096 <span>function</span> 1097 <span style="display: none; "></span> 1098 </span> 1099 </span> 1100 ) 1101 </div> 1102 1103 </em> 1104 </dt> 1105 <dd class="todo"> 1106 Undocumented. 1107 </dd> 1108 <dd style="display: none; "> 1109 Description of this parameter from the json schema. 1110 </dd> 1111 <dd style="display: none; "> 1112 This parameter was added in version 1113 <b><span></span></b>. 1114 You must omit this parameter in earlier versions, 1115 and you may omit it in any version. If you require this 1116 parameter, the manifest key 1117 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1118 can ensure that your extension won't be run in an earlier browser version. 1119 </dd> 1120 1121 <!-- OBJECT PROPERTIES --> 1122 <dd style="display: none; "> 1123 <dl> 1124 <div> 1125 <div> 1126 </div> 1127 </div> 1128 </dl> 1129 </dd> 1130 1131 <!-- OBJECT METHODS --> 1132 <dd style="display: none; "> 1133 <div></div> 1134 </dd> 1135 1136 <!-- OBJECT EVENT FIELDS --> 1137 <dd style="display: none; "> 1138 <div></div> 1139 </dd> 1140 1141 <!-- FUNCTION PARAMETERS --> 1142 <dd style="display: none; "> 1143 <div></div> 1144 </dd> 1145 1146 </div> 1147 </div> 1148 </dl> 1149 1150 <!-- RETURNS --> 1151 <h4 style="display: none; ">Returns</h4> 1152 <dl> 1153 <div style="display: none; "> 1154 <div> 1155 </div> 1156 </div> 1157 </dl> 1158 1159 <!-- CALLBACK --> 1160 <div> 1161 <div> 1162 <h4>Callback function</h4> 1163 <p> 1164 The callback <em>parameter</em> should specify a function 1165 that looks like this: 1166 </p> 1167 <p style="display: none; "> 1168 If you specify the <em>callback</em> parameter, it should 1169 specify a function that looks like this: 1170 </p> 1171 1172 <!-- Note: intentionally longer 80 columns --> 1173 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 1174 <dl> 1175 <div style="display: none; "> 1176 <div> 1177 </div> 1178 </div> 1179 </dl> 1180 </div> 1181 </div> 1182 1183 <!-- MIN_VERSION --> 1184 <p style="display: none; "> 1185 This function was added in version <b><span></span></b>. 1186 If you require this function, the manifest key 1187 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1188 can ensure that your extension won't be run in an earlier browser version. 1189 </p> 1190 </div> <!-- /description --> 1191 1192 </div><div class="apiItem"> 1193 <a name="method-deleteUrl"></a> <!-- method-anchor --> 1194 <h4>deleteUrl</h4> 1195 1196 <div class="summary"><span style="display: none; ">void</span> 1197 <!-- Note: intentionally longer 80 columns --> 1198 <span>chrome.history.deleteUrl</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1199 <var><span>details</span></var></span>)</div> 1200 1201 <div class="description"> 1202 <p class="todo" style="display: none; ">Undocumented.</p> 1203 <p>Removes all occurrences of the given URL from the history.</p> 1204 1205 <!-- PARAMETERS --> 1206 <h4>Parameters</h4> 1207 <dl> 1208 <div> 1209 <div> 1210 <dt> 1211 <var>details</var> 1212 <em> 1213 1214 <!-- TYPE --> 1215 <div style="display:inline"> 1216 ( 1217 <span class="optional" style="display: none; ">optional</span> 1218 <span class="enum" style="display: none; ">enumerated</span> 1219 <span id="typeTemplate"> 1220 <span style="display: none; "> 1221 <a> Type</a> 1222 </span> 1223 <span> 1224 <span style="display: none; "> 1225 array of <span><span></span></span> 1226 </span> 1227 <span>object</span> 1228 <span style="display: none; "></span> 1229 </span> 1230 </span> 1231 ) 1232 </div> 1233 1234 </em> 1235 </dt> 1236 <dd class="todo"> 1237 Undocumented. 1238 </dd> 1239 <dd style="display: none; "> 1240 Description of this parameter from the json schema. 1241 </dd> 1242 <dd style="display: none; "> 1243 This parameter was added in version 1244 <b><span></span></b>. 1245 You must omit this parameter in earlier versions, 1246 and you may omit it in any version. If you require this 1247 parameter, the manifest key 1248 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1249 can ensure that your extension won't be run in an earlier browser version. 1250 </dd> 1251 1252 <!-- OBJECT PROPERTIES --> 1253 <dd> 1254 <dl> 1255 <div> 1256 <div> 1257 <dt> 1258 <var>url</var> 1259 <em> 1260 1261 <!-- TYPE --> 1262 <div style="display:inline"> 1263 ( 1264 <span class="optional" style="display: none; ">optional</span> 1265 <span class="enum" style="display: none; ">enumerated</span> 1266 <span id="typeTemplate"> 1267 <span style="display: none; "> 1268 <a> Type</a> 1269 </span> 1270 <span> 1271 <span style="display: none; "> 1272 array of <span><span></span></span> 1273 </span> 1274 <span>string</span> 1275 <span style="display: none; "></span> 1276 </span> 1277 </span> 1278 ) 1279 </div> 1280 1281 </em> 1282 </dt> 1283 <dd class="todo" style="display: none; "> 1284 Undocumented. 1285 </dd> 1286 <dd>The URL to remove.</dd> 1287 <dd style="display: none; "> 1288 This parameter was added in version 1289 <b><span></span></b>. 1290 You must omit this parameter in earlier versions, 1291 and you may omit it in any version. If you require this 1292 parameter, the manifest key 1293 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1294 can ensure that your extension won't be run in an earlier browser version. 1295 </dd> 1296 1297 <!-- OBJECT PROPERTIES --> 1298 <dd style="display: none; "> 1299 <dl> 1300 <div> 1301 <div> 1302 </div> 1303 </div> 1304 </dl> 1305 </dd> 1306 1307 <!-- OBJECT METHODS --> 1308 <dd style="display: none; "> 1309 <div></div> 1310 </dd> 1311 1312 <!-- OBJECT EVENT FIELDS --> 1313 <dd style="display: none; "> 1314 <div></div> 1315 </dd> 1316 1317 <!-- FUNCTION PARAMETERS --> 1318 <dd style="display: none; "> 1319 <div></div> 1320 </dd> 1321 1322 </div> 1323 </div> 1324 </dl> 1325 </dd> 1326 1327 <!-- OBJECT METHODS --> 1328 <dd style="display: none; "> 1329 <div></div> 1330 </dd> 1331 1332 <!-- OBJECT EVENT FIELDS --> 1333 <dd style="display: none; "> 1334 <div></div> 1335 </dd> 1336 1337 <!-- FUNCTION PARAMETERS --> 1338 <dd style="display: none; "> 1339 <div></div> 1340 </dd> 1341 1342 </div> 1343 </div> 1344 </dl> 1345 1346 <!-- RETURNS --> 1347 <h4 style="display: none; ">Returns</h4> 1348 <dl> 1349 <div style="display: none; "> 1350 <div> 1351 </div> 1352 </div> 1353 </dl> 1354 1355 <!-- CALLBACK --> 1356 <div style="display: none; "> 1357 <div> 1358 <h4>Callback function</h4> 1359 <p> 1360 The callback <em>parameter</em> should specify a function 1361 that looks like this: 1362 </p> 1363 <p> 1364 If you specify the <em>callback</em> parameter, it should 1365 specify a function that looks like this: 1366 </p> 1367 1368 <!-- Note: intentionally longer 80 columns --> 1369 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1370 <dl> 1371 <div> 1372 <div> 1373 </div> 1374 </div> 1375 </dl> 1376 </div> 1377 </div> 1378 1379 <!-- MIN_VERSION --> 1380 <p style="display: none; "> 1381 This function was added in version <b><span></span></b>. 1382 If you require this function, the manifest key 1383 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1384 can ensure that your extension won't be run in an earlier browser version. 1385 </p> 1386 </div> <!-- /description --> 1387 1388 </div><div class="apiItem"> 1389 <a name="method-getVisits"></a> <!-- method-anchor --> 1390 <h4>getVisits</h4> 1391 1392 <div class="summary"><span style="display: none; ">void</span> 1393 <!-- Note: intentionally longer 80 columns --> 1394 <span>chrome.history.getVisits</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1395 <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span> 1396 <var><span>callback</span></var></span>)</div> 1397 1398 <div class="description"> 1399 <p class="todo" style="display: none; ">Undocumented.</p> 1400 <p>Retrieve information about visits to a URL.</p> 1401 1402 <!-- PARAMETERS --> 1403 <h4>Parameters</h4> 1404 <dl> 1405 <div> 1406 <div> 1407 <dt> 1408 <var>details</var> 1409 <em> 1410 1411 <!-- TYPE --> 1412 <div style="display:inline"> 1413 ( 1414 <span class="optional" style="display: none; ">optional</span> 1415 <span class="enum" style="display: none; ">enumerated</span> 1416 <span id="typeTemplate"> 1417 <span style="display: none; "> 1418 <a> Type</a> 1419 </span> 1420 <span> 1421 <span style="display: none; "> 1422 array of <span><span></span></span> 1423 </span> 1424 <span>object</span> 1425 <span style="display: none; "></span> 1426 </span> 1427 </span> 1428 ) 1429 </div> 1430 1431 </em> 1432 </dt> 1433 <dd class="todo"> 1434 Undocumented. 1435 </dd> 1436 <dd style="display: none; "> 1437 Description of this parameter from the json schema. 1438 </dd> 1439 <dd style="display: none; "> 1440 This parameter was added in version 1441 <b><span></span></b>. 1442 You must omit this parameter in earlier versions, 1443 and you may omit it in any version. If you require this 1444 parameter, the manifest key 1445 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1446 can ensure that your extension won't be run in an earlier browser version. 1447 </dd> 1448 1449 <!-- OBJECT PROPERTIES --> 1450 <dd> 1451 <dl> 1452 <div> 1453 <div> 1454 <dt> 1455 <var>url</var> 1456 <em> 1457 1458 <!-- TYPE --> 1459 <div style="display:inline"> 1460 ( 1461 <span class="optional" style="display: none; ">optional</span> 1462 <span class="enum" style="display: none; ">enumerated</span> 1463 <span id="typeTemplate"> 1464 <span style="display: none; "> 1465 <a> Type</a> 1466 </span> 1467 <span> 1468 <span style="display: none; "> 1469 array of <span><span></span></span> 1470 </span> 1471 <span>string</span> 1472 <span style="display: none; "></span> 1473 </span> 1474 </span> 1475 ) 1476 </div> 1477 1478 </em> 1479 </dt> 1480 <dd class="todo" style="display: none; "> 1481 Undocumented. 1482 </dd> 1483 <dd>The URL for which to retrieve visit information. It must be in the format as returned from a call to history.search.</dd> 1484 <dd style="display: none; "> 1485 This parameter was added in version 1486 <b><span></span></b>. 1487 You must omit this parameter in earlier versions, 1488 and you may omit it in any version. If you require this 1489 parameter, the manifest key 1490 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1491 can ensure that your extension won't be run in an earlier browser version. 1492 </dd> 1493 1494 <!-- OBJECT PROPERTIES --> 1495 <dd style="display: none; "> 1496 <dl> 1497 <div> 1498 <div> 1499 </div> 1500 </div> 1501 </dl> 1502 </dd> 1503 1504 <!-- OBJECT METHODS --> 1505 <dd style="display: none; "> 1506 <div></div> 1507 </dd> 1508 1509 <!-- OBJECT EVENT FIELDS --> 1510 <dd style="display: none; "> 1511 <div></div> 1512 </dd> 1513 1514 <!-- FUNCTION PARAMETERS --> 1515 <dd style="display: none; "> 1516 <div></div> 1517 </dd> 1518 1519 </div> 1520 </div> 1521 </dl> 1522 </dd> 1523 1524 <!-- OBJECT METHODS --> 1525 <dd style="display: none; "> 1526 <div></div> 1527 </dd> 1528 1529 <!-- OBJECT EVENT FIELDS --> 1530 <dd style="display: none; "> 1531 <div></div> 1532 </dd> 1533 1534 <!-- FUNCTION PARAMETERS --> 1535 <dd style="display: none; "> 1536 <div></div> 1537 </dd> 1538 1539 </div> 1540 </div><div> 1541 <div> 1542 <dt> 1543 <var>callback</var> 1544 <em> 1545 1546 <!-- TYPE --> 1547 <div style="display:inline"> 1548 ( 1549 <span class="optional" style="display: none; ">optional</span> 1550 <span class="enum" style="display: none; ">enumerated</span> 1551 <span id="typeTemplate"> 1552 <span style="display: none; "> 1553 <a> Type</a> 1554 </span> 1555 <span> 1556 <span style="display: none; "> 1557 array of <span><span></span></span> 1558 </span> 1559 <span>function</span> 1560 <span style="display: none; "></span> 1561 </span> 1562 </span> 1563 ) 1564 </div> 1565 1566 </em> 1567 </dt> 1568 <dd class="todo"> 1569 Undocumented. 1570 </dd> 1571 <dd style="display: none; "> 1572 Description of this parameter from the json schema. 1573 </dd> 1574 <dd style="display: none; "> 1575 This parameter was added in version 1576 <b><span></span></b>. 1577 You must omit this parameter in earlier versions, 1578 and you may omit it in any version. If you require this 1579 parameter, the manifest key 1580 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1581 can ensure that your extension won't be run in an earlier browser version. 1582 </dd> 1583 1584 <!-- OBJECT PROPERTIES --> 1585 <dd style="display: none; "> 1586 <dl> 1587 <div> 1588 <div> 1589 </div> 1590 </div> 1591 </dl> 1592 </dd> 1593 1594 <!-- OBJECT METHODS --> 1595 <dd style="display: none; "> 1596 <div></div> 1597 </dd> 1598 1599 <!-- OBJECT EVENT FIELDS --> 1600 <dd style="display: none; "> 1601 <div></div> 1602 </dd> 1603 1604 <!-- FUNCTION PARAMETERS --> 1605 <dd style="display: none; "> 1606 <div></div> 1607 </dd> 1608 1609 </div> 1610 </div> 1611 </dl> 1612 1613 <!-- RETURNS --> 1614 <h4 style="display: none; ">Returns</h4> 1615 <dl> 1616 <div style="display: none; "> 1617 <div> 1618 </div> 1619 </div> 1620 </dl> 1621 1622 <!-- CALLBACK --> 1623 <div> 1624 <div> 1625 <h4>Callback function</h4> 1626 <p> 1627 The callback <em>parameter</em> should specify a function 1628 that looks like this: 1629 </p> 1630 <p style="display: none; "> 1631 If you specify the <em>callback</em> parameter, it should 1632 specify a function that looks like this: 1633 </p> 1634 1635 <!-- Note: intentionally longer 80 columns --> 1636 <pre>function(<span>array of VisitItem results</span>) <span class="subdued">{...}</span>;</pre> 1637 <dl> 1638 <div> 1639 <div> 1640 <dt> 1641 <var>results</var> 1642 <em> 1643 1644 <!-- TYPE --> 1645 <div style="display:inline"> 1646 ( 1647 <span class="optional" style="display: none; ">optional</span> 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> 1655 array of <span><span> 1656 <span> 1657 <a href="history.html#type-VisitItem">VisitItem</a> 1658 </span> 1659 <span style="display: none; "> 1660 <span> 1661 array of <span><span></span></span> 1662 </span> 1663 <span>paramType</span> 1664 <span></span> 1665 </span> 1666 </span></span> 1667 </span> 1668 <span style="display: none; ">paramType</span> 1669 <span style="display: none; "></span> 1670 </span> 1671 </span> 1672 ) 1673 </div> 1674 1675 </em> 1676 </dt> 1677 <dd class="todo"> 1678 Undocumented. 1679 </dd> 1680 <dd style="display: none; "> 1681 Description of this parameter from the json schema. 1682 </dd> 1683 <dd style="display: none; "> 1684 This parameter was added in version 1685 <b><span></span></b>. 1686 You must omit this parameter in earlier versions, 1687 and you may omit it in any version. If you require this 1688 parameter, the manifest key 1689 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1690 can ensure that your extension won't be run in an earlier browser version. 1691 </dd> 1692 1693 <!-- OBJECT PROPERTIES --> 1694 <dd style="display: none; "> 1695 <dl> 1696 <div> 1697 <div> 1698 </div> 1699 </div> 1700 </dl> 1701 </dd> 1702 1703 <!-- OBJECT METHODS --> 1704 <dd style="display: none; "> 1705 <div></div> 1706 </dd> 1707 1708 <!-- OBJECT EVENT FIELDS --> 1709 <dd style="display: none; "> 1710 <div></div> 1711 </dd> 1712 1713 <!-- FUNCTION PARAMETERS --> 1714 <dd style="display: none; "> 1715 <div></div> 1716 </dd> 1717 1718 </div> 1719 </div> 1720 </dl> 1721 </div> 1722 </div> 1723 1724 <!-- MIN_VERSION --> 1725 <p style="display: none; "> 1726 This function was added in version <b><span></span></b>. 1727 If you require this function, the manifest key 1728 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1729 can ensure that your extension won't be run in an earlier browser version. 1730 </p> 1731 </div> <!-- /description --> 1732 1733 </div><div class="apiItem"> 1734 <a name="method-search"></a> <!-- method-anchor --> 1735 <h4>search</h4> 1736 1737 <div class="summary"><span style="display: none; ">void</span> 1738 <!-- Note: intentionally longer 80 columns --> 1739 <span>chrome.history.search</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1740 <var><span>query</span></var></span><span class="null"><span>, </span><span>function</span> 1741 <var><span>callback</span></var></span>)</div> 1742 1743 <div class="description"> 1744 <p class="todo" style="display: none; ">Undocumented.</p> 1745 <p>Search the history for the last visit time of each page matching the query.</p> 1746 1747 <!-- PARAMETERS --> 1748 <h4>Parameters</h4> 1749 <dl> 1750 <div> 1751 <div> 1752 <dt> 1753 <var>query</var> 1754 <em> 1755 1756 <!-- TYPE --> 1757 <div style="display:inline"> 1758 ( 1759 <span class="optional" style="display: none; ">optional</span> 1760 <span class="enum" style="display: none; ">enumerated</span> 1761 <span id="typeTemplate"> 1762 <span style="display: none; "> 1763 <a> Type</a> 1764 </span> 1765 <span> 1766 <span style="display: none; "> 1767 array of <span><span></span></span> 1768 </span> 1769 <span>object</span> 1770 <span style="display: none; "></span> 1771 </span> 1772 </span> 1773 ) 1774 </div> 1775 1776 </em> 1777 </dt> 1778 <dd class="todo"> 1779 Undocumented. 1780 </dd> 1781 <dd style="display: none; "> 1782 Description of this parameter from the json schema. 1783 </dd> 1784 <dd style="display: none; "> 1785 This parameter was added in version 1786 <b><span></span></b>. 1787 You must omit this parameter in earlier versions, 1788 and you may omit it in any version. If you require this 1789 parameter, the manifest key 1790 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1791 can ensure that your extension won't be run in an earlier browser version. 1792 </dd> 1793 1794 <!-- OBJECT PROPERTIES --> 1795 <dd> 1796 <dl> 1797 <div> 1798 <div> 1799 <dt> 1800 <var>text</var> 1801 <em> 1802 1803 <!-- TYPE --> 1804 <div style="display:inline"> 1805 ( 1806 <span class="optional" style="display: none; ">optional</span> 1807 <span class="enum" style="display: none; ">enumerated</span> 1808 <span id="typeTemplate"> 1809 <span style="display: none; "> 1810 <a> Type</a> 1811 </span> 1812 <span> 1813 <span style="display: none; "> 1814 array of <span><span></span></span> 1815 </span> 1816 <span>string</span> 1817 <span style="display: none; "></span> 1818 </span> 1819 </span> 1820 ) 1821 </div> 1822 1823 </em> 1824 </dt> 1825 <dd class="todo" style="display: none; "> 1826 Undocumented. 1827 </dd> 1828 <dd>A free-text query to the history service. Leave empty to retrieve all pages.</dd> 1829 <dd style="display: none; "> 1830 This parameter was added in version 1831 <b><span></span></b>. 1832 You must omit this parameter in earlier versions, 1833 and you may omit it in any version. If you require this 1834 parameter, the manifest key 1835 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1836 can ensure that your extension won't be run in an earlier browser version. 1837 </dd> 1838 1839 <!-- OBJECT PROPERTIES --> 1840 <dd style="display: none; "> 1841 <dl> 1842 <div> 1843 <div> 1844 </div> 1845 </div> 1846 </dl> 1847 </dd> 1848 1849 <!-- OBJECT METHODS --> 1850 <dd style="display: none; "> 1851 <div></div> 1852 </dd> 1853 1854 <!-- OBJECT EVENT FIELDS --> 1855 <dd style="display: none; "> 1856 <div></div> 1857 </dd> 1858 1859 <!-- FUNCTION PARAMETERS --> 1860 <dd style="display: none; "> 1861 <div></div> 1862 </dd> 1863 1864 </div> 1865 </div><div> 1866 <div> 1867 <dt> 1868 <var>startTime</var> 1869 <em> 1870 1871 <!-- TYPE --> 1872 <div style="display:inline"> 1873 ( 1874 <span class="optional">optional</span> 1875 <span class="enum" style="display: none; ">enumerated</span> 1876 <span id="typeTemplate"> 1877 <span style="display: none; "> 1878 <a> Type</a> 1879 </span> 1880 <span> 1881 <span style="display: none; "> 1882 array of <span><span></span></span> 1883 </span> 1884 <span>number</span> 1885 <span style="display: none; "></span> 1886 </span> 1887 </span> 1888 ) 1889 </div> 1890 1891 </em> 1892 </dt> 1893 <dd class="todo" style="display: none; "> 1894 Undocumented. 1895 </dd> 1896 <dd>Limit results to those visited after this date, represented in milliseconds since the epoch.</dd> 1897 <dd style="display: none; "> 1898 This parameter was added in version 1899 <b><span></span></b>. 1900 You must omit this parameter in earlier versions, 1901 and you may omit it in any version. If you require this 1902 parameter, the manifest key 1903 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1904 can ensure that your extension won't be run in an earlier browser version. 1905 </dd> 1906 1907 <!-- OBJECT PROPERTIES --> 1908 <dd style="display: none; "> 1909 <dl> 1910 <div> 1911 <div> 1912 </div> 1913 </div> 1914 </dl> 1915 </dd> 1916 1917 <!-- OBJECT METHODS --> 1918 <dd style="display: none; "> 1919 <div></div> 1920 </dd> 1921 1922 <!-- OBJECT EVENT FIELDS --> 1923 <dd style="display: none; "> 1924 <div></div> 1925 </dd> 1926 1927 <!-- FUNCTION PARAMETERS --> 1928 <dd style="display: none; "> 1929 <div></div> 1930 </dd> 1931 1932 </div> 1933 </div><div> 1934 <div> 1935 <dt> 1936 <var>endTime</var> 1937 <em> 1938 1939 <!-- TYPE --> 1940 <div style="display:inline"> 1941 ( 1942 <span class="optional">optional</span> 1943 <span class="enum" style="display: none; ">enumerated</span> 1944 <span id="typeTemplate"> 1945 <span style="display: none; "> 1946 <a> Type</a> 1947 </span> 1948 <span> 1949 <span style="display: none; "> 1950 array of <span><span></span></span> 1951 </span> 1952 <span>number</span> 1953 <span style="display: none; "></span> 1954 </span> 1955 </span> 1956 ) 1957 </div> 1958 1959 </em> 1960 </dt> 1961 <dd class="todo" style="display: none; "> 1962 Undocumented. 1963 </dd> 1964 <dd>Limit results to those visited before this date, represented in milliseconds since the epoch.</dd> 1965 <dd style="display: none; "> 1966 This parameter was added in version 1967 <b><span></span></b>. 1968 You must omit this parameter in earlier versions, 1969 and you may omit it in any version. If you require this 1970 parameter, the manifest key 1971 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1972 can ensure that your extension won't be run in an earlier browser version. 1973 </dd> 1974 1975 <!-- OBJECT PROPERTIES --> 1976 <dd style="display: none; "> 1977 <dl> 1978 <div> 1979 <div> 1980 </div> 1981 </div> 1982 </dl> 1983 </dd> 1984 1985 <!-- OBJECT METHODS --> 1986 <dd style="display: none; "> 1987 <div></div> 1988 </dd> 1989 1990 <!-- OBJECT EVENT FIELDS --> 1991 <dd style="display: none; "> 1992 <div></div> 1993 </dd> 1994 1995 <!-- FUNCTION PARAMETERS --> 1996 <dd style="display: none; "> 1997 <div></div> 1998 </dd> 1999 2000 </div> 2001 </div><div> 2002 <div> 2003 <dt> 2004 <var>maxResults</var> 2005 <em> 2006 2007 <!-- TYPE --> 2008 <div style="display:inline"> 2009 ( 2010 <span class="optional">optional</span> 2011 <span class="enum" style="display: none; ">enumerated</span> 2012 <span id="typeTemplate"> 2013 <span style="display: none; "> 2014 <a> Type</a> 2015 </span> 2016 <span> 2017 <span style="display: none; "> 2018 array of <span><span></span></span> 2019 </span> 2020 <span>integer</span> 2021 <span style="display: none; "></span> 2022 </span> 2023 </span> 2024 ) 2025 </div> 2026 2027 </em> 2028 </dt> 2029 <dd class="todo" style="display: none; "> 2030 Undocumented. 2031 </dd> 2032 <dd>The maximum number of results to retrieve. Defaults to 100.</dd> 2033 <dd style="display: none; "> 2034 This parameter was added in version 2035 <b><span></span></b>. 2036 You must omit this parameter in earlier versions, 2037 and you may omit it in any version. If you require this 2038 parameter, the manifest key 2039 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2040 can ensure that your extension won't be run in an earlier browser version. 2041 </dd> 2042 2043 <!-- OBJECT PROPERTIES --> 2044 <dd style="display: none; "> 2045 <dl> 2046 <div> 2047 <div> 2048 </div> 2049 </div> 2050 </dl> 2051 </dd> 2052 2053 <!-- OBJECT METHODS --> 2054 <dd style="display: none; "> 2055 <div></div> 2056 </dd> 2057 2058 <!-- OBJECT EVENT FIELDS --> 2059 <dd style="display: none; "> 2060 <div></div> 2061 </dd> 2062 2063 <!-- FUNCTION PARAMETERS --> 2064 <dd style="display: none; "> 2065 <div></div> 2066 </dd> 2067 2068 </div> 2069 </div> 2070 </dl> 2071 </dd> 2072 2073 <!-- OBJECT METHODS --> 2074 <dd style="display: none; "> 2075 <div></div> 2076 </dd> 2077 2078 <!-- OBJECT EVENT FIELDS --> 2079 <dd style="display: none; "> 2080 <div></div> 2081 </dd> 2082 2083 <!-- FUNCTION PARAMETERS --> 2084 <dd style="display: none; "> 2085 <div></div> 2086 </dd> 2087 2088 </div> 2089 </div><div> 2090 <div> 2091 <dt> 2092 <var>callback</var> 2093 <em> 2094 2095 <!-- TYPE --> 2096 <div style="display:inline"> 2097 ( 2098 <span class="optional" style="display: none; ">optional</span> 2099 <span class="enum" style="display: none; ">enumerated</span> 2100 <span id="typeTemplate"> 2101 <span style="display: none; "> 2102 <a> Type</a> 2103 </span> 2104 <span> 2105 <span style="display: none; "> 2106 array of <span><span></span></span> 2107 </span> 2108 <span>function</span> 2109 <span style="display: none; "></span> 2110 </span> 2111 </span> 2112 ) 2113 </div> 2114 2115 </em> 2116 </dt> 2117 <dd class="todo"> 2118 Undocumented. 2119 </dd> 2120 <dd style="display: none; "> 2121 Description of this parameter from the json schema. 2122 </dd> 2123 <dd style="display: none; "> 2124 This parameter was added in version 2125 <b><span></span></b>. 2126 You must omit this parameter in earlier versions, 2127 and you may omit it in any version. If you require this 2128 parameter, the manifest key 2129 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2130 can ensure that your extension won't be run in an earlier browser version. 2131 </dd> 2132 2133 <!-- OBJECT PROPERTIES --> 2134 <dd style="display: none; "> 2135 <dl> 2136 <div> 2137 <div> 2138 </div> 2139 </div> 2140 </dl> 2141 </dd> 2142 2143 <!-- OBJECT METHODS --> 2144 <dd style="display: none; "> 2145 <div></div> 2146 </dd> 2147 2148 <!-- OBJECT EVENT FIELDS --> 2149 <dd style="display: none; "> 2150 <div></div> 2151 </dd> 2152 2153 <!-- FUNCTION PARAMETERS --> 2154 <dd style="display: none; "> 2155 <div></div> 2156 </dd> 2157 2158 </div> 2159 </div> 2160 </dl> 2161 2162 <!-- RETURNS --> 2163 <h4 style="display: none; ">Returns</h4> 2164 <dl> 2165 <div style="display: none; "> 2166 <div> 2167 </div> 2168 </div> 2169 </dl> 2170 2171 <!-- CALLBACK --> 2172 <div> 2173 <div> 2174 <h4>Callback function</h4> 2175 <p> 2176 The callback <em>parameter</em> should specify a function 2177 that looks like this: 2178 </p> 2179 <p style="display: none; "> 2180 If you specify the <em>callback</em> parameter, it should 2181 specify a function that looks like this: 2182 </p> 2183 2184 <!-- Note: intentionally longer 80 columns --> 2185 <pre>function(<span>array of HistoryItem results</span>) <span class="subdued">{...}</span>;</pre> 2186 <dl> 2187 <div> 2188 <div> 2189 <dt> 2190 <var>results</var> 2191 <em> 2192 2193 <!-- TYPE --> 2194 <div style="display:inline"> 2195 ( 2196 <span class="optional" style="display: none; ">optional</span> 2197 <span class="enum" style="display: none; ">enumerated</span> 2198 <span id="typeTemplate"> 2199 <span style="display: none; "> 2200 <a> Type</a> 2201 </span> 2202 <span> 2203 <span> 2204 array of <span><span> 2205 <span> 2206 <a href="history.html#type-HistoryItem">HistoryItem</a> 2207 </span> 2208 <span style="display: none; "> 2209 <span> 2210 array of <span><span></span></span> 2211 </span> 2212 <span>paramType</span> 2213 <span></span> 2214 </span> 2215 </span></span> 2216 </span> 2217 <span style="display: none; ">paramType</span> 2218 <span style="display: none; "></span> 2219 </span> 2220 </span> 2221 ) 2222 </div> 2223 2224 </em> 2225 </dt> 2226 <dd class="todo"> 2227 Undocumented. 2228 </dd> 2229 <dd style="display: none; "> 2230 Description of this parameter from the json schema. 2231 </dd> 2232 <dd style="display: none; "> 2233 This parameter was added in version 2234 <b><span></span></b>. 2235 You must omit this parameter in earlier versions, 2236 and you may omit it in any version. If you require this 2237 parameter, the manifest key 2238 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2239 can ensure that your extension won't be run in an earlier browser version. 2240 </dd> 2241 2242 <!-- OBJECT PROPERTIES --> 2243 <dd style="display: none; "> 2244 <dl> 2245 <div> 2246 <div> 2247 </div> 2248 </div> 2249 </dl> 2250 </dd> 2251 2252 <!-- OBJECT METHODS --> 2253 <dd style="display: none; "> 2254 <div></div> 2255 </dd> 2256 2257 <!-- OBJECT EVENT FIELDS --> 2258 <dd style="display: none; "> 2259 <div></div> 2260 </dd> 2261 2262 <!-- FUNCTION PARAMETERS --> 2263 <dd style="display: none; "> 2264 <div></div> 2265 </dd> 2266 2267 </div> 2268 </div> 2269 </dl> 2270 </div> 2271 </div> 2272 2273 <!-- MIN_VERSION --> 2274 <p style="display: none; "> 2275 This function was added in version <b><span></span></b>. 2276 If you require this function, the manifest key 2277 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2278 can ensure that your extension won't be run in an earlier browser version. 2279 </p> 2280 </div> <!-- /description --> 2281 2282 </div> <!-- /apiItem --> 2283 2284 </div> <!-- /apiGroup --> 2285 2286 <!-- EVENTS --> 2287 <div id="eventsTemplate" class="apiGroup"> 2288 <a name="global-events"></a> 2289 <h3>Events</h3> 2290 <!-- iterates over all events --> 2291 <div class="apiItem"> 2292 <a name="event-onVisitRemoved"></a> 2293 <h4>onVisitRemoved</h4> 2294 2295 <div class="summary"> 2296 <!-- Note: intentionally longer 80 columns --> 2297 <span class="subdued">chrome.history.</span><span>onVisitRemoved</span><span class="subdued">.addListener</span>(function(<span>object removed</span>) <span class="subdued">{...}</span>); 2298 </div> 2299 2300 <div class="description"> 2301 <p class="todo" style="display: none; ">Undocumented.</p> 2302 <p>Fired when one or more URLs are removed from the history service. When all visits have been removed the URL is purged from history.</p> 2303 2304 <!-- PARAMETERS --> 2305 <div> 2306 <h4>Parameters</h4> 2307 <dl> 2308 <div> 2309 <div> 2310 <dt> 2311 <var>removed</var> 2312 <em> 2313 2314 <!-- TYPE --> 2315 <div style="display:inline"> 2316 ( 2317 <span class="optional" style="display: none; ">optional</span> 2318 <span class="enum" style="display: none; ">enumerated</span> 2319 <span id="typeTemplate"> 2320 <span style="display: none; "> 2321 <a> Type</a> 2322 </span> 2323 <span> 2324 <span style="display: none; "> 2325 array of <span><span></span></span> 2326 </span> 2327 <span>object</span> 2328 <span style="display: none; "></span> 2329 </span> 2330 </span> 2331 ) 2332 </div> 2333 2334 </em> 2335 </dt> 2336 <dd class="todo"> 2337 Undocumented. 2338 </dd> 2339 <dd style="display: none; "> 2340 Description of this parameter from the json schema. 2341 </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> 2354 <dl> 2355 <div> 2356 <div> 2357 <dt> 2358 <var>allHistory</var> 2359 <em> 2360 2361 <!-- TYPE --> 2362 <div style="display:inline"> 2363 ( 2364 <span class="optional" style="display: none; ">optional</span> 2365 <span class="enum" style="display: none; ">enumerated</span> 2366 <span id="typeTemplate"> 2367 <span style="display: none; "> 2368 <a> Type</a> 2369 </span> 2370 <span> 2371 <span style="display: none; "> 2372 array of <span><span></span></span> 2373 </span> 2374 <span>boolean</span> 2375 <span style="display: none; "></span> 2376 </span> 2377 </span> 2378 ) 2379 </div> 2380 2381 </em> 2382 </dt> 2383 <dd class="todo" style="display: none; "> 2384 Undocumented. 2385 </dd> 2386 <dd>True if all history was removed. If true, then urls will be empty.</dd> 2387 <dd style="display: none; "> 2388 This parameter was added in version 2389 <b><span></span></b>. 2390 You must omit this parameter in earlier versions, 2391 and you may omit it in any version. If you require this 2392 parameter, the manifest key 2393 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2394 can ensure that your extension won't be run in an earlier browser version. 2395 </dd> 2396 2397 <!-- OBJECT PROPERTIES --> 2398 <dd style="display: none; "> 2399 <dl> 2400 <div> 2401 <div> 2402 </div> 2403 </div> 2404 </dl> 2405 </dd> 2406 2407 <!-- OBJECT METHODS --> 2408 <dd style="display: none; "> 2409 <div></div> 2410 </dd> 2411 2412 <!-- OBJECT EVENT FIELDS --> 2413 <dd style="display: none; "> 2414 <div></div> 2415 </dd> 2416 2417 <!-- FUNCTION PARAMETERS --> 2418 <dd style="display: none; "> 2419 <div></div> 2420 </dd> 2421 2422 </div> 2423 </div><div> 2424 <div> 2425 <dt> 2426 <var>urls</var> 2427 <em> 2428 2429 <!-- TYPE --> 2430 <div style="display:inline"> 2431 ( 2432 <span class="optional">optional</span> 2433 <span class="enum" style="display: none; ">enumerated</span> 2434 <span id="typeTemplate"> 2435 <span style="display: none; "> 2436 <a> Type</a> 2437 </span> 2438 <span> 2439 <span> 2440 array of <span><span> 2441 <span style="display: none; "> 2442 <a> Type</a> 2443 </span> 2444 <span> 2445 <span style="display: none; "> 2446 array of <span><span></span></span> 2447 </span> 2448 <span>string</span> 2449 <span style="display: none; "></span> 2450 </span> 2451 </span></span> 2452 </span> 2453 <span style="display: none; ">paramType</span> 2454 <span style="display: none; "></span> 2455 </span> 2456 </span> 2457 ) 2458 </div> 2459 2460 </em> 2461 </dt> 2462 <dd class="todo"> 2463 Undocumented. 2464 </dd> 2465 <dd style="display: none; "> 2466 Description of this parameter from the json schema. 2467 </dd> 2468 <dd style="display: none; "> 2469 This parameter was added in version 2470 <b><span></span></b>. 2471 You must omit this parameter in earlier versions, 2472 and you may omit it in any version. If you require this 2473 parameter, the manifest key 2474 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2475 can ensure that your extension won't be run in an earlier browser version. 2476 </dd> 2477 2478 <!-- OBJECT PROPERTIES --> 2479 <dd style="display: none; "> 2480 <dl> 2481 <div> 2482 <div> 2483 </div> 2484 </div> 2485 </dl> 2486 </dd> 2487 2488 <!-- OBJECT METHODS --> 2489 <dd style="display: none; "> 2490 <div></div> 2491 </dd> 2492 2493 <!-- OBJECT EVENT FIELDS --> 2494 <dd style="display: none; "> 2495 <div></div> 2496 </dd> 2497 2498 <!-- FUNCTION PARAMETERS --> 2499 <dd style="display: none; "> 2500 <div></div> 2501 </dd> 2502 2503 </div> 2504 </div> 2505 </dl> 2506 </dd> 2507 2508 <!-- OBJECT METHODS --> 2509 <dd style="display: none; "> 2510 <div></div> 2511 </dd> 2512 2513 <!-- OBJECT EVENT FIELDS --> 2514 <dd style="display: none; "> 2515 <div></div> 2516 </dd> 2517 2518 <!-- FUNCTION PARAMETERS --> 2519 <dd style="display: none; "> 2520 <div></div> 2521 </dd> 2522 2523 </div> 2524 </div> 2525 </dl> 2526 </div> 2527 </div> <!-- /decription --> 2528 2529 </div><div class="apiItem"> 2530 <a name="event-onVisited"></a> 2531 <h4>onVisited</h4> 2532 2533 <div class="summary"> 2534 <!-- Note: intentionally longer 80 columns --> 2535 <span class="subdued">chrome.history.</span><span>onVisited</span><span class="subdued">.addListener</span>(function(<span>HistoryItem result</span>) <span class="subdued">{...}</span>); 2536 </div> 2537 2538 <div class="description"> 2539 <p class="todo" style="display: none; ">Undocumented.</p> 2540 <p>Fired when a URL is visited, providing the HistoryItem data for that URL.</p> 2541 2542 <!-- PARAMETERS --> 2543 <div> 2544 <h4>Parameters</h4> 2545 <dl> 2546 <div> 2547 <div> 2548 <dt> 2549 <var>result</var> 2550 <em> 2551 2552 <!-- TYPE --> 2553 <div style="display:inline"> 2554 ( 2555 <span class="optional" style="display: none; ">optional</span> 2556 <span class="enum" style="display: none; ">enumerated</span> 2557 <span id="typeTemplate"> 2558 <span> 2559 <a href="history.html#type-HistoryItem">HistoryItem</a> 2560 </span> 2561 <span style="display: none; "> 2562 <span> 2563 array of <span><span></span></span> 2564 </span> 2565 <span>paramType</span> 2566 <span></span> 2567 </span> 2568 </span> 2569 ) 2570 </div> 2571 2572 </em> 2573 </dt> 2574 <dd class="todo"> 2575 Undocumented. 2576 </dd> 2577 <dd style="display: none; "> 2578 Description of this parameter from the json schema. 2579 </dd> 2580 <dd style="display: none; "> 2581 This parameter was added in version 2582 <b><span></span></b>. 2583 You must omit this parameter in earlier versions, 2584 and you may omit it in any version. If you require this 2585 parameter, the manifest key 2586 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2587 can ensure that your extension won't be run in an earlier browser version. 2588 </dd> 2589 2590 <!-- OBJECT PROPERTIES --> 2591 <dd style="display: none; "> 2592 <dl> 2593 <div> 2594 <div> 2595 </div> 2596 </div> 2597 </dl> 2598 </dd> 2599 2600 <!-- OBJECT METHODS --> 2601 <dd style="display: none; "> 2602 <div></div> 2603 </dd> 2604 2605 <!-- OBJECT EVENT FIELDS --> 2606 <dd style="display: none; "> 2607 <div></div> 2608 </dd> 2609 2610 <!-- FUNCTION PARAMETERS --> 2611 <dd style="display: none; "> 2612 <div></div> 2613 </dd> 2614 2615 </div> 2616 </div> 2617 </dl> 2618 </div> 2619 </div> <!-- /decription --> 2620 2621 </div> <!-- /apiItem --> 2622 2623 </div> <!-- /apiGroup --> 2624 2625 <!-- TYPES --> 2626 <div class="apiGroup"> 2627 <a name="types"></a> 2628 <h3 id="types">Types</h3> 2629 2630 <!-- iterates over all types --> 2631 <div class="apiItem"> 2632 <a name="type-HistoryItem"></a> 2633 <h4>HistoryItem</h4> 2634 2635 <div> 2636 <dt> 2637 <var style="display: none; ">paramName</var> 2638 <em> 2639 2640 <!-- TYPE --> 2641 <div style="display:inline"> 2642 ( 2643 <span class="optional" style="display: none; ">optional</span> 2644 <span class="enum" style="display: none; ">enumerated</span> 2645 <span id="typeTemplate"> 2646 <span style="display: none; "> 2647 <a> Type</a> 2648 </span> 2649 <span> 2650 <span style="display: none; "> 2651 array of <span><span></span></span> 2652 </span> 2653 <span>object</span> 2654 <span style="display: none; "></span> 2655 </span> 2656 </span> 2657 ) 2658 </div> 2659 2660 </em> 2661 </dt> 2662 <dd class="todo" style="display: none; "> 2663 Undocumented. 2664 </dd> 2665 <dd>An object encapsulating one result of a history query.</dd> 2666 <dd style="display: none; "> 2667 This parameter was added in version 2668 <b><span></span></b>. 2669 You must omit this parameter in earlier versions, 2670 and you may omit it in any version. If you require this 2671 parameter, the manifest key 2672 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2673 can ensure that your extension won't be run in an earlier browser version. 2674 </dd> 2675 2676 <!-- OBJECT PROPERTIES --> 2677 <dd> 2678 <dl> 2679 <div> 2680 <div> 2681 <dt> 2682 <var>id</var> 2683 <em> 2684 2685 <!-- TYPE --> 2686 <div style="display:inline"> 2687 ( 2688 <span class="optional" style="display: none; ">optional</span> 2689 <span class="enum" style="display: none; ">enumerated</span> 2690 <span id="typeTemplate"> 2691 <span style="display: none; "> 2692 <a> Type</a> 2693 </span> 2694 <span> 2695 <span style="display: none; "> 2696 array of <span><span></span></span> 2697 </span> 2698 <span>string</span> 2699 <span style="display: none; "></span> 2700 </span> 2701 </span> 2702 ) 2703 </div> 2704 2705 </em> 2706 </dt> 2707 <dd class="todo" style="display: none; "> 2708 Undocumented. 2709 </dd> 2710 <dd>The unique identifier for the item.</dd> 2711 <dd style="display: none; "> 2712 This parameter was added in version 2713 <b><span></span></b>. 2714 You must omit this parameter in earlier versions, 2715 and you may omit it in any version. If you require this 2716 parameter, the manifest key 2717 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2718 can ensure that your extension won't be run in an earlier browser version. 2719 </dd> 2720 2721 <!-- OBJECT PROPERTIES --> 2722 <dd style="display: none; "> 2723 <dl> 2724 <div> 2725 <div> 2726 </div> 2727 </div> 2728 </dl> 2729 </dd> 2730 2731 <!-- OBJECT METHODS --> 2732 <dd style="display: none; "> 2733 <div></div> 2734 </dd> 2735 2736 <!-- OBJECT EVENT FIELDS --> 2737 <dd style="display: none; "> 2738 <div></div> 2739 </dd> 2740 2741 <!-- FUNCTION PARAMETERS --> 2742 <dd style="display: none; "> 2743 <div></div> 2744 </dd> 2745 2746 </div> 2747 </div><div> 2748 <div> 2749 <dt> 2750 <var>url</var> 2751 <em> 2752 2753 <!-- TYPE --> 2754 <div style="display:inline"> 2755 ( 2756 <span class="optional">optional</span> 2757 <span class="enum" style="display: none; ">enumerated</span> 2758 <span id="typeTemplate"> 2759 <span style="display: none; "> 2760 <a> Type</a> 2761 </span> 2762 <span> 2763 <span style="display: none; "> 2764 array of <span><span></span></span> 2765 </span> 2766 <span>string</span> 2767 <span style="display: none; "></span> 2768 </span> 2769 </span> 2770 ) 2771 </div> 2772 2773 </em> 2774 </dt> 2775 <dd class="todo" style="display: none; "> 2776 Undocumented. 2777 </dd> 2778 <dd>The URL navigated to by a user.</dd> 2779 <dd style="display: none; "> 2780 This parameter was added in version 2781 <b><span></span></b>. 2782 You must omit this parameter in earlier versions, 2783 and you may omit it in any version. If you require this 2784 parameter, the manifest key 2785 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2786 can ensure that your extension won't be run in an earlier browser version. 2787 </dd> 2788 2789 <!-- OBJECT PROPERTIES --> 2790 <dd style="display: none; "> 2791 <dl> 2792 <div> 2793 <div> 2794 </div> 2795 </div> 2796 </dl> 2797 </dd> 2798 2799 <!-- OBJECT METHODS --> 2800 <dd style="display: none; "> 2801 <div></div> 2802 </dd> 2803 2804 <!-- OBJECT EVENT FIELDS --> 2805 <dd style="display: none; "> 2806 <div></div> 2807 </dd> 2808 2809 <!-- FUNCTION PARAMETERS --> 2810 <dd style="display: none; "> 2811 <div></div> 2812 </dd> 2813 2814 </div> 2815 </div><div> 2816 <div> 2817 <dt> 2818 <var>title</var> 2819 <em> 2820 2821 <!-- TYPE --> 2822 <div style="display:inline"> 2823 ( 2824 <span class="optional">optional</span> 2825 <span class="enum" style="display: none; ">enumerated</span> 2826 <span id="typeTemplate"> 2827 <span style="display: none; "> 2828 <a> Type</a> 2829 </span> 2830 <span> 2831 <span style="display: none; "> 2832 array of <span><span></span></span> 2833 </span> 2834 <span>string</span> 2835 <span style="display: none; "></span> 2836 </span> 2837 </span> 2838 ) 2839 </div> 2840 2841 </em> 2842 </dt> 2843 <dd class="todo" style="display: none; "> 2844 Undocumented. 2845 </dd> 2846 <dd>The title of the history page.</dd> 2847 <dd style="display: none; "> 2848 This parameter was added in version 2849 <b><span></span></b>. 2850 You must omit this parameter in earlier versions, 2851 and you may omit it in any version. If you require this 2852 parameter, the manifest key 2853 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2854 can ensure that your extension won't be run in an earlier browser version. 2855 </dd> 2856 2857 <!-- OBJECT PROPERTIES --> 2858 <dd style="display: none; "> 2859 <dl> 2860 <div> 2861 <div> 2862 </div> 2863 </div> 2864 </dl> 2865 </dd> 2866 2867 <!-- OBJECT METHODS --> 2868 <dd style="display: none; "> 2869 <div></div> 2870 </dd> 2871 2872 <!-- OBJECT EVENT FIELDS --> 2873 <dd style="display: none; "> 2874 <div></div> 2875 </dd> 2876 2877 <!-- FUNCTION PARAMETERS --> 2878 <dd style="display: none; "> 2879 <div></div> 2880 </dd> 2881 2882 </div> 2883 </div><div> 2884 <div> 2885 <dt> 2886 <var>lastVisitTime</var> 2887 <em> 2888 2889 <!-- TYPE --> 2890 <div style="display:inline"> 2891 ( 2892 <span class="optional">optional</span> 2893 <span class="enum" style="display: none; ">enumerated</span> 2894 <span id="typeTemplate"> 2895 <span style="display: none; "> 2896 <a> Type</a> 2897 </span> 2898 <span> 2899 <span style="display: none; "> 2900 array of <span><span></span></span> 2901 </span> 2902 <span>number</span> 2903 <span style="display: none; "></span> 2904 </span> 2905 </span> 2906 ) 2907 </div> 2908 2909 </em> 2910 </dt> 2911 <dd class="todo" style="display: none; "> 2912 Undocumented. 2913 </dd> 2914 <dd>When this page was last loaded, represented in milliseconds since the epoch.</dd> 2915 <dd style="display: none; "> 2916 This parameter was added in version 2917 <b><span></span></b>. 2918 You must omit this parameter in earlier versions, 2919 and you may omit it in any version. If you require this 2920 parameter, the manifest key 2921 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2922 can ensure that your extension won't be run in an earlier browser version. 2923 </dd> 2924 2925 <!-- OBJECT PROPERTIES --> 2926 <dd style="display: none; "> 2927 <dl> 2928 <div> 2929 <div> 2930 </div> 2931 </div> 2932 </dl> 2933 </dd> 2934 2935 <!-- OBJECT METHODS --> 2936 <dd style="display: none; "> 2937 <div></div> 2938 </dd> 2939 2940 <!-- OBJECT EVENT FIELDS --> 2941 <dd style="display: none; "> 2942 <div></div> 2943 </dd> 2944 2945 <!-- FUNCTION PARAMETERS --> 2946 <dd style="display: none; "> 2947 <div></div> 2948 </dd> 2949 2950 </div> 2951 </div><div> 2952 <div> 2953 <dt> 2954 <var>visitCount</var> 2955 <em> 2956 2957 <!-- TYPE --> 2958 <div style="display:inline"> 2959 ( 2960 <span class="optional">optional</span> 2961 <span class="enum" style="display: none; ">enumerated</span> 2962 <span id="typeTemplate"> 2963 <span style="display: none; "> 2964 <a> Type</a> 2965 </span> 2966 <span> 2967 <span style="display: none; "> 2968 array of <span><span></span></span> 2969 </span> 2970 <span>integer</span> 2971 <span style="display: none; "></span> 2972 </span> 2973 </span> 2974 ) 2975 </div> 2976 2977 </em> 2978 </dt> 2979 <dd class="todo" style="display: none; "> 2980 Undocumented. 2981 </dd> 2982 <dd>The number of times the user has navigated to this page.</dd> 2983 <dd style="display: none; "> 2984 This parameter was added in version 2985 <b><span></span></b>. 2986 You must omit this parameter in earlier versions, 2987 and you may omit it in any version. If you require this 2988 parameter, the manifest key 2989 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2990 can ensure that your extension won't be run in an earlier browser version. 2991 </dd> 2992 2993 <!-- OBJECT PROPERTIES --> 2994 <dd style="display: none; "> 2995 <dl> 2996 <div> 2997 <div> 2998 </div> 2999 </div> 3000 </dl> 3001 </dd> 3002 3003 <!-- OBJECT METHODS --> 3004 <dd style="display: none; "> 3005 <div></div> 3006 </dd> 3007 3008 <!-- OBJECT EVENT FIELDS --> 3009 <dd style="display: none; "> 3010 <div></div> 3011 </dd> 3012 3013 <!-- FUNCTION PARAMETERS --> 3014 <dd style="display: none; "> 3015 <div></div> 3016 </dd> 3017 3018 </div> 3019 </div><div> 3020 <div> 3021 <dt> 3022 <var>typedCount</var> 3023 <em> 3024 3025 <!-- TYPE --> 3026 <div style="display:inline"> 3027 ( 3028 <span class="optional">optional</span> 3029 <span class="enum" style="display: none; ">enumerated</span> 3030 <span id="typeTemplate"> 3031 <span style="display: none; "> 3032 <a> Type</a> 3033 </span> 3034 <span> 3035 <span style="display: none; "> 3036 array of <span><span></span></span> 3037 </span> 3038 <span>integer</span> 3039 <span style="display: none; "></span> 3040 </span> 3041 </span> 3042 ) 3043 </div> 3044 3045 </em> 3046 </dt> 3047 <dd class="todo" style="display: none; "> 3048 Undocumented. 3049 </dd> 3050 <dd>The number of times the user has navigated to this page by typing in the address.</dd> 3051 <dd style="display: none; "> 3052 This parameter was added in version 3053 <b><span></span></b>. 3054 You must omit this parameter in earlier versions, 3055 and you may omit it in any version. If you require this 3056 parameter, the manifest key 3057 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3058 can ensure that your extension won't be run in an earlier browser version. 3059 </dd> 3060 3061 <!-- OBJECT PROPERTIES --> 3062 <dd style="display: none; "> 3063 <dl> 3064 <div> 3065 <div> 3066 </div> 3067 </div> 3068 </dl> 3069 </dd> 3070 3071 <!-- OBJECT METHODS --> 3072 <dd style="display: none; "> 3073 <div></div> 3074 </dd> 3075 3076 <!-- OBJECT EVENT FIELDS --> 3077 <dd style="display: none; "> 3078 <div></div> 3079 </dd> 3080 3081 <!-- FUNCTION PARAMETERS --> 3082 <dd style="display: none; "> 3083 <div></div> 3084 </dd> 3085 3086 </div> 3087 </div> 3088 </dl> 3089 </dd> 3090 3091 <!-- OBJECT METHODS --> 3092 <dd style="display: none; "> 3093 <div></div> 3094 </dd> 3095 3096 <!-- OBJECT EVENT FIELDS --> 3097 <dd style="display: none; "> 3098 <div></div> 3099 </dd> 3100 3101 <!-- FUNCTION PARAMETERS --> 3102 <dd style="display: none; "> 3103 <div></div> 3104 </dd> 3105 3106 </div> 3107 3108 </div><div class="apiItem"> 3109 <a name="type-VisitItem"></a> 3110 <h4>VisitItem</h4> 3111 3112 <div> 3113 <dt> 3114 <var style="display: none; ">paramName</var> 3115 <em> 3116 3117 <!-- TYPE --> 3118 <div style="display:inline"> 3119 ( 3120 <span class="optional" style="display: none; ">optional</span> 3121 <span class="enum" style="display: none; ">enumerated</span> 3122 <span id="typeTemplate"> 3123 <span style="display: none; "> 3124 <a> Type</a> 3125 </span> 3126 <span> 3127 <span style="display: none; "> 3128 array of <span><span></span></span> 3129 </span> 3130 <span>object</span> 3131 <span style="display: none; "></span> 3132 </span> 3133 </span> 3134 ) 3135 </div> 3136 3137 </em> 3138 </dt> 3139 <dd class="todo" style="display: none; "> 3140 Undocumented. 3141 </dd> 3142 <dd>An object encapsulating one visit to a URL.</dd> 3143 <dd style="display: none; "> 3144 This parameter was added in version 3145 <b><span></span></b>. 3146 You must omit this parameter in earlier versions, 3147 and you may omit it in any version. If you require this 3148 parameter, the manifest key 3149 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3150 can ensure that your extension won't be run in an earlier browser version. 3151 </dd> 3152 3153 <!-- OBJECT PROPERTIES --> 3154 <dd> 3155 <dl> 3156 <div> 3157 <div> 3158 <dt> 3159 <var>id</var> 3160 <em> 3161 3162 <!-- TYPE --> 3163 <div style="display:inline"> 3164 ( 3165 <span class="optional" style="display: none; ">optional</span> 3166 <span class="enum" style="display: none; ">enumerated</span> 3167 <span id="typeTemplate"> 3168 <span style="display: none; "> 3169 <a> Type</a> 3170 </span> 3171 <span> 3172 <span style="display: none; "> 3173 array of <span><span></span></span> 3174 </span> 3175 <span>string</span> 3176 <span style="display: none; "></span> 3177 </span> 3178 </span> 3179 ) 3180 </div> 3181 3182 </em> 3183 </dt> 3184 <dd class="todo" style="display: none; "> 3185 Undocumented. 3186 </dd> 3187 <dd>The unique identifier for the item.</dd> 3188 <dd style="display: none; "> 3189 This parameter was added in version 3190 <b><span></span></b>. 3191 You must omit this parameter in earlier versions, 3192 and you may omit it in any version. If you require this 3193 parameter, the manifest key 3194 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3195 can ensure that your extension won't be run in an earlier browser version. 3196 </dd> 3197 3198 <!-- OBJECT PROPERTIES --> 3199 <dd style="display: none; "> 3200 <dl> 3201 <div> 3202 <div> 3203 </div> 3204 </div> 3205 </dl> 3206 </dd> 3207 3208 <!-- OBJECT METHODS --> 3209 <dd style="display: none; "> 3210 <div></div> 3211 </dd> 3212 3213 <!-- OBJECT EVENT FIELDS --> 3214 <dd style="display: none; "> 3215 <div></div> 3216 </dd> 3217 3218 <!-- FUNCTION PARAMETERS --> 3219 <dd style="display: none; "> 3220 <div></div> 3221 </dd> 3222 3223 </div> 3224 </div><div> 3225 <div> 3226 <dt> 3227 <var>visitId</var> 3228 <em> 3229 3230 <!-- TYPE --> 3231 <div style="display:inline"> 3232 ( 3233 <span class="optional" style="display: none; ">optional</span> 3234 <span class="enum" style="display: none; ">enumerated</span> 3235 <span id="typeTemplate"> 3236 <span style="display: none; "> 3237 <a> Type</a> 3238 </span> 3239 <span> 3240 <span style="display: none; "> 3241 array of <span><span></span></span> 3242 </span> 3243 <span>string</span> 3244 <span style="display: none; "></span> 3245 </span> 3246 </span> 3247 ) 3248 </div> 3249 3250 </em> 3251 </dt> 3252 <dd class="todo" style="display: none; "> 3253 Undocumented. 3254 </dd> 3255 <dd>The unique identifier for this visit.</dd> 3256 <dd style="display: none; "> 3257 This parameter was added in version 3258 <b><span></span></b>. 3259 You must omit this parameter in earlier versions, 3260 and you may omit it in any version. If you require this 3261 parameter, the manifest key 3262 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3263 can ensure that your extension won't be run in an earlier browser version. 3264 </dd> 3265 3266 <!-- OBJECT PROPERTIES --> 3267 <dd style="display: none; "> 3268 <dl> 3269 <div> 3270 <div> 3271 </div> 3272 </div> 3273 </dl> 3274 </dd> 3275 3276 <!-- OBJECT METHODS --> 3277 <dd style="display: none; "> 3278 <div></div> 3279 </dd> 3280 3281 <!-- OBJECT EVENT FIELDS --> 3282 <dd style="display: none; "> 3283 <div></div> 3284 </dd> 3285 3286 <!-- FUNCTION PARAMETERS --> 3287 <dd style="display: none; "> 3288 <div></div> 3289 </dd> 3290 3291 </div> 3292 </div><div> 3293 <div> 3294 <dt> 3295 <var>visitTime</var> 3296 <em> 3297 3298 <!-- TYPE --> 3299 <div style="display:inline"> 3300 ( 3301 <span class="optional">optional</span> 3302 <span class="enum" style="display: none; ">enumerated</span> 3303 <span id="typeTemplate"> 3304 <span style="display: none; "> 3305 <a> Type</a> 3306 </span> 3307 <span> 3308 <span style="display: none; "> 3309 array of <span><span></span></span> 3310 </span> 3311 <span>number</span> 3312 <span style="display: none; "></span> 3313 </span> 3314 </span> 3315 ) 3316 </div> 3317 3318 </em> 3319 </dt> 3320 <dd class="todo" style="display: none; "> 3321 Undocumented. 3322 </dd> 3323 <dd>When this visit occurred, represented in milliseconds since the epoch.</dd> 3324 <dd style="display: none; "> 3325 This parameter was added in version 3326 <b><span></span></b>. 3327 You must omit this parameter in earlier versions, 3328 and you may omit it in any version. If you require this 3329 parameter, the manifest key 3330 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3331 can ensure that your extension won't be run in an earlier browser version. 3332 </dd> 3333 3334 <!-- OBJECT PROPERTIES --> 3335 <dd style="display: none; "> 3336 <dl> 3337 <div> 3338 <div> 3339 </div> 3340 </div> 3341 </dl> 3342 </dd> 3343 3344 <!-- OBJECT METHODS --> 3345 <dd style="display: none; "> 3346 <div></div> 3347 </dd> 3348 3349 <!-- OBJECT EVENT FIELDS --> 3350 <dd style="display: none; "> 3351 <div></div> 3352 </dd> 3353 3354 <!-- FUNCTION PARAMETERS --> 3355 <dd style="display: none; "> 3356 <div></div> 3357 </dd> 3358 3359 </div> 3360 </div><div> 3361 <div> 3362 <dt> 3363 <var>referringVisitId</var> 3364 <em> 3365 3366 <!-- TYPE --> 3367 <div style="display:inline"> 3368 ( 3369 <span class="optional" style="display: none; ">optional</span> 3370 <span class="enum" style="display: none; ">enumerated</span> 3371 <span id="typeTemplate"> 3372 <span style="display: none; "> 3373 <a> Type</a> 3374 </span> 3375 <span> 3376 <span style="display: none; "> 3377 array of <span><span></span></span> 3378 </span> 3379 <span>string</span> 3380 <span style="display: none; "></span> 3381 </span> 3382 </span> 3383 ) 3384 </div> 3385 3386 </em> 3387 </dt> 3388 <dd class="todo" style="display: none; "> 3389 Undocumented. 3390 </dd> 3391 <dd>The visit_id of the referrer.</dd> 3392 <dd style="display: none; "> 3393 This parameter was added in version 3394 <b><span></span></b>. 3395 You must omit this parameter in earlier versions, 3396 and you may omit it in any version. If you require this 3397 parameter, the manifest key 3398 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3399 can ensure that your extension won't be run in an earlier browser version. 3400 </dd> 3401 3402 <!-- OBJECT PROPERTIES --> 3403 <dd style="display: none; "> 3404 <dl> 3405 <div> 3406 <div> 3407 </div> 3408 </div> 3409 </dl> 3410 </dd> 3411 3412 <!-- OBJECT METHODS --> 3413 <dd style="display: none; "> 3414 <div></div> 3415 </dd> 3416 3417 <!-- OBJECT EVENT FIELDS --> 3418 <dd style="display: none; "> 3419 <div></div> 3420 </dd> 3421 3422 <!-- FUNCTION PARAMETERS --> 3423 <dd style="display: none; "> 3424 <div></div> 3425 </dd> 3426 3427 </div> 3428 </div><div> 3429 <div> 3430 <dt> 3431 <var>transition</var> 3432 <em> 3433 3434 <!-- TYPE --> 3435 <div style="display:inline"> 3436 ( 3437 <span class="optional" style="display: none; ">optional</span> 3438 <span class="enum">enumerated</span> 3439 <span id="typeTemplate"> 3440 <span style="display: none; "> 3441 <a> Type</a> 3442 </span> 3443 <span> 3444 <span style="display: none; "> 3445 array of <span><span></span></span> 3446 </span> 3447 <span>string</span> 3448 <span>["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"]</span> 3449 </span> 3450 </span> 3451 ) 3452 </div> 3453 3454 </em> 3455 </dt> 3456 <dd class="todo" style="display: none; "> 3457 Undocumented. 3458 </dd> 3459 <dd>The <a href="#transition_types">transition type</a> for this visit from its referrer.</dd> 3460 <dd style="display: none; "> 3461 This parameter was added in version 3462 <b><span></span></b>. 3463 You must omit this parameter in earlier versions, 3464 and you may omit it in any version. If you require this 3465 parameter, the manifest key 3466 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3467 can ensure that your extension won't be run in an earlier browser version. 3468 </dd> 3469 3470 <!-- OBJECT PROPERTIES --> 3471 <dd style="display: none; "> 3472 <dl> 3473 <div> 3474 <div> 3475 </div> 3476 </div> 3477 </dl> 3478 </dd> 3479 3480 <!-- OBJECT METHODS --> 3481 <dd style="display: none; "> 3482 <div></div> 3483 </dd> 3484 3485 <!-- OBJECT EVENT FIELDS --> 3486 <dd style="display: none; "> 3487 <div></div> 3488 </dd> 3489 3490 <!-- FUNCTION PARAMETERS --> 3491 <dd style="display: none; "> 3492 <div></div> 3493 </dd> 3494 3495 </div> 3496 </div> 3497 </dl> 3498 </dd> 3499 3500 <!-- OBJECT METHODS --> 3501 <dd style="display: none; "> 3502 <div></div> 3503 </dd> 3504 3505 <!-- OBJECT EVENT FIELDS --> 3506 <dd style="display: none; "> 3507 <div></div> 3508 </dd> 3509 3510 <!-- FUNCTION PARAMETERS --> 3511 <dd style="display: none; "> 3512 <div></div> 3513 </dd> 3514 3515 </div> 3516 3517 </div> <!-- /apiItem --> 3518 3519 </div> <!-- /apiGroup --> 3520 3521 </div> <!-- /apiPage --> 3522 </div> <!-- /gc-pagecontent --> 3523 </div> <!-- /g-section --> 3524 </div> <!-- /codesiteContent --> 3525 <div id="gc-footer" --=""> 3526 <div class="text"> 3527 <p> 3528 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 3529 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 3530 Attribution 3.0 License</a>, and code samples are licensed under the 3531 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 3532 </p> 3533 <p> 3534 ©2011 Google 3535 </p> 3536 3537<!-- begin analytics --> 3538<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 3539<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 3540 3541<script type="text/javascript"> 3542 // chrome doc tracking 3543 try { 3544 var engdocs = _gat._getTracker("YT-10763712-2"); 3545 engdocs._trackPageview(); 3546 } catch(err) {} 3547 3548 // code.google.com site-wide tracking 3549 try { 3550 _uacct="UA-18071-1"; 3551 _uanchor=1; 3552 _uff=0; 3553 urchinTracker(); 3554 } 3555 catch(e) {/* urchinTracker not available. */} 3556</script> 3557<!-- end analytics --> 3558 </div> 3559 </div> <!-- /gc-footer --> 3560 </div> <!-- /gc-container --> 3561</body></html> 3562
