| OLD | NEW |
| (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.contentSettings
module, which is part of the Google Chrome extension APIs."><title>Content Set
tings - Google Chrome 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&t13n_langs=en"></script> | |
| 70 <script type="text/javascript" src="https://www.google.com/coop/cse/br
and?form=cse&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><a href="cookies.html">Cookies</a></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">Content Settings</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="#patterns">Content setting patterns</a> | |
| 200 <ol> | |
| 201 <li> | |
| 202 <a href="#pattern-precedence">Pattern precedence</a> | |
| 203 </li> | |
| 204 </ol> | |
| 205 </li><li> | |
| 206 <a href="#primary-secondary">Primary and secondary patterns</a> | |
| 207 <ol> | |
| 208 </ol> | |
| 209 </li><li> | |
| 210 <a href="#resource-identifiers">Resource identifiers</a> | |
| 211 <ol> | |
| 212 </ol> | |
| 213 </li><li> | |
| 214 <a href="#examples">Examples</a> | |
| 215 <ol> | |
| 216 </ol> | |
| 217 </li> | |
| 218 <li> | |
| 219 <a href="#apiReference">API reference: chrome.contentSettings</a
> | |
| 220 <ol> | |
| 221 <li> | |
| 222 <a href="#properties">Properties</a> | |
| 223 <ol> | |
| 224 <li> | |
| 225 <a href="#property-cookies">cookies</a> | |
| 226 </li><li> | |
| 227 <a href="#property-images">images</a> | |
| 228 </li><li> | |
| 229 <a href="#property-javascript">javascript</a> | |
| 230 </li><li> | |
| 231 <a href="#property-plugins">plugins</a> | |
| 232 </li><li> | |
| 233 <a href="#property-popups">popups</a> | |
| 234 </li><li> | |
| 235 <a href="#property-notifications">notifications</a> | |
| 236 </li> | |
| 237 </ol> | |
| 238 </li> | |
| 239 <li> | |
| 240 <a href="#types">Types</a> | |
| 241 <ol> | |
| 242 <li> | |
| 243 <a href="#type-ResourceIdentifier">ResourceIdentifier</a> | |
| 244 <ol> | |
| 245 </ol> | |
| 246 </li><li> | |
| 247 <a href="#type-ContentSetting">ContentSetting</a> | |
| 248 <ol> | |
| 249 <li> | |
| 250 <a href="#global-ContentSetting-methods">Methods</a> | |
| 251 <ol> | |
| 252 <li> | |
| 253 <a href="#method-ContentSetting-clear">clear</a> | |
| 254 </li><li> | |
| 255 <a href="#method-ContentSetting-get">get</a> | |
| 256 </li><li> | |
| 257 <a href="#method-ContentSetting-getResourceIdentifiers">getResou
rceIdentifiers</a> | |
| 258 </li><li> | |
| 259 <a href="#method-ContentSetting-set">set</a> | |
| 260 </li> | |
| 261 </ol> | |
| 262 </li> | |
| 263 </ol> | |
| 264 </li> | |
| 265 </ol> | |
| 266 </li> | |
| 267 </ol> | |
| 268 </li> | |
| 269 </ol> | |
| 270 </div> | |
| 271 <!-- /TABLE OF CONTENTS --> | |
| 272 <!-- Standard content lead-in for experimental API pages --> | |
| 273 <!-- STATIC CONTENT PLACEHOLDER --> | |
| 274 <div id="static"><div id="pageData-name" class="pageData">Content Settin
gs</div> | |
| 275 <!-- BEGIN AUTHORED CONTENT --> | |
| 276 <p> | |
| 277 The content settings module allows you to change settings that control whether | |
| 278 websites can use features such as cookies, JavaScript, and plug-ins. | |
| 279 More generally speaking, content settings allow you to customize Chrome's | |
| 280 behavior on a per-site basis instead of globally.</p> | |
| 281 <p> | |
| 282 </p> | |
| 283 <h2 id="manifest">Manifest</h2> | |
| 284 <p>You must declare the "contentSettings" permission | |
| 285 in your extension's manifest to use the API. | |
| 286 For example:</p> | |
| 287 <pre>{ | |
| 288 "name": "My extension", | |
| 289 ... | |
| 290 <b>"permissions": [ | |
| 291 "contentSettings" | |
| 292 ]</b>, | |
| 293 ... | |
| 294 }</pre> | |
| 295 <h2 id="patterns">Content setting patterns</h2> | |
| 296 <p> | |
| 297 You can use patterns to specify the websites that each content setting affects. | |
| 298 For example, <code>http://*.youtube.com/*</code> specifies youtube.com and all | |
| 299 of its subdomains. The syntax for content setting patterns is the same as for | |
| 300 <a href="match_patterns.html">match patterns</a>, with a few differences: | |
| 301 </p><ul><li>For <code>http</code>, | |
| 302 <code>https</code>, and <code>ftp</code> URLs, the path must be a wildcard | |
| 303 (<code>/*</code>). For <code>file</code> URLs, the path must be completely | |
| 304 specified and <strong>must not</strong> contain wildcards.</li> | |
| 305 <li>In contrast to match patterns, content setting patterns can specify a port | |
| 306 number. If a port number is specified, the pattern only matches websites with | |
| 307 that port. If no port number is specified, the pattern matches all ports. | |
| 308 </li> | |
| 309 </ul> | |
| 310 <p></p> | |
| 311 <h3 id="pattern-precedence">Pattern precedence</h3> | |
| 312 <p> | |
| 313 When more than one content setting rule applies for a given site, the rule with | |
| 314 the more specific pattern takes precedence. | |
| 315 </p> | |
| 316 <p>For example, the following patterns are ordered by precedence:</p> | |
| 317 <ol> | |
| 318 <li><code>http://www.example.com/*</code></li> | |
| 319 <li><code>http://*.example.com/*</code> (matching | |
| 320 example.com and all subdomains)</li> | |
| 321 <li><code><all_urls></code> (matching every URL)</li> | |
| 322 </ol> | |
| 323 <p> | |
| 324 Three kinds of wildcards affect how specific a pattern is: | |
| 325 </p> | |
| 326 <ul> | |
| 327 <li>Wildcards in the port (for example | |
| 328 <code>http://www.example.com:*/*</code>)</li> | |
| 329 <li>Wildcards in the scheme (for example | |
| 330 <code>*://www.example.com:123/*</code>)</li> | |
| 331 <li>Wildcards in the hostname (for example | |
| 332 <code>http://*.example.com:123/*</code>)</li> | |
| 333 </ul> | |
| 334 <p> | |
| 335 If a pattern is more specific than another pattern in one part but less specific | |
| 336 in another part, the different parts are checked in the following order: | |
| 337 hostname, scheme, port. For example, the following patterns are ordered by | |
| 338 precedence:</p> | |
| 339 <ol> | |
| 340 <li><code>http://www.example.com:*/*</code><br> | |
| 341 Specifies the hostname and scheme.</li> | |
| 342 <li><code>*:/www.example.com:123/*</code><br> | |
| 343 Not as high, because although it specifies the hostname, it doesn't specify | |
| 344 the scheme.</li> | |
| 345 <li><code>http://*.example.com:123/*</code><br> | |
| 346 Lower because although it specifies the port and scheme, it has a wildcard | |
| 347 in the hostname.</li> | |
| 348 </ol> | |
| 349 <h2 id="primary-secondary">Primary and secondary patterns</h2> | |
| 350 <p> | |
| 351 The URL taken into account when deciding which content setting to apply depends | |
| 352 on the content type. For example, for | |
| 353 <a href="#property-notifications">notifications</a> settings are | |
| 354 based on the URL shown in the omnibox. This URL is called the "primary" URL.</p> | |
| 355 <p> | |
| 356 Some content types can take additional URLs into account. For example, | |
| 357 whether a site is allowed to set a | |
| 358 <a href="#property-cookies">cookie</a> is decided based on the URL | |
| 359 of the HTTP request (which is the primary URL in this case) as well as the URL | |
| 360 shown in the omnibox (which is called the "secondary" URL). | |
| 361 </p> | |
| 362 <p> | |
| 363 If multiple rules have primary and secondary patterns, the rule with the more | |
| 364 specific primary pattern takes precedence. If there multiple rules have the same | |
| 365 primary pattern, the rule with the more specific secondary pattern takes | |
| 366 precedence. For example, the following list of primary/secondary pattern pairs | |
| 367 is ordered by precedence:</p> | |
| 368 <table> | |
| 369 <tbody><tr><th>Precedence</th><th>Primary pattern</th><th>Secondary pattern</th> | |
| 370 </tr><tr> | |
| 371 <td>1</td> | |
| 372 <td><code>http://www.moose.com/*</code>, </td> | |
| 373 <td><code>http://www.wombat.com/*</code></td> | |
| 374 </tr><tr> | |
| 375 <td>2</td> | |
| 376 <td><code>http://www.moose.com/*</code>, </td> | |
| 377 <td><code><all_urls></code></td> | |
| 378 </tr><tr> | |
| 379 <td>3</td> | |
| 380 <td><code><all_urls></code>, </td> | |
| 381 <td><code>http://www.wombat.com/*</code></td> | |
| 382 </tr><tr> | |
| 383 <td>4</td> | |
| 384 <td><code><all_urls></code>, </td> | |
| 385 <td><code><all_urls></code></td> | |
| 386 </tr> | |
| 387 </tbody></table> | |
| 388 <h2 id="resource-identifiers">Resource identifiers</h2> | |
| 389 <p> | |
| 390 Resource identifiers allow you to specify content settings for specific | |
| 391 subtypes of a content type. Currently, the only content type that supports | |
| 392 resource identifiers is <a href="#property-plugins"><code>plugins</code></a>, | |
| 393 where a resource identifier identifies a specific plug-in. When applying content | |
| 394 settings, first the settings for the specific plug-in are checked. If there are | |
| 395 no settings found for the specific plug-in, the general content settings for | |
| 396 plug-ins are checked. | |
| 397 </p> | |
| 398 <p> | |
| 399 For example, if a content setting rule has the resource identifier | |
| 400 <code>adobe-flash-player</code> and the pattern <code><all_urls></code>, | |
| 401 it takes precedence over a rule without a resource identifier and the pattern | |
| 402 <code>http://www.example.com/*</code>, even if that pattern is more specific. | |
| 403 </p> | |
| 404 <p> | |
| 405 You can get a list of resource identifiers for a content type by calling the | |
| 406 <a href="contentSettings.html#method-ContentSetting-getResourceIdentifiers"> | |
| 407 <code>getResourceIdentifiers()</code></a> method. The returned list | |
| 408 can change with the set of installed plug-ins on the user's machine, but Chrome | |
| 409 tries to keep the identifiers stable across plug-in updates. | |
| 410 </p> | |
| 411 <h2 id="examples">Examples</h2> | |
| 412 <p> | |
| 413 You can find samples of this API on the | |
| 414 <a href="samples.html#contentSettings">sample page</a>. | |
| 415 </p> | |
| 416 <!-- END AUTHORED CONTENT --> | |
| 417 </div> | |
| 418 <!-- API PAGE --> | |
| 419 <div class="apiPage"> | |
| 420 <a name="apiReference"></a> | |
| 421 <h2>API reference: chrome.contentSettings</h2> | |
| 422 <!-- PROPERTIES --> | |
| 423 <div class="apiGroup"> | |
| 424 <a name="properties"></a> | |
| 425 <h3 id="properties">Properties</h3> | |
| 426 <div> | |
| 427 <a name="property-cookies"></a> | |
| 428 <h4>cookies</h4> | |
| 429 <div class="summary"> | |
| 430 <!-- Note: intentionally longer 80 columns --> | |
| 431 <span>chrome.contentSettings.</span><span>cookies</span> | |
| 432 </div> | |
| 433 <div> | |
| 434 <dt> | |
| 435 <var>cookies</var> | |
| 436 <em> | |
| 437 <!-- TYPE --> | |
| 438 <div style="display:inline"> | |
| 439 ( | |
| 440 <span id="typeTemplate"> | |
| 441 <span> | |
| 442 <a href="contentSettings.html#type-ContentSetting">Conte
ntSetting</a> | |
| 443 </span> | |
| 444 </span> | |
| 445 ) | |
| 446 </div> | |
| 447 </em> | |
| 448 </dt> | |
| 449 <dd>Whether to allow cookies and other local data to be set by website
s. One of<br><var>allow</var>: Accept cookies,<br><var>block</var>: Block cookie
s,<br><var>session_only</var>: Accept cookies only for the current session. <br>
Default is <var>allow</var>.<br>The primary URL is the URL representing the cook
ie origin. The secondary URL is the URL of the top-level frame.</dd> | |
| 450 <!-- OBJECT PROPERTIES --> | |
| 451 <!-- OBJECT METHODS --> | |
| 452 <!-- OBJECT EVENT FIELDS --> | |
| 453 <!-- FUNCTION PARAMETERS --> | |
| 454 </div> | |
| 455 </div><div> | |
| 456 <a name="property-images"></a> | |
| 457 <h4>images</h4> | |
| 458 <div class="summary"> | |
| 459 <!-- Note: intentionally longer 80 columns --> | |
| 460 <span>chrome.contentSettings.</span><span>images</span> | |
| 461 </div> | |
| 462 <div> | |
| 463 <dt> | |
| 464 <var>images</var> | |
| 465 <em> | |
| 466 <!-- TYPE --> | |
| 467 <div style="display:inline"> | |
| 468 ( | |
| 469 <span id="typeTemplate"> | |
| 470 <span> | |
| 471 <a href="contentSettings.html#type-ContentSetting">Conte
ntSetting</a> | |
| 472 </span> | |
| 473 </span> | |
| 474 ) | |
| 475 </div> | |
| 476 </em> | |
| 477 </dt> | |
| 478 <dd>Whether to show images. One of<br><var>allow</var>: Show images,<b
r><var>block</var>: Don't show images. <br>Default is <var>allow</var>.<br>The p
rimary URL is the main-frame URL. The secondary URL is the URL of the image.</dd
> | |
| 479 <!-- OBJECT PROPERTIES --> | |
| 480 <!-- OBJECT METHODS --> | |
| 481 <!-- OBJECT EVENT FIELDS --> | |
| 482 <!-- FUNCTION PARAMETERS --> | |
| 483 </div> | |
| 484 </div><div> | |
| 485 <a name="property-javascript"></a> | |
| 486 <h4>javascript</h4> | |
| 487 <div class="summary"> | |
| 488 <!-- Note: intentionally longer 80 columns --> | |
| 489 <span>chrome.contentSettings.</span><span>javascript</span> | |
| 490 </div> | |
| 491 <div> | |
| 492 <dt> | |
| 493 <var>javascript</var> | |
| 494 <em> | |
| 495 <!-- TYPE --> | |
| 496 <div style="display:inline"> | |
| 497 ( | |
| 498 <span id="typeTemplate"> | |
| 499 <span> | |
| 500 <a href="contentSettings.html#type-ContentSetting">Conte
ntSetting</a> | |
| 501 </span> | |
| 502 </span> | |
| 503 ) | |
| 504 </div> | |
| 505 </em> | |
| 506 </dt> | |
| 507 <dd>Whether to run JavaScript. One of<br><var>allow</var>: Run JavaScr
ipt,<br><var>block</var>: Don't run JavaScript. <br>Default is <var>allow</var>.
<br>The primary URL is the main-frame URL. The secondary URL is not used.</dd> | |
| 508 <!-- OBJECT PROPERTIES --> | |
| 509 <!-- OBJECT METHODS --> | |
| 510 <!-- OBJECT EVENT FIELDS --> | |
| 511 <!-- FUNCTION PARAMETERS --> | |
| 512 </div> | |
| 513 </div><div> | |
| 514 <a name="property-plugins"></a> | |
| 515 <h4>plugins</h4> | |
| 516 <div class="summary"> | |
| 517 <!-- Note: intentionally longer 80 columns --> | |
| 518 <span>chrome.contentSettings.</span><span>plugins</span> | |
| 519 </div> | |
| 520 <div> | |
| 521 <dt> | |
| 522 <var>plugins</var> | |
| 523 <em> | |
| 524 <!-- TYPE --> | |
| 525 <div style="display:inline"> | |
| 526 ( | |
| 527 <span id="typeTemplate"> | |
| 528 <span> | |
| 529 <a href="contentSettings.html#type-ContentSetting">Conte
ntSetting</a> | |
| 530 </span> | |
| 531 </span> | |
| 532 ) | |
| 533 </div> | |
| 534 </em> | |
| 535 </dt> | |
| 536 <dd>Whether to run plug-ins. One of<br><var>allow</var>: Run plug-ins
automatically,<br><var>block</var>: Don't run plug-ins automatically. <br>Defaul
t is <var>allow</var>.<br>The primary URL is the main-frame URL. The secondary U
RL is not used.</dd> | |
| 537 <!-- OBJECT PROPERTIES --> | |
| 538 <!-- OBJECT METHODS --> | |
| 539 <!-- OBJECT EVENT FIELDS --> | |
| 540 <!-- FUNCTION PARAMETERS --> | |
| 541 </div> | |
| 542 </div><div> | |
| 543 <a name="property-popups"></a> | |
| 544 <h4>popups</h4> | |
| 545 <div class="summary"> | |
| 546 <!-- Note: intentionally longer 80 columns --> | |
| 547 <span>chrome.contentSettings.</span><span>popups</span> | |
| 548 </div> | |
| 549 <div> | |
| 550 <dt> | |
| 551 <var>popups</var> | |
| 552 <em> | |
| 553 <!-- TYPE --> | |
| 554 <div style="display:inline"> | |
| 555 ( | |
| 556 <span id="typeTemplate"> | |
| 557 <span> | |
| 558 <a href="contentSettings.html#type-ContentSetting">Conte
ntSetting</a> | |
| 559 </span> | |
| 560 </span> | |
| 561 ) | |
| 562 </div> | |
| 563 </em> | |
| 564 </dt> | |
| 565 <dd>Whether to allow sites to show pop-ups. One of<br><var>allow</var>
: Allow sites to show pop-ups,<br><var>block</var>: Don't allow sites to show po
p-ups. <br>Default is <var>block</var>.<br>The primary URL is the main-frame URL
. The secondary URL is not used.</dd> | |
| 566 <!-- OBJECT PROPERTIES --> | |
| 567 <!-- OBJECT METHODS --> | |
| 568 <!-- OBJECT EVENT FIELDS --> | |
| 569 <!-- FUNCTION PARAMETERS --> | |
| 570 </div> | |
| 571 </div><div> | |
| 572 <a name="property-notifications"></a> | |
| 573 <h4>notifications</h4> | |
| 574 <div class="summary"> | |
| 575 <!-- Note: intentionally longer 80 columns --> | |
| 576 <span>chrome.contentSettings.</span><span>notifications</span> | |
| 577 </div> | |
| 578 <div> | |
| 579 <dt> | |
| 580 <var>notifications</var> | |
| 581 <em> | |
| 582 <!-- TYPE --> | |
| 583 <div style="display:inline"> | |
| 584 ( | |
| 585 <span id="typeTemplate"> | |
| 586 <span> | |
| 587 <a href="contentSettings.html#type-ContentSetting">Conte
ntSetting</a> | |
| 588 </span> | |
| 589 </span> | |
| 590 ) | |
| 591 </div> | |
| 592 </em> | |
| 593 </dt> | |
| 594 <dd>Whether to allow sites to show desktop notifications. One of<br><v
ar>allow</var>: Allow sites to show desktop notifications,<br><var>block</var>:
Don't allow sites to show desktop notifications,<br><var>ask</var>: Ask when a s
ite wants to show desktop notifications. <br>Default is <var>ask</var>.<br>The p
rimary URL is the main-frame URL. The secondary URL is not used.</dd> | |
| 595 <!-- OBJECT PROPERTIES --> | |
| 596 <!-- OBJECT METHODS --> | |
| 597 <!-- OBJECT EVENT FIELDS --> | |
| 598 <!-- FUNCTION PARAMETERS --> | |
| 599 </div> | |
| 600 </div> | |
| 601 </div> <!-- /apiGroup --> | |
| 602 <!-- METHODS --> | |
| 603 <!-- /apiGroup --> | |
| 604 <!-- EVENTS --> | |
| 605 <!-- /apiGroup --> | |
| 606 <!-- TYPES --> | |
| 607 <div class="apiGroup"> | |
| 608 <a name="types"></a> | |
| 609 <h3 id="types">Types</h3> | |
| 610 <!-- iterates over all types --> | |
| 611 <div class="apiItem"> | |
| 612 <a name="type-ResourceIdentifier"></a> | |
| 613 <h4>ResourceIdentifier</h4> | |
| 614 <div> | |
| 615 <dt> | |
| 616 <em> | |
| 617 <!-- TYPE --> | |
| 618 <div style="display:inline"> | |
| 619 ( | |
| 620 <span id="typeTemplate"> | |
| 621 <span> | |
| 622 <span>object</span> | |
| 623 </span> | |
| 624 </span> | |
| 625 ) | |
| 626 </div> | |
| 627 </em> | |
| 628 </dt> | |
| 629 <dd>The only content type using resource identifiers is <a href="conte
ntSettings.html#property-plugins"><var>plugins</var></a>. For more information,
see <a href="contentSettings.html#resource-identifiers">Resource Identifiers</a>
.</dd> | |
| 630 <!-- OBJECT PROPERTIES --> | |
| 631 <dd> | |
| 632 <dl> | |
| 633 <div> | |
| 634 <div> | |
| 635 <dt> | |
| 636 <var>id</var> | |
| 637 <em> | |
| 638 <!-- TYPE --> | |
| 639 <div style="display:inline"> | |
| 640 ( | |
| 641 <span id="typeTemplate"> | |
| 642 <span> | |
| 643 <span>string</span> | |
| 644 </span> | |
| 645 </span> | |
| 646 ) | |
| 647 </div> | |
| 648 </em> | |
| 649 </dt> | |
| 650 <dd>The resource identifier for the given content type.</dd> | |
| 651 <!-- OBJECT PROPERTIES --> | |
| 652 <!-- OBJECT METHODS --> | |
| 653 <!-- OBJECT EVENT FIELDS --> | |
| 654 <!-- FUNCTION PARAMETERS --> | |
| 655 </div> | |
| 656 </div><div> | |
| 657 <div> | |
| 658 <dt> | |
| 659 <var>description</var> | |
| 660 <em> | |
| 661 <!-- TYPE --> | |
| 662 <div style="display:inline"> | |
| 663 ( | |
| 664 <span class="optional">optional</span> | |
| 665 <span id="typeTemplate"> | |
| 666 <span> | |
| 667 <span>string</span> | |
| 668 </span> | |
| 669 </span> | |
| 670 ) | |
| 671 </div> | |
| 672 </em> | |
| 673 </dt> | |
| 674 <dd>A human readable description of the resource.</dd> | |
| 675 <!-- OBJECT PROPERTIES --> | |
| 676 <!-- OBJECT METHODS --> | |
| 677 <!-- OBJECT EVENT FIELDS --> | |
| 678 <!-- FUNCTION PARAMETERS --> | |
| 679 </div> | |
| 680 </div> | |
| 681 </dl> | |
| 682 </dd> | |
| 683 <!-- OBJECT METHODS --> | |
| 684 <!-- OBJECT EVENT FIELDS --> | |
| 685 <!-- FUNCTION PARAMETERS --> | |
| 686 </div> | |
| 687 </div><div class="apiItem"> | |
| 688 <a name="type-ContentSetting"></a> | |
| 689 <h4>ContentSetting</h4> | |
| 690 <div> | |
| 691 <dt> | |
| 692 <em> | |
| 693 <!-- TYPE --> | |
| 694 <div style="display:inline"> | |
| 695 ( | |
| 696 <span id="typeTemplate"> | |
| 697 <span> | |
| 698 <span>object</span> | |
| 699 </span> | |
| 700 </span> | |
| 701 ) | |
| 702 </div> | |
| 703 </em> | |
| 704 </dt> | |
| 705 <dd class="todo"> | |
| 706 Undocumented. | |
| 707 </dd> | |
| 708 <!-- OBJECT PROPERTIES --> | |
| 709 <!-- OBJECT METHODS --> | |
| 710 <dd> | |
| 711 <div class="apiGroup"> | |
| 712 <a name="global-ContentSetting-methods"></a> | |
| 713 <h3>Methods of ContentSetting</h3> | |
| 714 <!-- iterates over all functions --> | |
| 715 <div class="apiItem"> | |
| 716 <a name="method-ContentSetting-clear"></a> <!-- method-anchor --> | |
| 717 <h4>clear</h4> | |
| 718 <div class="summary"> | |
| 719 <!-- Note: intentionally longer 80 columns --> | |
| 720 <span>contentSetting.clear</span>(<span class="null"><span>obj
ect</span> | |
| 721 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> | |
| 722 <var><span>callback</span></var></span>)</div> | |
| 723 <div class="description"> | |
| 724 <p>Clear all content setting rules set by this extension.</p> | |
| 725 <!-- PARAMETERS --> | |
| 726 <h4>Parameters</h4> | |
| 727 <dl> | |
| 728 <div> | |
| 729 <div> | |
| 730 <dt> | |
| 731 <var>details</var> | |
| 732 <em> | |
| 733 <!-- TYPE --> | |
| 734 <div style="display:inline"> | |
| 735 ( | |
| 736 <span id="typeTemplate"> | |
| 737 <span> | |
| 738 <span>object</span> | |
| 739 </span> | |
| 740 </span> | |
| 741 ) | |
| 742 </div> | |
| 743 </em> | |
| 744 </dt> | |
| 745 <dd class="todo"> | |
| 746 Undocumented. | |
| 747 </dd> | |
| 748 <!-- OBJECT PROPERTIES --> | |
| 749 <dd> | |
| 750 <dl> | |
| 751 <div> | |
| 752 <div> | |
| 753 <dt> | |
| 754 <var>scope</var> | |
| 755 <em> | |
| 756 <!-- TYPE --> | |
| 757 <div style="display:inline"> | |
| 758 ( | |
| 759 <span class="optional">optional</span> | |
| 760 <span class="enum">enumerated</span> | |
| 761 <span id="typeTemplate"> | |
| 762 <span> | |
| 763 <span>string</span> | |
| 764 <span>["regular", "incognito_session_only"]</span> | |
| 765 </span> | |
| 766 </span> | |
| 767 ) | |
| 768 </div> | |
| 769 </em> | |
| 770 </dt> | |
| 771 <dd>Where to set the setting (default: regular). One of<br><var>regula
r</var>: setting for regular profile (which is inherited by the incognito profil
e if not overridden elsewhere),<br><var>incognito_session_only</var>: setting fo
r incognito profile that can only be set during an incognito session and is dele
ted when the incognito session ends (overrides regular settings).</dd> | |
| 772 <!-- OBJECT PROPERTIES --> | |
| 773 <!-- OBJECT METHODS --> | |
| 774 <!-- OBJECT EVENT FIELDS --> | |
| 775 <!-- FUNCTION PARAMETERS --> | |
| 776 </div> | |
| 777 </div> | |
| 778 </dl> | |
| 779 </dd> | |
| 780 <!-- OBJECT METHODS --> | |
| 781 <!-- OBJECT EVENT FIELDS --> | |
| 782 <!-- FUNCTION PARAMETERS --> | |
| 783 </div> | |
| 784 </div><div> | |
| 785 <div> | |
| 786 <dt> | |
| 787 <var>callback</var> | |
| 788 <em> | |
| 789 <!-- TYPE --> | |
| 790 <div style="display:inline"> | |
| 791 ( | |
| 792 <span class="optional">optional</span> | |
| 793 <span id="typeTemplate"> | |
| 794 <span> | |
| 795 <span>function</span> | |
| 796 </span> | |
| 797 </span> | |
| 798 ) | |
| 799 </div> | |
| 800 </em> | |
| 801 </dt> | |
| 802 <dd class="todo"> | |
| 803 Undocumented. | |
| 804 </dd> | |
| 805 <!-- OBJECT PROPERTIES --> | |
| 806 <!-- OBJECT METHODS --> | |
| 807 <!-- OBJECT EVENT FIELDS --> | |
| 808 <!-- FUNCTION PARAMETERS --> | |
| 809 </div> | |
| 810 </div> | |
| 811 </dl> | |
| 812 <!-- RETURNS --> | |
| 813 <dl> | |
| 814 </dl> | |
| 815 <!-- CALLBACK --> | |
| 816 <div> | |
| 817 <div> | |
| 818 <h4>Callback function</h4> | |
| 819 <p> | |
| 820 If you specify the <em>callback</em> parameter, it should | |
| 821 specify a function that looks like this: | |
| 822 </p> | |
| 823 <!-- Note: intentionally longer 80 columns --> | |
| 824 <pre>function(<span></span>) <span class="subdued">{...}</span
>;</pre> | |
| 825 <dl> | |
| 826 </dl> | |
| 827 </div> | |
| 828 </div> | |
| 829 <!-- MIN_VERSION --> | |
| 830 </div> <!-- /description --> | |
| 831 </div><div class="apiItem"> | |
| 832 <a name="method-ContentSetting-get"></a> <!-- method-anchor --> | |
| 833 <h4>get</h4> | |
| 834 <div class="summary"> | |
| 835 <!-- Note: intentionally longer 80 columns --> | |
| 836 <span>contentSetting.get</span>(<span class="null"><span>objec
t</span> | |
| 837 <var><span>details</span></var></span><span class="null"><
span>, </span><span>function</span> | |
| 838 <var><span>callback</span></var></span>)</div> | |
| 839 <div class="description"> | |
| 840 <p>Gets the current content setting for a given pair of URLs.</p
> | |
| 841 <!-- PARAMETERS --> | |
| 842 <h4>Parameters</h4> | |
| 843 <dl> | |
| 844 <div> | |
| 845 <div> | |
| 846 <dt> | |
| 847 <var>details</var> | |
| 848 <em> | |
| 849 <!-- TYPE --> | |
| 850 <div style="display:inline"> | |
| 851 ( | |
| 852 <span id="typeTemplate"> | |
| 853 <span> | |
| 854 <span>object</span> | |
| 855 </span> | |
| 856 </span> | |
| 857 ) | |
| 858 </div> | |
| 859 </em> | |
| 860 </dt> | |
| 861 <dd class="todo"> | |
| 862 Undocumented. | |
| 863 </dd> | |
| 864 <!-- OBJECT PROPERTIES --> | |
| 865 <dd> | |
| 866 <dl> | |
| 867 <div> | |
| 868 <div> | |
| 869 <dt> | |
| 870 <var>primaryUrl</var> | |
| 871 <em> | |
| 872 <!-- TYPE --> | |
| 873 <div style="display:inline"> | |
| 874 ( | |
| 875 <span id="typeTemplate"> | |
| 876 <span> | |
| 877 <span>string</span> | |
| 878 </span> | |
| 879 </span> | |
| 880 ) | |
| 881 </div> | |
| 882 </em> | |
| 883 </dt> | |
| 884 <dd>The primary URL for which the content setting should be retrieved.
Note that the meaning of a primary URL depends on the content type.</dd> | |
| 885 <!-- OBJECT PROPERTIES --> | |
| 886 <!-- OBJECT METHODS --> | |
| 887 <!-- OBJECT EVENT FIELDS --> | |
| 888 <!-- FUNCTION PARAMETERS --> | |
| 889 </div> | |
| 890 </div><div> | |
| 891 <div> | |
| 892 <dt> | |
| 893 <var>secondaryUrl</var> | |
| 894 <em> | |
| 895 <!-- TYPE --> | |
| 896 <div style="display:inline"> | |
| 897 ( | |
| 898 <span class="optional">optional</span> | |
| 899 <span id="typeTemplate"> | |
| 900 <span> | |
| 901 <span>string</span> | |
| 902 </span> | |
| 903 </span> | |
| 904 ) | |
| 905 </div> | |
| 906 </em> | |
| 907 </dt> | |
| 908 <dd>The secondary URL for which the content setting should be retrieve
d. Defaults to the primary URL. Note that the meaning of a secondary URL depends
on the content type, and not all content types use secondary URLs.</dd> | |
| 909 <!-- OBJECT PROPERTIES --> | |
| 910 <!-- OBJECT METHODS --> | |
| 911 <!-- OBJECT EVENT FIELDS --> | |
| 912 <!-- FUNCTION PARAMETERS --> | |
| 913 </div> | |
| 914 </div><div> | |
| 915 <div> | |
| 916 <dt> | |
| 917 <var>resourceIdentifier</var> | |
| 918 <em> | |
| 919 <!-- TYPE --> | |
| 920 <div style="display:inline"> | |
| 921 ( | |
| 922 <span class="optional">optional</span> | |
| 923 <span id="typeTemplate"> | |
| 924 <span> | |
| 925 <a href="contentSettings.html#type-ResourceIdentifier">R
esourceIdentifier</a> | |
| 926 </span> | |
| 927 </span> | |
| 928 ) | |
| 929 </div> | |
| 930 </em> | |
| 931 </dt> | |
| 932 <dd>A more specific identifier of the type of content for which the se
ttings should be retrieved.</dd> | |
| 933 <!-- OBJECT PROPERTIES --> | |
| 934 <!-- OBJECT METHODS --> | |
| 935 <!-- OBJECT EVENT FIELDS --> | |
| 936 <!-- FUNCTION PARAMETERS --> | |
| 937 </div> | |
| 938 </div><div> | |
| 939 <div> | |
| 940 <dt> | |
| 941 <var>incognito</var> | |
| 942 <em> | |
| 943 <!-- TYPE --> | |
| 944 <div style="display:inline"> | |
| 945 ( | |
| 946 <span class="optional">optional</span> | |
| 947 <span id="typeTemplate"> | |
| 948 <span> | |
| 949 <span>boolean</span> | |
| 950 </span> | |
| 951 </span> | |
| 952 ) | |
| 953 </div> | |
| 954 </em> | |
| 955 </dt> | |
| 956 <dd>Whether to check the content settings for an incognito session. (d
efault false)</dd> | |
| 957 <!-- OBJECT PROPERTIES --> | |
| 958 <!-- OBJECT METHODS --> | |
| 959 <!-- OBJECT EVENT FIELDS --> | |
| 960 <!-- FUNCTION PARAMETERS --> | |
| 961 </div> | |
| 962 </div> | |
| 963 </dl> | |
| 964 </dd> | |
| 965 <!-- OBJECT METHODS --> | |
| 966 <!-- OBJECT EVENT FIELDS --> | |
| 967 <!-- FUNCTION PARAMETERS --> | |
| 968 </div> | |
| 969 </div><div> | |
| 970 <div> | |
| 971 <dt> | |
| 972 <var>callback</var> | |
| 973 <em> | |
| 974 <!-- TYPE --> | |
| 975 <div style="display:inline"> | |
| 976 ( | |
| 977 <span id="typeTemplate"> | |
| 978 <span> | |
| 979 <span>function</span> | |
| 980 </span> | |
| 981 </span> | |
| 982 ) | |
| 983 </div> | |
| 984 </em> | |
| 985 </dt> | |
| 986 <dd class="todo"> | |
| 987 Undocumented. | |
| 988 </dd> | |
| 989 <!-- OBJECT PROPERTIES --> | |
| 990 <!-- OBJECT METHODS --> | |
| 991 <!-- OBJECT EVENT FIELDS --> | |
| 992 <!-- FUNCTION PARAMETERS --> | |
| 993 </div> | |
| 994 </div> | |
| 995 </dl> | |
| 996 <!-- RETURNS --> | |
| 997 <dl> | |
| 998 </dl> | |
| 999 <!-- CALLBACK --> | |
| 1000 <div> | |
| 1001 <div> | |
| 1002 <h4>Callback function</h4> | |
| 1003 <p> | |
| 1004 The <em>callback</em> parameter should specify a function | |
| 1005 that looks like this: | |
| 1006 </p> | |
| 1007 <!-- Note: intentionally longer 80 columns --> | |
| 1008 <pre>function(<span>object details</span>) <span class="subdue
d">{...}</span>;</pre> | |
| 1009 <dl> | |
| 1010 <div> | |
| 1011 <div> | |
| 1012 <dt> | |
| 1013 <var>details</var> | |
| 1014 <em> | |
| 1015 <!-- TYPE --> | |
| 1016 <div style="display:inline"> | |
| 1017 ( | |
| 1018 <span id="typeTemplate"> | |
| 1019 <span> | |
| 1020 <span>object</span> | |
| 1021 </span> | |
| 1022 </span> | |
| 1023 ) | |
| 1024 </div> | |
| 1025 </em> | |
| 1026 </dt> | |
| 1027 <dd class="todo"> | |
| 1028 Undocumented. | |
| 1029 </dd> | |
| 1030 <!-- OBJECT PROPERTIES --> | |
| 1031 <dd> | |
| 1032 <dl> | |
| 1033 <div> | |
| 1034 <div> | |
| 1035 <dt> | |
| 1036 <var>setting</var> | |
| 1037 <em> | |
| 1038 <!-- TYPE --> | |
| 1039 <div style="display:inline"> | |
| 1040 ( | |
| 1041 <span id="typeTemplate"> | |
| 1042 <span> | |
| 1043 <span>any</span> | |
| 1044 </span> | |
| 1045 </span> | |
| 1046 ) | |
| 1047 </div> | |
| 1048 </em> | |
| 1049 </dt> | |
| 1050 <dd>The content setting. See the description of the individual Content
Setting objects for the possible values.</dd> | |
| 1051 <!-- OBJECT PROPERTIES --> | |
| 1052 <!-- OBJECT METHODS --> | |
| 1053 <!-- OBJECT EVENT FIELDS --> | |
| 1054 <!-- FUNCTION PARAMETERS --> | |
| 1055 </div> | |
| 1056 </div> | |
| 1057 </dl> | |
| 1058 </dd> | |
| 1059 <!-- OBJECT METHODS --> | |
| 1060 <!-- OBJECT EVENT FIELDS --> | |
| 1061 <!-- FUNCTION PARAMETERS --> | |
| 1062 </div> | |
| 1063 </div> | |
| 1064 </dl> | |
| 1065 </div> | |
| 1066 </div> | |
| 1067 <!-- MIN_VERSION --> | |
| 1068 </div> <!-- /description --> | |
| 1069 </div><div class="apiItem"> | |
| 1070 <a name="method-ContentSetting-getResourceIdentifiers"></a> <!-- m
ethod-anchor --> | |
| 1071 <h4>getResourceIdentifiers</h4> | |
| 1072 <div class="summary"> | |
| 1073 <!-- Note: intentionally longer 80 columns --> | |
| 1074 <span>contentSetting.getResourceIdentifiers</span>(<span class
="null"><span>function</span> | |
| 1075 <var><span>callback</span></var></span>)</div> | |
| 1076 <div class="description"> | |
| 1077 <p class="todo">Undocumented.</p> | |
| 1078 <!-- PARAMETERS --> | |
| 1079 <h4>Parameters</h4> | |
| 1080 <dl> | |
| 1081 <div> | |
| 1082 <div> | |
| 1083 <dt> | |
| 1084 <var>callback</var> | |
| 1085 <em> | |
| 1086 <!-- TYPE --> | |
| 1087 <div style="display:inline"> | |
| 1088 ( | |
| 1089 <span id="typeTemplate"> | |
| 1090 <span> | |
| 1091 <span>function</span> | |
| 1092 </span> | |
| 1093 </span> | |
| 1094 ) | |
| 1095 </div> | |
| 1096 </em> | |
| 1097 </dt> | |
| 1098 <dd class="todo"> | |
| 1099 Undocumented. | |
| 1100 </dd> | |
| 1101 <!-- OBJECT PROPERTIES --> | |
| 1102 <!-- OBJECT METHODS --> | |
| 1103 <!-- OBJECT EVENT FIELDS --> | |
| 1104 <!-- FUNCTION PARAMETERS --> | |
| 1105 </div> | |
| 1106 </div> | |
| 1107 </dl> | |
| 1108 <!-- RETURNS --> | |
| 1109 <dl> | |
| 1110 </dl> | |
| 1111 <!-- CALLBACK --> | |
| 1112 <div> | |
| 1113 <div> | |
| 1114 <h4>Callback function</h4> | |
| 1115 <p> | |
| 1116 The <em>callback</em> parameter should specify a function | |
| 1117 that looks like this: | |
| 1118 </p> | |
| 1119 <!-- Note: intentionally longer 80 columns --> | |
| 1120 <pre>function(<span>array of ResourceIdentifier resourceIdenti
fiers</span>) <span class="subdued">{...}</span>;</pre> | |
| 1121 <dl> | |
| 1122 <div> | |
| 1123 <div> | |
| 1124 <dt> | |
| 1125 <var>resourceIdentifiers</var> | |
| 1126 <em> | |
| 1127 <!-- TYPE --> | |
| 1128 <div style="display:inline"> | |
| 1129 ( | |
| 1130 <span class="optional">optional</span> | |
| 1131 <span id="typeTemplate"> | |
| 1132 <span> | |
| 1133 <span> | |
| 1134 array of <span><span> | |
| 1135 <span> | |
| 1136 <a href="contentSettings.html#type-ResourceIdentifier">R
esourceIdentifier</a> | |
| 1137 </span> | |
| 1138 </span></span> | |
| 1139 </span> | |
| 1140 </span> | |
| 1141 </span> | |
| 1142 ) | |
| 1143 </div> | |
| 1144 </em> | |
| 1145 </dt> | |
| 1146 <dd>A list of resource identifiers for this content type, or <var>unde
fined</var> if this content type does not use resource identifiers.</dd> | |
| 1147 <!-- OBJECT PROPERTIES --> | |
| 1148 <!-- OBJECT METHODS --> | |
| 1149 <!-- OBJECT EVENT FIELDS --> | |
| 1150 <!-- FUNCTION PARAMETERS --> | |
| 1151 </div> | |
| 1152 </div> | |
| 1153 </dl> | |
| 1154 </div> | |
| 1155 </div> | |
| 1156 <!-- MIN_VERSION --> | |
| 1157 </div> <!-- /description --> | |
| 1158 </div><div class="apiItem"> | |
| 1159 <a name="method-ContentSetting-set"></a> <!-- method-anchor --> | |
| 1160 <h4>set</h4> | |
| 1161 <div class="summary"> | |
| 1162 <!-- Note: intentionally longer 80 columns --> | |
| 1163 <span>contentSetting.set</span>(<span class="null"><span>objec
t</span> | |
| 1164 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> | |
| 1165 <var><span>callback</span></var></span>)</div> | |
| 1166 <div class="description"> | |
| 1167 <p>Applies a new content setting rule.</p> | |
| 1168 <!-- PARAMETERS --> | |
| 1169 <h4>Parameters</h4> | |
| 1170 <dl> | |
| 1171 <div> | |
| 1172 <div> | |
| 1173 <dt> | |
| 1174 <var>details</var> | |
| 1175 <em> | |
| 1176 <!-- TYPE --> | |
| 1177 <div style="display:inline"> | |
| 1178 ( | |
| 1179 <span id="typeTemplate"> | |
| 1180 <span> | |
| 1181 <span>object</span> | |
| 1182 </span> | |
| 1183 </span> | |
| 1184 ) | |
| 1185 </div> | |
| 1186 </em> | |
| 1187 </dt> | |
| 1188 <dd class="todo"> | |
| 1189 Undocumented. | |
| 1190 </dd> | |
| 1191 <!-- OBJECT PROPERTIES --> | |
| 1192 <dd> | |
| 1193 <dl> | |
| 1194 <div> | |
| 1195 <div> | |
| 1196 <dt> | |
| 1197 <var>primaryPattern</var> | |
| 1198 <em> | |
| 1199 <!-- TYPE --> | |
| 1200 <div style="display:inline"> | |
| 1201 ( | |
| 1202 <span id="typeTemplate"> | |
| 1203 <span> | |
| 1204 <span>string</span> | |
| 1205 </span> | |
| 1206 </span> | |
| 1207 ) | |
| 1208 </div> | |
| 1209 </em> | |
| 1210 </dt> | |
| 1211 <dd>The pattern for the primary URL. For details on the format of a pa
ttern, see <a href="contentSettings.html#patterns">Content Setting Patterns</a>.
</dd> | |
| 1212 <!-- OBJECT PROPERTIES --> | |
| 1213 <!-- OBJECT METHODS --> | |
| 1214 <!-- OBJECT EVENT FIELDS --> | |
| 1215 <!-- FUNCTION PARAMETERS --> | |
| 1216 </div> | |
| 1217 </div><div> | |
| 1218 <div> | |
| 1219 <dt> | |
| 1220 <var>secondaryPattern</var> | |
| 1221 <em> | |
| 1222 <!-- TYPE --> | |
| 1223 <div style="display:inline"> | |
| 1224 ( | |
| 1225 <span class="optional">optional</span> | |
| 1226 <span id="typeTemplate"> | |
| 1227 <span> | |
| 1228 <span>string</span> | |
| 1229 </span> | |
| 1230 </span> | |
| 1231 ) | |
| 1232 </div> | |
| 1233 </em> | |
| 1234 </dt> | |
| 1235 <dd>The pattern for the secondary URL. Defaults to matching all URLs.
For details on the format of a pattern, see <a href="contentSettings.html#patter
ns">Content Setting Patterns</a>.</dd> | |
| 1236 <!-- OBJECT PROPERTIES --> | |
| 1237 <!-- OBJECT METHODS --> | |
| 1238 <!-- OBJECT EVENT FIELDS --> | |
| 1239 <!-- FUNCTION PARAMETERS --> | |
| 1240 </div> | |
| 1241 </div><div> | |
| 1242 <div> | |
| 1243 <dt> | |
| 1244 <var>resourceIdentifier</var> | |
| 1245 <em> | |
| 1246 <!-- TYPE --> | |
| 1247 <div style="display:inline"> | |
| 1248 ( | |
| 1249 <span class="optional">optional</span> | |
| 1250 <span id="typeTemplate"> | |
| 1251 <span> | |
| 1252 <a href="contentSettings.html#type-ResourceIdentifier">R
esourceIdentifier</a> | |
| 1253 </span> | |
| 1254 </span> | |
| 1255 ) | |
| 1256 </div> | |
| 1257 </em> | |
| 1258 </dt> | |
| 1259 <dd>The resource identifier for the content type.</dd> | |
| 1260 <!-- OBJECT PROPERTIES --> | |
| 1261 <!-- OBJECT METHODS --> | |
| 1262 <!-- OBJECT EVENT FIELDS --> | |
| 1263 <!-- FUNCTION PARAMETERS --> | |
| 1264 </div> | |
| 1265 </div><div> | |
| 1266 <div> | |
| 1267 <dt> | |
| 1268 <var>setting</var> | |
| 1269 <em> | |
| 1270 <!-- TYPE --> | |
| 1271 <div style="display:inline"> | |
| 1272 ( | |
| 1273 <span id="typeTemplate"> | |
| 1274 <span> | |
| 1275 <span>any</span> | |
| 1276 </span> | |
| 1277 </span> | |
| 1278 ) | |
| 1279 </div> | |
| 1280 </em> | |
| 1281 </dt> | |
| 1282 <dd>The setting applied by this rule. See the description of the indiv
idual ContentSetting objects for the possible values.</dd> | |
| 1283 <!-- OBJECT PROPERTIES --> | |
| 1284 <!-- OBJECT METHODS --> | |
| 1285 <!-- OBJECT EVENT FIELDS --> | |
| 1286 <!-- FUNCTION PARAMETERS --> | |
| 1287 </div> | |
| 1288 </div><div> | |
| 1289 <div> | |
| 1290 <dt> | |
| 1291 <var>scope</var> | |
| 1292 <em> | |
| 1293 <!-- TYPE --> | |
| 1294 <div style="display:inline"> | |
| 1295 ( | |
| 1296 <span class="optional">optional</span> | |
| 1297 <span class="enum">enumerated</span> | |
| 1298 <span id="typeTemplate"> | |
| 1299 <span> | |
| 1300 <span>string</span> | |
| 1301 <span>["regular", "incognito_session_only"]</span> | |
| 1302 </span> | |
| 1303 </span> | |
| 1304 ) | |
| 1305 </div> | |
| 1306 </em> | |
| 1307 </dt> | |
| 1308 <dd>Where to clear the setting (default: regular). One of<br><var>regu
lar</var>: setting for regular profile (which is inherited by the incognito prof
ile if not overridden elsewhere),<br><var>incognito_session_only</var>: setting
for incognito profile that can only be set during an incognito session and is de
leted when the incognito session ends (overrides regular settings).</dd> | |
| 1309 <!-- OBJECT PROPERTIES --> | |
| 1310 <!-- OBJECT METHODS --> | |
| 1311 <!-- OBJECT EVENT FIELDS --> | |
| 1312 <!-- FUNCTION PARAMETERS --> | |
| 1313 </div> | |
| 1314 </div> | |
| 1315 </dl> | |
| 1316 </dd> | |
| 1317 <!-- OBJECT METHODS --> | |
| 1318 <!-- OBJECT EVENT FIELDS --> | |
| 1319 <!-- FUNCTION PARAMETERS --> | |
| 1320 </div> | |
| 1321 </div><div> | |
| 1322 <div> | |
| 1323 <dt> | |
| 1324 <var>callback</var> | |
| 1325 <em> | |
| 1326 <!-- TYPE --> | |
| 1327 <div style="display:inline"> | |
| 1328 ( | |
| 1329 <span class="optional">optional</span> | |
| 1330 <span id="typeTemplate"> | |
| 1331 <span> | |
| 1332 <span>function</span> | |
| 1333 </span> | |
| 1334 </span> | |
| 1335 ) | |
| 1336 </div> | |
| 1337 </em> | |
| 1338 </dt> | |
| 1339 <dd class="todo"> | |
| 1340 Undocumented. | |
| 1341 </dd> | |
| 1342 <!-- OBJECT PROPERTIES --> | |
| 1343 <!-- OBJECT METHODS --> | |
| 1344 <!-- OBJECT EVENT FIELDS --> | |
| 1345 <!-- FUNCTION PARAMETERS --> | |
| 1346 </div> | |
| 1347 </div> | |
| 1348 </dl> | |
| 1349 <!-- RETURNS --> | |
| 1350 <dl> | |
| 1351 </dl> | |
| 1352 <!-- CALLBACK --> | |
| 1353 <div> | |
| 1354 <div> | |
| 1355 <h4>Callback function</h4> | |
| 1356 <p> | |
| 1357 If you specify the <em>callback</em> parameter, it should | |
| 1358 specify a function that looks like this: | |
| 1359 </p> | |
| 1360 <!-- Note: intentionally longer 80 columns --> | |
| 1361 <pre>function(<span></span>) <span class="subdued">{...}</span
>;</pre> | |
| 1362 <dl> | |
| 1363 </dl> | |
| 1364 </div> | |
| 1365 </div> | |
| 1366 <!-- MIN_VERSION --> | |
| 1367 </div> <!-- /description --> | |
| 1368 </div> <!-- /apiItem --> | |
| 1369 </div> | |
| 1370 </dd> | |
| 1371 <!-- OBJECT EVENT FIELDS --> | |
| 1372 <!-- FUNCTION PARAMETERS --> | |
| 1373 </div> | |
| 1374 </div> <!-- /apiItem --> | |
| 1375 </div> <!-- /apiGroup --> | |
| 1376 </div> <!-- /apiPage --> | |
| 1377 </div> <!-- /gc-pagecontent --> | |
| 1378 </div> <!-- /g-section --> | |
| 1379 </div> <!-- /codesiteContent --> | |
| 1380 <div id="gc-footer" --=""> | |
| 1381 <div class="text"> | |
| 1382 <p> | |
| 1383 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, | |
| 1384 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons | |
| 1385 Attribution 3.0 License</a>, and code samples are licensed under the | |
| 1386 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. | |
| 1387 </p> | |
| 1388 <p> | |
| 1389 ©2011 Google | |
| 1390 </p> | |
| 1391 <!-- begin analytics --> | |
| 1392 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript">
</script> | |
| 1393 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc
ript> | |
| 1394 <script type="text/javascript"> | |
| 1395 // chrome doc tracking | |
| 1396 try { | |
| 1397 var engdocs = _gat._getTracker("YT-10763712-2"); | |
| 1398 engdocs._trackPageview(); | |
| 1399 } catch(err) {} | |
| 1400 // code.google.com site-wide tracking | |
| 1401 try { | |
| 1402 _uacct="UA-18071-1"; | |
| 1403 _uanchor=1; | |
| 1404 _uff=0; | |
| 1405 urchinTracker(); | |
| 1406 } | |
| 1407 catch(e) {/* urchinTracker not available. */} | |
| 1408 </script> | |
| 1409 <!-- end analytics --> | |
| 1410 </div> | |
| 1411 </div> <!-- /gc-footer --> | |
| 1412 </div> <!-- /gc-container --> | |
| 1413 </body></html> | |
| OLD | NEW |