• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2    1) The <head> information in this page is significant, should be uniform
3       across api docs and should be edited only with knowledge of the
4       templating mechanism.
5    3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6       browser, it will be re-generated from the template, json schema and
7       authored overview content.
8    4) The <body>.innerHTML is also generated by an offline step so that this
9       page may easily be indexed by search engines.
10--><html xmlns="http://www.w3.org/1999/xhtml"><head>
11    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12    <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13    <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14    <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
15    </script>
16    <script type="text/javascript" src="js/api_page_generator.js"></script>
17    <script type="text/javascript" src="js/bootstrap.js"></script>
18    <script type="text/javascript" src="js/sidebar.js"></script>
19  <title>chrome.experimental.contentSettings.misc - 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&amp;t13n_langs=en"></script>
136          <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&amp;lang=en"></script>
137        </td>
138      </tr>
139    </tbody></table>
140
141    <div id="codesiteContent" class="">
142
143      <a id="gc-topnav-anchor"></a>
144      <div id="gc-topnav">
145        <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>
146        <ul id="home" class="gc-topnav-tabs">
147          <li id="home_link">
148            <a href="index.html" title="Google Chrome Extensions home page">Home</a>
149          </li>
150          <li id="docs_link">
151            <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>
152          </li>
153          <li id="faq_link">
154            <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>
155          </li>
156          <li id="samples_link">
157            <a href="samples.html" title="Sample extensions (with source code)">Samples</a>
158          </li>
159          <li id="group_link">
160            <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>
161          </li>
162        </ul>
163      </div> <!-- end gc-topnav -->
164
165    <div class="g-section g-tpl-170">
166      <!-- SIDENAV -->
167      <div class="g-unit g-first" id="gc-toc">
168        <ul>
169          <li><a href="getstarted.html">Getting Started</a></li>
170          <li><a href="overview.html">Overview</a></li>
171          <li><a href="whats_new.html">What's New?</a></li>
172          <li><h2><a href="devguide.html">Developer's Guide</a></h2>
173            <ul>
174              <li>Browser UI
175                <ul>
176                  <li><a href="browserAction.html">Browser Actions</a></li>
177                  <li><a href="contextMenus.html">Context Menus</a></li>
178                  <li><a href="notifications.html">Desktop Notifications</a></li>
179                  <li><a href="omnibox.html">Omnibox</a></li>
180                  <li><a href="options.html">Options Pages</a></li>
181                  <li><a href="override.html">Override Pages</a></li>
182                  <li><a href="pageAction.html">Page Actions</a></li>
183                </ul>
184              </li>
185              <li>Browser Interaction
186                <ul>
187                  <li><a href="bookmarks.html">Bookmarks</a></li>
188                  <li><a href="cookies.html">Cookies</a></li>
189                  <li><a href="events.html">Events</a></li>
190                  <li><a href="history.html">History</a></li>
191                  <li><a href="management.html">Management</a></li>
192                  <li><a href="tabs.html">Tabs</a></li>
193                  <li><a href="windows.html">Windows</a></li>
194                </ul>
195              </li>
196              <li>Implementation
197                <ul>
198                  <li><a href="a11y.html">Accessibility</a></li>
199                  <li><a href="background_pages.html">Background Pages</a></li>
200                  <li><a href="content_scripts.html">Content Scripts</a></li>
201                  <li><a href="xhr.html">Cross-Origin XHR</a></li>
202                  <li><a href="idle.html">Idle</a></li>
203                  <li><a href="i18n.html">Internationalization</a></li>
204                  <li><a href="messaging.html">Message Passing</a></li>
205                  <li><a href="npapi.html">NPAPI Plugins</a></li>
206                </ul>
207              </li>
208              <li>Finishing
209                <ul>
210                  <li><a href="hosting.html">Hosting</a></li>
211                  <li><a href="external_extensions.html">Other Deployment Options</a></li>
212                </ul>
213              </li>
214            </ul>
215          </li>
216          <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
217          <li><h2><a href="tutorials.html">Tutorials</a></h2>
218            <ul>
219              <li><a href="tut_debugging.html">Debugging</a></li>
220              <li><a href="tut_analytics.html">Google Analytics</a></li>
221              <li><a href="tut_oauth.html">OAuth</a></li>
222            </ul>
223          </li>
224          <li><h2>Reference</h2>
225            <ul>
226              <li>Formats
227                <ul>
228                  <li><a href="manifest.html">Manifest Files</a></li>
229                  <li><a href="match_patterns.html">Match Patterns</a></li>
230                </ul>
231              </li>
232              <li><a href="permission_warnings.html">Permission Warnings</a></li>
233              <li><a href="api_index.html">chrome.* APIs</a></li>
234              <li><a href="api_other.html">Other APIs</a></li>
235            </ul>
236          </li>
237          <li><h2><a href="samples.html">Samples</a></h2></li>
238          <div class="line"> </div>
239          <li><h2>More</h2>
240            <ul>
241              <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>
242              <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>
243              <li><a href="themes.html">Themes</a></li>
244            </ul>
245          </li>
246        </ul>
247      </div>
248      <script>
249        initToggles();
250      </script>
251
252    <div class="g-unit" id="gc-pagecontent">
253      <div id="pageTitle">
254        <h1 class="page_title">chrome.experimental.contentSettings.misc</h1>
255      </div>
256        <!-- TABLE OF CONTENTS -->
257        <div id="toc">
258          <h2>Contents</h2>
259          <ol>
260            <li style="display: none; ">
261              <a>h2Name</a>
262              <ol>
263                <li>
264                  <a>h3Name</a>
265                </li>
266              </ol>
267            </li>
268              <li>
269                <a href="#apiReference">API reference: chrome.experimental.contentSettings.misc</a>
270                <ol>
271                  <li>
272                    <a href="#properties">Properties</a>
273                    <ol>
274                      <li>
275                        <a href="#property-blockThirdPartyCookies">blockThirdPartyCookies</a>
276                      </li><li>
277                        <a href="#property-enableReferrers">enableReferrers</a>
278                      </li><li>
279                        <a href="#property-enableHyperlinkAuditing">enableHyperlinkAuditing</a>
280                      </li>
281                    </ol>
282                  </li>
283                  <li style="display: none; ">
284                    <a>Methods</a>
285                    <ol>
286                      <li>
287                        <a href="#method-anchor">methodName</a>
288                      </li>
289                    </ol>
290                  </li>
291                  <li style="display: none; ">
292                    <a>Events</a>
293                    <ol>
294                      <li>
295                        <a href="#event-anchor">eventName</a>
296                      </li>
297                    </ol>
298                  </li>
299                  <li style="display: none; ">
300                    <a href="#types">Types</a>
301                    <ol>
302                      <li>
303                        <a href="#id-anchor">id</a>
304                      </li>
305                    </ol>
306                  </li>
307                </ol>
308              </li>
309          </ol>
310        </div>
311        <!-- /TABLE OF CONTENTS -->
312
313        <!-- Standard content lead-in for experimental API pages -->
314        <p id="classSummary">
315          For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.
316        </p>
317
318        <!-- STATIC CONTENT PLACEHOLDER -->
319        <div id="static"></div>
320
321        <!-- API PAGE -->
322        <div class="apiPage">
323        <a name="apiReference"></a>
324        <h2>API reference: chrome.experimental.contentSettings.misc</h2>
325
326          <!-- PROPERTIES -->
327          <div class="apiGroup">
328            <a name="properties"></a>
329            <h3 id="properties">Properties</h3>
330
331            <div>
332              <a name="property-blockThirdPartyCookies"></a>
333              <h4>blockThirdPartyCookies</h4>
334              <div class="summary">
335                <!-- Note: intentionally longer 80 columns -->
336                <span>chrome.experimental.contentSettings.misc.</span><span>blockThirdPartyCookies</span>
337              </div>
338              <div>
339          <dt>
340            <var>blockThirdPartyCookies</var>
341              <em>
342
343                <!-- TYPE -->
344                <div style="display:inline">
345                  (
346                    <span class="optional" style="display: none; ">optional</span>
347                    <span class="enum" style="display: none; ">enumerated</span>
348                    <span id="typeTemplate">
349                      <span>
350                        <a href="experimental.extension.html#type-Preference">Preference</a>
351                      </span>
352                      <span style="display: none; ">
353                        <span>
354                          array of <span><span></span></span>
355                        </span>
356                        <span>paramType</span>
357                        <span></span>
358                      </span>
359                    </span>
360                  )
361                </div>
362
363              </em>
364          </dt>
365          <dd class="todo" style="display: none; ">
366            Undocumented.
367          </dd>
368          <dd>Whether third party cookies should be blocked. The value of this preference is of type boolean.</dd>
369          <dd style="display: none; ">
370            This parameter was added in version
371            <b><span></span></b>.
372            You must omit this parameter in earlier versions,
373            and you may omit it in any version.  If you require this
374            parameter, the manifest key
375            <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
376            can ensure that your extension won't be run in an earlier browser version.
377          </dd>
378
379          <!-- OBJECT PROPERTIES -->
380          <dd style="display: none; ">
381            <dl>
382              <div>
383                <div>
384                </div>
385              </div>
386            </dl>
387          </dd>
388
389          <!-- OBJECT METHODS -->
390          <dd style="display: none; ">
391            <div></div>
392          </dd>
393
394          <!-- OBJECT EVENT FIELDS -->
395          <dd style="display: none; ">
396            <div></div>
397          </dd>
398
399          <!-- FUNCTION PARAMETERS -->
400          <dd style="display: none; ">
401            <div></div>
402          </dd>
403
404        </div>
405            </div><div>
406              <a name="property-enableReferrers"></a>
407              <h4>enableReferrers</h4>
408              <div class="summary">
409                <!-- Note: intentionally longer 80 columns -->
410                <span>chrome.experimental.contentSettings.misc.</span><span>enableReferrers</span>
411              </div>
412              <div>
413          <dt>
414            <var>enableReferrers</var>
415              <em>
416
417                <!-- TYPE -->
418                <div style="display:inline">
419                  (
420                    <span class="optional" style="display: none; ">optional</span>
421                    <span class="enum" style="display: none; ">enumerated</span>
422                    <span id="typeTemplate">
423                      <span>
424                        <a href="experimental.extension.html#type-Preference">Preference</a>
425                      </span>
426                      <span style="display: none; ">
427                        <span>
428                          array of <span><span></span></span>
429                        </span>
430                        <span>paramType</span>
431                        <span></span>
432                      </span>
433                    </span>
434                  )
435                </div>
436
437              </em>
438          </dt>
439          <dd class="todo" style="display: none; ">
440            Undocumented.
441          </dd>
442          <dd>Whether referrers should be enabled. The value of this preference is of type boolean.</dd>
443          <dd style="display: none; ">
444            This parameter was added in version
445            <b><span></span></b>.
446            You must omit this parameter in earlier versions,
447            and you may omit it in any version.  If you require this
448            parameter, the manifest key
449            <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
450            can ensure that your extension won't be run in an earlier browser version.
451          </dd>
452
453          <!-- OBJECT PROPERTIES -->
454          <dd style="display: none; ">
455            <dl>
456              <div>
457                <div>
458                </div>
459              </div>
460            </dl>
461          </dd>
462
463          <!-- OBJECT METHODS -->
464          <dd style="display: none; ">
465            <div></div>
466          </dd>
467
468          <!-- OBJECT EVENT FIELDS -->
469          <dd style="display: none; ">
470            <div></div>
471          </dd>
472
473          <!-- FUNCTION PARAMETERS -->
474          <dd style="display: none; ">
475            <div></div>
476          </dd>
477
478        </div>
479            </div><div>
480              <a name="property-enableHyperlinkAuditing"></a>
481              <h4>enableHyperlinkAuditing</h4>
482              <div class="summary">
483                <!-- Note: intentionally longer 80 columns -->
484                <span>chrome.experimental.contentSettings.misc.</span><span>enableHyperlinkAuditing</span>
485              </div>
486              <div>
487          <dt>
488            <var>enableHyperlinkAuditing</var>
489              <em>
490
491                <!-- TYPE -->
492                <div style="display:inline">
493                  (
494                    <span class="optional" style="display: none; ">optional</span>
495                    <span class="enum" style="display: none; ">enumerated</span>
496                    <span id="typeTemplate">
497                      <span>
498                        <a href="experimental.extension.html#type-Preference">Preference</a>
499                      </span>
500                      <span style="display: none; ">
501                        <span>
502                          array of <span><span></span></span>
503                        </span>
504                        <span>paramType</span>
505                        <span></span>
506                      </span>
507                    </span>
508                  )
509                </div>
510
511              </em>
512          </dt>
513          <dd class="todo" style="display: none; ">
514            Undocumented.
515          </dd>
516          <dd>Whether to enable hyperlink auditing ("&lt;a ping&gt;"). The value of this preference is of type boolean.</dd>
517          <dd style="display: none; ">
518            This parameter was added in version
519            <b><span></span></b>.
520            You must omit this parameter in earlier versions,
521            and you may omit it in any version.  If you require this
522            parameter, the manifest key
523            <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
524            can ensure that your extension won't be run in an earlier browser version.
525          </dd>
526
527          <!-- OBJECT PROPERTIES -->
528          <dd style="display: none; ">
529            <dl>
530              <div>
531                <div>
532                </div>
533              </div>
534            </dl>
535          </dd>
536
537          <!-- OBJECT METHODS -->
538          <dd style="display: none; ">
539            <div></div>
540          </dd>
541
542          <!-- OBJECT EVENT FIELDS -->
543          <dd style="display: none; ">
544            <div></div>
545          </dd>
546
547          <!-- FUNCTION PARAMETERS -->
548          <dd style="display: none; ">
549            <div></div>
550          </dd>
551
552        </div>
553            </div>
554
555          </div> <!-- /apiGroup -->
556
557          <!-- METHODS -->
558          <div id="methodsTemplate" class="apiGroup" style="display: none; ">
559            <a></a>
560            <h3>Methods</h3>
561
562            <!-- iterates over all functions -->
563            <div class="apiItem">
564              <a></a> <!-- method-anchor -->
565              <h4>method name</h4>
566
567              <div class="summary"><span>void</span>
568                  <!-- Note: intentionally longer 80 columns -->
569                  <span>chrome.module.methodName</span>(<span><span>, </span><span></span>
570                      <var><span></span></var></span>)</div>
571
572              <div class="description">
573                <p class="todo">Undocumented.</p>
574                <p>
575                  A description from the json schema def of the function goes here.
576                </p>
577
578                <!-- PARAMETERS -->
579                <h4>Parameters</h4>
580                <dl>
581                  <div>
582                    <div>
583                    </div>
584                  </div>
585                </dl>
586
587                <!-- RETURNS -->
588                <h4>Returns</h4>
589                <dl>
590                  <div>
591                    <div>
592                    </div>
593                  </div>
594                </dl>
595
596                <!-- CALLBACK -->
597                <div>
598                  <div>
599                  <h4>Callback function</h4>
600                  <p>
601                    The callback <em>parameter</em> should specify a function
602                    that looks like this:
603                  </p>
604                  <p>
605                    If you specify the <em>callback</em> parameter, it should
606                    specify a function that looks like this:
607                  </p>
608
609                  <!-- Note: intentionally longer 80 columns -->
610                  <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre>
611                  <dl>
612                    <div>
613                      <div>
614                      </div>
615                    </div>
616                  </dl>
617                  </div>
618                </div>
619
620                <!-- MIN_VERSION -->
621                <p>
622                  This function was added in version <b><span></span></b>.
623                  If you require this function, the manifest key
624                  <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
625                  can ensure that your extension won't be run in an earlier browser version.
626                </p>
627              </div> <!-- /description -->
628
629            </div>  <!-- /apiItem -->
630
631          </div>  <!-- /apiGroup -->
632
633          <!-- EVENTS -->
634          <div id="eventsTemplate" class="apiGroup" style="display: none; ">
635            <a></a>
636            <h3>Events</h3>
637            <!-- iterates over all events -->
638            <div class="apiItem">
639              <a></a>
640              <h4>event name</h4>
641
642              <div class="summary">
643                <!-- Note: intentionally longer 80 columns -->
644                <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);
645              </div>
646
647              <div class="description">
648                <p class="todo">Undocumented.</p>
649                <p>
650                  A description from the json schema def of the event goes here.
651                </p>
652
653                <!-- PARAMETERS -->
654                <div>
655                  <h4>Parameters</h4>
656                  <dl>
657                    <div>
658                      <div>
659                      </div>
660                    </div>
661                  </dl>
662                </div>
663              </div> <!-- /decription -->
664
665            </div> <!-- /apiItem -->
666
667          </div> <!-- /apiGroup -->
668
669          <!-- TYPES -->
670          <div class="apiGroup" style="display: none; ">
671            <a name="types"></a>
672            <h3 id="types">Types</h3>
673
674            <!-- iterates over all types -->
675            <div class="apiItem">
676              <a></a>
677              <h4>type name</h4>
678
679              <div>
680              </div>
681
682            </div> <!-- /apiItem -->
683
684          </div> <!-- /apiGroup -->
685
686        </div> <!-- /apiPage -->
687      </div> <!-- /gc-pagecontent -->
688    </div> <!-- /g-section -->
689  </div> <!-- /codesiteContent -->
690    <div id="gc-footer" --="">
691      <div class="text">
692  <p>
693  Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
694  the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
695  Attribution 3.0 License</a>, and code samples are licensed under the
696  <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
697  </p>
698  <p>
699  ©2011 Google
700  </p>
701
702<!-- begin analytics -->
703<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
704<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>
705
706<script type="text/javascript">
707  // chrome doc tracking
708  try {
709    var engdocs = _gat._getTracker("YT-10763712-2");
710    engdocs._trackPageview();
711  } catch(err) {}
712
713  // code.google.com site-wide tracking
714  try {
715    _uacct="UA-18071-1";
716    _uanchor=1;
717    _uff=0;
718    urchinTracker();
719  }
720  catch(e) {/* urchinTracker not available. */}
721</script>
722<!-- end analytics -->
723      </div>
724    </div> <!-- /gc-footer -->
725  </div> <!-- /gc-container -->
726</body></html>
727