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>Cookies - 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 class="leftNavSelected">Cookies</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">Cookies</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="#examples"> Examples </a> 269 <ol> 270 <li style="display: none; "> 271 <a>h3Name</a> 272 </li> 273 </ol> 274 </li> 275 <li> 276 <a href="#apiReference">API reference: chrome.cookies</a> 277 <ol> 278 <li style="display: none; "> 279 <a href="#properties">Properties</a> 280 <ol> 281 <li> 282 <a href="#property-anchor">propertyName</a> 283 </li> 284 </ol> 285 </li> 286 <li> 287 <a href="#global-methods">Methods</a> 288 <ol> 289 <li> 290 <a href="#method-get">get</a> 291 </li><li> 292 <a href="#method-getAll">getAll</a> 293 </li><li> 294 <a href="#method-getAllCookieStores">getAllCookieStores</a> 295 </li><li> 296 <a href="#method-remove">remove</a> 297 </li><li> 298 <a href="#method-set">set</a> 299 </li> 300 </ol> 301 </li> 302 <li> 303 <a href="#global-events">Events</a> 304 <ol> 305 <li> 306 <a href="#event-onChanged">onChanged</a> 307 </li> 308 </ol> 309 </li> 310 <li> 311 <a href="#types">Types</a> 312 <ol> 313 <li> 314 <a href="#type-Cookie">Cookie</a> 315 </li><li> 316 <a href="#type-CookieStore">CookieStore</a> 317 </li> 318 </ol> 319 </li> 320 </ol> 321 </li> 322 </ol> 323 </div> 324 <!-- /TABLE OF CONTENTS --> 325 326 <!-- Standard content lead-in for experimental API pages --> 327 <p id="classSummary" style="display: none; "> 328 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 329 </p> 330 331 <!-- STATIC CONTENT PLACEHOLDER --> 332 <div id="static"><div id="pageData-name" class="pageData">Cookies</div> 333 334 <!-- BEGIN AUTHORED CONTENT --> 335 <h2 id="manifest">Manifest</h2> 336 337 <p>To use the cookies API, 338 you must declare the "cookies" permission in your manifest, 339 along with <a href="manifest.html#permissions">host permissions</a> 340 for any hosts whose cookies 341 you want to access. 342 For example:</p> 343 344 <pre>{ 345 "name": "My extension", 346 ... 347 <b>"permissions": [ 348 "cookies", 349 "*://*.google.com" 350 ]</b>, 351 ... 352 }</pre> 353 354 <h2 id="examples"> Examples </h2> 355 356 <p> 357 You can find a simple example 358 of using the cookies API in the 359 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/cookies/">examples/api/cookies</a> 360 directory. 361 For other examples 362 and for help in viewing the source code, 363 see <a href="samples.html">Samples</a>. 364 </p> 365 366 <!-- END AUTHORED CONTENT --> 367 </div> 368 369 <!-- API PAGE --> 370 <div class="apiPage"> 371 <a name="apiReference"></a> 372 <h2>API reference: chrome.cookies</h2> 373 374 <!-- PROPERTIES --> 375 <div class="apiGroup" style="display: none; "> 376 <a name="properties"></a> 377 <h3 id="properties">Properties</h3> 378 379 <div> 380 <a></a> 381 <h4>getLastError</h4> 382 <div class="summary"> 383 <!-- Note: intentionally longer 80 columns --> 384 <span>chrome.extension</span><span>lastError</span> 385 </div> 386 <div> 387 </div> 388 </div> 389 390 </div> <!-- /apiGroup --> 391 392 <!-- METHODS --> 393 <div id="methodsTemplate" class="apiGroup"> 394 <a name="global-methods"></a> 395 <h3>Methods</h3> 396 397 <!-- iterates over all functions --> 398 <div class="apiItem"> 399 <a name="method-get"></a> <!-- method-anchor --> 400 <h4>get</h4> 401 402 <div class="summary"><span style="display: none; ">void</span> 403 <!-- Note: intentionally longer 80 columns --> 404 <span>chrome.cookies.get</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 405 <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span> 406 <var><span>callback</span></var></span>)</div> 407 408 <div class="description"> 409 <p class="todo" style="display: none; ">Undocumented.</p> 410 <p>Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned.</p> 411 412 <!-- PARAMETERS --> 413 <h4>Parameters</h4> 414 <dl> 415 <div> 416 <div> 417 <dt> 418 <var>details</var> 419 <em> 420 421 <!-- TYPE --> 422 <div style="display:inline"> 423 ( 424 <span class="optional" style="display: none; ">optional</span> 425 <span class="enum" style="display: none; ">enumerated</span> 426 <span id="typeTemplate"> 427 <span style="display: none; "> 428 <a> Type</a> 429 </span> 430 <span> 431 <span style="display: none; "> 432 array of <span><span></span></span> 433 </span> 434 <span>object</span> 435 <span style="display: none; "></span> 436 </span> 437 </span> 438 ) 439 </div> 440 441 </em> 442 </dt> 443 <dd class="todo" style="display: none; "> 444 Undocumented. 445 </dd> 446 <dd>Details to identify the cookie being retrieved.</dd> 447 <dd style="display: none; "> 448 This parameter was added in version 449 <b><span></span></b>. 450 You must omit this parameter in earlier versions, 451 and you may omit it in any version. If you require this 452 parameter, the manifest key 453 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 454 can ensure that your extension won't be run in an earlier browser version. 455 </dd> 456 457 <!-- OBJECT PROPERTIES --> 458 <dd> 459 <dl> 460 <div> 461 <div> 462 <dt> 463 <var>url</var> 464 <em> 465 466 <!-- TYPE --> 467 <div style="display:inline"> 468 ( 469 <span class="optional" style="display: none; ">optional</span> 470 <span class="enum" style="display: none; ">enumerated</span> 471 <span id="typeTemplate"> 472 <span style="display: none; "> 473 <a> Type</a> 474 </span> 475 <span> 476 <span style="display: none; "> 477 array of <span><span></span></span> 478 </span> 479 <span>string</span> 480 <span style="display: none; "></span> 481 </span> 482 </span> 483 ) 484 </div> 485 486 </em> 487 </dt> 488 <dd class="todo" style="display: none; "> 489 Undocumented. 490 </dd> 491 <dd>The URL with which the cookie to retrieve is associated. This argument may be a full URL, in which case any data following the URL path (e.g. the query string) is simply ignored. If host permissions for this URL are not specified in the manifest file, the API call will fail.</dd> 492 <dd style="display: none; "> 493 This parameter was added in version 494 <b><span></span></b>. 495 You must omit this parameter in earlier versions, 496 and you may omit it in any version. If you require this 497 parameter, the manifest key 498 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 499 can ensure that your extension won't be run in an earlier browser version. 500 </dd> 501 502 <!-- OBJECT PROPERTIES --> 503 <dd style="display: none; "> 504 <dl> 505 <div> 506 <div> 507 </div> 508 </div> 509 </dl> 510 </dd> 511 512 <!-- OBJECT METHODS --> 513 <dd style="display: none; "> 514 <div></div> 515 </dd> 516 517 <!-- OBJECT EVENT FIELDS --> 518 <dd style="display: none; "> 519 <div></div> 520 </dd> 521 522 <!-- FUNCTION PARAMETERS --> 523 <dd style="display: none; "> 524 <div></div> 525 </dd> 526 527 </div> 528 </div><div> 529 <div> 530 <dt> 531 <var>name</var> 532 <em> 533 534 <!-- TYPE --> 535 <div style="display:inline"> 536 ( 537 <span class="optional" style="display: none; ">optional</span> 538 <span class="enum" style="display: none; ">enumerated</span> 539 <span id="typeTemplate"> 540 <span style="display: none; "> 541 <a> Type</a> 542 </span> 543 <span> 544 <span style="display: none; "> 545 array of <span><span></span></span> 546 </span> 547 <span>string</span> 548 <span style="display: none; "></span> 549 </span> 550 </span> 551 ) 552 </div> 553 554 </em> 555 </dt> 556 <dd class="todo" style="display: none; "> 557 Undocumented. 558 </dd> 559 <dd>The name of the cookie to retrieve.</dd> 560 <dd style="display: none; "> 561 This parameter was added in version 562 <b><span></span></b>. 563 You must omit this parameter in earlier versions, 564 and you may omit it in any version. If you require this 565 parameter, the manifest key 566 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 567 can ensure that your extension won't be run in an earlier browser version. 568 </dd> 569 570 <!-- OBJECT PROPERTIES --> 571 <dd style="display: none; "> 572 <dl> 573 <div> 574 <div> 575 </div> 576 </div> 577 </dl> 578 </dd> 579 580 <!-- OBJECT METHODS --> 581 <dd style="display: none; "> 582 <div></div> 583 </dd> 584 585 <!-- OBJECT EVENT FIELDS --> 586 <dd style="display: none; "> 587 <div></div> 588 </dd> 589 590 <!-- FUNCTION PARAMETERS --> 591 <dd style="display: none; "> 592 <div></div> 593 </dd> 594 595 </div> 596 </div><div> 597 <div> 598 <dt> 599 <var>storeId</var> 600 <em> 601 602 <!-- TYPE --> 603 <div style="display:inline"> 604 ( 605 <span class="optional">optional</span> 606 <span class="enum" style="display: none; ">enumerated</span> 607 <span id="typeTemplate"> 608 <span style="display: none; "> 609 <a> Type</a> 610 </span> 611 <span> 612 <span style="display: none; "> 613 array of <span><span></span></span> 614 </span> 615 <span>string</span> 616 <span style="display: none; "></span> 617 </span> 618 </span> 619 ) 620 </div> 621 622 </em> 623 </dt> 624 <dd class="todo" style="display: none; "> 625 Undocumented. 626 </dd> 627 <dd>The ID of the cookie store in which to look for the cookie. By default, the current execution context's cookie store will be used.</dd> 628 <dd style="display: none; "> 629 This parameter was added in version 630 <b><span></span></b>. 631 You must omit this parameter in earlier versions, 632 and you may omit it in any version. If you require this 633 parameter, the manifest key 634 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 635 can ensure that your extension won't be run in an earlier browser version. 636 </dd> 637 638 <!-- OBJECT PROPERTIES --> 639 <dd style="display: none; "> 640 <dl> 641 <div> 642 <div> 643 </div> 644 </div> 645 </dl> 646 </dd> 647 648 <!-- OBJECT METHODS --> 649 <dd style="display: none; "> 650 <div></div> 651 </dd> 652 653 <!-- OBJECT EVENT FIELDS --> 654 <dd style="display: none; "> 655 <div></div> 656 </dd> 657 658 <!-- FUNCTION PARAMETERS --> 659 <dd style="display: none; "> 660 <div></div> 661 </dd> 662 663 </div> 664 </div> 665 </dl> 666 </dd> 667 668 <!-- OBJECT METHODS --> 669 <dd style="display: none; "> 670 <div></div> 671 </dd> 672 673 <!-- OBJECT EVENT FIELDS --> 674 <dd style="display: none; "> 675 <div></div> 676 </dd> 677 678 <!-- FUNCTION PARAMETERS --> 679 <dd style="display: none; "> 680 <div></div> 681 </dd> 682 683 </div> 684 </div><div> 685 <div> 686 <dt> 687 <var>callback</var> 688 <em> 689 690 <!-- TYPE --> 691 <div style="display:inline"> 692 ( 693 <span class="optional" style="display: none; ">optional</span> 694 <span class="enum" style="display: none; ">enumerated</span> 695 <span id="typeTemplate"> 696 <span style="display: none; "> 697 <a> Type</a> 698 </span> 699 <span> 700 <span style="display: none; "> 701 array of <span><span></span></span> 702 </span> 703 <span>function</span> 704 <span style="display: none; "></span> 705 </span> 706 </span> 707 ) 708 </div> 709 710 </em> 711 </dt> 712 <dd class="todo"> 713 Undocumented. 714 </dd> 715 <dd style="display: none; "> 716 Description of this parameter from the json schema. 717 </dd> 718 <dd style="display: none; "> 719 This parameter was added in version 720 <b><span></span></b>. 721 You must omit this parameter in earlier versions, 722 and you may omit it in any version. If you require this 723 parameter, the manifest key 724 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 725 can ensure that your extension won't be run in an earlier browser version. 726 </dd> 727 728 <!-- OBJECT PROPERTIES --> 729 <dd style="display: none; "> 730 <dl> 731 <div> 732 <div> 733 </div> 734 </div> 735 </dl> 736 </dd> 737 738 <!-- OBJECT METHODS --> 739 <dd style="display: none; "> 740 <div></div> 741 </dd> 742 743 <!-- OBJECT EVENT FIELDS --> 744 <dd style="display: none; "> 745 <div></div> 746 </dd> 747 748 <!-- FUNCTION PARAMETERS --> 749 <dd style="display: none; "> 750 <div></div> 751 </dd> 752 753 </div> 754 </div> 755 </dl> 756 757 <!-- RETURNS --> 758 <h4 style="display: none; ">Returns</h4> 759 <dl> 760 <div style="display: none; "> 761 <div> 762 </div> 763 </div> 764 </dl> 765 766 <!-- CALLBACK --> 767 <div> 768 <div> 769 <h4>Callback function</h4> 770 <p> 771 The callback <em>parameter</em> should specify a function 772 that looks like this: 773 </p> 774 <p style="display: none; "> 775 If you specify the <em>callback</em> parameter, it should 776 specify a function that looks like this: 777 </p> 778 779 <!-- Note: intentionally longer 80 columns --> 780 <pre>function(<span>Cookie cookie</span>) <span class="subdued">{...}</span>;</pre> 781 <dl> 782 <div> 783 <div> 784 <dt> 785 <var>cookie</var> 786 <em> 787 788 <!-- TYPE --> 789 <div style="display:inline"> 790 ( 791 <span class="optional">optional</span> 792 <span class="enum" style="display: none; ">enumerated</span> 793 <span id="typeTemplate"> 794 <span> 795 <a href="cookies.html#type-Cookie">Cookie</a> 796 </span> 797 <span style="display: none; "> 798 <span> 799 array of <span><span></span></span> 800 </span> 801 <span>paramType</span> 802 <span></span> 803 </span> 804 </span> 805 ) 806 </div> 807 808 </em> 809 </dt> 810 <dd class="todo" style="display: none; "> 811 Undocumented. 812 </dd> 813 <dd>Contains details about the cookie. This parameter is null if no such cookie was found.</dd> 814 <dd style="display: none; "> 815 This parameter was added in version 816 <b><span></span></b>. 817 You must omit this parameter in earlier versions, 818 and you may omit it in any version. If you require this 819 parameter, the manifest key 820 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 821 can ensure that your extension won't be run in an earlier browser version. 822 </dd> 823 824 <!-- OBJECT PROPERTIES --> 825 <dd style="display: none; "> 826 <dl> 827 <div> 828 <div> 829 </div> 830 </div> 831 </dl> 832 </dd> 833 834 <!-- OBJECT METHODS --> 835 <dd style="display: none; "> 836 <div></div> 837 </dd> 838 839 <!-- OBJECT EVENT FIELDS --> 840 <dd style="display: none; "> 841 <div></div> 842 </dd> 843 844 <!-- FUNCTION PARAMETERS --> 845 <dd style="display: none; "> 846 <div></div> 847 </dd> 848 849 </div> 850 </div> 851 </dl> 852 </div> 853 </div> 854 855 <!-- MIN_VERSION --> 856 <p style="display: none; "> 857 This function was added in version <b><span></span></b>. 858 If you require this function, the manifest key 859 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 860 can ensure that your extension won't be run in an earlier browser version. 861 </p> 862 </div> <!-- /description --> 863 864 </div><div class="apiItem"> 865 <a name="method-getAll"></a> <!-- method-anchor --> 866 <h4>getAll</h4> 867 868 <div class="summary"><span style="display: none; ">void</span> 869 <!-- Note: intentionally longer 80 columns --> 870 <span>chrome.cookies.getAll</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 871 <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span> 872 <var><span>callback</span></var></span>)</div> 873 874 <div class="description"> 875 <p class="todo" style="display: none; ">Undocumented.</p> 876 <p>Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first.</p> 877 878 <!-- PARAMETERS --> 879 <h4>Parameters</h4> 880 <dl> 881 <div> 882 <div> 883 <dt> 884 <var>details</var> 885 <em> 886 887 <!-- TYPE --> 888 <div style="display:inline"> 889 ( 890 <span class="optional" style="display: none; ">optional</span> 891 <span class="enum" style="display: none; ">enumerated</span> 892 <span id="typeTemplate"> 893 <span style="display: none; "> 894 <a> Type</a> 895 </span> 896 <span> 897 <span style="display: none; "> 898 array of <span><span></span></span> 899 </span> 900 <span>object</span> 901 <span style="display: none; "></span> 902 </span> 903 </span> 904 ) 905 </div> 906 907 </em> 908 </dt> 909 <dd class="todo" style="display: none; "> 910 Undocumented. 911 </dd> 912 <dd>Information to filter the cookies being retrieved.</dd> 913 <dd style="display: none; "> 914 This parameter was added in version 915 <b><span></span></b>. 916 You must omit this parameter in earlier versions, 917 and you may omit it in any version. If you require this 918 parameter, the manifest key 919 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 920 can ensure that your extension won't be run in an earlier browser version. 921 </dd> 922 923 <!-- OBJECT PROPERTIES --> 924 <dd> 925 <dl> 926 <div> 927 <div> 928 <dt> 929 <var>url</var> 930 <em> 931 932 <!-- TYPE --> 933 <div style="display:inline"> 934 ( 935 <span class="optional">optional</span> 936 <span class="enum" style="display: none; ">enumerated</span> 937 <span id="typeTemplate"> 938 <span style="display: none; "> 939 <a> Type</a> 940 </span> 941 <span> 942 <span style="display: none; "> 943 array of <span><span></span></span> 944 </span> 945 <span>string</span> 946 <span style="display: none; "></span> 947 </span> 948 </span> 949 ) 950 </div> 951 952 </em> 953 </dt> 954 <dd class="todo" style="display: none; "> 955 Undocumented. 956 </dd> 957 <dd>Restricts the retrieved cookies to those that would match the given URL.</dd> 958 <dd style="display: none; "> 959 This parameter was added in version 960 <b><span></span></b>. 961 You must omit this parameter in earlier versions, 962 and you may omit it in any version. If you require this 963 parameter, the manifest key 964 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 965 can ensure that your extension won't be run in an earlier browser version. 966 </dd> 967 968 <!-- OBJECT PROPERTIES --> 969 <dd style="display: none; "> 970 <dl> 971 <div> 972 <div> 973 </div> 974 </div> 975 </dl> 976 </dd> 977 978 <!-- OBJECT METHODS --> 979 <dd style="display: none; "> 980 <div></div> 981 </dd> 982 983 <!-- OBJECT EVENT FIELDS --> 984 <dd style="display: none; "> 985 <div></div> 986 </dd> 987 988 <!-- FUNCTION PARAMETERS --> 989 <dd style="display: none; "> 990 <div></div> 991 </dd> 992 993 </div> 994 </div><div> 995 <div> 996 <dt> 997 <var>name</var> 998 <em> 999 1000 <!-- TYPE --> 1001 <div style="display:inline"> 1002 ( 1003 <span class="optional">optional</span> 1004 <span class="enum" style="display: none; ">enumerated</span> 1005 <span id="typeTemplate"> 1006 <span style="display: none; "> 1007 <a> Type</a> 1008 </span> 1009 <span> 1010 <span style="display: none; "> 1011 array of <span><span></span></span> 1012 </span> 1013 <span>string</span> 1014 <span style="display: none; "></span> 1015 </span> 1016 </span> 1017 ) 1018 </div> 1019 1020 </em> 1021 </dt> 1022 <dd class="todo" style="display: none; "> 1023 Undocumented. 1024 </dd> 1025 <dd>Filters the cookies by name.</dd> 1026 <dd style="display: none; "> 1027 This parameter was added in version 1028 <b><span></span></b>. 1029 You must omit this parameter in earlier versions, 1030 and you may omit it in any version. If you require this 1031 parameter, the manifest key 1032 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1033 can ensure that your extension won't be run in an earlier browser version. 1034 </dd> 1035 1036 <!-- OBJECT PROPERTIES --> 1037 <dd style="display: none; "> 1038 <dl> 1039 <div> 1040 <div> 1041 </div> 1042 </div> 1043 </dl> 1044 </dd> 1045 1046 <!-- OBJECT METHODS --> 1047 <dd style="display: none; "> 1048 <div></div> 1049 </dd> 1050 1051 <!-- OBJECT EVENT FIELDS --> 1052 <dd style="display: none; "> 1053 <div></div> 1054 </dd> 1055 1056 <!-- FUNCTION PARAMETERS --> 1057 <dd style="display: none; "> 1058 <div></div> 1059 </dd> 1060 1061 </div> 1062 </div><div> 1063 <div> 1064 <dt> 1065 <var>domain</var> 1066 <em> 1067 1068 <!-- TYPE --> 1069 <div style="display:inline"> 1070 ( 1071 <span class="optional">optional</span> 1072 <span class="enum" style="display: none; ">enumerated</span> 1073 <span id="typeTemplate"> 1074 <span style="display: none; "> 1075 <a> Type</a> 1076 </span> 1077 <span> 1078 <span style="display: none; "> 1079 array of <span><span></span></span> 1080 </span> 1081 <span>string</span> 1082 <span style="display: none; "></span> 1083 </span> 1084 </span> 1085 ) 1086 </div> 1087 1088 </em> 1089 </dt> 1090 <dd class="todo" style="display: none; "> 1091 Undocumented. 1092 </dd> 1093 <dd>Restricts the retrieved cookies to those whose domains match or are subdomains of this one.</dd> 1094 <dd style="display: none; "> 1095 This parameter was added in version 1096 <b><span></span></b>. 1097 You must omit this parameter in earlier versions, 1098 and you may omit it in any version. If you require this 1099 parameter, the manifest key 1100 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1101 can ensure that your extension won't be run in an earlier browser version. 1102 </dd> 1103 1104 <!-- OBJECT PROPERTIES --> 1105 <dd style="display: none; "> 1106 <dl> 1107 <div> 1108 <div> 1109 </div> 1110 </div> 1111 </dl> 1112 </dd> 1113 1114 <!-- OBJECT METHODS --> 1115 <dd style="display: none; "> 1116 <div></div> 1117 </dd> 1118 1119 <!-- OBJECT EVENT FIELDS --> 1120 <dd style="display: none; "> 1121 <div></div> 1122 </dd> 1123 1124 <!-- FUNCTION PARAMETERS --> 1125 <dd style="display: none; "> 1126 <div></div> 1127 </dd> 1128 1129 </div> 1130 </div><div> 1131 <div> 1132 <dt> 1133 <var>path</var> 1134 <em> 1135 1136 <!-- TYPE --> 1137 <div style="display:inline"> 1138 ( 1139 <span class="optional">optional</span> 1140 <span class="enum" style="display: none; ">enumerated</span> 1141 <span id="typeTemplate"> 1142 <span style="display: none; "> 1143 <a> Type</a> 1144 </span> 1145 <span> 1146 <span style="display: none; "> 1147 array of <span><span></span></span> 1148 </span> 1149 <span>string</span> 1150 <span style="display: none; "></span> 1151 </span> 1152 </span> 1153 ) 1154 </div> 1155 1156 </em> 1157 </dt> 1158 <dd class="todo" style="display: none; "> 1159 Undocumented. 1160 </dd> 1161 <dd>Restricts the retrieved cookies to those whose path exactly matches this string.</dd> 1162 <dd style="display: none; "> 1163 This parameter was added in version 1164 <b><span></span></b>. 1165 You must omit this parameter in earlier versions, 1166 and you may omit it in any version. If you require this 1167 parameter, the manifest key 1168 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1169 can ensure that your extension won't be run in an earlier browser version. 1170 </dd> 1171 1172 <!-- OBJECT PROPERTIES --> 1173 <dd style="display: none; "> 1174 <dl> 1175 <div> 1176 <div> 1177 </div> 1178 </div> 1179 </dl> 1180 </dd> 1181 1182 <!-- OBJECT METHODS --> 1183 <dd style="display: none; "> 1184 <div></div> 1185 </dd> 1186 1187 <!-- OBJECT EVENT FIELDS --> 1188 <dd style="display: none; "> 1189 <div></div> 1190 </dd> 1191 1192 <!-- FUNCTION PARAMETERS --> 1193 <dd style="display: none; "> 1194 <div></div> 1195 </dd> 1196 1197 </div> 1198 </div><div> 1199 <div> 1200 <dt> 1201 <var>secure</var> 1202 <em> 1203 1204 <!-- TYPE --> 1205 <div style="display:inline"> 1206 ( 1207 <span class="optional">optional</span> 1208 <span class="enum" style="display: none; ">enumerated</span> 1209 <span id="typeTemplate"> 1210 <span style="display: none; "> 1211 <a> Type</a> 1212 </span> 1213 <span> 1214 <span style="display: none; "> 1215 array of <span><span></span></span> 1216 </span> 1217 <span>boolean</span> 1218 <span style="display: none; "></span> 1219 </span> 1220 </span> 1221 ) 1222 </div> 1223 1224 </em> 1225 </dt> 1226 <dd class="todo" style="display: none; "> 1227 Undocumented. 1228 </dd> 1229 <dd>Filters the cookies by their Secure property.</dd> 1230 <dd style="display: none; "> 1231 This parameter was added in version 1232 <b><span></span></b>. 1233 You must omit this parameter in earlier versions, 1234 and you may omit it in any version. If you require this 1235 parameter, the manifest key 1236 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1237 can ensure that your extension won't be run in an earlier browser version. 1238 </dd> 1239 1240 <!-- OBJECT PROPERTIES --> 1241 <dd style="display: none; "> 1242 <dl> 1243 <div> 1244 <div> 1245 </div> 1246 </div> 1247 </dl> 1248 </dd> 1249 1250 <!-- OBJECT METHODS --> 1251 <dd style="display: none; "> 1252 <div></div> 1253 </dd> 1254 1255 <!-- OBJECT EVENT FIELDS --> 1256 <dd style="display: none; "> 1257 <div></div> 1258 </dd> 1259 1260 <!-- FUNCTION PARAMETERS --> 1261 <dd style="display: none; "> 1262 <div></div> 1263 </dd> 1264 1265 </div> 1266 </div><div> 1267 <div> 1268 <dt> 1269 <var>session</var> 1270 <em> 1271 1272 <!-- TYPE --> 1273 <div style="display:inline"> 1274 ( 1275 <span class="optional">optional</span> 1276 <span class="enum" style="display: none; ">enumerated</span> 1277 <span id="typeTemplate"> 1278 <span style="display: none; "> 1279 <a> Type</a> 1280 </span> 1281 <span> 1282 <span style="display: none; "> 1283 array of <span><span></span></span> 1284 </span> 1285 <span>boolean</span> 1286 <span style="display: none; "></span> 1287 </span> 1288 </span> 1289 ) 1290 </div> 1291 1292 </em> 1293 </dt> 1294 <dd class="todo" style="display: none; "> 1295 Undocumented. 1296 </dd> 1297 <dd>Filters out session vs. persistent cookies.</dd> 1298 <dd style="display: none; "> 1299 This parameter was added in version 1300 <b><span></span></b>. 1301 You must omit this parameter in earlier versions, 1302 and you may omit it in any version. If you require this 1303 parameter, the manifest key 1304 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1305 can ensure that your extension won't be run in an earlier browser version. 1306 </dd> 1307 1308 <!-- OBJECT PROPERTIES --> 1309 <dd style="display: none; "> 1310 <dl> 1311 <div> 1312 <div> 1313 </div> 1314 </div> 1315 </dl> 1316 </dd> 1317 1318 <!-- OBJECT METHODS --> 1319 <dd style="display: none; "> 1320 <div></div> 1321 </dd> 1322 1323 <!-- OBJECT EVENT FIELDS --> 1324 <dd style="display: none; "> 1325 <div></div> 1326 </dd> 1327 1328 <!-- FUNCTION PARAMETERS --> 1329 <dd style="display: none; "> 1330 <div></div> 1331 </dd> 1332 1333 </div> 1334 </div><div> 1335 <div> 1336 <dt> 1337 <var>storeId</var> 1338 <em> 1339 1340 <!-- TYPE --> 1341 <div style="display:inline"> 1342 ( 1343 <span class="optional">optional</span> 1344 <span class="enum" style="display: none; ">enumerated</span> 1345 <span id="typeTemplate"> 1346 <span style="display: none; "> 1347 <a> Type</a> 1348 </span> 1349 <span> 1350 <span style="display: none; "> 1351 array of <span><span></span></span> 1352 </span> 1353 <span>string</span> 1354 <span style="display: none; "></span> 1355 </span> 1356 </span> 1357 ) 1358 </div> 1359 1360 </em> 1361 </dt> 1362 <dd class="todo" style="display: none; "> 1363 Undocumented. 1364 </dd> 1365 <dd>The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.</dd> 1366 <dd style="display: none; "> 1367 This parameter was added in version 1368 <b><span></span></b>. 1369 You must omit this parameter in earlier versions, 1370 and you may omit it in any version. If you require this 1371 parameter, the manifest key 1372 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1373 can ensure that your extension won't be run in an earlier browser version. 1374 </dd> 1375 1376 <!-- OBJECT PROPERTIES --> 1377 <dd style="display: none; "> 1378 <dl> 1379 <div> 1380 <div> 1381 </div> 1382 </div> 1383 </dl> 1384 </dd> 1385 1386 <!-- OBJECT METHODS --> 1387 <dd style="display: none; "> 1388 <div></div> 1389 </dd> 1390 1391 <!-- OBJECT EVENT FIELDS --> 1392 <dd style="display: none; "> 1393 <div></div> 1394 </dd> 1395 1396 <!-- FUNCTION PARAMETERS --> 1397 <dd style="display: none; "> 1398 <div></div> 1399 </dd> 1400 1401 </div> 1402 </div> 1403 </dl> 1404 </dd> 1405 1406 <!-- OBJECT METHODS --> 1407 <dd style="display: none; "> 1408 <div></div> 1409 </dd> 1410 1411 <!-- OBJECT EVENT FIELDS --> 1412 <dd style="display: none; "> 1413 <div></div> 1414 </dd> 1415 1416 <!-- FUNCTION PARAMETERS --> 1417 <dd style="display: none; "> 1418 <div></div> 1419 </dd> 1420 1421 </div> 1422 </div><div> 1423 <div> 1424 <dt> 1425 <var>callback</var> 1426 <em> 1427 1428 <!-- TYPE --> 1429 <div style="display:inline"> 1430 ( 1431 <span class="optional" style="display: none; ">optional</span> 1432 <span class="enum" style="display: none; ">enumerated</span> 1433 <span id="typeTemplate"> 1434 <span style="display: none; "> 1435 <a> Type</a> 1436 </span> 1437 <span> 1438 <span style="display: none; "> 1439 array of <span><span></span></span> 1440 </span> 1441 <span>function</span> 1442 <span style="display: none; "></span> 1443 </span> 1444 </span> 1445 ) 1446 </div> 1447 1448 </em> 1449 </dt> 1450 <dd class="todo"> 1451 Undocumented. 1452 </dd> 1453 <dd style="display: none; "> 1454 Description of this parameter from the json schema. 1455 </dd> 1456 <dd style="display: none; "> 1457 This parameter was added in version 1458 <b><span></span></b>. 1459 You must omit this parameter in earlier versions, 1460 and you may omit it in any version. If you require this 1461 parameter, the manifest key 1462 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1463 can ensure that your extension won't be run in an earlier browser version. 1464 </dd> 1465 1466 <!-- OBJECT PROPERTIES --> 1467 <dd style="display: none; "> 1468 <dl> 1469 <div> 1470 <div> 1471 </div> 1472 </div> 1473 </dl> 1474 </dd> 1475 1476 <!-- OBJECT METHODS --> 1477 <dd style="display: none; "> 1478 <div></div> 1479 </dd> 1480 1481 <!-- OBJECT EVENT FIELDS --> 1482 <dd style="display: none; "> 1483 <div></div> 1484 </dd> 1485 1486 <!-- FUNCTION PARAMETERS --> 1487 <dd style="display: none; "> 1488 <div></div> 1489 </dd> 1490 1491 </div> 1492 </div> 1493 </dl> 1494 1495 <!-- RETURNS --> 1496 <h4 style="display: none; ">Returns</h4> 1497 <dl> 1498 <div style="display: none; "> 1499 <div> 1500 </div> 1501 </div> 1502 </dl> 1503 1504 <!-- CALLBACK --> 1505 <div> 1506 <div> 1507 <h4>Callback function</h4> 1508 <p> 1509 The callback <em>parameter</em> should specify a function 1510 that looks like this: 1511 </p> 1512 <p style="display: none; "> 1513 If you specify the <em>callback</em> parameter, it should 1514 specify a function that looks like this: 1515 </p> 1516 1517 <!-- Note: intentionally longer 80 columns --> 1518 <pre>function(<span>array of Cookie cookies</span>) <span class="subdued">{...}</span>;</pre> 1519 <dl> 1520 <div> 1521 <div> 1522 <dt> 1523 <var>cookies</var> 1524 <em> 1525 1526 <!-- TYPE --> 1527 <div style="display:inline"> 1528 ( 1529 <span class="optional" style="display: none; ">optional</span> 1530 <span class="enum" style="display: none; ">enumerated</span> 1531 <span id="typeTemplate"> 1532 <span style="display: none; "> 1533 <a> Type</a> 1534 </span> 1535 <span> 1536 <span> 1537 array of <span><span> 1538 <span> 1539 <a href="cookies.html#type-Cookie">Cookie</a> 1540 </span> 1541 <span style="display: none; "> 1542 <span> 1543 array of <span><span></span></span> 1544 </span> 1545 <span>paramType</span> 1546 <span></span> 1547 </span> 1548 </span></span> 1549 </span> 1550 <span style="display: none; ">paramType</span> 1551 <span style="display: none; "></span> 1552 </span> 1553 </span> 1554 ) 1555 </div> 1556 1557 </em> 1558 </dt> 1559 <dd class="todo" style="display: none; "> 1560 Undocumented. 1561 </dd> 1562 <dd>All the existing, unexpired cookies that match the given cookie info.</dd> 1563 <dd style="display: none; "> 1564 This parameter was added in version 1565 <b><span></span></b>. 1566 You must omit this parameter in earlier versions, 1567 and you may omit it in any version. If you require this 1568 parameter, the manifest key 1569 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1570 can ensure that your extension won't be run in an earlier browser version. 1571 </dd> 1572 1573 <!-- OBJECT PROPERTIES --> 1574 <dd style="display: none; "> 1575 <dl> 1576 <div> 1577 <div> 1578 </div> 1579 </div> 1580 </dl> 1581 </dd> 1582 1583 <!-- OBJECT METHODS --> 1584 <dd style="display: none; "> 1585 <div></div> 1586 </dd> 1587 1588 <!-- OBJECT EVENT FIELDS --> 1589 <dd style="display: none; "> 1590 <div></div> 1591 </dd> 1592 1593 <!-- FUNCTION PARAMETERS --> 1594 <dd style="display: none; "> 1595 <div></div> 1596 </dd> 1597 1598 </div> 1599 </div> 1600 </dl> 1601 </div> 1602 </div> 1603 1604 <!-- MIN_VERSION --> 1605 <p style="display: none; "> 1606 This function was added in version <b><span></span></b>. 1607 If you require this function, the manifest key 1608 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1609 can ensure that your extension won't be run in an earlier browser version. 1610 </p> 1611 </div> <!-- /description --> 1612 1613 </div><div class="apiItem"> 1614 <a name="method-getAllCookieStores"></a> <!-- method-anchor --> 1615 <h4>getAllCookieStores</h4> 1616 1617 <div class="summary"><span style="display: none; ">void</span> 1618 <!-- Note: intentionally longer 80 columns --> 1619 <span>chrome.cookies.getAllCookieStores</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> 1620 <var><span>callback</span></var></span>)</div> 1621 1622 <div class="description"> 1623 <p class="todo" style="display: none; ">Undocumented.</p> 1624 <p>Lists all existing cookie stores.</p> 1625 1626 <!-- PARAMETERS --> 1627 <h4>Parameters</h4> 1628 <dl> 1629 <div> 1630 <div> 1631 <dt> 1632 <var>callback</var> 1633 <em> 1634 1635 <!-- TYPE --> 1636 <div style="display:inline"> 1637 ( 1638 <span class="optional" style="display: none; ">optional</span> 1639 <span class="enum" style="display: none; ">enumerated</span> 1640 <span id="typeTemplate"> 1641 <span style="display: none; "> 1642 <a> Type</a> 1643 </span> 1644 <span> 1645 <span style="display: none; "> 1646 array of <span><span></span></span> 1647 </span> 1648 <span>function</span> 1649 <span style="display: none; "></span> 1650 </span> 1651 </span> 1652 ) 1653 </div> 1654 1655 </em> 1656 </dt> 1657 <dd class="todo"> 1658 Undocumented. 1659 </dd> 1660 <dd style="display: none; "> 1661 Description of this parameter from the json schema. 1662 </dd> 1663 <dd style="display: none; "> 1664 This parameter was added in version 1665 <b><span></span></b>. 1666 You must omit this parameter in earlier versions, 1667 and you may omit it in any version. If you require this 1668 parameter, the manifest key 1669 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1670 can ensure that your extension won't be run in an earlier browser version. 1671 </dd> 1672 1673 <!-- OBJECT PROPERTIES --> 1674 <dd style="display: none; "> 1675 <dl> 1676 <div> 1677 <div> 1678 </div> 1679 </div> 1680 </dl> 1681 </dd> 1682 1683 <!-- OBJECT METHODS --> 1684 <dd style="display: none; "> 1685 <div></div> 1686 </dd> 1687 1688 <!-- OBJECT EVENT FIELDS --> 1689 <dd style="display: none; "> 1690 <div></div> 1691 </dd> 1692 1693 <!-- FUNCTION PARAMETERS --> 1694 <dd style="display: none; "> 1695 <div></div> 1696 </dd> 1697 1698 </div> 1699 </div> 1700 </dl> 1701 1702 <!-- RETURNS --> 1703 <h4 style="display: none; ">Returns</h4> 1704 <dl> 1705 <div style="display: none; "> 1706 <div> 1707 </div> 1708 </div> 1709 </dl> 1710 1711 <!-- CALLBACK --> 1712 <div> 1713 <div> 1714 <h4>Callback function</h4> 1715 <p> 1716 The callback <em>parameter</em> should specify a function 1717 that looks like this: 1718 </p> 1719 <p style="display: none; "> 1720 If you specify the <em>callback</em> parameter, it should 1721 specify a function that looks like this: 1722 </p> 1723 1724 <!-- Note: intentionally longer 80 columns --> 1725 <pre>function(<span>array of CookieStore cookieStores</span>) <span class="subdued">{...}</span>;</pre> 1726 <dl> 1727 <div> 1728 <div> 1729 <dt> 1730 <var>cookieStores</var> 1731 <em> 1732 1733 <!-- TYPE --> 1734 <div style="display:inline"> 1735 ( 1736 <span class="optional" style="display: none; ">optional</span> 1737 <span class="enum" style="display: none; ">enumerated</span> 1738 <span id="typeTemplate"> 1739 <span style="display: none; "> 1740 <a> Type</a> 1741 </span> 1742 <span> 1743 <span> 1744 array of <span><span> 1745 <span> 1746 <a href="cookies.html#type-CookieStore">CookieStore</a> 1747 </span> 1748 <span style="display: none; "> 1749 <span> 1750 array of <span><span></span></span> 1751 </span> 1752 <span>paramType</span> 1753 <span></span> 1754 </span> 1755 </span></span> 1756 </span> 1757 <span style="display: none; ">paramType</span> 1758 <span style="display: none; "></span> 1759 </span> 1760 </span> 1761 ) 1762 </div> 1763 1764 </em> 1765 </dt> 1766 <dd class="todo" style="display: none; "> 1767 Undocumented. 1768 </dd> 1769 <dd>All the existing cookie stores.</dd> 1770 <dd style="display: none; "> 1771 This parameter was added in version 1772 <b><span></span></b>. 1773 You must omit this parameter in earlier versions, 1774 and you may omit it in any version. If you require this 1775 parameter, the manifest key 1776 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1777 can ensure that your extension won't be run in an earlier browser version. 1778 </dd> 1779 1780 <!-- OBJECT PROPERTIES --> 1781 <dd style="display: none; "> 1782 <dl> 1783 <div> 1784 <div> 1785 </div> 1786 </div> 1787 </dl> 1788 </dd> 1789 1790 <!-- OBJECT METHODS --> 1791 <dd style="display: none; "> 1792 <div></div> 1793 </dd> 1794 1795 <!-- OBJECT EVENT FIELDS --> 1796 <dd style="display: none; "> 1797 <div></div> 1798 </dd> 1799 1800 <!-- FUNCTION PARAMETERS --> 1801 <dd style="display: none; "> 1802 <div></div> 1803 </dd> 1804 1805 </div> 1806 </div> 1807 </dl> 1808 </div> 1809 </div> 1810 1811 <!-- MIN_VERSION --> 1812 <p style="display: none; "> 1813 This function was added in version <b><span></span></b>. 1814 If you require this function, the manifest key 1815 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1816 can ensure that your extension won't be run in an earlier browser version. 1817 </p> 1818 </div> <!-- /description --> 1819 1820 </div><div class="apiItem"> 1821 <a name="method-remove"></a> <!-- method-anchor --> 1822 <h4>remove</h4> 1823 1824 <div class="summary"><span style="display: none; ">void</span> 1825 <!-- Note: intentionally longer 80 columns --> 1826 <span>chrome.cookies.remove</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1827 <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> 1828 <var><span>callback</span></var></span>)</div> 1829 1830 <div class="description"> 1831 <p class="todo" style="display: none; ">Undocumented.</p> 1832 <p>Deletes a cookie by name.</p> 1833 1834 <!-- PARAMETERS --> 1835 <h4>Parameters</h4> 1836 <dl> 1837 <div> 1838 <div> 1839 <dt> 1840 <var>details</var> 1841 <em> 1842 1843 <!-- TYPE --> 1844 <div style="display:inline"> 1845 ( 1846 <span class="optional" style="display: none; ">optional</span> 1847 <span class="enum" style="display: none; ">enumerated</span> 1848 <span id="typeTemplate"> 1849 <span style="display: none; "> 1850 <a> Type</a> 1851 </span> 1852 <span> 1853 <span style="display: none; "> 1854 array of <span><span></span></span> 1855 </span> 1856 <span>object</span> 1857 <span style="display: none; "></span> 1858 </span> 1859 </span> 1860 ) 1861 </div> 1862 1863 </em> 1864 </dt> 1865 <dd class="todo" style="display: none; "> 1866 Undocumented. 1867 </dd> 1868 <dd>Information to identify the cookie to remove.</dd> 1869 <dd style="display: none; "> 1870 This parameter was added in version 1871 <b><span></span></b>. 1872 You must omit this parameter in earlier versions, 1873 and you may omit it in any version. If you require this 1874 parameter, the manifest key 1875 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1876 can ensure that your extension won't be run in an earlier browser version. 1877 </dd> 1878 1879 <!-- OBJECT PROPERTIES --> 1880 <dd> 1881 <dl> 1882 <div> 1883 <div> 1884 <dt> 1885 <var>url</var> 1886 <em> 1887 1888 <!-- TYPE --> 1889 <div style="display:inline"> 1890 ( 1891 <span class="optional" style="display: none; ">optional</span> 1892 <span class="enum" style="display: none; ">enumerated</span> 1893 <span id="typeTemplate"> 1894 <span style="display: none; "> 1895 <a> Type</a> 1896 </span> 1897 <span> 1898 <span style="display: none; "> 1899 array of <span><span></span></span> 1900 </span> 1901 <span>string</span> 1902 <span style="display: none; "></span> 1903 </span> 1904 </span> 1905 ) 1906 </div> 1907 1908 </em> 1909 </dt> 1910 <dd class="todo" style="display: none; "> 1911 Undocumented. 1912 </dd> 1913 <dd>The URL associated with the cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.</dd> 1914 <dd style="display: none; "> 1915 This parameter was added in version 1916 <b><span></span></b>. 1917 You must omit this parameter in earlier versions, 1918 and you may omit it in any version. If you require this 1919 parameter, the manifest key 1920 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1921 can ensure that your extension won't be run in an earlier browser version. 1922 </dd> 1923 1924 <!-- OBJECT PROPERTIES --> 1925 <dd style="display: none; "> 1926 <dl> 1927 <div> 1928 <div> 1929 </div> 1930 </div> 1931 </dl> 1932 </dd> 1933 1934 <!-- OBJECT METHODS --> 1935 <dd style="display: none; "> 1936 <div></div> 1937 </dd> 1938 1939 <!-- OBJECT EVENT FIELDS --> 1940 <dd style="display: none; "> 1941 <div></div> 1942 </dd> 1943 1944 <!-- FUNCTION PARAMETERS --> 1945 <dd style="display: none; "> 1946 <div></div> 1947 </dd> 1948 1949 </div> 1950 </div><div> 1951 <div> 1952 <dt> 1953 <var>name</var> 1954 <em> 1955 1956 <!-- TYPE --> 1957 <div style="display:inline"> 1958 ( 1959 <span class="optional" style="display: none; ">optional</span> 1960 <span class="enum" style="display: none; ">enumerated</span> 1961 <span id="typeTemplate"> 1962 <span style="display: none; "> 1963 <a> Type</a> 1964 </span> 1965 <span> 1966 <span style="display: none; "> 1967 array of <span><span></span></span> 1968 </span> 1969 <span>string</span> 1970 <span style="display: none; "></span> 1971 </span> 1972 </span> 1973 ) 1974 </div> 1975 1976 </em> 1977 </dt> 1978 <dd class="todo" style="display: none; "> 1979 Undocumented. 1980 </dd> 1981 <dd>The name of the cookie to remove.</dd> 1982 <dd style="display: none; "> 1983 This parameter was added in version 1984 <b><span></span></b>. 1985 You must omit this parameter in earlier versions, 1986 and you may omit it in any version. If you require this 1987 parameter, the manifest key 1988 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1989 can ensure that your extension won't be run in an earlier browser version. 1990 </dd> 1991 1992 <!-- OBJECT PROPERTIES --> 1993 <dd style="display: none; "> 1994 <dl> 1995 <div> 1996 <div> 1997 </div> 1998 </div> 1999 </dl> 2000 </dd> 2001 2002 <!-- OBJECT METHODS --> 2003 <dd style="display: none; "> 2004 <div></div> 2005 </dd> 2006 2007 <!-- OBJECT EVENT FIELDS --> 2008 <dd style="display: none; "> 2009 <div></div> 2010 </dd> 2011 2012 <!-- FUNCTION PARAMETERS --> 2013 <dd style="display: none; "> 2014 <div></div> 2015 </dd> 2016 2017 </div> 2018 </div><div> 2019 <div> 2020 <dt> 2021 <var>storeId</var> 2022 <em> 2023 2024 <!-- TYPE --> 2025 <div style="display:inline"> 2026 ( 2027 <span class="optional">optional</span> 2028 <span class="enum" style="display: none; ">enumerated</span> 2029 <span id="typeTemplate"> 2030 <span style="display: none; "> 2031 <a> Type</a> 2032 </span> 2033 <span> 2034 <span style="display: none; "> 2035 array of <span><span></span></span> 2036 </span> 2037 <span>string</span> 2038 <span style="display: none; "></span> 2039 </span> 2040 </span> 2041 ) 2042 </div> 2043 2044 </em> 2045 </dt> 2046 <dd class="todo" style="display: none; "> 2047 Undocumented. 2048 </dd> 2049 <dd>The ID of the cookie store to look in for the cookie. If unspecified, the cookie is looked for by default in the current execution context's cookie store.</dd> 2050 <dd style="display: none; "> 2051 This parameter was added in version 2052 <b><span></span></b>. 2053 You must omit this parameter in earlier versions, 2054 and you may omit it in any version. If you require this 2055 parameter, the manifest key 2056 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2057 can ensure that your extension won't be run in an earlier browser version. 2058 </dd> 2059 2060 <!-- OBJECT PROPERTIES --> 2061 <dd style="display: none; "> 2062 <dl> 2063 <div> 2064 <div> 2065 </div> 2066 </div> 2067 </dl> 2068 </dd> 2069 2070 <!-- OBJECT METHODS --> 2071 <dd style="display: none; "> 2072 <div></div> 2073 </dd> 2074 2075 <!-- OBJECT EVENT FIELDS --> 2076 <dd style="display: none; "> 2077 <div></div> 2078 </dd> 2079 2080 <!-- FUNCTION PARAMETERS --> 2081 <dd style="display: none; "> 2082 <div></div> 2083 </dd> 2084 2085 </div> 2086 </div> 2087 </dl> 2088 </dd> 2089 2090 <!-- OBJECT METHODS --> 2091 <dd style="display: none; "> 2092 <div></div> 2093 </dd> 2094 2095 <!-- OBJECT EVENT FIELDS --> 2096 <dd style="display: none; "> 2097 <div></div> 2098 </dd> 2099 2100 <!-- FUNCTION PARAMETERS --> 2101 <dd style="display: none; "> 2102 <div></div> 2103 </dd> 2104 2105 </div> 2106 </div><div> 2107 <div> 2108 <dt> 2109 <var>callback</var> 2110 <em> 2111 2112 <!-- TYPE --> 2113 <div style="display:inline"> 2114 ( 2115 <span class="optional">optional</span> 2116 <span class="enum" style="display: none; ">enumerated</span> 2117 <span id="typeTemplate"> 2118 <span style="display: none; "> 2119 <a> Type</a> 2120 </span> 2121 <span> 2122 <span style="display: none; "> 2123 array of <span><span></span></span> 2124 </span> 2125 <span>function</span> 2126 <span style="display: none; "></span> 2127 </span> 2128 </span> 2129 ) 2130 </div> 2131 2132 </em> 2133 </dt> 2134 <dd class="todo"> 2135 Undocumented. 2136 </dd> 2137 <dd style="display: none; "> 2138 Description of this parameter from the json schema. 2139 </dd> 2140 <dd> 2141 This parameter was added in version 2142 <b><span>11.0.674.0</span></b>. 2143 You must omit this parameter in earlier versions, 2144 and you may omit it in any version. If you require this 2145 parameter, the manifest key 2146 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2147 can ensure that your extension won't be run in an earlier browser version. 2148 </dd> 2149 2150 <!-- OBJECT PROPERTIES --> 2151 <dd style="display: none; "> 2152 <dl> 2153 <div> 2154 <div> 2155 </div> 2156 </div> 2157 </dl> 2158 </dd> 2159 2160 <!-- OBJECT METHODS --> 2161 <dd style="display: none; "> 2162 <div></div> 2163 </dd> 2164 2165 <!-- OBJECT EVENT FIELDS --> 2166 <dd style="display: none; "> 2167 <div></div> 2168 </dd> 2169 2170 <!-- FUNCTION PARAMETERS --> 2171 <dd style="display: none; "> 2172 <div></div> 2173 </dd> 2174 2175 </div> 2176 </div> 2177 </dl> 2178 2179 <!-- RETURNS --> 2180 <h4 style="display: none; ">Returns</h4> 2181 <dl> 2182 <div style="display: none; "> 2183 <div> 2184 </div> 2185 </div> 2186 </dl> 2187 2188 <!-- CALLBACK --> 2189 <div> 2190 <div> 2191 <h4>Callback function</h4> 2192 <p style="display: none; "> 2193 The callback <em>parameter</em> should specify a function 2194 that looks like this: 2195 </p> 2196 <p> 2197 If you specify the <em>callback</em> parameter, it should 2198 specify a function that looks like this: 2199 </p> 2200 2201 <!-- Note: intentionally longer 80 columns --> 2202 <pre>function(<span>object details</span>) <span class="subdued">{...}</span>;</pre> 2203 <dl> 2204 <div> 2205 <div> 2206 <dt> 2207 <var>details</var> 2208 <em> 2209 2210 <!-- TYPE --> 2211 <div style="display:inline"> 2212 ( 2213 <span class="optional">optional</span> 2214 <span class="enum" style="display: none; ">enumerated</span> 2215 <span id="typeTemplate"> 2216 <span style="display: none; "> 2217 <a> Type</a> 2218 </span> 2219 <span> 2220 <span style="display: none; "> 2221 array of <span><span></span></span> 2222 </span> 2223 <span>object</span> 2224 <span style="display: none; "></span> 2225 </span> 2226 </span> 2227 ) 2228 </div> 2229 2230 </em> 2231 </dt> 2232 <dd class="todo" style="display: none; "> 2233 Undocumented. 2234 </dd> 2235 <dd>Contains details about the cookie that's been removed. If removal failed for any reason, this will be "null", and "chrome.extension.lastError" will be set.</dd> 2236 <dd style="display: none; "> 2237 This parameter was added in version 2238 <b><span></span></b>. 2239 You must omit this parameter in earlier versions, 2240 and you may omit it in any version. If you require this 2241 parameter, the manifest key 2242 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2243 can ensure that your extension won't be run in an earlier browser version. 2244 </dd> 2245 2246 <!-- OBJECT PROPERTIES --> 2247 <dd> 2248 <dl> 2249 <div> 2250 <div> 2251 <dt> 2252 <var>url</var> 2253 <em> 2254 2255 <!-- TYPE --> 2256 <div style="display:inline"> 2257 ( 2258 <span class="optional" style="display: none; ">optional</span> 2259 <span class="enum" style="display: none; ">enumerated</span> 2260 <span id="typeTemplate"> 2261 <span style="display: none; "> 2262 <a> Type</a> 2263 </span> 2264 <span> 2265 <span style="display: none; "> 2266 array of <span><span></span></span> 2267 </span> 2268 <span>string</span> 2269 <span style="display: none; "></span> 2270 </span> 2271 </span> 2272 ) 2273 </div> 2274 2275 </em> 2276 </dt> 2277 <dd class="todo" style="display: none; "> 2278 Undocumented. 2279 </dd> 2280 <dd>The URL associated with the cookie that's been removed.</dd> 2281 <dd style="display: none; "> 2282 This parameter was added in version 2283 <b><span></span></b>. 2284 You must omit this parameter in earlier versions, 2285 and you may omit it in any version. If you require this 2286 parameter, the manifest key 2287 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2288 can ensure that your extension won't be run in an earlier browser version. 2289 </dd> 2290 2291 <!-- OBJECT PROPERTIES --> 2292 <dd style="display: none; "> 2293 <dl> 2294 <div> 2295 <div> 2296 </div> 2297 </div> 2298 </dl> 2299 </dd> 2300 2301 <!-- OBJECT METHODS --> 2302 <dd style="display: none; "> 2303 <div></div> 2304 </dd> 2305 2306 <!-- OBJECT EVENT FIELDS --> 2307 <dd style="display: none; "> 2308 <div></div> 2309 </dd> 2310 2311 <!-- FUNCTION PARAMETERS --> 2312 <dd style="display: none; "> 2313 <div></div> 2314 </dd> 2315 2316 </div> 2317 </div><div> 2318 <div> 2319 <dt> 2320 <var>name</var> 2321 <em> 2322 2323 <!-- TYPE --> 2324 <div style="display:inline"> 2325 ( 2326 <span class="optional" style="display: none; ">optional</span> 2327 <span class="enum" style="display: none; ">enumerated</span> 2328 <span id="typeTemplate"> 2329 <span style="display: none; "> 2330 <a> Type</a> 2331 </span> 2332 <span> 2333 <span style="display: none; "> 2334 array of <span><span></span></span> 2335 </span> 2336 <span>string</span> 2337 <span style="display: none; "></span> 2338 </span> 2339 </span> 2340 ) 2341 </div> 2342 2343 </em> 2344 </dt> 2345 <dd class="todo" style="display: none; "> 2346 Undocumented. 2347 </dd> 2348 <dd>The name of the cookie that's been removed.</dd> 2349 <dd style="display: none; "> 2350 This parameter was added in version 2351 <b><span></span></b>. 2352 You must omit this parameter in earlier versions, 2353 and you may omit it in any version. If you require this 2354 parameter, the manifest key 2355 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2356 can ensure that your extension won't be run in an earlier browser version. 2357 </dd> 2358 2359 <!-- OBJECT PROPERTIES --> 2360 <dd style="display: none; "> 2361 <dl> 2362 <div> 2363 <div> 2364 </div> 2365 </div> 2366 </dl> 2367 </dd> 2368 2369 <!-- OBJECT METHODS --> 2370 <dd style="display: none; "> 2371 <div></div> 2372 </dd> 2373 2374 <!-- OBJECT EVENT FIELDS --> 2375 <dd style="display: none; "> 2376 <div></div> 2377 </dd> 2378 2379 <!-- FUNCTION PARAMETERS --> 2380 <dd style="display: none; "> 2381 <div></div> 2382 </dd> 2383 2384 </div> 2385 </div><div> 2386 <div> 2387 <dt> 2388 <var>storeId</var> 2389 <em> 2390 2391 <!-- TYPE --> 2392 <div style="display:inline"> 2393 ( 2394 <span class="optional" style="display: none; ">optional</span> 2395 <span class="enum" style="display: none; ">enumerated</span> 2396 <span id="typeTemplate"> 2397 <span style="display: none; "> 2398 <a> Type</a> 2399 </span> 2400 <span> 2401 <span style="display: none; "> 2402 array of <span><span></span></span> 2403 </span> 2404 <span>string</span> 2405 <span style="display: none; "></span> 2406 </span> 2407 </span> 2408 ) 2409 </div> 2410 2411 </em> 2412 </dt> 2413 <dd class="todo" style="display: none; "> 2414 Undocumented. 2415 </dd> 2416 <dd>The ID of the cookie store from which the cookie was removed.</dd> 2417 <dd style="display: none; "> 2418 This parameter was added in version 2419 <b><span></span></b>. 2420 You must omit this parameter in earlier versions, 2421 and you may omit it in any version. If you require this 2422 parameter, the manifest key 2423 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2424 can ensure that your extension won't be run in an earlier browser version. 2425 </dd> 2426 2427 <!-- OBJECT PROPERTIES --> 2428 <dd style="display: none; "> 2429 <dl> 2430 <div> 2431 <div> 2432 </div> 2433 </div> 2434 </dl> 2435 </dd> 2436 2437 <!-- OBJECT METHODS --> 2438 <dd style="display: none; "> 2439 <div></div> 2440 </dd> 2441 2442 <!-- OBJECT EVENT FIELDS --> 2443 <dd style="display: none; "> 2444 <div></div> 2445 </dd> 2446 2447 <!-- FUNCTION PARAMETERS --> 2448 <dd style="display: none; "> 2449 <div></div> 2450 </dd> 2451 2452 </div> 2453 </div> 2454 </dl> 2455 </dd> 2456 2457 <!-- OBJECT METHODS --> 2458 <dd style="display: none; "> 2459 <div></div> 2460 </dd> 2461 2462 <!-- OBJECT EVENT FIELDS --> 2463 <dd style="display: none; "> 2464 <div></div> 2465 </dd> 2466 2467 <!-- FUNCTION PARAMETERS --> 2468 <dd style="display: none; "> 2469 <div></div> 2470 </dd> 2471 2472 </div> 2473 </div> 2474 </dl> 2475 </div> 2476 </div> 2477 2478 <!-- MIN_VERSION --> 2479 <p style="display: none; "> 2480 This function was added in version <b><span></span></b>. 2481 If you require this function, the manifest key 2482 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2483 can ensure that your extension won't be run in an earlier browser version. 2484 </p> 2485 </div> <!-- /description --> 2486 2487 </div><div class="apiItem"> 2488 <a name="method-set"></a> <!-- method-anchor --> 2489 <h4>set</h4> 2490 2491 <div class="summary"><span style="display: none; ">void</span> 2492 <!-- Note: intentionally longer 80 columns --> 2493 <span>chrome.cookies.set</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 2494 <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> 2495 <var><span>callback</span></var></span>)</div> 2496 2497 <div class="description"> 2498 <p class="todo" style="display: none; ">Undocumented.</p> 2499 <p>Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.</p> 2500 2501 <!-- PARAMETERS --> 2502 <h4>Parameters</h4> 2503 <dl> 2504 <div> 2505 <div> 2506 <dt> 2507 <var>details</var> 2508 <em> 2509 2510 <!-- TYPE --> 2511 <div style="display:inline"> 2512 ( 2513 <span class="optional" style="display: none; ">optional</span> 2514 <span class="enum" style="display: none; ">enumerated</span> 2515 <span id="typeTemplate"> 2516 <span style="display: none; "> 2517 <a> Type</a> 2518 </span> 2519 <span> 2520 <span style="display: none; "> 2521 array of <span><span></span></span> 2522 </span> 2523 <span>object</span> 2524 <span style="display: none; "></span> 2525 </span> 2526 </span> 2527 ) 2528 </div> 2529 2530 </em> 2531 </dt> 2532 <dd class="todo" style="display: none; "> 2533 Undocumented. 2534 </dd> 2535 <dd>Details about the cookie being set.</dd> 2536 <dd style="display: none; "> 2537 This parameter was added in version 2538 <b><span></span></b>. 2539 You must omit this parameter in earlier versions, 2540 and you may omit it in any version. If you require this 2541 parameter, the manifest key 2542 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2543 can ensure that your extension won't be run in an earlier browser version. 2544 </dd> 2545 2546 <!-- OBJECT PROPERTIES --> 2547 <dd> 2548 <dl> 2549 <div> 2550 <div> 2551 <dt> 2552 <var>url</var> 2553 <em> 2554 2555 <!-- TYPE --> 2556 <div style="display:inline"> 2557 ( 2558 <span class="optional" style="display: none; ">optional</span> 2559 <span class="enum" style="display: none; ">enumerated</span> 2560 <span id="typeTemplate"> 2561 <span style="display: none; "> 2562 <a> Type</a> 2563 </span> 2564 <span> 2565 <span style="display: none; "> 2566 array of <span><span></span></span> 2567 </span> 2568 <span>string</span> 2569 <span style="display: none; "></span> 2570 </span> 2571 </span> 2572 ) 2573 </div> 2574 2575 </em> 2576 </dt> 2577 <dd class="todo" style="display: none; "> 2578 Undocumented. 2579 </dd> 2580 <dd>The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.</dd> 2581 <dd style="display: none; "> 2582 This parameter was added in version 2583 <b><span></span></b>. 2584 You must omit this parameter in earlier versions, 2585 and you may omit it in any version. If you require this 2586 parameter, the manifest key 2587 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2588 can ensure that your extension won't be run in an earlier browser version. 2589 </dd> 2590 2591 <!-- OBJECT PROPERTIES --> 2592 <dd style="display: none; "> 2593 <dl> 2594 <div> 2595 <div> 2596 </div> 2597 </div> 2598 </dl> 2599 </dd> 2600 2601 <!-- OBJECT METHODS --> 2602 <dd style="display: none; "> 2603 <div></div> 2604 </dd> 2605 2606 <!-- OBJECT EVENT FIELDS --> 2607 <dd style="display: none; "> 2608 <div></div> 2609 </dd> 2610 2611 <!-- FUNCTION PARAMETERS --> 2612 <dd style="display: none; "> 2613 <div></div> 2614 </dd> 2615 2616 </div> 2617 </div><div> 2618 <div> 2619 <dt> 2620 <var>name</var> 2621 <em> 2622 2623 <!-- TYPE --> 2624 <div style="display:inline"> 2625 ( 2626 <span class="optional">optional</span> 2627 <span class="enum" style="display: none; ">enumerated</span> 2628 <span id="typeTemplate"> 2629 <span style="display: none; "> 2630 <a> Type</a> 2631 </span> 2632 <span> 2633 <span style="display: none; "> 2634 array of <span><span></span></span> 2635 </span> 2636 <span>string</span> 2637 <span style="display: none; "></span> 2638 </span> 2639 </span> 2640 ) 2641 </div> 2642 2643 </em> 2644 </dt> 2645 <dd class="todo" style="display: none; "> 2646 Undocumented. 2647 </dd> 2648 <dd>The name of the cookie. Empty by default if omitted.</dd> 2649 <dd style="display: none; "> 2650 This parameter was added in version 2651 <b><span></span></b>. 2652 You must omit this parameter in earlier versions, 2653 and you may omit it in any version. If you require this 2654 parameter, the manifest key 2655 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2656 can ensure that your extension won't be run in an earlier browser version. 2657 </dd> 2658 2659 <!-- OBJECT PROPERTIES --> 2660 <dd style="display: none; "> 2661 <dl> 2662 <div> 2663 <div> 2664 </div> 2665 </div> 2666 </dl> 2667 </dd> 2668 2669 <!-- OBJECT METHODS --> 2670 <dd style="display: none; "> 2671 <div></div> 2672 </dd> 2673 2674 <!-- OBJECT EVENT FIELDS --> 2675 <dd style="display: none; "> 2676 <div></div> 2677 </dd> 2678 2679 <!-- FUNCTION PARAMETERS --> 2680 <dd style="display: none; "> 2681 <div></div> 2682 </dd> 2683 2684 </div> 2685 </div><div> 2686 <div> 2687 <dt> 2688 <var>value</var> 2689 <em> 2690 2691 <!-- TYPE --> 2692 <div style="display:inline"> 2693 ( 2694 <span class="optional">optional</span> 2695 <span class="enum" style="display: none; ">enumerated</span> 2696 <span id="typeTemplate"> 2697 <span style="display: none; "> 2698 <a> Type</a> 2699 </span> 2700 <span> 2701 <span style="display: none; "> 2702 array of <span><span></span></span> 2703 </span> 2704 <span>string</span> 2705 <span style="display: none; "></span> 2706 </span> 2707 </span> 2708 ) 2709 </div> 2710 2711 </em> 2712 </dt> 2713 <dd class="todo" style="display: none; "> 2714 Undocumented. 2715 </dd> 2716 <dd>The value of the cookie. Empty by default if omitted.</dd> 2717 <dd style="display: none; "> 2718 This parameter was added in version 2719 <b><span></span></b>. 2720 You must omit this parameter in earlier versions, 2721 and you may omit it in any version. If you require this 2722 parameter, the manifest key 2723 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2724 can ensure that your extension won't be run in an earlier browser version. 2725 </dd> 2726 2727 <!-- OBJECT PROPERTIES --> 2728 <dd style="display: none; "> 2729 <dl> 2730 <div> 2731 <div> 2732 </div> 2733 </div> 2734 </dl> 2735 </dd> 2736 2737 <!-- OBJECT METHODS --> 2738 <dd style="display: none; "> 2739 <div></div> 2740 </dd> 2741 2742 <!-- OBJECT EVENT FIELDS --> 2743 <dd style="display: none; "> 2744 <div></div> 2745 </dd> 2746 2747 <!-- FUNCTION PARAMETERS --> 2748 <dd style="display: none; "> 2749 <div></div> 2750 </dd> 2751 2752 </div> 2753 </div><div> 2754 <div> 2755 <dt> 2756 <var>domain</var> 2757 <em> 2758 2759 <!-- TYPE --> 2760 <div style="display:inline"> 2761 ( 2762 <span class="optional">optional</span> 2763 <span class="enum" style="display: none; ">enumerated</span> 2764 <span id="typeTemplate"> 2765 <span style="display: none; "> 2766 <a> Type</a> 2767 </span> 2768 <span> 2769 <span style="display: none; "> 2770 array of <span><span></span></span> 2771 </span> 2772 <span>string</span> 2773 <span style="display: none; "></span> 2774 </span> 2775 </span> 2776 ) 2777 </div> 2778 2779 </em> 2780 </dt> 2781 <dd class="todo" style="display: none; "> 2782 Undocumented. 2783 </dd> 2784 <dd>The domain of the cookie. If omitted, the cookie becomes a host-only cookie.</dd> 2785 <dd style="display: none; "> 2786 This parameter was added in version 2787 <b><span></span></b>. 2788 You must omit this parameter in earlier versions, 2789 and you may omit it in any version. If you require this 2790 parameter, the manifest key 2791 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2792 can ensure that your extension won't be run in an earlier browser version. 2793 </dd> 2794 2795 <!-- OBJECT PROPERTIES --> 2796 <dd style="display: none; "> 2797 <dl> 2798 <div> 2799 <div> 2800 </div> 2801 </div> 2802 </dl> 2803 </dd> 2804 2805 <!-- OBJECT METHODS --> 2806 <dd style="display: none; "> 2807 <div></div> 2808 </dd> 2809 2810 <!-- OBJECT EVENT FIELDS --> 2811 <dd style="display: none; "> 2812 <div></div> 2813 </dd> 2814 2815 <!-- FUNCTION PARAMETERS --> 2816 <dd style="display: none; "> 2817 <div></div> 2818 </dd> 2819 2820 </div> 2821 </div><div> 2822 <div> 2823 <dt> 2824 <var>path</var> 2825 <em> 2826 2827 <!-- TYPE --> 2828 <div style="display:inline"> 2829 ( 2830 <span class="optional">optional</span> 2831 <span class="enum" style="display: none; ">enumerated</span> 2832 <span id="typeTemplate"> 2833 <span style="display: none; "> 2834 <a> Type</a> 2835 </span> 2836 <span> 2837 <span style="display: none; "> 2838 array of <span><span></span></span> 2839 </span> 2840 <span>string</span> 2841 <span style="display: none; "></span> 2842 </span> 2843 </span> 2844 ) 2845 </div> 2846 2847 </em> 2848 </dt> 2849 <dd class="todo" style="display: none; "> 2850 Undocumented. 2851 </dd> 2852 <dd>The path of the cookie. Defaults to the path portion of the url parameter.</dd> 2853 <dd style="display: none; "> 2854 This parameter was added in version 2855 <b><span></span></b>. 2856 You must omit this parameter in earlier versions, 2857 and you may omit it in any version. If you require this 2858 parameter, the manifest key 2859 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2860 can ensure that your extension won't be run in an earlier browser version. 2861 </dd> 2862 2863 <!-- OBJECT PROPERTIES --> 2864 <dd style="display: none; "> 2865 <dl> 2866 <div> 2867 <div> 2868 </div> 2869 </div> 2870 </dl> 2871 </dd> 2872 2873 <!-- OBJECT METHODS --> 2874 <dd style="display: none; "> 2875 <div></div> 2876 </dd> 2877 2878 <!-- OBJECT EVENT FIELDS --> 2879 <dd style="display: none; "> 2880 <div></div> 2881 </dd> 2882 2883 <!-- FUNCTION PARAMETERS --> 2884 <dd style="display: none; "> 2885 <div></div> 2886 </dd> 2887 2888 </div> 2889 </div><div> 2890 <div> 2891 <dt> 2892 <var>secure</var> 2893 <em> 2894 2895 <!-- TYPE --> 2896 <div style="display:inline"> 2897 ( 2898 <span class="optional">optional</span> 2899 <span class="enum" style="display: none; ">enumerated</span> 2900 <span id="typeTemplate"> 2901 <span style="display: none; "> 2902 <a> Type</a> 2903 </span> 2904 <span> 2905 <span style="display: none; "> 2906 array of <span><span></span></span> 2907 </span> 2908 <span>boolean</span> 2909 <span style="display: none; "></span> 2910 </span> 2911 </span> 2912 ) 2913 </div> 2914 2915 </em> 2916 </dt> 2917 <dd class="todo" style="display: none; "> 2918 Undocumented. 2919 </dd> 2920 <dd>Whether the cookie should be marked as Secure. Defaults to false.</dd> 2921 <dd style="display: none; "> 2922 This parameter was added in version 2923 <b><span></span></b>. 2924 You must omit this parameter in earlier versions, 2925 and you may omit it in any version. If you require this 2926 parameter, the manifest key 2927 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2928 can ensure that your extension won't be run in an earlier browser version. 2929 </dd> 2930 2931 <!-- OBJECT PROPERTIES --> 2932 <dd style="display: none; "> 2933 <dl> 2934 <div> 2935 <div> 2936 </div> 2937 </div> 2938 </dl> 2939 </dd> 2940 2941 <!-- OBJECT METHODS --> 2942 <dd style="display: none; "> 2943 <div></div> 2944 </dd> 2945 2946 <!-- OBJECT EVENT FIELDS --> 2947 <dd style="display: none; "> 2948 <div></div> 2949 </dd> 2950 2951 <!-- FUNCTION PARAMETERS --> 2952 <dd style="display: none; "> 2953 <div></div> 2954 </dd> 2955 2956 </div> 2957 </div><div> 2958 <div> 2959 <dt> 2960 <var>httpOnly</var> 2961 <em> 2962 2963 <!-- TYPE --> 2964 <div style="display:inline"> 2965 ( 2966 <span class="optional">optional</span> 2967 <span class="enum" style="display: none; ">enumerated</span> 2968 <span id="typeTemplate"> 2969 <span style="display: none; "> 2970 <a> Type</a> 2971 </span> 2972 <span> 2973 <span style="display: none; "> 2974 array of <span><span></span></span> 2975 </span> 2976 <span>boolean</span> 2977 <span style="display: none; "></span> 2978 </span> 2979 </span> 2980 ) 2981 </div> 2982 2983 </em> 2984 </dt> 2985 <dd class="todo" style="display: none; "> 2986 Undocumented. 2987 </dd> 2988 <dd>Whether the cookie should be marked as HttpOnly. Defaults to false.</dd> 2989 <dd style="display: none; "> 2990 This parameter was added in version 2991 <b><span></span></b>. 2992 You must omit this parameter in earlier versions, 2993 and you may omit it in any version. If you require this 2994 parameter, the manifest key 2995 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2996 can ensure that your extension won't be run in an earlier browser version. 2997 </dd> 2998 2999 <!-- OBJECT PROPERTIES --> 3000 <dd style="display: none; "> 3001 <dl> 3002 <div> 3003 <div> 3004 </div> 3005 </div> 3006 </dl> 3007 </dd> 3008 3009 <!-- OBJECT METHODS --> 3010 <dd style="display: none; "> 3011 <div></div> 3012 </dd> 3013 3014 <!-- OBJECT EVENT FIELDS --> 3015 <dd style="display: none; "> 3016 <div></div> 3017 </dd> 3018 3019 <!-- FUNCTION PARAMETERS --> 3020 <dd style="display: none; "> 3021 <div></div> 3022 </dd> 3023 3024 </div> 3025 </div><div> 3026 <div> 3027 <dt> 3028 <var>expirationDate</var> 3029 <em> 3030 3031 <!-- TYPE --> 3032 <div style="display:inline"> 3033 ( 3034 <span class="optional">optional</span> 3035 <span class="enum" style="display: none; ">enumerated</span> 3036 <span id="typeTemplate"> 3037 <span style="display: none; "> 3038 <a> Type</a> 3039 </span> 3040 <span> 3041 <span style="display: none; "> 3042 array of <span><span></span></span> 3043 </span> 3044 <span>number</span> 3045 <span style="display: none; "></span> 3046 </span> 3047 </span> 3048 ) 3049 </div> 3050 3051 </em> 3052 </dt> 3053 <dd class="todo" style="display: none; "> 3054 Undocumented. 3055 </dd> 3056 <dd>The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie.</dd> 3057 <dd style="display: none; "> 3058 This parameter was added in version 3059 <b><span></span></b>. 3060 You must omit this parameter in earlier versions, 3061 and you may omit it in any version. If you require this 3062 parameter, the manifest key 3063 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3064 can ensure that your extension won't be run in an earlier browser version. 3065 </dd> 3066 3067 <!-- OBJECT PROPERTIES --> 3068 <dd style="display: none; "> 3069 <dl> 3070 <div> 3071 <div> 3072 </div> 3073 </div> 3074 </dl> 3075 </dd> 3076 3077 <!-- OBJECT METHODS --> 3078 <dd style="display: none; "> 3079 <div></div> 3080 </dd> 3081 3082 <!-- OBJECT EVENT FIELDS --> 3083 <dd style="display: none; "> 3084 <div></div> 3085 </dd> 3086 3087 <!-- FUNCTION PARAMETERS --> 3088 <dd style="display: none; "> 3089 <div></div> 3090 </dd> 3091 3092 </div> 3093 </div><div> 3094 <div> 3095 <dt> 3096 <var>storeId</var> 3097 <em> 3098 3099 <!-- TYPE --> 3100 <div style="display:inline"> 3101 ( 3102 <span class="optional">optional</span> 3103 <span class="enum" style="display: none; ">enumerated</span> 3104 <span id="typeTemplate"> 3105 <span style="display: none; "> 3106 <a> Type</a> 3107 </span> 3108 <span> 3109 <span style="display: none; "> 3110 array of <span><span></span></span> 3111 </span> 3112 <span>string</span> 3113 <span style="display: none; "></span> 3114 </span> 3115 </span> 3116 ) 3117 </div> 3118 3119 </em> 3120 </dt> 3121 <dd class="todo" style="display: none; "> 3122 Undocumented. 3123 </dd> 3124 <dd>The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's cookie store.</dd> 3125 <dd style="display: none; "> 3126 This parameter was added in version 3127 <b><span></span></b>. 3128 You must omit this parameter in earlier versions, 3129 and you may omit it in any version. If you require this 3130 parameter, the manifest key 3131 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3132 can ensure that your extension won't be run in an earlier browser version. 3133 </dd> 3134 3135 <!-- OBJECT PROPERTIES --> 3136 <dd style="display: none; "> 3137 <dl> 3138 <div> 3139 <div> 3140 </div> 3141 </div> 3142 </dl> 3143 </dd> 3144 3145 <!-- OBJECT METHODS --> 3146 <dd style="display: none; "> 3147 <div></div> 3148 </dd> 3149 3150 <!-- OBJECT EVENT FIELDS --> 3151 <dd style="display: none; "> 3152 <div></div> 3153 </dd> 3154 3155 <!-- FUNCTION PARAMETERS --> 3156 <dd style="display: none; "> 3157 <div></div> 3158 </dd> 3159 3160 </div> 3161 </div> 3162 </dl> 3163 </dd> 3164 3165 <!-- OBJECT METHODS --> 3166 <dd style="display: none; "> 3167 <div></div> 3168 </dd> 3169 3170 <!-- OBJECT EVENT FIELDS --> 3171 <dd style="display: none; "> 3172 <div></div> 3173 </dd> 3174 3175 <!-- FUNCTION PARAMETERS --> 3176 <dd style="display: none; "> 3177 <div></div> 3178 </dd> 3179 3180 </div> 3181 </div><div> 3182 <div> 3183 <dt> 3184 <var>callback</var> 3185 <em> 3186 3187 <!-- TYPE --> 3188 <div style="display:inline"> 3189 ( 3190 <span class="optional">optional</span> 3191 <span class="enum" style="display: none; ">enumerated</span> 3192 <span id="typeTemplate"> 3193 <span style="display: none; "> 3194 <a> Type</a> 3195 </span> 3196 <span> 3197 <span style="display: none; "> 3198 array of <span><span></span></span> 3199 </span> 3200 <span>function</span> 3201 <span style="display: none; "></span> 3202 </span> 3203 </span> 3204 ) 3205 </div> 3206 3207 </em> 3208 </dt> 3209 <dd class="todo"> 3210 Undocumented. 3211 </dd> 3212 <dd style="display: none; "> 3213 Description of this parameter from the json schema. 3214 </dd> 3215 <dd> 3216 This parameter was added in version 3217 <b><span>11.0.674.0</span></b>. 3218 You must omit this parameter in earlier versions, 3219 and you may omit it in any version. If you require this 3220 parameter, the manifest key 3221 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3222 can ensure that your extension won't be run in an earlier browser version. 3223 </dd> 3224 3225 <!-- OBJECT PROPERTIES --> 3226 <dd style="display: none; "> 3227 <dl> 3228 <div> 3229 <div> 3230 </div> 3231 </div> 3232 </dl> 3233 </dd> 3234 3235 <!-- OBJECT METHODS --> 3236 <dd style="display: none; "> 3237 <div></div> 3238 </dd> 3239 3240 <!-- OBJECT EVENT FIELDS --> 3241 <dd style="display: none; "> 3242 <div></div> 3243 </dd> 3244 3245 <!-- FUNCTION PARAMETERS --> 3246 <dd style="display: none; "> 3247 <div></div> 3248 </dd> 3249 3250 </div> 3251 </div> 3252 </dl> 3253 3254 <!-- RETURNS --> 3255 <h4 style="display: none; ">Returns</h4> 3256 <dl> 3257 <div style="display: none; "> 3258 <div> 3259 </div> 3260 </div> 3261 </dl> 3262 3263 <!-- CALLBACK --> 3264 <div> 3265 <div> 3266 <h4>Callback function</h4> 3267 <p style="display: none; "> 3268 The callback <em>parameter</em> should specify a function 3269 that looks like this: 3270 </p> 3271 <p> 3272 If you specify the <em>callback</em> parameter, it should 3273 specify a function that looks like this: 3274 </p> 3275 3276 <!-- Note: intentionally longer 80 columns --> 3277 <pre>function(<span>Cookie cookie</span>) <span class="subdued">{...}</span>;</pre> 3278 <dl> 3279 <div> 3280 <div> 3281 <dt> 3282 <var>cookie</var> 3283 <em> 3284 3285 <!-- TYPE --> 3286 <div style="display:inline"> 3287 ( 3288 <span class="optional">optional</span> 3289 <span class="enum" style="display: none; ">enumerated</span> 3290 <span id="typeTemplate"> 3291 <span> 3292 <a href="cookies.html#type-Cookie">Cookie</a> 3293 </span> 3294 <span style="display: none; "> 3295 <span> 3296 array of <span><span></span></span> 3297 </span> 3298 <span>paramType</span> 3299 <span></span> 3300 </span> 3301 </span> 3302 ) 3303 </div> 3304 3305 </em> 3306 </dt> 3307 <dd class="todo" style="display: none; "> 3308 Undocumented. 3309 </dd> 3310 <dd>Contains details about the cookie that's been set. If setting failed for any reason, this will be "null", and "chrome.extension.lastError" will be set.</dd> 3311 <dd style="display: none; "> 3312 This parameter was added in version 3313 <b><span></span></b>. 3314 You must omit this parameter in earlier versions, 3315 and you may omit it in any version. If you require this 3316 parameter, the manifest key 3317 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3318 can ensure that your extension won't be run in an earlier browser version. 3319 </dd> 3320 3321 <!-- OBJECT PROPERTIES --> 3322 <dd style="display: none; "> 3323 <dl> 3324 <div> 3325 <div> 3326 </div> 3327 </div> 3328 </dl> 3329 </dd> 3330 3331 <!-- OBJECT METHODS --> 3332 <dd style="display: none; "> 3333 <div></div> 3334 </dd> 3335 3336 <!-- OBJECT EVENT FIELDS --> 3337 <dd style="display: none; "> 3338 <div></div> 3339 </dd> 3340 3341 <!-- FUNCTION PARAMETERS --> 3342 <dd style="display: none; "> 3343 <div></div> 3344 </dd> 3345 3346 </div> 3347 </div> 3348 </dl> 3349 </div> 3350 </div> 3351 3352 <!-- MIN_VERSION --> 3353 <p style="display: none; "> 3354 This function was added in version <b><span></span></b>. 3355 If you require this function, the manifest key 3356 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3357 can ensure that your extension won't be run in an earlier browser version. 3358 </p> 3359 </div> <!-- /description --> 3360 3361 </div> <!-- /apiItem --> 3362 3363 </div> <!-- /apiGroup --> 3364 3365 <!-- EVENTS --> 3366 <div id="eventsTemplate" class="apiGroup"> 3367 <a name="global-events"></a> 3368 <h3>Events</h3> 3369 <!-- iterates over all events --> 3370 <div class="apiItem"> 3371 <a name="event-onChanged"></a> 3372 <h4>onChanged</h4> 3373 3374 <div class="summary"> 3375 <!-- Note: intentionally longer 80 columns --> 3376 <span class="subdued">chrome.cookies.</span><span>onChanged</span><span class="subdued">.addListener</span>(function(<span>object changeInfo</span>) <span class="subdued">{...}</span>); 3377 </div> 3378 3379 <div class="description"> 3380 <p class="todo" style="display: none; ">Undocumented.</p> 3381 <p>Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of "overwrite" . Afterwards, a new cookie is written with the updated values, generating a second notification with "cause" "explicit".</p> 3382 3383 <!-- PARAMETERS --> 3384 <div> 3385 <h4>Parameters</h4> 3386 <dl> 3387 <div> 3388 <div> 3389 <dt> 3390 <var>changeInfo</var> 3391 <em> 3392 3393 <!-- TYPE --> 3394 <div style="display:inline"> 3395 ( 3396 <span class="optional" style="display: none; ">optional</span> 3397 <span class="enum" style="display: none; ">enumerated</span> 3398 <span id="typeTemplate"> 3399 <span style="display: none; "> 3400 <a> Type</a> 3401 </span> 3402 <span> 3403 <span style="display: none; "> 3404 array of <span><span></span></span> 3405 </span> 3406 <span>object</span> 3407 <span style="display: none; "></span> 3408 </span> 3409 </span> 3410 ) 3411 </div> 3412 3413 </em> 3414 </dt> 3415 <dd class="todo"> 3416 Undocumented. 3417 </dd> 3418 <dd style="display: none; "> 3419 Description of this parameter from the json schema. 3420 </dd> 3421 <dd style="display: none; "> 3422 This parameter was added in version 3423 <b><span></span></b>. 3424 You must omit this parameter in earlier versions, 3425 and you may omit it in any version. If you require this 3426 parameter, the manifest key 3427 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3428 can ensure that your extension won't be run in an earlier browser version. 3429 </dd> 3430 3431 <!-- OBJECT PROPERTIES --> 3432 <dd> 3433 <dl> 3434 <div> 3435 <div> 3436 <dt> 3437 <var>removed</var> 3438 <em> 3439 3440 <!-- TYPE --> 3441 <div style="display:inline"> 3442 ( 3443 <span class="optional" style="display: none; ">optional</span> 3444 <span class="enum" style="display: none; ">enumerated</span> 3445 <span id="typeTemplate"> 3446 <span style="display: none; "> 3447 <a> Type</a> 3448 </span> 3449 <span> 3450 <span style="display: none; "> 3451 array of <span><span></span></span> 3452 </span> 3453 <span>boolean</span> 3454 <span style="display: none; "></span> 3455 </span> 3456 </span> 3457 ) 3458 </div> 3459 3460 </em> 3461 </dt> 3462 <dd class="todo" style="display: none; "> 3463 Undocumented. 3464 </dd> 3465 <dd>True if a cookie was removed.</dd> 3466 <dd style="display: none; "> 3467 This parameter was added in version 3468 <b><span></span></b>. 3469 You must omit this parameter in earlier versions, 3470 and you may omit it in any version. If you require this 3471 parameter, the manifest key 3472 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3473 can ensure that your extension won't be run in an earlier browser version. 3474 </dd> 3475 3476 <!-- OBJECT PROPERTIES --> 3477 <dd style="display: none; "> 3478 <dl> 3479 <div> 3480 <div> 3481 </div> 3482 </div> 3483 </dl> 3484 </dd> 3485 3486 <!-- OBJECT METHODS --> 3487 <dd style="display: none; "> 3488 <div></div> 3489 </dd> 3490 3491 <!-- OBJECT EVENT FIELDS --> 3492 <dd style="display: none; "> 3493 <div></div> 3494 </dd> 3495 3496 <!-- FUNCTION PARAMETERS --> 3497 <dd style="display: none; "> 3498 <div></div> 3499 </dd> 3500 3501 </div> 3502 </div><div> 3503 <div> 3504 <dt> 3505 <var>cookie</var> 3506 <em> 3507 3508 <!-- TYPE --> 3509 <div style="display:inline"> 3510 ( 3511 <span class="optional" style="display: none; ">optional</span> 3512 <span class="enum" style="display: none; ">enumerated</span> 3513 <span id="typeTemplate"> 3514 <span> 3515 <a href="cookies.html#type-Cookie">Cookie</a> 3516 </span> 3517 <span style="display: none; "> 3518 <span> 3519 array of <span><span></span></span> 3520 </span> 3521 <span>paramType</span> 3522 <span></span> 3523 </span> 3524 </span> 3525 ) 3526 </div> 3527 3528 </em> 3529 </dt> 3530 <dd class="todo" style="display: none; "> 3531 Undocumented. 3532 </dd> 3533 <dd>Information about the cookie that was set or removed.</dd> 3534 <dd style="display: none; "> 3535 This parameter was added in version 3536 <b><span></span></b>. 3537 You must omit this parameter in earlier versions, 3538 and you may omit it in any version. If you require this 3539 parameter, the manifest key 3540 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3541 can ensure that your extension won't be run in an earlier browser version. 3542 </dd> 3543 3544 <!-- OBJECT PROPERTIES --> 3545 <dd style="display: none; "> 3546 <dl> 3547 <div> 3548 <div> 3549 </div> 3550 </div> 3551 </dl> 3552 </dd> 3553 3554 <!-- OBJECT METHODS --> 3555 <dd style="display: none; "> 3556 <div></div> 3557 </dd> 3558 3559 <!-- OBJECT EVENT FIELDS --> 3560 <dd style="display: none; "> 3561 <div></div> 3562 </dd> 3563 3564 <!-- FUNCTION PARAMETERS --> 3565 <dd style="display: none; "> 3566 <div></div> 3567 </dd> 3568 3569 </div> 3570 </div><div> 3571 <div> 3572 <dt> 3573 <var>cause</var> 3574 <em> 3575 3576 <!-- TYPE --> 3577 <div style="display:inline"> 3578 ( 3579 <span class="optional" style="display: none; ">optional</span> 3580 <span class="enum">enumerated</span> 3581 <span id="typeTemplate"> 3582 <span style="display: none; "> 3583 <a> Type</a> 3584 </span> 3585 <span> 3586 <span style="display: none; "> 3587 array of <span><span></span></span> 3588 </span> 3589 <span>string</span> 3590 <span>["evicted", "expired", "explicit", "expired_overwrite", "overwrite"]</span> 3591 </span> 3592 </span> 3593 ) 3594 </div> 3595 3596 </em> 3597 </dt> 3598 <dd class="todo" style="display: none; "> 3599 Undocumented. 3600 </dd> 3601 <dd>The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to "chrome.cookies.remove", "cause" will be "explicit". If a cookie was automatically removed due to expiry, "cause" will be "expired". If a cookie was removed due to being overwritten with an already-expired expiration date, "cause" will be set to "expired_overwrite". If a cookie was automatically removed due to garbage collection, "cause" will be "evicted". If a cookie was automatically removed due to a "set" call that overwrote it, "cause" will be "overwrite". Plan your response accordingly.</dd> 3602 <dd> 3603 This parameter was added in version 3604 <b><span>12.0.707.0</span></b>. 3605 You must omit this parameter in earlier versions, 3606 and you may omit it in any version. If you require this 3607 parameter, the manifest key 3608 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3609 can ensure that your extension won't be run in an earlier browser version. 3610 </dd> 3611 3612 <!-- OBJECT PROPERTIES --> 3613 <dd style="display: none; "> 3614 <dl> 3615 <div> 3616 <div> 3617 </div> 3618 </div> 3619 </dl> 3620 </dd> 3621 3622 <!-- OBJECT METHODS --> 3623 <dd style="display: none; "> 3624 <div></div> 3625 </dd> 3626 3627 <!-- OBJECT EVENT FIELDS --> 3628 <dd style="display: none; "> 3629 <div></div> 3630 </dd> 3631 3632 <!-- FUNCTION PARAMETERS --> 3633 <dd style="display: none; "> 3634 <div></div> 3635 </dd> 3636 3637 </div> 3638 </div> 3639 </dl> 3640 </dd> 3641 3642 <!-- OBJECT METHODS --> 3643 <dd style="display: none; "> 3644 <div></div> 3645 </dd> 3646 3647 <!-- OBJECT EVENT FIELDS --> 3648 <dd style="display: none; "> 3649 <div></div> 3650 </dd> 3651 3652 <!-- FUNCTION PARAMETERS --> 3653 <dd style="display: none; "> 3654 <div></div> 3655 </dd> 3656 3657 </div> 3658 </div> 3659 </dl> 3660 </div> 3661 </div> <!-- /decription --> 3662 3663 </div> <!-- /apiItem --> 3664 3665 </div> <!-- /apiGroup --> 3666 3667 <!-- TYPES --> 3668 <div class="apiGroup"> 3669 <a name="types"></a> 3670 <h3 id="types">Types</h3> 3671 3672 <!-- iterates over all types --> 3673 <div class="apiItem"> 3674 <a name="type-Cookie"></a> 3675 <h4>Cookie</h4> 3676 3677 <div> 3678 <dt> 3679 <var style="display: none; ">paramName</var> 3680 <em> 3681 3682 <!-- TYPE --> 3683 <div style="display:inline"> 3684 ( 3685 <span class="optional" style="display: none; ">optional</span> 3686 <span class="enum" style="display: none; ">enumerated</span> 3687 <span id="typeTemplate"> 3688 <span style="display: none; "> 3689 <a> Type</a> 3690 </span> 3691 <span> 3692 <span style="display: none; "> 3693 array of <span><span></span></span> 3694 </span> 3695 <span>object</span> 3696 <span style="display: none; "></span> 3697 </span> 3698 </span> 3699 ) 3700 </div> 3701 3702 </em> 3703 </dt> 3704 <dd class="todo" style="display: none; "> 3705 Undocumented. 3706 </dd> 3707 <dd>Represents information about an HTTP cookie.</dd> 3708 <dd style="display: none; "> 3709 This parameter was added in version 3710 <b><span></span></b>. 3711 You must omit this parameter in earlier versions, 3712 and you may omit it in any version. If you require this 3713 parameter, the manifest key 3714 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3715 can ensure that your extension won't be run in an earlier browser version. 3716 </dd> 3717 3718 <!-- OBJECT PROPERTIES --> 3719 <dd> 3720 <dl> 3721 <div> 3722 <div> 3723 <dt> 3724 <var>name</var> 3725 <em> 3726 3727 <!-- TYPE --> 3728 <div style="display:inline"> 3729 ( 3730 <span class="optional" style="display: none; ">optional</span> 3731 <span class="enum" style="display: none; ">enumerated</span> 3732 <span id="typeTemplate"> 3733 <span style="display: none; "> 3734 <a> Type</a> 3735 </span> 3736 <span> 3737 <span style="display: none; "> 3738 array of <span><span></span></span> 3739 </span> 3740 <span>string</span> 3741 <span style="display: none; "></span> 3742 </span> 3743 </span> 3744 ) 3745 </div> 3746 3747 </em> 3748 </dt> 3749 <dd class="todo" style="display: none; "> 3750 Undocumented. 3751 </dd> 3752 <dd>The name of the cookie.</dd> 3753 <dd style="display: none; "> 3754 This parameter was added in version 3755 <b><span></span></b>. 3756 You must omit this parameter in earlier versions, 3757 and you may omit it in any version. If you require this 3758 parameter, the manifest key 3759 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3760 can ensure that your extension won't be run in an earlier browser version. 3761 </dd> 3762 3763 <!-- OBJECT PROPERTIES --> 3764 <dd style="display: none; "> 3765 <dl> 3766 <div> 3767 <div> 3768 </div> 3769 </div> 3770 </dl> 3771 </dd> 3772 3773 <!-- OBJECT METHODS --> 3774 <dd style="display: none; "> 3775 <div></div> 3776 </dd> 3777 3778 <!-- OBJECT EVENT FIELDS --> 3779 <dd style="display: none; "> 3780 <div></div> 3781 </dd> 3782 3783 <!-- FUNCTION PARAMETERS --> 3784 <dd style="display: none; "> 3785 <div></div> 3786 </dd> 3787 3788 </div> 3789 </div><div> 3790 <div> 3791 <dt> 3792 <var>value</var> 3793 <em> 3794 3795 <!-- TYPE --> 3796 <div style="display:inline"> 3797 ( 3798 <span class="optional" style="display: none; ">optional</span> 3799 <span class="enum" style="display: none; ">enumerated</span> 3800 <span id="typeTemplate"> 3801 <span style="display: none; "> 3802 <a> Type</a> 3803 </span> 3804 <span> 3805 <span style="display: none; "> 3806 array of <span><span></span></span> 3807 </span> 3808 <span>string</span> 3809 <span style="display: none; "></span> 3810 </span> 3811 </span> 3812 ) 3813 </div> 3814 3815 </em> 3816 </dt> 3817 <dd class="todo" style="display: none; "> 3818 Undocumented. 3819 </dd> 3820 <dd>The value of the cookie.</dd> 3821 <dd style="display: none; "> 3822 This parameter was added in version 3823 <b><span></span></b>. 3824 You must omit this parameter in earlier versions, 3825 and you may omit it in any version. If you require this 3826 parameter, the manifest key 3827 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3828 can ensure that your extension won't be run in an earlier browser version. 3829 </dd> 3830 3831 <!-- OBJECT PROPERTIES --> 3832 <dd style="display: none; "> 3833 <dl> 3834 <div> 3835 <div> 3836 </div> 3837 </div> 3838 </dl> 3839 </dd> 3840 3841 <!-- OBJECT METHODS --> 3842 <dd style="display: none; "> 3843 <div></div> 3844 </dd> 3845 3846 <!-- OBJECT EVENT FIELDS --> 3847 <dd style="display: none; "> 3848 <div></div> 3849 </dd> 3850 3851 <!-- FUNCTION PARAMETERS --> 3852 <dd style="display: none; "> 3853 <div></div> 3854 </dd> 3855 3856 </div> 3857 </div><div> 3858 <div> 3859 <dt> 3860 <var>domain</var> 3861 <em> 3862 3863 <!-- TYPE --> 3864 <div style="display:inline"> 3865 ( 3866 <span class="optional" style="display: none; ">optional</span> 3867 <span class="enum" style="display: none; ">enumerated</span> 3868 <span id="typeTemplate"> 3869 <span style="display: none; "> 3870 <a> Type</a> 3871 </span> 3872 <span> 3873 <span style="display: none; "> 3874 array of <span><span></span></span> 3875 </span> 3876 <span>string</span> 3877 <span style="display: none; "></span> 3878 </span> 3879 </span> 3880 ) 3881 </div> 3882 3883 </em> 3884 </dt> 3885 <dd class="todo" style="display: none; "> 3886 Undocumented. 3887 </dd> 3888 <dd>The domain of the cookie (e.g. "www.google.com", "example.com").</dd> 3889 <dd style="display: none; "> 3890 This parameter was added in version 3891 <b><span></span></b>. 3892 You must omit this parameter in earlier versions, 3893 and you may omit it in any version. If you require this 3894 parameter, the manifest key 3895 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3896 can ensure that your extension won't be run in an earlier browser version. 3897 </dd> 3898 3899 <!-- OBJECT PROPERTIES --> 3900 <dd style="display: none; "> 3901 <dl> 3902 <div> 3903 <div> 3904 </div> 3905 </div> 3906 </dl> 3907 </dd> 3908 3909 <!-- OBJECT METHODS --> 3910 <dd style="display: none; "> 3911 <div></div> 3912 </dd> 3913 3914 <!-- OBJECT EVENT FIELDS --> 3915 <dd style="display: none; "> 3916 <div></div> 3917 </dd> 3918 3919 <!-- FUNCTION PARAMETERS --> 3920 <dd style="display: none; "> 3921 <div></div> 3922 </dd> 3923 3924 </div> 3925 </div><div> 3926 <div> 3927 <dt> 3928 <var>hostOnly</var> 3929 <em> 3930 3931 <!-- TYPE --> 3932 <div style="display:inline"> 3933 ( 3934 <span class="optional" style="display: none; ">optional</span> 3935 <span class="enum" style="display: none; ">enumerated</span> 3936 <span id="typeTemplate"> 3937 <span style="display: none; "> 3938 <a> Type</a> 3939 </span> 3940 <span> 3941 <span style="display: none; "> 3942 array of <span><span></span></span> 3943 </span> 3944 <span>boolean</span> 3945 <span style="display: none; "></span> 3946 </span> 3947 </span> 3948 ) 3949 </div> 3950 3951 </em> 3952 </dt> 3953 <dd class="todo" style="display: none; "> 3954 Undocumented. 3955 </dd> 3956 <dd>True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie).</dd> 3957 <dd style="display: none; "> 3958 This parameter was added in version 3959 <b><span></span></b>. 3960 You must omit this parameter in earlier versions, 3961 and you may omit it in any version. If you require this 3962 parameter, the manifest key 3963 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3964 can ensure that your extension won't be run in an earlier browser version. 3965 </dd> 3966 3967 <!-- OBJECT PROPERTIES --> 3968 <dd style="display: none; "> 3969 <dl> 3970 <div> 3971 <div> 3972 </div> 3973 </div> 3974 </dl> 3975 </dd> 3976 3977 <!-- OBJECT METHODS --> 3978 <dd style="display: none; "> 3979 <div></div> 3980 </dd> 3981 3982 <!-- OBJECT EVENT FIELDS --> 3983 <dd style="display: none; "> 3984 <div></div> 3985 </dd> 3986 3987 <!-- FUNCTION PARAMETERS --> 3988 <dd style="display: none; "> 3989 <div></div> 3990 </dd> 3991 3992 </div> 3993 </div><div> 3994 <div> 3995 <dt> 3996 <var>path</var> 3997 <em> 3998 3999 <!-- TYPE --> 4000 <div style="display:inline"> 4001 ( 4002 <span class="optional" style="display: none; ">optional</span> 4003 <span class="enum" style="display: none; ">enumerated</span> 4004 <span id="typeTemplate"> 4005 <span style="display: none; "> 4006 <a> Type</a> 4007 </span> 4008 <span> 4009 <span style="display: none; "> 4010 array of <span><span></span></span> 4011 </span> 4012 <span>string</span> 4013 <span style="display: none; "></span> 4014 </span> 4015 </span> 4016 ) 4017 </div> 4018 4019 </em> 4020 </dt> 4021 <dd class="todo" style="display: none; "> 4022 Undocumented. 4023 </dd> 4024 <dd>The path of the cookie.</dd> 4025 <dd style="display: none; "> 4026 This parameter was added in version 4027 <b><span></span></b>. 4028 You must omit this parameter in earlier versions, 4029 and you may omit it in any version. If you require this 4030 parameter, the manifest key 4031 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4032 can ensure that your extension won't be run in an earlier browser version. 4033 </dd> 4034 4035 <!-- OBJECT PROPERTIES --> 4036 <dd style="display: none; "> 4037 <dl> 4038 <div> 4039 <div> 4040 </div> 4041 </div> 4042 </dl> 4043 </dd> 4044 4045 <!-- OBJECT METHODS --> 4046 <dd style="display: none; "> 4047 <div></div> 4048 </dd> 4049 4050 <!-- OBJECT EVENT FIELDS --> 4051 <dd style="display: none; "> 4052 <div></div> 4053 </dd> 4054 4055 <!-- FUNCTION PARAMETERS --> 4056 <dd style="display: none; "> 4057 <div></div> 4058 </dd> 4059 4060 </div> 4061 </div><div> 4062 <div> 4063 <dt> 4064 <var>secure</var> 4065 <em> 4066 4067 <!-- TYPE --> 4068 <div style="display:inline"> 4069 ( 4070 <span class="optional" style="display: none; ">optional</span> 4071 <span class="enum" style="display: none; ">enumerated</span> 4072 <span id="typeTemplate"> 4073 <span style="display: none; "> 4074 <a> Type</a> 4075 </span> 4076 <span> 4077 <span style="display: none; "> 4078 array of <span><span></span></span> 4079 </span> 4080 <span>boolean</span> 4081 <span style="display: none; "></span> 4082 </span> 4083 </span> 4084 ) 4085 </div> 4086 4087 </em> 4088 </dt> 4089 <dd class="todo" style="display: none; "> 4090 Undocumented. 4091 </dd> 4092 <dd>True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS).</dd> 4093 <dd style="display: none; "> 4094 This parameter was added in version 4095 <b><span></span></b>. 4096 You must omit this parameter in earlier versions, 4097 and you may omit it in any version. If you require this 4098 parameter, the manifest key 4099 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4100 can ensure that your extension won't be run in an earlier browser version. 4101 </dd> 4102 4103 <!-- OBJECT PROPERTIES --> 4104 <dd style="display: none; "> 4105 <dl> 4106 <div> 4107 <div> 4108 </div> 4109 </div> 4110 </dl> 4111 </dd> 4112 4113 <!-- OBJECT METHODS --> 4114 <dd style="display: none; "> 4115 <div></div> 4116 </dd> 4117 4118 <!-- OBJECT EVENT FIELDS --> 4119 <dd style="display: none; "> 4120 <div></div> 4121 </dd> 4122 4123 <!-- FUNCTION PARAMETERS --> 4124 <dd style="display: none; "> 4125 <div></div> 4126 </dd> 4127 4128 </div> 4129 </div><div> 4130 <div> 4131 <dt> 4132 <var>httpOnly</var> 4133 <em> 4134 4135 <!-- TYPE --> 4136 <div style="display:inline"> 4137 ( 4138 <span class="optional" style="display: none; ">optional</span> 4139 <span class="enum" style="display: none; ">enumerated</span> 4140 <span id="typeTemplate"> 4141 <span style="display: none; "> 4142 <a> Type</a> 4143 </span> 4144 <span> 4145 <span style="display: none; "> 4146 array of <span><span></span></span> 4147 </span> 4148 <span>boolean</span> 4149 <span style="display: none; "></span> 4150 </span> 4151 </span> 4152 ) 4153 </div> 4154 4155 </em> 4156 </dt> 4157 <dd class="todo" style="display: none; "> 4158 Undocumented. 4159 </dd> 4160 <dd>True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts).</dd> 4161 <dd style="display: none; "> 4162 This parameter was added in version 4163 <b><span></span></b>. 4164 You must omit this parameter in earlier versions, 4165 and you may omit it in any version. If you require this 4166 parameter, the manifest key 4167 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4168 can ensure that your extension won't be run in an earlier browser version. 4169 </dd> 4170 4171 <!-- OBJECT PROPERTIES --> 4172 <dd style="display: none; "> 4173 <dl> 4174 <div> 4175 <div> 4176 </div> 4177 </div> 4178 </dl> 4179 </dd> 4180 4181 <!-- OBJECT METHODS --> 4182 <dd style="display: none; "> 4183 <div></div> 4184 </dd> 4185 4186 <!-- OBJECT EVENT FIELDS --> 4187 <dd style="display: none; "> 4188 <div></div> 4189 </dd> 4190 4191 <!-- FUNCTION PARAMETERS --> 4192 <dd style="display: none; "> 4193 <div></div> 4194 </dd> 4195 4196 </div> 4197 </div><div> 4198 <div> 4199 <dt> 4200 <var>session</var> 4201 <em> 4202 4203 <!-- TYPE --> 4204 <div style="display:inline"> 4205 ( 4206 <span class="optional" style="display: none; ">optional</span> 4207 <span class="enum" style="display: none; ">enumerated</span> 4208 <span id="typeTemplate"> 4209 <span style="display: none; "> 4210 <a> Type</a> 4211 </span> 4212 <span> 4213 <span style="display: none; "> 4214 array of <span><span></span></span> 4215 </span> 4216 <span>boolean</span> 4217 <span style="display: none; "></span> 4218 </span> 4219 </span> 4220 ) 4221 </div> 4222 4223 </em> 4224 </dt> 4225 <dd class="todo" style="display: none; "> 4226 Undocumented. 4227 </dd> 4228 <dd>True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date.</dd> 4229 <dd style="display: none; "> 4230 This parameter was added in version 4231 <b><span></span></b>. 4232 You must omit this parameter in earlier versions, 4233 and you may omit it in any version. If you require this 4234 parameter, the manifest key 4235 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4236 can ensure that your extension won't be run in an earlier browser version. 4237 </dd> 4238 4239 <!-- OBJECT PROPERTIES --> 4240 <dd style="display: none; "> 4241 <dl> 4242 <div> 4243 <div> 4244 </div> 4245 </div> 4246 </dl> 4247 </dd> 4248 4249 <!-- OBJECT METHODS --> 4250 <dd style="display: none; "> 4251 <div></div> 4252 </dd> 4253 4254 <!-- OBJECT EVENT FIELDS --> 4255 <dd style="display: none; "> 4256 <div></div> 4257 </dd> 4258 4259 <!-- FUNCTION PARAMETERS --> 4260 <dd style="display: none; "> 4261 <div></div> 4262 </dd> 4263 4264 </div> 4265 </div><div> 4266 <div> 4267 <dt> 4268 <var>expirationDate</var> 4269 <em> 4270 4271 <!-- TYPE --> 4272 <div style="display:inline"> 4273 ( 4274 <span class="optional">optional</span> 4275 <span class="enum" style="display: none; ">enumerated</span> 4276 <span id="typeTemplate"> 4277 <span style="display: none; "> 4278 <a> Type</a> 4279 </span> 4280 <span> 4281 <span style="display: none; "> 4282 array of <span><span></span></span> 4283 </span> 4284 <span>number</span> 4285 <span style="display: none; "></span> 4286 </span> 4287 </span> 4288 ) 4289 </div> 4290 4291 </em> 4292 </dt> 4293 <dd class="todo" style="display: none; "> 4294 Undocumented. 4295 </dd> 4296 <dd>The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.</dd> 4297 <dd style="display: none; "> 4298 This parameter was added in version 4299 <b><span></span></b>. 4300 You must omit this parameter in earlier versions, 4301 and you may omit it in any version. If you require this 4302 parameter, the manifest key 4303 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4304 can ensure that your extension won't be run in an earlier browser version. 4305 </dd> 4306 4307 <!-- OBJECT PROPERTIES --> 4308 <dd style="display: none; "> 4309 <dl> 4310 <div> 4311 <div> 4312 </div> 4313 </div> 4314 </dl> 4315 </dd> 4316 4317 <!-- OBJECT METHODS --> 4318 <dd style="display: none; "> 4319 <div></div> 4320 </dd> 4321 4322 <!-- OBJECT EVENT FIELDS --> 4323 <dd style="display: none; "> 4324 <div></div> 4325 </dd> 4326 4327 <!-- FUNCTION PARAMETERS --> 4328 <dd style="display: none; "> 4329 <div></div> 4330 </dd> 4331 4332 </div> 4333 </div><div> 4334 <div> 4335 <dt> 4336 <var>storeId</var> 4337 <em> 4338 4339 <!-- TYPE --> 4340 <div style="display:inline"> 4341 ( 4342 <span class="optional" style="display: none; ">optional</span> 4343 <span class="enum" style="display: none; ">enumerated</span> 4344 <span id="typeTemplate"> 4345 <span style="display: none; "> 4346 <a> Type</a> 4347 </span> 4348 <span> 4349 <span style="display: none; "> 4350 array of <span><span></span></span> 4351 </span> 4352 <span>string</span> 4353 <span style="display: none; "></span> 4354 </span> 4355 </span> 4356 ) 4357 </div> 4358 4359 </em> 4360 </dt> 4361 <dd class="todo" style="display: none; "> 4362 Undocumented. 4363 </dd> 4364 <dd>The ID of the cookie store containing this cookie, as provided in getAllCookieStores().</dd> 4365 <dd style="display: none; "> 4366 This parameter was added in version 4367 <b><span></span></b>. 4368 You must omit this parameter in earlier versions, 4369 and you may omit it in any version. If you require this 4370 parameter, the manifest key 4371 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4372 can ensure that your extension won't be run in an earlier browser version. 4373 </dd> 4374 4375 <!-- OBJECT PROPERTIES --> 4376 <dd style="display: none; "> 4377 <dl> 4378 <div> 4379 <div> 4380 </div> 4381 </div> 4382 </dl> 4383 </dd> 4384 4385 <!-- OBJECT METHODS --> 4386 <dd style="display: none; "> 4387 <div></div> 4388 </dd> 4389 4390 <!-- OBJECT EVENT FIELDS --> 4391 <dd style="display: none; "> 4392 <div></div> 4393 </dd> 4394 4395 <!-- FUNCTION PARAMETERS --> 4396 <dd style="display: none; "> 4397 <div></div> 4398 </dd> 4399 4400 </div> 4401 </div> 4402 </dl> 4403 </dd> 4404 4405 <!-- OBJECT METHODS --> 4406 <dd style="display: none; "> 4407 <div></div> 4408 </dd> 4409 4410 <!-- OBJECT EVENT FIELDS --> 4411 <dd style="display: none; "> 4412 <div></div> 4413 </dd> 4414 4415 <!-- FUNCTION PARAMETERS --> 4416 <dd style="display: none; "> 4417 <div></div> 4418 </dd> 4419 4420 </div> 4421 4422 </div><div class="apiItem"> 4423 <a name="type-CookieStore"></a> 4424 <h4>CookieStore</h4> 4425 4426 <div> 4427 <dt> 4428 <var style="display: none; ">paramName</var> 4429 <em> 4430 4431 <!-- TYPE --> 4432 <div style="display:inline"> 4433 ( 4434 <span class="optional" style="display: none; ">optional</span> 4435 <span class="enum" style="display: none; ">enumerated</span> 4436 <span id="typeTemplate"> 4437 <span style="display: none; "> 4438 <a> Type</a> 4439 </span> 4440 <span> 4441 <span style="display: none; "> 4442 array of <span><span></span></span> 4443 </span> 4444 <span>object</span> 4445 <span style="display: none; "></span> 4446 </span> 4447 </span> 4448 ) 4449 </div> 4450 4451 </em> 4452 </dt> 4453 <dd class="todo" style="display: none; "> 4454 Undocumented. 4455 </dd> 4456 <dd>Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window.</dd> 4457 <dd style="display: none; "> 4458 This parameter was added in version 4459 <b><span></span></b>. 4460 You must omit this parameter in earlier versions, 4461 and you may omit it in any version. If you require this 4462 parameter, the manifest key 4463 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4464 can ensure that your extension won't be run in an earlier browser version. 4465 </dd> 4466 4467 <!-- OBJECT PROPERTIES --> 4468 <dd> 4469 <dl> 4470 <div> 4471 <div> 4472 <dt> 4473 <var>id</var> 4474 <em> 4475 4476 <!-- TYPE --> 4477 <div style="display:inline"> 4478 ( 4479 <span class="optional" style="display: none; ">optional</span> 4480 <span class="enum" style="display: none; ">enumerated</span> 4481 <span id="typeTemplate"> 4482 <span style="display: none; "> 4483 <a> Type</a> 4484 </span> 4485 <span> 4486 <span style="display: none; "> 4487 array of <span><span></span></span> 4488 </span> 4489 <span>string</span> 4490 <span style="display: none; "></span> 4491 </span> 4492 </span> 4493 ) 4494 </div> 4495 4496 </em> 4497 </dt> 4498 <dd class="todo" style="display: none; "> 4499 Undocumented. 4500 </dd> 4501 <dd>The unique identifier for the cookie store.</dd> 4502 <dd style="display: none; "> 4503 This parameter was added in version 4504 <b><span></span></b>. 4505 You must omit this parameter in earlier versions, 4506 and you may omit it in any version. If you require this 4507 parameter, the manifest key 4508 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4509 can ensure that your extension won't be run in an earlier browser version. 4510 </dd> 4511 4512 <!-- OBJECT PROPERTIES --> 4513 <dd style="display: none; "> 4514 <dl> 4515 <div> 4516 <div> 4517 </div> 4518 </div> 4519 </dl> 4520 </dd> 4521 4522 <!-- OBJECT METHODS --> 4523 <dd style="display: none; "> 4524 <div></div> 4525 </dd> 4526 4527 <!-- OBJECT EVENT FIELDS --> 4528 <dd style="display: none; "> 4529 <div></div> 4530 </dd> 4531 4532 <!-- FUNCTION PARAMETERS --> 4533 <dd style="display: none; "> 4534 <div></div> 4535 </dd> 4536 4537 </div> 4538 </div><div> 4539 <div> 4540 <dt> 4541 <var>tabIds</var> 4542 <em> 4543 4544 <!-- TYPE --> 4545 <div style="display:inline"> 4546 ( 4547 <span class="optional" style="display: none; ">optional</span> 4548 <span class="enum" style="display: none; ">enumerated</span> 4549 <span id="typeTemplate"> 4550 <span style="display: none; "> 4551 <a> Type</a> 4552 </span> 4553 <span> 4554 <span> 4555 array of <span><span> 4556 <span style="display: none; "> 4557 <a> Type</a> 4558 </span> 4559 <span> 4560 <span style="display: none; "> 4561 array of <span><span></span></span> 4562 </span> 4563 <span>integer</span> 4564 <span style="display: none; "></span> 4565 </span> 4566 </span></span> 4567 </span> 4568 <span style="display: none; ">paramType</span> 4569 <span style="display: none; "></span> 4570 </span> 4571 </span> 4572 ) 4573 </div> 4574 4575 </em> 4576 </dt> 4577 <dd class="todo" style="display: none; "> 4578 Undocumented. 4579 </dd> 4580 <dd>Identifiers of all the browser tabs that share this cookie store.</dd> 4581 <dd style="display: none; "> 4582 This parameter was added in version 4583 <b><span></span></b>. 4584 You must omit this parameter in earlier versions, 4585 and you may omit it in any version. If you require this 4586 parameter, the manifest key 4587 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4588 can ensure that your extension won't be run in an earlier browser version. 4589 </dd> 4590 4591 <!-- OBJECT PROPERTIES --> 4592 <dd style="display: none; "> 4593 <dl> 4594 <div> 4595 <div> 4596 </div> 4597 </div> 4598 </dl> 4599 </dd> 4600 4601 <!-- OBJECT METHODS --> 4602 <dd style="display: none; "> 4603 <div></div> 4604 </dd> 4605 4606 <!-- OBJECT EVENT FIELDS --> 4607 <dd style="display: none; "> 4608 <div></div> 4609 </dd> 4610 4611 <!-- FUNCTION PARAMETERS --> 4612 <dd style="display: none; "> 4613 <div></div> 4614 </dd> 4615 4616 </div> 4617 </div> 4618 </dl> 4619 </dd> 4620 4621 <!-- OBJECT METHODS --> 4622 <dd style="display: none; "> 4623 <div></div> 4624 </dd> 4625 4626 <!-- OBJECT EVENT FIELDS --> 4627 <dd style="display: none; "> 4628 <div></div> 4629 </dd> 4630 4631 <!-- FUNCTION PARAMETERS --> 4632 <dd style="display: none; "> 4633 <div></div> 4634 </dd> 4635 4636 </div> 4637 4638 </div> <!-- /apiItem --> 4639 4640 </div> <!-- /apiGroup --> 4641 4642 </div> <!-- /apiPage --> 4643 </div> <!-- /gc-pagecontent --> 4644 </div> <!-- /g-section --> 4645 </div> <!-- /codesiteContent --> 4646 <div id="gc-footer" --=""> 4647 <div class="text"> 4648 <p> 4649 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 4650 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 4651 Attribution 3.0 License</a>, and code samples are licensed under the 4652 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 4653 </p> 4654 <p> 4655 2011 Google 4656 </p> 4657 4658 <!-- begin analytics --> 4659 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 4660 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 4661 4662 <script type="text/javascript"> 4663 // chrome doc tracking 4664 try { 4665 var engdocs = _gat._getTracker("YT-10763712-2"); 4666 engdocs._trackPageview(); 4667 } catch(err) {} 4668 4669 // code.google.com site-wide tracking 4670 try { 4671 _uacct="UA-18071-1"; 4672 _uanchor=1; 4673 _uff=0; 4674 urchinTracker(); 4675 } 4676 catch(e) {/* urchinTracker not available. */} 4677 </script> 4678 <!-- end analytics --> 4679 </div> 4680 </div> <!-- /gc-footer --> 4681 </div> <!-- /gc-container --> 4682 </body></html> 4683
