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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/cookies.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/contextMenus.html ('k') | chrome/common/extensions/docs/crx.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <meta name="description" content="Documentation for the chrome.cookies module, which is part of the Google Chrome extension APIs."><title>Cookies - Google Ch rome Extensions - Google Code</title></head>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li class="leftNavSelected">Cookies</li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">Cookies</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#manifest">Manifest</a>
196 <ol>
197 </ol>
198 </li><li>
199 <a href="#examples"> Examples </a>
200 <ol>
201 </ol>
202 </li>
203 <li>
204 <a href="#apiReference">API reference: chrome.cookies</a>
205 <ol>
206 <li>
207 <a href="#global-methods">Methods</a>
208 <ol>
209 <li>
210 <a href="#method-get">get</a>
211 </li><li>
212 <a href="#method-getAll">getAll</a>
213 </li><li>
214 <a href="#method-getAllCookieStores">getAllCookieStores</a>
215 </li><li>
216 <a href="#method-remove">remove</a>
217 </li><li>
218 <a href="#method-set">set</a>
219 </li>
220 </ol>
221 </li>
222 <li>
223 <a href="#global-events">Events</a>
224 <ol>
225 <li>
226 <a href="#event-onChanged">onChanged</a>
227 </li>
228 </ol>
229 </li>
230 <li>
231 <a href="#types">Types</a>
232 <ol>
233 <li>
234 <a href="#type-Cookie">Cookie</a>
235 <ol>
236 </ol>
237 </li><li>
238 <a href="#type-CookieStore">CookieStore</a>
239 <ol>
240 </ol>
241 </li>
242 </ol>
243 </li>
244 </ol>
245 </li>
246 </ol>
247 </div>
248 <!-- /TABLE OF CONTENTS -->
249 <!-- Standard content lead-in for experimental API pages -->
250 <!-- STATIC CONTENT PLACEHOLDER -->
251 <div id="static"><div id="pageData-name" class="pageData">Cookies</div>
252 <!-- BEGIN AUTHORED CONTENT -->
253 <h2 id="manifest">Manifest</h2>
254 <p>To use the cookies API,
255 you must declare the "cookies" permission in your manifest,
256 along with <a href="manifest.html#permissions">host permissions</a>
257 for any hosts whose cookies
258 you want to access.
259 For example:</p>
260 <pre>{
261 "name": "My extension",
262 ...
263 <b>"permissions": [
264 "cookies",
265 "*://*.google.com"
266 ]</b>,
267 ...
268 }</pre>
269 <h2 id="examples"> Examples </h2>
270 <p>
271 You can find a simple example
272 of using the cookies API in the
273 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/cookies/">examples/api/cookies</a>
274 directory.
275 For other examples
276 and for help in viewing the source code,
277 see <a href="samples.html">Samples</a>.
278 </p>
279 <!-- END AUTHORED CONTENT -->
280 </div>
281 <!-- API PAGE -->
282 <div class="apiPage">
283 <a name="apiReference"></a>
284 <h2>API reference: chrome.cookies</h2>
285 <!-- PROPERTIES -->
286 <!-- /apiGroup -->
287 <!-- METHODS -->
288 <div id="methodsTemplate" class="apiGroup">
289 <a name="global-methods"></a>
290 <h3>Methods</h3>
291 <!-- iterates over all functions -->
292 <div class="apiItem">
293 <a name="method-get"></a> <!-- method-anchor -->
294 <h4>get</h4>
295 <div class="summary">
296 <!-- Note: intentionally longer 80 columns -->
297 <span>chrome.cookies.get</span>(<span class="null"><span>objec t</span>
298 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
299 <var><span>callback</span></var></span>)</div>
300 <div class="description">
301 <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 ea rliest creation time will be returned.</p>
302 <!-- PARAMETERS -->
303 <h4>Parameters</h4>
304 <dl>
305 <div>
306 <div>
307 <dt>
308 <var>details</var>
309 <em>
310 <!-- TYPE -->
311 <div style="display:inline">
312 (
313 <span id="typeTemplate">
314 <span>
315 <span>object</span>
316 </span>
317 </span>
318 )
319 </div>
320 </em>
321 </dt>
322 <dd>Details to identify the cookie being retrieved.</dd>
323 <!-- OBJECT PROPERTIES -->
324 <dd>
325 <dl>
326 <div>
327 <div>
328 <dt>
329 <var>url</var>
330 <em>
331 <!-- TYPE -->
332 <div style="display:inline">
333 (
334 <span id="typeTemplate">
335 <span>
336 <span>string</span>
337 </span>
338 </span>
339 )
340 </div>
341 </em>
342 </dt>
343 <dd>The URL with which the cookie to retrieve is associated. This argu ment 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 specif ied in the manifest file, the API call will fail.</dd>
344 <!-- OBJECT PROPERTIES -->
345 <!-- OBJECT METHODS -->
346 <!-- OBJECT EVENT FIELDS -->
347 <!-- FUNCTION PARAMETERS -->
348 </div>
349 </div><div>
350 <div>
351 <dt>
352 <var>name</var>
353 <em>
354 <!-- TYPE -->
355 <div style="display:inline">
356 (
357 <span id="typeTemplate">
358 <span>
359 <span>string</span>
360 </span>
361 </span>
362 )
363 </div>
364 </em>
365 </dt>
366 <dd>The name of the cookie to retrieve.</dd>
367 <!-- OBJECT PROPERTIES -->
368 <!-- OBJECT METHODS -->
369 <!-- OBJECT EVENT FIELDS -->
370 <!-- FUNCTION PARAMETERS -->
371 </div>
372 </div><div>
373 <div>
374 <dt>
375 <var>storeId</var>
376 <em>
377 <!-- TYPE -->
378 <div style="display:inline">
379 (
380 <span class="optional">optional</span>
381 <span id="typeTemplate">
382 <span>
383 <span>string</span>
384 </span>
385 </span>
386 )
387 </div>
388 </em>
389 </dt>
390 <dd>The ID of the cookie store in which to look for the cookie. By def ault, the current execution context's cookie store will be used.</dd>
391 <!-- OBJECT PROPERTIES -->
392 <!-- OBJECT METHODS -->
393 <!-- OBJECT EVENT FIELDS -->
394 <!-- FUNCTION PARAMETERS -->
395 </div>
396 </div>
397 </dl>
398 </dd>
399 <!-- OBJECT METHODS -->
400 <!-- OBJECT EVENT FIELDS -->
401 <!-- FUNCTION PARAMETERS -->
402 </div>
403 </div><div>
404 <div>
405 <dt>
406 <var>callback</var>
407 <em>
408 <!-- TYPE -->
409 <div style="display:inline">
410 (
411 <span id="typeTemplate">
412 <span>
413 <span>function</span>
414 </span>
415 </span>
416 )
417 </div>
418 </em>
419 </dt>
420 <dd class="todo">
421 Undocumented.
422 </dd>
423 <!-- OBJECT PROPERTIES -->
424 <!-- OBJECT METHODS -->
425 <!-- OBJECT EVENT FIELDS -->
426 <!-- FUNCTION PARAMETERS -->
427 </div>
428 </div>
429 </dl>
430 <!-- RETURNS -->
431 <dl>
432 </dl>
433 <!-- CALLBACK -->
434 <div>
435 <div>
436 <h4>Callback function</h4>
437 <p>
438 The <em>callback</em> parameter should specify a function
439 that looks like this:
440 </p>
441 <!-- Note: intentionally longer 80 columns -->
442 <pre>function(<span>Cookie cookie</span>) <span class="subdued ">{...}</span>;</pre>
443 <dl>
444 <div>
445 <div>
446 <dt>
447 <var>cookie</var>
448 <em>
449 <!-- TYPE -->
450 <div style="display:inline">
451 (
452 <span class="optional">optional</span>
453 <span id="typeTemplate">
454 <span>
455 <a href="cookies.html#type-Cookie">Cookie</a>
456 </span>
457 </span>
458 )
459 </div>
460 </em>
461 </dt>
462 <dd>Contains details about the cookie. This parameter is null if no su ch cookie was found.</dd>
463 <!-- OBJECT PROPERTIES -->
464 <!-- OBJECT METHODS -->
465 <!-- OBJECT EVENT FIELDS -->
466 <!-- FUNCTION PARAMETERS -->
467 </div>
468 </div>
469 </dl>
470 </div>
471 </div>
472 <!-- MIN_VERSION -->
473 </div> <!-- /description -->
474 </div><div class="apiItem">
475 <a name="method-getAll"></a> <!-- method-anchor -->
476 <h4>getAll</h4>
477 <div class="summary">
478 <!-- Note: intentionally longer 80 columns -->
479 <span>chrome.cookies.getAll</span>(<span class="null"><span>ob ject</span>
480 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
481 <var><span>callback</span></var></span>)</div>
482 <div class="description">
483 <p>Retrieves all cookies from a single cookie store that match t he 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 t he earliest creation time will be first.</p>
484 <!-- PARAMETERS -->
485 <h4>Parameters</h4>
486 <dl>
487 <div>
488 <div>
489 <dt>
490 <var>details</var>
491 <em>
492 <!-- TYPE -->
493 <div style="display:inline">
494 (
495 <span id="typeTemplate">
496 <span>
497 <span>object</span>
498 </span>
499 </span>
500 )
501 </div>
502 </em>
503 </dt>
504 <dd>Information to filter the cookies being retrieved.</dd>
505 <!-- OBJECT PROPERTIES -->
506 <dd>
507 <dl>
508 <div>
509 <div>
510 <dt>
511 <var>url</var>
512 <em>
513 <!-- TYPE -->
514 <div style="display:inline">
515 (
516 <span class="optional">optional</span>
517 <span id="typeTemplate">
518 <span>
519 <span>string</span>
520 </span>
521 </span>
522 )
523 </div>
524 </em>
525 </dt>
526 <dd>Restricts the retrieved cookies to those that would match the give n URL.</dd>
527 <!-- OBJECT PROPERTIES -->
528 <!-- OBJECT METHODS -->
529 <!-- OBJECT EVENT FIELDS -->
530 <!-- FUNCTION PARAMETERS -->
531 </div>
532 </div><div>
533 <div>
534 <dt>
535 <var>name</var>
536 <em>
537 <!-- TYPE -->
538 <div style="display:inline">
539 (
540 <span class="optional">optional</span>
541 <span id="typeTemplate">
542 <span>
543 <span>string</span>
544 </span>
545 </span>
546 )
547 </div>
548 </em>
549 </dt>
550 <dd>Filters the cookies by name.</dd>
551 <!-- OBJECT PROPERTIES -->
552 <!-- OBJECT METHODS -->
553 <!-- OBJECT EVENT FIELDS -->
554 <!-- FUNCTION PARAMETERS -->
555 </div>
556 </div><div>
557 <div>
558 <dt>
559 <var>domain</var>
560 <em>
561 <!-- TYPE -->
562 <div style="display:inline">
563 (
564 <span class="optional">optional</span>
565 <span id="typeTemplate">
566 <span>
567 <span>string</span>
568 </span>
569 </span>
570 )
571 </div>
572 </em>
573 </dt>
574 <dd>Restricts the retrieved cookies to those whose domains match or ar e subdomains of this one.</dd>
575 <!-- OBJECT PROPERTIES -->
576 <!-- OBJECT METHODS -->
577 <!-- OBJECT EVENT FIELDS -->
578 <!-- FUNCTION PARAMETERS -->
579 </div>
580 </div><div>
581 <div>
582 <dt>
583 <var>path</var>
584 <em>
585 <!-- TYPE -->
586 <div style="display:inline">
587 (
588 <span class="optional">optional</span>
589 <span id="typeTemplate">
590 <span>
591 <span>string</span>
592 </span>
593 </span>
594 )
595 </div>
596 </em>
597 </dt>
598 <dd>Restricts the retrieved cookies to those whose path exactly matche s this string.</dd>
599 <!-- OBJECT PROPERTIES -->
600 <!-- OBJECT METHODS -->
601 <!-- OBJECT EVENT FIELDS -->
602 <!-- FUNCTION PARAMETERS -->
603 </div>
604 </div><div>
605 <div>
606 <dt>
607 <var>secure</var>
608 <em>
609 <!-- TYPE -->
610 <div style="display:inline">
611 (
612 <span class="optional">optional</span>
613 <span id="typeTemplate">
614 <span>
615 <span>boolean</span>
616 </span>
617 </span>
618 )
619 </div>
620 </em>
621 </dt>
622 <dd>Filters the cookies by their Secure property.</dd>
623 <!-- OBJECT PROPERTIES -->
624 <!-- OBJECT METHODS -->
625 <!-- OBJECT EVENT FIELDS -->
626 <!-- FUNCTION PARAMETERS -->
627 </div>
628 </div><div>
629 <div>
630 <dt>
631 <var>session</var>
632 <em>
633 <!-- TYPE -->
634 <div style="display:inline">
635 (
636 <span class="optional">optional</span>
637 <span id="typeTemplate">
638 <span>
639 <span>boolean</span>
640 </span>
641 </span>
642 )
643 </div>
644 </em>
645 </dt>
646 <dd>Filters out session vs. persistent cookies.</dd>
647 <!-- OBJECT PROPERTIES -->
648 <!-- OBJECT METHODS -->
649 <!-- OBJECT EVENT FIELDS -->
650 <!-- FUNCTION PARAMETERS -->
651 </div>
652 </div><div>
653 <div>
654 <dt>
655 <var>storeId</var>
656 <em>
657 <!-- TYPE -->
658 <div style="display:inline">
659 (
660 <span class="optional">optional</span>
661 <span id="typeTemplate">
662 <span>
663 <span>string</span>
664 </span>
665 </span>
666 )
667 </div>
668 </em>
669 </dt>
670 <dd>The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.</dd>
671 <!-- OBJECT PROPERTIES -->
672 <!-- OBJECT METHODS -->
673 <!-- OBJECT EVENT FIELDS -->
674 <!-- FUNCTION PARAMETERS -->
675 </div>
676 </div>
677 </dl>
678 </dd>
679 <!-- OBJECT METHODS -->
680 <!-- OBJECT EVENT FIELDS -->
681 <!-- FUNCTION PARAMETERS -->
682 </div>
683 </div><div>
684 <div>
685 <dt>
686 <var>callback</var>
687 <em>
688 <!-- TYPE -->
689 <div style="display:inline">
690 (
691 <span id="typeTemplate">
692 <span>
693 <span>function</span>
694 </span>
695 </span>
696 )
697 </div>
698 </em>
699 </dt>
700 <dd class="todo">
701 Undocumented.
702 </dd>
703 <!-- OBJECT PROPERTIES -->
704 <!-- OBJECT METHODS -->
705 <!-- OBJECT EVENT FIELDS -->
706 <!-- FUNCTION PARAMETERS -->
707 </div>
708 </div>
709 </dl>
710 <!-- RETURNS -->
711 <dl>
712 </dl>
713 <!-- CALLBACK -->
714 <div>
715 <div>
716 <h4>Callback function</h4>
717 <p>
718 The <em>callback</em> parameter should specify a function
719 that looks like this:
720 </p>
721 <!-- Note: intentionally longer 80 columns -->
722 <pre>function(<span>array of Cookie cookies</span>) <span clas s="subdued">{...}</span>;</pre>
723 <dl>
724 <div>
725 <div>
726 <dt>
727 <var>cookies</var>
728 <em>
729 <!-- TYPE -->
730 <div style="display:inline">
731 (
732 <span id="typeTemplate">
733 <span>
734 <span>
735 array of <span><span>
736 <span>
737 <a href="cookies.html#type-Cookie">Cookie</a>
738 </span>
739 </span></span>
740 </span>
741 </span>
742 </span>
743 )
744 </div>
745 </em>
746 </dt>
747 <dd>All the existing, unexpired cookies that match the given cookie in fo.</dd>
748 <!-- OBJECT PROPERTIES -->
749 <!-- OBJECT METHODS -->
750 <!-- OBJECT EVENT FIELDS -->
751 <!-- FUNCTION PARAMETERS -->
752 </div>
753 </div>
754 </dl>
755 </div>
756 </div>
757 <!-- MIN_VERSION -->
758 </div> <!-- /description -->
759 </div><div class="apiItem">
760 <a name="method-getAllCookieStores"></a> <!-- method-anchor -->
761 <h4>getAllCookieStores</h4>
762 <div class="summary">
763 <!-- Note: intentionally longer 80 columns -->
764 <span>chrome.cookies.getAllCookieStores</span>(<span class="nu ll"><span>function</span>
765 <var><span>callback</span></var></span>)</div>
766 <div class="description">
767 <p>Lists all existing cookie stores.</p>
768 <!-- PARAMETERS -->
769 <h4>Parameters</h4>
770 <dl>
771 <div>
772 <div>
773 <dt>
774 <var>callback</var>
775 <em>
776 <!-- TYPE -->
777 <div style="display:inline">
778 (
779 <span id="typeTemplate">
780 <span>
781 <span>function</span>
782 </span>
783 </span>
784 )
785 </div>
786 </em>
787 </dt>
788 <dd class="todo">
789 Undocumented.
790 </dd>
791 <!-- OBJECT PROPERTIES -->
792 <!-- OBJECT METHODS -->
793 <!-- OBJECT EVENT FIELDS -->
794 <!-- FUNCTION PARAMETERS -->
795 </div>
796 </div>
797 </dl>
798 <!-- RETURNS -->
799 <dl>
800 </dl>
801 <!-- CALLBACK -->
802 <div>
803 <div>
804 <h4>Callback function</h4>
805 <p>
806 The <em>callback</em> parameter should specify a function
807 that looks like this:
808 </p>
809 <!-- Note: intentionally longer 80 columns -->
810 <pre>function(<span>array of CookieStore cookieStores</span>) <span class="subdued">{...}</span>;</pre>
811 <dl>
812 <div>
813 <div>
814 <dt>
815 <var>cookieStores</var>
816 <em>
817 <!-- TYPE -->
818 <div style="display:inline">
819 (
820 <span id="typeTemplate">
821 <span>
822 <span>
823 array of <span><span>
824 <span>
825 <a href="cookies.html#type-CookieStore">CookieStore</a>
826 </span>
827 </span></span>
828 </span>
829 </span>
830 </span>
831 )
832 </div>
833 </em>
834 </dt>
835 <dd>All the existing cookie stores.</dd>
836 <!-- OBJECT PROPERTIES -->
837 <!-- OBJECT METHODS -->
838 <!-- OBJECT EVENT FIELDS -->
839 <!-- FUNCTION PARAMETERS -->
840 </div>
841 </div>
842 </dl>
843 </div>
844 </div>
845 <!-- MIN_VERSION -->
846 </div> <!-- /description -->
847 </div><div class="apiItem">
848 <a name="method-remove"></a> <!-- method-anchor -->
849 <h4>remove</h4>
850 <div class="summary">
851 <!-- Note: intentionally longer 80 columns -->
852 <span>chrome.cookies.remove</span>(<span class="null"><span>ob ject</span>
853 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
854 <var><span>callback</span></var></span>)</div>
855 <div class="description">
856 <p>Deletes a cookie by name.</p>
857 <!-- PARAMETERS -->
858 <h4>Parameters</h4>
859 <dl>
860 <div>
861 <div>
862 <dt>
863 <var>details</var>
864 <em>
865 <!-- TYPE -->
866 <div style="display:inline">
867 (
868 <span id="typeTemplate">
869 <span>
870 <span>object</span>
871 </span>
872 </span>
873 )
874 </div>
875 </em>
876 </dt>
877 <dd>Information to identify the cookie to remove.</dd>
878 <!-- OBJECT PROPERTIES -->
879 <dd>
880 <dl>
881 <div>
882 <div>
883 <dt>
884 <var>url</var>
885 <em>
886 <!-- TYPE -->
887 <div style="display:inline">
888 (
889 <span id="typeTemplate">
890 <span>
891 <span>string</span>
892 </span>
893 </span>
894 )
895 </div>
896 </em>
897 </dt>
898 <dd>The URL associated with the cookie. If host permissions for this U RL are not specified in the manifest file, the API call will fail.</dd>
899 <!-- OBJECT PROPERTIES -->
900 <!-- OBJECT METHODS -->
901 <!-- OBJECT EVENT FIELDS -->
902 <!-- FUNCTION PARAMETERS -->
903 </div>
904 </div><div>
905 <div>
906 <dt>
907 <var>name</var>
908 <em>
909 <!-- TYPE -->
910 <div style="display:inline">
911 (
912 <span id="typeTemplate">
913 <span>
914 <span>string</span>
915 </span>
916 </span>
917 )
918 </div>
919 </em>
920 </dt>
921 <dd>The name of the cookie to remove.</dd>
922 <!-- OBJECT PROPERTIES -->
923 <!-- OBJECT METHODS -->
924 <!-- OBJECT EVENT FIELDS -->
925 <!-- FUNCTION PARAMETERS -->
926 </div>
927 </div><div>
928 <div>
929 <dt>
930 <var>storeId</var>
931 <em>
932 <!-- TYPE -->
933 <div style="display:inline">
934 (
935 <span class="optional">optional</span>
936 <span id="typeTemplate">
937 <span>
938 <span>string</span>
939 </span>
940 </span>
941 )
942 </div>
943 </em>
944 </dt>
945 <dd>The ID of the cookie store to look in for the cookie. If unspecifi ed, the cookie is looked for by default in the current execution context's cooki e store.</dd>
946 <!-- OBJECT PROPERTIES -->
947 <!-- OBJECT METHODS -->
948 <!-- OBJECT EVENT FIELDS -->
949 <!-- FUNCTION PARAMETERS -->
950 </div>
951 </div>
952 </dl>
953 </dd>
954 <!-- OBJECT METHODS -->
955 <!-- OBJECT EVENT FIELDS -->
956 <!-- FUNCTION PARAMETERS -->
957 </div>
958 </div><div>
959 <div>
960 <dt>
961 <var>callback</var>
962 <em>
963 <!-- TYPE -->
964 <div style="display:inline">
965 (
966 <span class="optional">optional</span>
967 <span id="typeTemplate">
968 <span>
969 <span>function</span>
970 </span>
971 </span>
972 )
973 </div>
974 </em>
975 </dt>
976 <dd class="todo">
977 Undocumented.
978 </dd>
979 <dd>
980 This parameter was added in version
981 <b><span>11.0.674.0</span></b>.
982 You must omit this parameter in earlier versions,
983 and you may omit it in any version. If you require this
984 parameter, the manifest key
985 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
986 can ensure that your extension won't be run in an earlier browser ve rsion.
987 </dd>
988 <!-- OBJECT PROPERTIES -->
989 <!-- OBJECT METHODS -->
990 <!-- OBJECT EVENT FIELDS -->
991 <!-- FUNCTION PARAMETERS -->
992 </div>
993 </div>
994 </dl>
995 <!-- RETURNS -->
996 <dl>
997 </dl>
998 <!-- CALLBACK -->
999 <div>
1000 <div>
1001 <h4>Callback function</h4>
1002 <p>
1003 If you specify the <em>callback</em> parameter, it should
1004 specify a function that looks like this:
1005 </p>
1006 <!-- Note: intentionally longer 80 columns -->
1007 <pre>function(<span>object details</span>) <span class="subdue d">{...}</span>;</pre>
1008 <dl>
1009 <div>
1010 <div>
1011 <dt>
1012 <var>details</var>
1013 <em>
1014 <!-- TYPE -->
1015 <div style="display:inline">
1016 (
1017 <span class="optional">optional</span>
1018 <span id="typeTemplate">
1019 <span>
1020 <span>object</span>
1021 </span>
1022 </span>
1023 )
1024 </div>
1025 </em>
1026 </dt>
1027 <dd>Contains details about the cookie that's been removed. If removal failed for any reason, this will be "null", and "chrome.extension.lastError" wi ll be set.</dd>
1028 <!-- OBJECT PROPERTIES -->
1029 <dd>
1030 <dl>
1031 <div>
1032 <div>
1033 <dt>
1034 <var>url</var>
1035 <em>
1036 <!-- TYPE -->
1037 <div style="display:inline">
1038 (
1039 <span id="typeTemplate">
1040 <span>
1041 <span>string</span>
1042 </span>
1043 </span>
1044 )
1045 </div>
1046 </em>
1047 </dt>
1048 <dd>The URL associated with the cookie that's been removed.</dd>
1049 <!-- OBJECT PROPERTIES -->
1050 <!-- OBJECT METHODS -->
1051 <!-- OBJECT EVENT FIELDS -->
1052 <!-- FUNCTION PARAMETERS -->
1053 </div>
1054 </div><div>
1055 <div>
1056 <dt>
1057 <var>name</var>
1058 <em>
1059 <!-- TYPE -->
1060 <div style="display:inline">
1061 (
1062 <span id="typeTemplate">
1063 <span>
1064 <span>string</span>
1065 </span>
1066 </span>
1067 )
1068 </div>
1069 </em>
1070 </dt>
1071 <dd>The name of the cookie that's been removed.</dd>
1072 <!-- OBJECT PROPERTIES -->
1073 <!-- OBJECT METHODS -->
1074 <!-- OBJECT EVENT FIELDS -->
1075 <!-- FUNCTION PARAMETERS -->
1076 </div>
1077 </div><div>
1078 <div>
1079 <dt>
1080 <var>storeId</var>
1081 <em>
1082 <!-- TYPE -->
1083 <div style="display:inline">
1084 (
1085 <span id="typeTemplate">
1086 <span>
1087 <span>string</span>
1088 </span>
1089 </span>
1090 )
1091 </div>
1092 </em>
1093 </dt>
1094 <dd>The ID of the cookie store from which the cookie was removed.</dd>
1095 <!-- OBJECT PROPERTIES -->
1096 <!-- OBJECT METHODS -->
1097 <!-- OBJECT EVENT FIELDS -->
1098 <!-- FUNCTION PARAMETERS -->
1099 </div>
1100 </div>
1101 </dl>
1102 </dd>
1103 <!-- OBJECT METHODS -->
1104 <!-- OBJECT EVENT FIELDS -->
1105 <!-- FUNCTION PARAMETERS -->
1106 </div>
1107 </div>
1108 </dl>
1109 </div>
1110 </div>
1111 <!-- MIN_VERSION -->
1112 </div> <!-- /description -->
1113 </div><div class="apiItem">
1114 <a name="method-set"></a> <!-- method-anchor -->
1115 <h4>set</h4>
1116 <div class="summary">
1117 <!-- Note: intentionally longer 80 columns -->
1118 <span>chrome.cookies.set</span>(<span class="null"><span>objec t</span>
1119 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
1120 <var><span>callback</span></var></span>)</div>
1121 <div class="description">
1122 <p>Sets a cookie with the given cookie data; may overwrite equiv alent cookies if they exist.</p>
1123 <!-- PARAMETERS -->
1124 <h4>Parameters</h4>
1125 <dl>
1126 <div>
1127 <div>
1128 <dt>
1129 <var>details</var>
1130 <em>
1131 <!-- TYPE -->
1132 <div style="display:inline">
1133 (
1134 <span id="typeTemplate">
1135 <span>
1136 <span>object</span>
1137 </span>
1138 </span>
1139 )
1140 </div>
1141 </em>
1142 </dt>
1143 <dd>Details about the cookie being set.</dd>
1144 <!-- OBJECT PROPERTIES -->
1145 <dd>
1146 <dl>
1147 <div>
1148 <div>
1149 <dt>
1150 <var>url</var>
1151 <em>
1152 <!-- TYPE -->
1153 <div style="display:inline">
1154 (
1155 <span id="typeTemplate">
1156 <span>
1157 <span>string</span>
1158 </span>
1159 </span>
1160 )
1161 </div>
1162 </em>
1163 </dt>
1164 <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 ho st permissions for this URL are not specified in the manifest file, the API call will fail.</dd>
1165 <!-- OBJECT PROPERTIES -->
1166 <!-- OBJECT METHODS -->
1167 <!-- OBJECT EVENT FIELDS -->
1168 <!-- FUNCTION PARAMETERS -->
1169 </div>
1170 </div><div>
1171 <div>
1172 <dt>
1173 <var>name</var>
1174 <em>
1175 <!-- TYPE -->
1176 <div style="display:inline">
1177 (
1178 <span class="optional">optional</span>
1179 <span id="typeTemplate">
1180 <span>
1181 <span>string</span>
1182 </span>
1183 </span>
1184 )
1185 </div>
1186 </em>
1187 </dt>
1188 <dd>The name of the cookie. Empty by default if omitted.</dd>
1189 <!-- OBJECT PROPERTIES -->
1190 <!-- OBJECT METHODS -->
1191 <!-- OBJECT EVENT FIELDS -->
1192 <!-- FUNCTION PARAMETERS -->
1193 </div>
1194 </div><div>
1195 <div>
1196 <dt>
1197 <var>value</var>
1198 <em>
1199 <!-- TYPE -->
1200 <div style="display:inline">
1201 (
1202 <span class="optional">optional</span>
1203 <span id="typeTemplate">
1204 <span>
1205 <span>string</span>
1206 </span>
1207 </span>
1208 )
1209 </div>
1210 </em>
1211 </dt>
1212 <dd>The value of the cookie. Empty by default if omitted.</dd>
1213 <!-- OBJECT PROPERTIES -->
1214 <!-- OBJECT METHODS -->
1215 <!-- OBJECT EVENT FIELDS -->
1216 <!-- FUNCTION PARAMETERS -->
1217 </div>
1218 </div><div>
1219 <div>
1220 <dt>
1221 <var>domain</var>
1222 <em>
1223 <!-- TYPE -->
1224 <div style="display:inline">
1225 (
1226 <span class="optional">optional</span>
1227 <span id="typeTemplate">
1228 <span>
1229 <span>string</span>
1230 </span>
1231 </span>
1232 )
1233 </div>
1234 </em>
1235 </dt>
1236 <dd>The domain of the cookie. If omitted, the cookie becomes a host-on ly cookie.</dd>
1237 <!-- OBJECT PROPERTIES -->
1238 <!-- OBJECT METHODS -->
1239 <!-- OBJECT EVENT FIELDS -->
1240 <!-- FUNCTION PARAMETERS -->
1241 </div>
1242 </div><div>
1243 <div>
1244 <dt>
1245 <var>path</var>
1246 <em>
1247 <!-- TYPE -->
1248 <div style="display:inline">
1249 (
1250 <span class="optional">optional</span>
1251 <span id="typeTemplate">
1252 <span>
1253 <span>string</span>
1254 </span>
1255 </span>
1256 )
1257 </div>
1258 </em>
1259 </dt>
1260 <dd>The path of the cookie. Defaults to the path portion of the url pa rameter.</dd>
1261 <!-- OBJECT PROPERTIES -->
1262 <!-- OBJECT METHODS -->
1263 <!-- OBJECT EVENT FIELDS -->
1264 <!-- FUNCTION PARAMETERS -->
1265 </div>
1266 </div><div>
1267 <div>
1268 <dt>
1269 <var>secure</var>
1270 <em>
1271 <!-- TYPE -->
1272 <div style="display:inline">
1273 (
1274 <span class="optional">optional</span>
1275 <span id="typeTemplate">
1276 <span>
1277 <span>boolean</span>
1278 </span>
1279 </span>
1280 )
1281 </div>
1282 </em>
1283 </dt>
1284 <dd>Whether the cookie should be marked as Secure. Defaults to false.< /dd>
1285 <!-- OBJECT PROPERTIES -->
1286 <!-- OBJECT METHODS -->
1287 <!-- OBJECT EVENT FIELDS -->
1288 <!-- FUNCTION PARAMETERS -->
1289 </div>
1290 </div><div>
1291 <div>
1292 <dt>
1293 <var>httpOnly</var>
1294 <em>
1295 <!-- TYPE -->
1296 <div style="display:inline">
1297 (
1298 <span class="optional">optional</span>
1299 <span id="typeTemplate">
1300 <span>
1301 <span>boolean</span>
1302 </span>
1303 </span>
1304 )
1305 </div>
1306 </em>
1307 </dt>
1308 <dd>Whether the cookie should be marked as HttpOnly. Defaults to false .</dd>
1309 <!-- OBJECT PROPERTIES -->
1310 <!-- OBJECT METHODS -->
1311 <!-- OBJECT EVENT FIELDS -->
1312 <!-- FUNCTION PARAMETERS -->
1313 </div>
1314 </div><div>
1315 <div>
1316 <dt>
1317 <var>expirationDate</var>
1318 <em>
1319 <!-- TYPE -->
1320 <div style="display:inline">
1321 (
1322 <span class="optional">optional</span>
1323 <span id="typeTemplate">
1324 <span>
1325 <span>number</span>
1326 </span>
1327 </span>
1328 )
1329 </div>
1330 </em>
1331 </dt>
1332 <dd>The expiration date of the cookie as the number of seconds since t he UNIX epoch. If omitted, the cookie becomes a session cookie.</dd>
1333 <!-- OBJECT PROPERTIES -->
1334 <!-- OBJECT METHODS -->
1335 <!-- OBJECT EVENT FIELDS -->
1336 <!-- FUNCTION PARAMETERS -->
1337 </div>
1338 </div><div>
1339 <div>
1340 <dt>
1341 <var>storeId</var>
1342 <em>
1343 <!-- TYPE -->
1344 <div style="display:inline">
1345 (
1346 <span class="optional">optional</span>
1347 <span id="typeTemplate">
1348 <span>
1349 <span>string</span>
1350 </span>
1351 </span>
1352 )
1353 </div>
1354 </em>
1355 </dt>
1356 <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>
1357 <!-- OBJECT PROPERTIES -->
1358 <!-- OBJECT METHODS -->
1359 <!-- OBJECT EVENT FIELDS -->
1360 <!-- FUNCTION PARAMETERS -->
1361 </div>
1362 </div>
1363 </dl>
1364 </dd>
1365 <!-- OBJECT METHODS -->
1366 <!-- OBJECT EVENT FIELDS -->
1367 <!-- FUNCTION PARAMETERS -->
1368 </div>
1369 </div><div>
1370 <div>
1371 <dt>
1372 <var>callback</var>
1373 <em>
1374 <!-- TYPE -->
1375 <div style="display:inline">
1376 (
1377 <span class="optional">optional</span>
1378 <span id="typeTemplate">
1379 <span>
1380 <span>function</span>
1381 </span>
1382 </span>
1383 )
1384 </div>
1385 </em>
1386 </dt>
1387 <dd class="todo">
1388 Undocumented.
1389 </dd>
1390 <dd>
1391 This parameter was added in version
1392 <b><span>11.0.674.0</span></b>.
1393 You must omit this parameter in earlier versions,
1394 and you may omit it in any version. If you require this
1395 parameter, the manifest key
1396 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1397 can ensure that your extension won't be run in an earlier browser ve rsion.
1398 </dd>
1399 <!-- OBJECT PROPERTIES -->
1400 <!-- OBJECT METHODS -->
1401 <!-- OBJECT EVENT FIELDS -->
1402 <!-- FUNCTION PARAMETERS -->
1403 </div>
1404 </div>
1405 </dl>
1406 <!-- RETURNS -->
1407 <dl>
1408 </dl>
1409 <!-- CALLBACK -->
1410 <div>
1411 <div>
1412 <h4>Callback function</h4>
1413 <p>
1414 If you specify the <em>callback</em> parameter, it should
1415 specify a function that looks like this:
1416 </p>
1417 <!-- Note: intentionally longer 80 columns -->
1418 <pre>function(<span>Cookie cookie</span>) <span class="subdued ">{...}</span>;</pre>
1419 <dl>
1420 <div>
1421 <div>
1422 <dt>
1423 <var>cookie</var>
1424 <em>
1425 <!-- TYPE -->
1426 <div style="display:inline">
1427 (
1428 <span class="optional">optional</span>
1429 <span id="typeTemplate">
1430 <span>
1431 <a href="cookies.html#type-Cookie">Cookie</a>
1432 </span>
1433 </span>
1434 )
1435 </div>
1436 </em>
1437 </dt>
1438 <dd>Contains details about the cookie that's been set. If setting fai led for any reason, this will be "null", and "chrome.extension.lastError" will b e set.</dd>
1439 <!-- OBJECT PROPERTIES -->
1440 <!-- OBJECT METHODS -->
1441 <!-- OBJECT EVENT FIELDS -->
1442 <!-- FUNCTION PARAMETERS -->
1443 </div>
1444 </div>
1445 </dl>
1446 </div>
1447 </div>
1448 <!-- MIN_VERSION -->
1449 </div> <!-- /description -->
1450 </div> <!-- /apiItem -->
1451 </div> <!-- /apiGroup -->
1452 <!-- EVENTS -->
1453 <div id="eventsTemplate" class="apiGroup">
1454 <a name="global-events"></a>
1455 <h3>Events</h3>
1456 <!-- iterates over all events -->
1457 <div class="apiItem">
1458 <a name="event-onChanged"></a>
1459 <h4>onChanged</h4>
1460 <div class="summary">
1461 <!-- Note: intentionally longer 80 columns -->
1462 <span class="subdued">chrome.cookies.</span><span>onChanged</spa n><span class="subdued">.addListener</span>(function(<span>object changeInfo</sp an>) <span class="subdued">{...}</span><span></span>);
1463 </div>
1464 <div class="description">
1465 <p>Fired when a cookie is set or removed. As a special case, not e 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 va lues, generating a second notification with "cause" "explicit".</p>
1466 <!-- LISTENER PARAMETERS -->
1467 <div>
1468 <h4>Listener parameters</h4>
1469 <dl>
1470 <div>
1471 <div>
1472 <dt>
1473 <var>changeInfo</var>
1474 <em>
1475 <!-- TYPE -->
1476 <div style="display:inline">
1477 (
1478 <span id="typeTemplate">
1479 <span>
1480 <span>object</span>
1481 </span>
1482 </span>
1483 )
1484 </div>
1485 </em>
1486 </dt>
1487 <dd class="todo">
1488 Undocumented.
1489 </dd>
1490 <!-- OBJECT PROPERTIES -->
1491 <dd>
1492 <dl>
1493 <div>
1494 <div>
1495 <dt>
1496 <var>removed</var>
1497 <em>
1498 <!-- TYPE -->
1499 <div style="display:inline">
1500 (
1501 <span id="typeTemplate">
1502 <span>
1503 <span>boolean</span>
1504 </span>
1505 </span>
1506 )
1507 </div>
1508 </em>
1509 </dt>
1510 <dd>True if a cookie was removed.</dd>
1511 <!-- OBJECT PROPERTIES -->
1512 <!-- OBJECT METHODS -->
1513 <!-- OBJECT EVENT FIELDS -->
1514 <!-- FUNCTION PARAMETERS -->
1515 </div>
1516 </div><div>
1517 <div>
1518 <dt>
1519 <var>cookie</var>
1520 <em>
1521 <!-- TYPE -->
1522 <div style="display:inline">
1523 (
1524 <span id="typeTemplate">
1525 <span>
1526 <a href="cookies.html#type-Cookie">Cookie</a>
1527 </span>
1528 </span>
1529 )
1530 </div>
1531 </em>
1532 </dt>
1533 <dd>Information about the cookie that was set or removed.</dd>
1534 <!-- OBJECT PROPERTIES -->
1535 <!-- OBJECT METHODS -->
1536 <!-- OBJECT EVENT FIELDS -->
1537 <!-- FUNCTION PARAMETERS -->
1538 </div>
1539 </div><div>
1540 <div>
1541 <dt>
1542 <var>cause</var>
1543 <em>
1544 <!-- TYPE -->
1545 <div style="display:inline">
1546 (
1547 <span class="enum">enumerated</span>
1548 <span id="typeTemplate">
1549 <span>
1550 <span>string</span>
1551 <span>["evicted", "expired", "explicit", "expired_overwr ite", "overwrite"]</span>
1552 </span>
1553 </span>
1554 )
1555 </div>
1556 </em>
1557 </dt>
1558 <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" wi ll be "explicit". If a cookie was automatically removed due to expiry, "cause" w ill be "expired". If a cookie was removed due to being overwritten with an alrea dy-expired expiration date, "cause" will be set to "expired_overwrite". If a co okie was automatically removed due to garbage collection, "cause" will be "evict ed". If a cookie was automatically removed due to a "set" call that overwrote i t, "cause" will be "overwrite". Plan your response accordingly.</dd>
1559 <dd>
1560 This parameter was added in version
1561 <b><span>12.0.707.0</span></b>.
1562 You must omit this parameter in earlier versions,
1563 and you may omit it in any version. If you require this
1564 parameter, the manifest key
1565 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1566 can ensure that your extension won't be run in an earlier browser ve rsion.
1567 </dd>
1568 <!-- OBJECT PROPERTIES -->
1569 <!-- OBJECT METHODS -->
1570 <!-- OBJECT EVENT FIELDS -->
1571 <!-- FUNCTION PARAMETERS -->
1572 </div>
1573 </div>
1574 </dl>
1575 </dd>
1576 <!-- OBJECT METHODS -->
1577 <!-- OBJECT EVENT FIELDS -->
1578 <!-- FUNCTION PARAMETERS -->
1579 </div>
1580 </div>
1581 </dl>
1582 </div>
1583 <!-- EXTRA PARAMETERS -->
1584 <!-- LISTENER RETURN VALUE -->
1585 <dl>
1586 </dl>
1587 </div> <!-- /description -->
1588 <!-- /description -->
1589 </div> <!-- /apiItem -->
1590 </div> <!-- /apiGroup -->
1591 <!-- TYPES -->
1592 <div class="apiGroup">
1593 <a name="types"></a>
1594 <h3 id="types">Types</h3>
1595 <!-- iterates over all types -->
1596 <div class="apiItem">
1597 <a name="type-Cookie"></a>
1598 <h4>Cookie</h4>
1599 <div>
1600 <dt>
1601 <em>
1602 <!-- TYPE -->
1603 <div style="display:inline">
1604 (
1605 <span id="typeTemplate">
1606 <span>
1607 <span>object</span>
1608 </span>
1609 </span>
1610 )
1611 </div>
1612 </em>
1613 </dt>
1614 <dd>Represents information about an HTTP cookie.</dd>
1615 <!-- OBJECT PROPERTIES -->
1616 <dd>
1617 <dl>
1618 <div>
1619 <div>
1620 <dt>
1621 <var>name</var>
1622 <em>
1623 <!-- TYPE -->
1624 <div style="display:inline">
1625 (
1626 <span id="typeTemplate">
1627 <span>
1628 <span>string</span>
1629 </span>
1630 </span>
1631 )
1632 </div>
1633 </em>
1634 </dt>
1635 <dd>The name of the cookie.</dd>
1636 <!-- OBJECT PROPERTIES -->
1637 <!-- OBJECT METHODS -->
1638 <!-- OBJECT EVENT FIELDS -->
1639 <!-- FUNCTION PARAMETERS -->
1640 </div>
1641 </div><div>
1642 <div>
1643 <dt>
1644 <var>value</var>
1645 <em>
1646 <!-- TYPE -->
1647 <div style="display:inline">
1648 (
1649 <span id="typeTemplate">
1650 <span>
1651 <span>string</span>
1652 </span>
1653 </span>
1654 )
1655 </div>
1656 </em>
1657 </dt>
1658 <dd>The value of the cookie.</dd>
1659 <!-- OBJECT PROPERTIES -->
1660 <!-- OBJECT METHODS -->
1661 <!-- OBJECT EVENT FIELDS -->
1662 <!-- FUNCTION PARAMETERS -->
1663 </div>
1664 </div><div>
1665 <div>
1666 <dt>
1667 <var>domain</var>
1668 <em>
1669 <!-- TYPE -->
1670 <div style="display:inline">
1671 (
1672 <span id="typeTemplate">
1673 <span>
1674 <span>string</span>
1675 </span>
1676 </span>
1677 )
1678 </div>
1679 </em>
1680 </dt>
1681 <dd>The domain of the cookie (e.g. "www.google.com", "example.com").</ dd>
1682 <!-- OBJECT PROPERTIES -->
1683 <!-- OBJECT METHODS -->
1684 <!-- OBJECT EVENT FIELDS -->
1685 <!-- FUNCTION PARAMETERS -->
1686 </div>
1687 </div><div>
1688 <div>
1689 <dt>
1690 <var>hostOnly</var>
1691 <em>
1692 <!-- TYPE -->
1693 <div style="display:inline">
1694 (
1695 <span id="typeTemplate">
1696 <span>
1697 <span>boolean</span>
1698 </span>
1699 </span>
1700 )
1701 </div>
1702 </em>
1703 </dt>
1704 <dd>True if the cookie is a host-only cookie (i.e. a request's host mu st exactly match the domain of the cookie).</dd>
1705 <!-- OBJECT PROPERTIES -->
1706 <!-- OBJECT METHODS -->
1707 <!-- OBJECT EVENT FIELDS -->
1708 <!-- FUNCTION PARAMETERS -->
1709 </div>
1710 </div><div>
1711 <div>
1712 <dt>
1713 <var>path</var>
1714 <em>
1715 <!-- TYPE -->
1716 <div style="display:inline">
1717 (
1718 <span id="typeTemplate">
1719 <span>
1720 <span>string</span>
1721 </span>
1722 </span>
1723 )
1724 </div>
1725 </em>
1726 </dt>
1727 <dd>The path of the cookie.</dd>
1728 <!-- OBJECT PROPERTIES -->
1729 <!-- OBJECT METHODS -->
1730 <!-- OBJECT EVENT FIELDS -->
1731 <!-- FUNCTION PARAMETERS -->
1732 </div>
1733 </div><div>
1734 <div>
1735 <dt>
1736 <var>secure</var>
1737 <em>
1738 <!-- TYPE -->
1739 <div style="display:inline">
1740 (
1741 <span id="typeTemplate">
1742 <span>
1743 <span>boolean</span>
1744 </span>
1745 </span>
1746 )
1747 </div>
1748 </em>
1749 </dt>
1750 <dd>True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS).</dd>
1751 <!-- OBJECT PROPERTIES -->
1752 <!-- OBJECT METHODS -->
1753 <!-- OBJECT EVENT FIELDS -->
1754 <!-- FUNCTION PARAMETERS -->
1755 </div>
1756 </div><div>
1757 <div>
1758 <dt>
1759 <var>httpOnly</var>
1760 <em>
1761 <!-- TYPE -->
1762 <div style="display:inline">
1763 (
1764 <span id="typeTemplate">
1765 <span>
1766 <span>boolean</span>
1767 </span>
1768 </span>
1769 )
1770 </div>
1771 </em>
1772 </dt>
1773 <dd>True if the cookie is marked as HttpOnly (i.e. the cookie is inacc essible to client-side scripts).</dd>
1774 <!-- OBJECT PROPERTIES -->
1775 <!-- OBJECT METHODS -->
1776 <!-- OBJECT EVENT FIELDS -->
1777 <!-- FUNCTION PARAMETERS -->
1778 </div>
1779 </div><div>
1780 <div>
1781 <dt>
1782 <var>session</var>
1783 <em>
1784 <!-- TYPE -->
1785 <div style="display:inline">
1786 (
1787 <span id="typeTemplate">
1788 <span>
1789 <span>boolean</span>
1790 </span>
1791 </span>
1792 )
1793 </div>
1794 </em>
1795 </dt>
1796 <dd>True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date.</dd>
1797 <!-- OBJECT PROPERTIES -->
1798 <!-- OBJECT METHODS -->
1799 <!-- OBJECT EVENT FIELDS -->
1800 <!-- FUNCTION PARAMETERS -->
1801 </div>
1802 </div><div>
1803 <div>
1804 <dt>
1805 <var>expirationDate</var>
1806 <em>
1807 <!-- TYPE -->
1808 <div style="display:inline">
1809 (
1810 <span class="optional">optional</span>
1811 <span id="typeTemplate">
1812 <span>
1813 <span>number</span>
1814 </span>
1815 </span>
1816 )
1817 </div>
1818 </em>
1819 </dt>
1820 <dd>The expiration date of the cookie as the number of seconds since t he UNIX epoch. Not provided for session cookies.</dd>
1821 <!-- OBJECT PROPERTIES -->
1822 <!-- OBJECT METHODS -->
1823 <!-- OBJECT EVENT FIELDS -->
1824 <!-- FUNCTION PARAMETERS -->
1825 </div>
1826 </div><div>
1827 <div>
1828 <dt>
1829 <var>storeId</var>
1830 <em>
1831 <!-- TYPE -->
1832 <div style="display:inline">
1833 (
1834 <span id="typeTemplate">
1835 <span>
1836 <span>string</span>
1837 </span>
1838 </span>
1839 )
1840 </div>
1841 </em>
1842 </dt>
1843 <dd>The ID of the cookie store containing this cookie, as provided in getAllCookieStores().</dd>
1844 <!-- OBJECT PROPERTIES -->
1845 <!-- OBJECT METHODS -->
1846 <!-- OBJECT EVENT FIELDS -->
1847 <!-- FUNCTION PARAMETERS -->
1848 </div>
1849 </div>
1850 </dl>
1851 </dd>
1852 <!-- OBJECT METHODS -->
1853 <!-- OBJECT EVENT FIELDS -->
1854 <!-- FUNCTION PARAMETERS -->
1855 </div>
1856 </div><div class="apiItem">
1857 <a name="type-CookieStore"></a>
1858 <h4>CookieStore</h4>
1859 <div>
1860 <dt>
1861 <em>
1862 <!-- TYPE -->
1863 <div style="display:inline">
1864 (
1865 <span id="typeTemplate">
1866 <span>
1867 <span>object</span>
1868 </span>
1869 </span>
1870 )
1871 </div>
1872 </em>
1873 </dt>
1874 <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>
1875 <!-- OBJECT PROPERTIES -->
1876 <dd>
1877 <dl>
1878 <div>
1879 <div>
1880 <dt>
1881 <var>id</var>
1882 <em>
1883 <!-- TYPE -->
1884 <div style="display:inline">
1885 (
1886 <span id="typeTemplate">
1887 <span>
1888 <span>string</span>
1889 </span>
1890 </span>
1891 )
1892 </div>
1893 </em>
1894 </dt>
1895 <dd>The unique identifier for the cookie store.</dd>
1896 <!-- OBJECT PROPERTIES -->
1897 <!-- OBJECT METHODS -->
1898 <!-- OBJECT EVENT FIELDS -->
1899 <!-- FUNCTION PARAMETERS -->
1900 </div>
1901 </div><div>
1902 <div>
1903 <dt>
1904 <var>tabIds</var>
1905 <em>
1906 <!-- TYPE -->
1907 <div style="display:inline">
1908 (
1909 <span id="typeTemplate">
1910 <span>
1911 <span>
1912 array of <span><span>
1913 <span>
1914 <span>integer</span>
1915 </span>
1916 </span></span>
1917 </span>
1918 </span>
1919 </span>
1920 )
1921 </div>
1922 </em>
1923 </dt>
1924 <dd>Identifiers of all the browser tabs that share this cookie store.< /dd>
1925 <!-- OBJECT PROPERTIES -->
1926 <!-- OBJECT METHODS -->
1927 <!-- OBJECT EVENT FIELDS -->
1928 <!-- FUNCTION PARAMETERS -->
1929 </div>
1930 </div>
1931 </dl>
1932 </dd>
1933 <!-- OBJECT METHODS -->
1934 <!-- OBJECT EVENT FIELDS -->
1935 <!-- FUNCTION PARAMETERS -->
1936 </div>
1937 </div> <!-- /apiItem -->
1938 </div> <!-- /apiGroup -->
1939 </div> <!-- /apiPage -->
1940 </div> <!-- /gc-pagecontent -->
1941 </div> <!-- /g-section -->
1942 </div> <!-- /codesiteContent -->
1943 <div id="gc-footer" --="">
1944 <div class="text">
1945 <p>
1946 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1947 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1948 Attribution 3.0 License</a>, and code samples are licensed under the
1949 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1950 </p>
1951 <p>
1952 ©2011 Google
1953 </p>
1954 <!-- begin analytics -->
1955 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
1956 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
1957 <script type="text/javascript">
1958 // chrome doc tracking
1959 try {
1960 var engdocs = _gat._getTracker("YT-10763712-2");
1961 engdocs._trackPageview();
1962 } catch(err) {}
1963 // code.google.com site-wide tracking
1964 try {
1965 _uacct="UA-18071-1";
1966 _uanchor=1;
1967 _uff=0;
1968 urchinTracker();
1969 }
1970 catch(e) {/* urchinTracker not available. */}
1971 </script>
1972 <!-- end analytics -->
1973 </div>
1974 </div> <!-- /gc-footer -->
1975 </div> <!-- /gc-container -->
1976 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/contextMenus.html ('k') | chrome/common/extensions/docs/crx.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698