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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.contentSettings.html

Issue 7029031: Content settings extension API (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: sync & review Created 9 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/experimental.html ('k') | chrome/common/extensions/docs/extension.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 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 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 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 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 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 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"> 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script> 15 </script>
16 <script type="text/javascript" src="js/api_page_generator.js"></script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script>
17 <script type="text/javascript" src="js/bootstrap.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <script type="text/javascript" src="js/sidebar.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script>
19 <title>chrome.extension - Google Chrome Extensions - Google Code</title></head > 19 <title>chrome.experimental.contentSettings - Google Chrome Extensions - Google Code</title></head>
20 <body> <div id="gc-container" class="labs"> 20 <body> <div id="gc-container" class="labs">
21 <div id="devModeWarning"> 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. 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> 23 </div>
24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
25 <!-- In particular, sub-templates that recurse, must be used by allowing 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 26 jstemplate to make a copy of the template in this section which
27 are not operated on by way of the jsskip="true" --> 27 are not operated on by way of the jsskip="true" -->
28 <div style="display:none"> 28 <div style="display:none">
29 29
(...skipping 214 matching lines...) Expand 10 before | Expand all | Expand 10 after
244 </ul> 244 </ul>
245 </li> 245 </li>
246 </ul> 246 </ul>
247 </div> 247 </div>
248 <script> 248 <script>
249 initToggles(); 249 initToggles();
250 </script> 250 </script>
251 251
252 <div class="g-unit" id="gc-pagecontent"> 252 <div class="g-unit" id="gc-pagecontent">
253 <div id="pageTitle"> 253 <div id="pageTitle">
254 <h1 class="page_title">chrome.extension</h1> 254 <h1 class="page_title">chrome.experimental.contentSettings</h1>
255 </div> 255 </div>
256 <!-- TABLE OF CONTENTS --> 256 <!-- TABLE OF CONTENTS -->
257 <div id="toc"> 257 <div id="toc">
258 <h2>Contents</h2> 258 <h2>Contents</h2>
259 <ol> 259 <ol>
260 <li> 260 <li style="display: none; ">
261 <a href="#content scripts">Support for content scripts</a> 261 <a>h2Name</a>
262 <ol> 262 <ol>
263 <li style="display: none; "> 263 <li>
264 <a>h3Name</a> 264 <a>h3Name</a>
265 </li> 265 </li>
266 </ol> 266 </ol>
267 </li> 267 </li>
268 <li> 268 <li>
269 <a href="#apiReference">API reference: chrome.extension</a> 269 <a href="#apiReference">API reference: chrome.experimental.conte ntSettings</a>
270 <ol> 270 <ol>
271 <li> 271 <li>
272 <a href="#properties">Properties</a> 272 <a href="#properties">Properties</a>
273 <ol> 273 <ol>
274 <li> 274 <li>
275 <a href="#property-lastError">lastError</a> 275 <a href="#property-global">global</a>
276 </li><li> 276 </li><li>
277 <a href="#property-inIncognitoContext">inIncognitoContex t</a> 277 <a href="#property-cookies">cookies</a>
278 </li><li>
279 <a href="#property-images">images</a>
280 </li><li>
281 <a href="#property-javascript">javascript</a>
282 </li><li>
283 <a href="#property-plugins">plugins</a>
284 </li><li>
285 <a href="#property-popups">popups</a>
286 </li><li>
287 <a href="#property-notifications">notifications</a>
278 </li> 288 </li>
279 </ol> 289 </ol>
280 </li> 290 </li>
281 <li> 291 <li style="display: none; ">
282 <a href="#global-methods">Methods</a> 292 <a>Methods</a>
283 <ol> 293 <ol>
284 <li> 294 <li>
285 <a href="#method-connect">connect</a>
286 </li><li>
287 <a href="#method-getBackgroundPage">getBackgroundPage</a >
288 </li><li style="display: none; ">
289 <a href="#method-anchor">methodName</a> 295 <a href="#method-anchor">methodName</a>
290 </li><li style="display: none; ">
291 <a href="#method-anchor">methodName</a>
292 </li><li>
293 <a href="#method-getURL">getURL</a>
294 </li><li>
295 <a href="#method-getViews">getViews</a>
296 </li><li>
297 <a href="#method-isAllowedFileSchemeAccess">isAllowedFil eSchemeAccess</a>
298 </li><li>
299 <a href="#method-isAllowedIncognitoAccess">isAllowedInco gnitoAccess</a>
300 </li><li>
301 <a href="#method-sendRequest">sendRequest</a>
302 </li><li>
303 <a href="#method-setUpdateUrlData">setUpdateUrlData</a>
304 </li> 296 </li>
305 </ol> 297 </ol>
306 </li> 298 </li>
307 <li> 299 <li style="display: none; ">
308 <a href="#global-events">Events</a> 300 <a>Events</a>
309 <ol> 301 <ol>
310 <li> 302 <li>
311 <a href="#event-onConnect">onConnect</a> 303 <a href="#event-anchor">eventName</a>
312 </li><li>
313 <a href="#event-onConnectExternal">onConnectExternal</a>
314 </li><li>
315 <a href="#event-onRequest">onRequest</a>
316 </li><li>
317 <a href="#event-onRequestExternal">onRequestExternal</a>
318 </li> 304 </li>
319 </ol> 305 </ol>
320 </li> 306 </li>
321 <li> 307 <li>
322 <a href="#types">Types</a> 308 <a href="#types">Types</a>
323 <ol> 309 <ol>
324 <li> 310 <li>
325 <a href="#type-MessageSender">MessageSender</a> 311 <a href="#type-ResourceIdentifier">ResourceIdentifier</a >
326 </li><li> 312 </li><li>
327 <a href="#type-Event">Event</a> 313 <a href="#type-Pattern">Pattern</a>
328 </li><li> 314 </li><li>
329 <a href="#type-Port">Port</a> 315 <a href="#type-ContentSettingRule">ContentSettingRule</a >
316 </li><li>
317 <a href="#type-ContentSetting">ContentSetting</a>
330 </li> 318 </li>
331 </ol> 319 </ol>
332 </li> 320 </li>
333 </ol> 321 </ol>
334 </li> 322 </li>
335 </ol> 323 </ol>
336 </div> 324 </div>
337 <!-- /TABLE OF CONTENTS --> 325 <!-- /TABLE OF CONTENTS -->
338 326
339 <!-- Standard content lead-in for experimental API pages --> 327 <!-- Standard content lead-in for experimental API pages -->
340 <p id="classSummary" style="display: none; "> 328 <p id="classSummary">
341 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page. 329 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
342 </p> 330 </p>
343 331
344 <!-- STATIC CONTENT PLACEHOLDER --> 332 <!-- STATIC CONTENT PLACEHOLDER -->
345 <div id="static"><!-- BEGIN AUTHORED CONTENT --> 333 <div id="static"></div>
346 <p id="classSummary">
347 The <code>chrome.extension</code> module
348 has utilities that can be used by any extension page.
349 It includes support for exchanging messages
350 between an extension and its content scripts
351 or between extensions,
352 as described in detail in
353 <a href="messaging.html">Message Passing</a>.
354 </p>
355
356 <h2 id="content scripts">Support for content scripts</h2>
357 <p>
358 Unlike the other chrome.* APIs,
359 parts of <code>chrome.extension</code>
360 can be used by content scripts:
361 </p>
362
363 <dl>
364 <dt>
365 <a href="#method-sendRequest"><code>sendRequest()</code></a> and
366 <a href="#event-onRequest"><code>onRequest</code></a>
367 </dt>
368 <dd>
369 Simple communication with extension pages
370 </dd>
371 <dt>
372 <a href="#method-connect"><code>connect()</code></a> and
373 <a href="#event-onConnect"><code>onConnect</code></a>
374 </dt>
375 <dd>
376 Extended communication with extension pages
377 </dd>
378 <dt>
379 <a href="#method-getURL"><code>getURL()</code></a>
380 </dt>
381 <dd>
382 Access to extension resources such as image files
383 </dd>
384 </dl>
385
386 <p>
387 For details, see
388 <a href="content_scripts.html">Content Scripts</a>.
389 </p>
390
391 <!-- END AUTHORED CONTENT -->
392 </div>
393 334
394 <!-- API PAGE --> 335 <!-- API PAGE -->
395 <div class="apiPage"> 336 <div class="apiPage">
396 <a name="apiReference"></a> 337 <a name="apiReference"></a>
397 <h2>API reference: chrome.extension</h2> 338 <h2>API reference: chrome.experimental.contentSettings</h2>
398 339
399 <!-- PROPERTIES --> 340 <!-- PROPERTIES -->
400 <div class="apiGroup"> 341 <div class="apiGroup">
401 <a name="properties"></a> 342 <a name="properties"></a>
402 <h3 id="properties">Properties</h3> 343 <h3 id="properties">Properties</h3>
403 344
404 <div> 345 <div>
405 <a name="property-lastError"></a> 346 <a name="property-global"></a>
406 <h4>lastError</h4> 347 <h4>global</h4>
407 <div class="summary"> 348 <div class="summary">
408 <!-- Note: intentionally longer 80 columns --> 349 <!-- Note: intentionally longer 80 columns -->
409 <span>chrome.extension.</span><span>lastError</span> 350 <span>chrome.experimental.contentSettings.</span><span>global</s pan>
410 </div> 351 </div>
411 <div> 352 <div>
412 <dt> 353 <dt>
413 <var>lastError</var> 354 <var>global</var>
414 <em> 355 <em>
415 356
416 <!-- TYPE --> 357 <!-- TYPE -->
417 <div style="display:inline"> 358 <div style="display:inline">
418 ( 359 (
419 <span class="optional">optional</span> 360 <span class="optional" style="display: none; ">optional</spa n>
420 <span class="enum" style="display: none; ">enumerated</span> 361 <span class="enum" style="display: none; ">enumerated</span>
421 <span id="typeTemplate"> 362 <span id="typeTemplate">
422 <span style="display: none; "> 363 <span style="display: none; ">
423 <a> Type</a> 364 <a> Type</a>
424 </span> 365 </span>
425 <span> 366 <span>
426 <span style="display: none; "> 367 <span style="display: none; ">
427 array of <span><span></span></span> 368 array of <span><span></span></span>
428 </span> 369 </span>
429 <span>object</span> 370 <span>object</span>
430 <span style="display: none; "></span> 371 <span style="display: none; "></span>
431 </span> 372 </span>
432 </span> 373 </span>
433 ) 374 )
434 </div> 375 </div>
435 376
436 </em> 377 </em>
437 </dt> 378 </dt>
438 <dd class="todo" style="display: none; "> 379 <dd class="todo">
439 Undocumented. 380 Undocumented.
440 </dd> 381 </dd>
441 <dd>Set for the lifetime of a callback if an ansychronous extension ap i has resulted in an error. If no error has occured lastError will be <var>undef ined</var>.</dd> 382 <dd style="display: none; ">
383 Description of this parameter from the json schema.
384 </dd>
442 <dd style="display: none; "> 385 <dd style="display: none; ">
443 This parameter was added in version 386 This parameter was added in version
444 <b><span></span></b>. 387 <b><span></span></b>.
445 You must omit this parameter in earlier versions, 388 You must omit this parameter in earlier versions,
446 and you may omit it in any version. If you require this 389 and you may omit it in any version. If you require this
447 parameter, the manifest key 390 parameter, the manifest key
448 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 391 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
449 can ensure that your extension won't be run in an earlier browser ve rsion. 392 can ensure that your extension won't be run in an earlier browser ve rsion.
450 </dd> 393 </dd>
451 394
452 <!-- OBJECT PROPERTIES --> 395 <!-- OBJECT PROPERTIES -->
453 <dd> 396 <dd>
454 <dl> 397 <dl>
455 <div> 398 <div>
456 <div> 399 <div>
457 <dt> 400 <dt>
458 <var>message</var> 401 <var>thirdPartyCookiesAllowed</var>
459 <em> 402 <em>
460 403
461 <!-- TYPE --> 404 <!-- TYPE -->
462 <div style="display:inline"> 405 <div style="display:inline">
463 ( 406 (
464 <span class="optional" style="display: none; ">optional</spa n> 407 <span class="optional" style="display: none; ">optional</spa n>
465 <span class="enum" style="display: none; ">enumerated</span> 408 <span class="enum" style="display: none; ">enumerated</span>
466 <span id="typeTemplate"> 409 <span id="typeTemplate">
410 <span>
411 <a href="types.html#type-ChromeSetting">ChromeSetting</a >
412 </span>
467 <span style="display: none; "> 413 <span style="display: none; ">
468 <a> Type</a> 414 <span>
469 </span>
470 <span>
471 <span style="display: none; ">
472 array of <span><span></span></span> 415 array of <span><span></span></span>
473 </span> 416 </span>
474 <span>string</span> 417 <span>paramType</span>
475 <span style="display: none; "></span> 418 <span></span>
476 </span> 419 </span>
477 </span> 420 </span>
478 ) 421 )
479 </div> 422 </div>
480 423
481 </em> 424 </em>
482 </dt> 425 </dt>
483 <dd class="todo" style="display: none; "> 426 <dd class="todo" style="display: none; ">
484 Undocumented. 427 Undocumented.
485 </dd> 428 </dd>
486 <dd>Description of the error that has taken place.</dd> 429 <dd>Whether third party cookies should be allowed. The value of this p reference is of type boolean, and the default value is true.</dd>
487 <dd style="display: none; "> 430 <dd style="display: none; ">
488 This parameter was added in version 431 This parameter was added in version
489 <b><span></span></b>. 432 <b><span></span></b>.
490 You must omit this parameter in earlier versions, 433 You must omit this parameter in earlier versions,
491 and you may omit it in any version. If you require this 434 and you may omit it in any version. If you require this
492 parameter, the manifest key 435 parameter, the manifest key
493 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 436 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
494 can ensure that your extension won't be run in an earlier browser ve rsion. 437 can ensure that your extension won't be run in an earlier browser ve rsion.
495 </dd> 438 </dd>
496 439
(...skipping 16 matching lines...) Expand all
513 <dd style="display: none; "> 456 <dd style="display: none; ">
514 <div></div> 457 <div></div>
515 </dd> 458 </dd>
516 459
517 <!-- FUNCTION PARAMETERS --> 460 <!-- FUNCTION PARAMETERS -->
518 <dd style="display: none; "> 461 <dd style="display: none; ">
519 <div></div> 462 <div></div>
520 </dd> 463 </dd>
521 464
522 </div> 465 </div>
523 </div> 466 </div><div>
524 </dl> 467 <div>
525 </dd>
526
527 <!-- OBJECT METHODS -->
528 <dd style="display: none; ">
529 <div></div>
530 </dd>
531
532 <!-- OBJECT EVENT FIELDS -->
533 <dd style="display: none; ">
534 <div></div>
535 </dd>
536
537 <!-- FUNCTION PARAMETERS -->
538 <dd style="display: none; ">
539 <div></div>
540 </dd>
541
542 </div>
543 </div><div>
544 <a name="property-inIncognitoContext"></a>
545 <h4>inIncognitoContext</h4>
546 <div class="summary">
547 <!-- Note: intentionally longer 80 columns -->
548 <span>chrome.extension.</span><span>inIncognitoContext</span>
549 </div>
550 <div>
551 <dt> 468 <dt>
552 <var>inIncognitoContext</var> 469 <var>referrersEnabled</var>
553 <em> 470 <em>
554 471
555 <!-- TYPE --> 472 <!-- TYPE -->
556 <div style="display:inline"> 473 <div style="display:inline">
557 ( 474 (
558 <span class="optional">optional</span> 475 <span class="optional" style="display: none; ">optional</spa n>
559 <span class="enum" style="display: none; ">enumerated</span> 476 <span class="enum" style="display: none; ">enumerated</span>
560 <span id="typeTemplate"> 477 <span id="typeTemplate">
478 <span>
479 <a href="types.html#type-ChromeSetting">ChromeSetting</a >
480 </span>
561 <span style="display: none; "> 481 <span style="display: none; ">
562 <a> Type</a> 482 <span>
563 </span>
564 <span>
565 <span style="display: none; ">
566 array of <span><span></span></span> 483 array of <span><span></span></span>
567 </span> 484 </span>
568 <span>object</span> 485 <span>paramType</span>
569 <span style="display: none; "></span> 486 <span></span>
570 </span> 487 </span>
571 </span> 488 </span>
572 ) 489 )
573 </div> 490 </div>
574 491
575 </em> 492 </em>
576 </dt> 493 </dt>
577 <dd class="todo" style="display: none; "> 494 <dd class="todo" style="display: none; ">
578 Undocumented. 495 Undocumented.
579 </dd> 496 </dd>
580 <dd>True for content scripts running inside incognito tabs, and for ex tension pages running inside an incognito process. The latter only applies to ex tensions with 'split' incognito_behavior.</dd> 497 <dd>Whether referrers should be enabled. The value of this preference is of type boolean, and the default value is true.</dd>
581 <dd style="display: none; "> 498 <dd style="display: none; ">
582 This parameter was added in version 499 This parameter was added in version
583 <b><span></span></b>. 500 <b><span></span></b>.
584 You must omit this parameter in earlier versions, 501 You must omit this parameter in earlier versions,
585 and you may omit it in any version. If you require this 502 and you may omit it in any version. If you require this
586 parameter, the manifest key 503 parameter, the manifest key
587 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 504 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
588 can ensure that your extension won't be run in an earlier browser ve rsion. 505 can ensure that your extension won't be run in an earlier browser ve rsion.
589 </dd> 506 </dd>
590 507
591 <!-- OBJECT PROPERTIES --> 508 <!-- OBJECT PROPERTIES -->
592 <dd> 509 <dd style="display: none; ">
593 <dl> 510 <dl>
594 <div> 511 <div>
595 <div> 512 <div>
513 </div>
514 </div>
515 </dl>
516 </dd>
517
518 <!-- OBJECT METHODS -->
519 <dd style="display: none; ">
520 <div></div>
521 </dd>
522
523 <!-- OBJECT EVENT FIELDS -->
524 <dd style="display: none; ">
525 <div></div>
526 </dd>
527
528 <!-- FUNCTION PARAMETERS -->
529 <dd style="display: none; ">
530 <div></div>
531 </dd>
532
533 </div>
534 </div><div>
535 <div>
596 <dt> 536 <dt>
597 <var>message</var> 537 <var>hyperlinkAuditingEnabled</var>
598 <em> 538 <em>
599 539
600 <!-- TYPE --> 540 <!-- TYPE -->
601 <div style="display:inline"> 541 <div style="display:inline">
602 ( 542 (
603 <span class="optional" style="display: none; ">optional</spa n> 543 <span class="optional" style="display: none; ">optional</spa n>
604 <span class="enum" style="display: none; ">enumerated</span> 544 <span class="enum" style="display: none; ">enumerated</span>
605 <span id="typeTemplate"> 545 <span id="typeTemplate">
546 <span>
547 <a href="types.html#type-ChromeSetting">ChromeSetting</a >
548 </span>
606 <span style="display: none; "> 549 <span style="display: none; ">
607 <a> Type</a> 550 <span>
608 </span>
609 <span>
610 <span style="display: none; ">
611 array of <span><span></span></span> 551 array of <span><span></span></span>
612 </span> 552 </span>
613 <span>boolean</span> 553 <span>paramType</span>
614 <span style="display: none; "></span> 554 <span></span>
615 </span> 555 </span>
616 </span> 556 </span>
617 ) 557 )
618 </div> 558 </div>
619 559
620 </em> 560 </em>
621 </dt> 561 </dt>
622 <dd class="todo" style="display: none; "> 562 <dd class="todo" style="display: none; ">
623 Undocumented. 563 Undocumented.
624 </dd> 564 </dd>
625 <dd>True if the page or script is in an incongito process.</dd> 565 <dd>Whether to enable hyperlink auditing ("&lt;a ping&gt;"). The value of this preference is of type boolean, and the default value is true.</dd>
626 <dd style="display: none; "> 566 <dd style="display: none; ">
627 This parameter was added in version 567 This parameter was added in version
628 <b><span></span></b>. 568 <b><span></span></b>.
629 You must omit this parameter in earlier versions, 569 You must omit this parameter in earlier versions,
630 and you may omit it in any version. If you require this 570 and you may omit it in any version. If you require this
631 parameter, the manifest key 571 parameter, the manifest key
632 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 572 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
633 can ensure that your extension won't be run in an earlier browser ve rsion. 573 can ensure that your extension won't be run in an earlier browser ve rsion.
634 </dd> 574 </dd>
635 575
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
672 <dd style="display: none; "> 612 <dd style="display: none; ">
673 <div></div> 613 <div></div>
674 </dd> 614 </dd>
675 615
676 <!-- FUNCTION PARAMETERS --> 616 <!-- FUNCTION PARAMETERS -->
677 <dd style="display: none; "> 617 <dd style="display: none; ">
678 <div></div> 618 <div></div>
679 </dd> 619 </dd>
680 620
681 </div> 621 </div>
682 </div> 622 </div><div>
683 623 <a name="property-cookies"></a>
684 </div> <!-- /apiGroup --> 624 <h4>cookies</h4>
685 625 <div class="summary">
686 <!-- METHODS --> 626 <!-- Note: intentionally longer 80 columns -->
687 <div id="methodsTemplate" class="apiGroup"> 627 <span>chrome.experimental.contentSettings.</span><span>cookies</ span>
688 <a name="global-methods"></a> 628 </div>
689 <h3>Methods</h3> 629 <div>
690
691 <!-- iterates over all functions -->
692 <div class="apiItem">
693 <a name="method-connect"></a> <!-- method-anchor -->
694 <h4>connect</h4>
695
696 <div class="summary"><span>Port</span>
697 <!-- Note: intentionally longer 80 columns -->
698 <span>chrome.extension.connect</span>(<span class="optional">< span style="display: none; ">, </span><span>string</span>
699 <var><span>extensionId</span></var></span><span class="opt ional"><span>, </span><span>object</span>
700 <var><span>connectInfo</span></var></span>)</div>
701
702 <div class="description">
703 <p class="todo" style="display: none; ">Undocumented.</p>
704 <p>Attempts to connect to other listeners within the extension ( such as the extension's background page). This is primarily useful for content s cripts connecting to their extension processes. Extensions may connect to conten t scripts embedded in tabs via <a href="tabs.html#method-connect"><code>chrome.t abs.connect()</code></a>.</p>
705
706 <!-- PARAMETERS -->
707 <h4>Parameters</h4>
708 <dl>
709 <div>
710 <div>
711 <dt> 630 <dt>
712 <var>extensionId</var> 631 <var>cookies</var>
713 <em> 632 <em>
714 633
715 <!-- TYPE --> 634 <!-- TYPE -->
716 <div style="display:inline"> 635 <div style="display:inline">
717 ( 636 (
718 <span class="optional">optional</span> 637 <span class="optional" style="display: none; ">optional</spa n>
719 <span class="enum" style="display: none; ">enumerated</span> 638 <span class="enum" style="display: none; ">enumerated</span>
720 <span id="typeTemplate"> 639 <span id="typeTemplate">
640 <span>
641 <a href="experimental.contentSettings.html#type-ContentS etting">ContentSetting</a>
642 </span>
721 <span style="display: none; "> 643 <span style="display: none; ">
722 <a> Type</a> 644 <span>
723 </span>
724 <span>
725 <span style="display: none; ">
726 array of <span><span></span></span> 645 array of <span><span></span></span>
727 </span> 646 </span>
728 <span>string</span> 647 <span>paramType</span>
729 <span style="display: none; "></span> 648 <span></span>
730 </span> 649 </span>
731 </span> 650 </span>
732 ) 651 )
733 </div> 652 </div>
734 653
735 </em> 654 </em>
736 </dt> 655 </dt>
737 <dd class="todo" style="display: none; "> 656 <dd class="todo" style="display: none; ">
738 Undocumented. 657 Undocumented.
739 </dd> 658 </dd>
740 <dd>The extension ID of the extension you want to connect to. If omitt ed, default is your own extension.</dd> 659 <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. Defa ult is <var>allow</var>.</dd>
741 <dd style="display: none; "> 660 <dd style="display: none; ">
742 This parameter was added in version 661 This parameter was added in version
743 <b><span></span></b>. 662 <b><span></span></b>.
744 You must omit this parameter in earlier versions, 663 You must omit this parameter in earlier versions,
745 and you may omit it in any version. If you require this 664 and you may omit it in any version. If you require this
746 parameter, the manifest key 665 parameter, the manifest key
747 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 666 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
748 can ensure that your extension won't be run in an earlier browser ve rsion. 667 can ensure that your extension won't be run in an earlier browser ve rsion.
749 </dd> 668 </dd>
750 669
(...skipping 16 matching lines...) Expand all
767 <dd style="display: none; "> 686 <dd style="display: none; ">
768 <div></div> 687 <div></div>
769 </dd> 688 </dd>
770 689
771 <!-- FUNCTION PARAMETERS --> 690 <!-- FUNCTION PARAMETERS -->
772 <dd style="display: none; "> 691 <dd style="display: none; ">
773 <div></div> 692 <div></div>
774 </dd> 693 </dd>
775 694
776 </div> 695 </div>
777 </div><div> 696 </div><div>
778 <div> 697 <a name="property-images"></a>
698 <h4>images</h4>
699 <div class="summary">
700 <!-- Note: intentionally longer 80 columns -->
701 <span>chrome.experimental.contentSettings.</span><span>images</s pan>
702 </div>
703 <div>
779 <dt> 704 <dt>
780 <var>connectInfo</var> 705 <var>images</var>
781 <em> 706 <em>
782 707
783 <!-- TYPE --> 708 <!-- TYPE -->
784 <div style="display:inline"> 709 <div style="display:inline">
785 ( 710 (
786 <span class="optional">optional</span> 711 <span class="optional" style="display: none; ">optional</spa n>
787 <span class="enum" style="display: none; ">enumerated</span> 712 <span class="enum" style="display: none; ">enumerated</span>
788 <span id="typeTemplate"> 713 <span id="typeTemplate">
714 <span>
715 <a href="experimental.contentSettings.html#type-ContentS etting">ContentSetting</a>
716 </span>
789 <span style="display: none; "> 717 <span style="display: none; ">
790 <a> Type</a> 718 <span>
791 </span>
792 <span>
793 <span style="display: none; ">
794 array of <span><span></span></span> 719 array of <span><span></span></span>
795 </span> 720 </span>
796 <span>object</span> 721 <span>paramType</span>
797 <span style="display: none; "></span> 722 <span></span>
798 </span> 723 </span>
799 </span> 724 </span>
800 ) 725 )
801 </div> 726 </div>
802 727
803 </em> 728 </em>
804 </dt> 729 </dt>
805 <dd class="todo"> 730 <dd class="todo" style="display: none; ">
806 Undocumented. 731 Undocumented.
807 </dd> 732 </dd>
808 <dd style="display: none; "> 733 <dd>Whether to show images. One of<br><var>allow</var>: Show images,<b r><var>block</var>: Don't show images. Default is <var>allow</var>.</dd>
809 Description of this parameter from the json schema.
810 </dd>
811 <dd style="display: none; "> 734 <dd style="display: none; ">
812 This parameter was added in version 735 This parameter was added in version
813 <b><span></span></b>. 736 <b><span></span></b>.
814 You must omit this parameter in earlier versions, 737 You must omit this parameter in earlier versions,
815 and you may omit it in any version. If you require this 738 and you may omit it in any version. If you require this
816 parameter, the manifest key 739 parameter, the manifest key
817 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 740 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
818 can ensure that your extension won't be run in an earlier browser ve rsion. 741 can ensure that your extension won't be run in an earlier browser ve rsion.
819 </dd> 742 </dd>
820 743
821 <!-- OBJECT PROPERTIES --> 744 <!-- OBJECT PROPERTIES -->
822 <dd> 745 <dd style="display: none; ">
823 <dl> 746 <dl>
824 <div> 747 <div>
825 <div> 748 <div>
749 </div>
750 </div>
751 </dl>
752 </dd>
753
754 <!-- OBJECT METHODS -->
755 <dd style="display: none; ">
756 <div></div>
757 </dd>
758
759 <!-- OBJECT EVENT FIELDS -->
760 <dd style="display: none; ">
761 <div></div>
762 </dd>
763
764 <!-- FUNCTION PARAMETERS -->
765 <dd style="display: none; ">
766 <div></div>
767 </dd>
768
769 </div>
770 </div><div>
771 <a name="property-javascript"></a>
772 <h4>javascript</h4>
773 <div class="summary">
774 <!-- Note: intentionally longer 80 columns -->
775 <span>chrome.experimental.contentSettings.</span><span>javascrip t</span>
776 </div>
777 <div>
826 <dt> 778 <dt>
827 <var>name</var> 779 <var>javascript</var>
828 <em> 780 <em>
829 781
830 <!-- TYPE --> 782 <!-- TYPE -->
831 <div style="display:inline"> 783 <div style="display:inline">
832 ( 784 (
833 <span class="optional">optional</span> 785 <span class="optional" style="display: none; ">optional</spa n>
834 <span class="enum" style="display: none; ">enumerated</span> 786 <span class="enum" style="display: none; ">enumerated</span>
835 <span id="typeTemplate"> 787 <span id="typeTemplate">
788 <span>
789 <a href="experimental.contentSettings.html#type-ContentS etting">ContentSetting</a>
790 </span>
836 <span style="display: none; "> 791 <span style="display: none; ">
837 <a> Type</a> 792 <span>
838 </span>
839 <span>
840 <span style="display: none; ">
841 array of <span><span></span></span> 793 array of <span><span></span></span>
842 </span> 794 </span>
843 <span>string</span> 795 <span>paramType</span>
844 <span style="display: none; "></span> 796 <span></span>
845 </span> 797 </span>
846 </span> 798 </span>
847 ) 799 )
848 </div> 800 </div>
849 801
850 </em> 802 </em>
851 </dt> 803 </dt>
852 <dd class="todo" style="display: none; "> 804 <dd class="todo" style="display: none; ">
853 Undocumented. 805 Undocumented.
854 </dd> 806 </dd>
855 <dd>Will be passed into onConnect for extension processes that are lis tening for the connection event.</dd> 807 <dd>Whether to run Javascript. One of<br><var>allow</var>: Run Javascr ipt,<br><var>block</var>: Don't run Javascript. Default is <var>allow</var>.</dd >
856 <dd style="display: none; "> 808 <dd style="display: none; ">
857 This parameter was added in version 809 This parameter was added in version
858 <b><span></span></b>. 810 <b><span></span></b>.
859 You must omit this parameter in earlier versions, 811 You must omit this parameter in earlier versions,
860 and you may omit it in any version. If you require this 812 and you may omit it in any version. If you require this
861 parameter, the manifest key 813 parameter, the manifest key
862 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 814 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
863 can ensure that your extension won't be run in an earlier browser ve rsion. 815 can ensure that your extension won't be run in an earlier browser ve rsion.
864 </dd> 816 </dd>
865 817
(...skipping 16 matching lines...) Expand all
882 <dd style="display: none; "> 834 <dd style="display: none; ">
883 <div></div> 835 <div></div>
884 </dd> 836 </dd>
885 837
886 <!-- FUNCTION PARAMETERS --> 838 <!-- FUNCTION PARAMETERS -->
887 <dd style="display: none; "> 839 <dd style="display: none; ">
888 <div></div> 840 <div></div>
889 </dd> 841 </dd>
890 842
891 </div> 843 </div>
844 </div><div>
845 <a name="property-plugins"></a>
846 <h4>plugins</h4>
847 <div class="summary">
848 <!-- Note: intentionally longer 80 columns -->
849 <span>chrome.experimental.contentSettings.</span><span>plugins</ span>
892 </div> 850 </div>
893 </dl> 851 <div>
894 </dd>
895
896 <!-- OBJECT METHODS -->
897 <dd style="display: none; ">
898 <div></div>
899 </dd>
900
901 <!-- OBJECT EVENT FIELDS -->
902 <dd style="display: none; ">
903 <div></div>
904 </dd>
905
906 <!-- FUNCTION PARAMETERS -->
907 <dd style="display: none; ">
908 <div></div>
909 </dd>
910
911 </div>
912 </div>
913 </dl>
914
915 <!-- RETURNS -->
916 <h4>Returns</h4>
917 <dl>
918 <div>
919 <div>
920 <dt> 852 <dt>
921 <var style="display: none; ">paramName</var> 853 <var>plugins</var>
922 <em> 854 <em>
923 855
924 <!-- TYPE --> 856 <!-- TYPE -->
925 <div style="display:inline"> 857 <div style="display:inline">
926 ( 858 (
927 <span class="optional" style="display: none; ">optional</spa n> 859 <span class="optional" style="display: none; ">optional</spa n>
928 <span class="enum" style="display: none; ">enumerated</span> 860 <span class="enum" style="display: none; ">enumerated</span>
929 <span id="typeTemplate"> 861 <span id="typeTemplate">
930 <span> 862 <span>
931 <a href="extension.html#type-Port">Port</a> 863 <a href="experimental.contentSettings.html#type-ContentS etting">ContentSetting</a>
932 </span> 864 </span>
933 <span style="display: none; "> 865 <span style="display: none; ">
934 <span> 866 <span>
935 array of <span><span></span></span> 867 array of <span><span></span></span>
936 </span> 868 </span>
937 <span>paramType</span> 869 <span>paramType</span>
938 <span></span> 870 <span></span>
939 </span> 871 </span>
940 </span> 872 </span>
941 ) 873 )
942 </div> 874 </div>
943 875
944 </em> 876 </em>
945 </dt> 877 </dt>
946 <dd class="todo" style="display: none; "> 878 <dd class="todo" style="display: none; ">
947 Undocumented. 879 Undocumented.
948 </dd> 880 </dd>
949 <dd>Port through which messages can be sent and received with the exte nsion. The port's <a href="extension.html#type-Port">onDisconnect</a> event is f ired if extension does not exist. </dd> 881 <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. Default is <var>allow</var>.</dd>
950 <dd style="display: none; "> 882 <dd style="display: none; ">
951 This parameter was added in version 883 This parameter was added in version
952 <b><span></span></b>. 884 <b><span></span></b>.
953 You must omit this parameter in earlier versions, 885 You must omit this parameter in earlier versions,
954 and you may omit it in any version. If you require this 886 and you may omit it in any version. If you require this
955 parameter, the manifest key 887 parameter, the manifest key
956 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 888 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
957 can ensure that your extension won't be run in an earlier browser ve rsion. 889 can ensure that your extension won't be run in an earlier browser ve rsion.
958 </dd> 890 </dd>
959 891
(...skipping 16 matching lines...) Expand all
976 <dd style="display: none; "> 908 <dd style="display: none; ">
977 <div></div> 909 <div></div>
978 </dd> 910 </dd>
979 911
980 <!-- FUNCTION PARAMETERS --> 912 <!-- FUNCTION PARAMETERS -->
981 <dd style="display: none; "> 913 <dd style="display: none; ">
982 <div></div> 914 <div></div>
983 </dd> 915 </dd>
984 916
985 </div> 917 </div>
986 </div> 918 </div><div>
987 </dl> 919 <a name="property-popups"></a>
988 920 <h4>popups</h4>
989 <!-- CALLBACK --> 921 <div class="summary">
990 <div style="display: none; "> 922 <!-- Note: intentionally longer 80 columns -->
991 <div> 923 <span>chrome.experimental.contentSettings.</span><span>popups</s pan>
992 <h4>Callback function</h4> 924 </div>
993 <p> 925 <div>
994 The callback <em>parameter</em> should specify a function
995 that looks like this:
996 </p>
997 <p>
998 If you specify the <em>callback</em> parameter, it should
999 specify a function that looks like this:
1000 </p>
1001
1002 <!-- Note: intentionally longer 80 columns -->
1003 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
1004 <dl>
1005 <div>
1006 <div>
1007 </div>
1008 </div>
1009 </dl>
1010 </div>
1011 </div>
1012
1013 <!-- MIN_VERSION -->
1014 <p style="display: none; ">
1015 This function was added in version <b><span></span></b>.
1016 If you require this function, the manifest key
1017 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1018 can ensure that your extension won't be run in an earlier brow ser version.
1019 </p>
1020 </div> <!-- /description -->
1021
1022 </div><div class="apiItem">
1023 <a name="method-getBackgroundPage"></a> <!-- method-anchor -->
1024 <h4>getBackgroundPage</h4>
1025
1026 <div class="summary"><span>DOMWindow</span>
1027 <!-- Note: intentionally longer 80 columns -->
1028 <span>chrome.extension.getBackgroundPage</span>(<span style="d isplay: none; "><span>, </span><span></span>
1029 <var><span></span></var></span>)</div>
1030
1031 <div class="description">
1032 <p class="todo" style="display: none; ">Undocumented.</p>
1033 <p>Returns the JavaScript 'window' object for the background pag e running inside the current extension. Returns null if the extension has no bac kground page.</p>
1034
1035 <!-- PARAMETERS -->
1036 <h4 style="display: none; ">Parameters</h4>
1037 <dl>
1038 <div style="display: none; ">
1039 <div>
1040 </div>
1041 </div>
1042 </dl>
1043
1044 <!-- RETURNS -->
1045 <h4>Returns</h4>
1046 <dl>
1047 <div>
1048 <div>
1049 <dt> 926 <dt>
1050 <var style="display: none; ">paramName</var> 927 <var>popups</var>
1051 <em> 928 <em>
1052 929
1053 <!-- TYPE --> 930 <!-- TYPE -->
1054 <div style="display:inline">
1055 (
1056 <span class="optional" style="display: none; ">optional</spa n>
1057 <span class="enum" style="display: none; ">enumerated</span>
1058 <span id="typeTemplate">
1059 <span style="display: none; ">
1060 <a> Type</a>
1061 </span>
1062 <span>
1063 <span style="display: none; ">
1064 array of <span><span></span></span>
1065 </span>
1066 <span>DOMWindow</span>
1067 <span style="display: none; "></span>
1068 </span>
1069 </span>
1070 )
1071 </div>
1072
1073 </em>
1074 </dt>
1075 <dd class="todo">
1076 Undocumented.
1077 </dd>
1078 <dd style="display: none; ">
1079 Description of this parameter from the json schema.
1080 </dd>
1081 <dd style="display: none; ">
1082 This parameter was added in version
1083 <b><span></span></b>.
1084 You must omit this parameter in earlier versions,
1085 and you may omit it in any version. If you require this
1086 parameter, the manifest key
1087 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1088 can ensure that your extension won't be run in an earlier browser ve rsion.
1089 </dd>
1090
1091 <!-- OBJECT PROPERTIES -->
1092 <dd>
1093 <dl>
1094 <div style="display: none; ">
1095 <div>
1096 </div>
1097 </div>
1098 </dl>
1099 </dd>
1100
1101 <!-- OBJECT METHODS -->
1102 <dd style="display: none; ">
1103 <div></div>
1104 </dd>
1105
1106 <!-- OBJECT EVENT FIELDS -->
1107 <dd style="display: none; ">
1108 <div></div>
1109 </dd>
1110
1111 <!-- FUNCTION PARAMETERS -->
1112 <dd style="display: none; ">
1113 <div></div>
1114 </dd>
1115
1116 </div>
1117 </div>
1118 </dl>
1119
1120 <!-- CALLBACK -->
1121 <div style="display: none; ">
1122 <div>
1123 <h4>Callback function</h4>
1124 <p>
1125 The callback <em>parameter</em> should specify a function
1126 that looks like this:
1127 </p>
1128 <p>
1129 If you specify the <em>callback</em> parameter, it should
1130 specify a function that looks like this:
1131 </p>
1132
1133 <!-- Note: intentionally longer 80 columns -->
1134 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
1135 <dl>
1136 <div>
1137 <div>
1138 </div>
1139 </div>
1140 </dl>
1141 </div>
1142 </div>
1143
1144 <!-- MIN_VERSION -->
1145 <p style="display: none; ">
1146 This function was added in version <b><span></span></b>.
1147 If you require this function, the manifest key
1148 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1149 can ensure that your extension won't be run in an earlier brow ser version.
1150 </p>
1151 </div> <!-- /description -->
1152
1153 </div><div class="apiItem" style="display: none; ">
1154 <a></a> <!-- method-anchor -->
1155 <h4>method name</h4>
1156
1157 <div class="summary"><span>void</span>
1158 <!-- Note: intentionally longer 80 columns -->
1159 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
1160 <var><span></span></var></span>)</div>
1161
1162 <div class="description">
1163 <p class="todo">Undocumented.</p>
1164 <p>
1165 A description from the json schema def of the function goes he re.
1166 </p>
1167
1168 <!-- PARAMETERS -->
1169 <h4>Parameters</h4>
1170 <dl>
1171 <div>
1172 <div>
1173 </div>
1174 </div>
1175 </dl>
1176
1177 <!-- RETURNS -->
1178 <h4>Returns</h4>
1179 <dl>
1180 <div>
1181 <div>
1182 </div>
1183 </div>
1184 </dl>
1185
1186 <!-- CALLBACK -->
1187 <div>
1188 <div>
1189 <h4>Callback function</h4>
1190 <p>
1191 The callback <em>parameter</em> should specify a function
1192 that looks like this:
1193 </p>
1194 <p>
1195 If you specify the <em>callback</em> parameter, it should
1196 specify a function that looks like this:
1197 </p>
1198
1199 <!-- Note: intentionally longer 80 columns -->
1200 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
1201 <dl>
1202 <div>
1203 <div>
1204 </div>
1205 </div>
1206 </dl>
1207 </div>
1208 </div>
1209
1210 <!-- MIN_VERSION -->
1211 <p>
1212 This function was added in version <b><span></span></b>.
1213 If you require this function, the manifest key
1214 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1215 can ensure that your extension won't be run in an earlier brow ser version.
1216 </p>
1217 </div> <!-- /description -->
1218
1219 </div><div class="apiItem" style="display: none; ">
1220 <a></a> <!-- method-anchor -->
1221 <h4>method name</h4>
1222
1223 <div class="summary"><span>void</span>
1224 <!-- Note: intentionally longer 80 columns -->
1225 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
1226 <var><span></span></var></span>)</div>
1227
1228 <div class="description">
1229 <p class="todo">Undocumented.</p>
1230 <p>
1231 A description from the json schema def of the function goes he re.
1232 </p>
1233
1234 <!-- PARAMETERS -->
1235 <h4>Parameters</h4>
1236 <dl>
1237 <div>
1238 <div>
1239 </div>
1240 </div>
1241 </dl>
1242
1243 <!-- RETURNS -->
1244 <h4>Returns</h4>
1245 <dl>
1246 <div>
1247 <div>
1248 </div>
1249 </div>
1250 </dl>
1251
1252 <!-- CALLBACK -->
1253 <div>
1254 <div>
1255 <h4>Callback function</h4>
1256 <p>
1257 The callback <em>parameter</em> should specify a function
1258 that looks like this:
1259 </p>
1260 <p>
1261 If you specify the <em>callback</em> parameter, it should
1262 specify a function that looks like this:
1263 </p>
1264
1265 <!-- Note: intentionally longer 80 columns -->
1266 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
1267 <dl>
1268 <div>
1269 <div>
1270 </div>
1271 </div>
1272 </dl>
1273 </div>
1274 </div>
1275
1276 <!-- MIN_VERSION -->
1277 <p>
1278 This function was added in version <b><span></span></b>.
1279 If you require this function, the manifest key
1280 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1281 can ensure that your extension won't be run in an earlier brow ser version.
1282 </p>
1283 </div> <!-- /description -->
1284
1285 </div><div class="apiItem">
1286 <a name="method-getURL"></a> <!-- method-anchor -->
1287 <h4>getURL</h4>
1288
1289 <div class="summary"><span>string</span>
1290 <!-- Note: intentionally longer 80 columns -->
1291 <span>chrome.extension.getURL</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
1292 <var><span>path</span></var></span>)</div>
1293
1294 <div class="description">
1295 <p class="todo" style="display: none; ">Undocumented.</p>
1296 <p>Converts a relative path within an extension install director y to a fully-qualified URL.</p>
1297
1298 <!-- PARAMETERS -->
1299 <h4>Parameters</h4>
1300 <dl>
1301 <div>
1302 <div>
1303 <dt>
1304 <var>path</var>
1305 <em>
1306
1307 <!-- TYPE -->
1308 <div style="display:inline">
1309 (
1310 <span class="optional" style="display: none; ">optional</spa n>
1311 <span class="enum" style="display: none; ">enumerated</span>
1312 <span id="typeTemplate">
1313 <span style="display: none; ">
1314 <a> Type</a>
1315 </span>
1316 <span>
1317 <span style="display: none; ">
1318 array of <span><span></span></span>
1319 </span>
1320 <span>string</span>
1321 <span style="display: none; "></span>
1322 </span>
1323 </span>
1324 )
1325 </div>
1326
1327 </em>
1328 </dt>
1329 <dd class="todo" style="display: none; ">
1330 Undocumented.
1331 </dd>
1332 <dd>A path to a resource within an extension expressed relative to its install directory.</dd>
1333 <dd style="display: none; ">
1334 This parameter was added in version
1335 <b><span></span></b>.
1336 You must omit this parameter in earlier versions,
1337 and you may omit it in any version. If you require this
1338 parameter, the manifest key
1339 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1340 can ensure that your extension won't be run in an earlier browser ve rsion.
1341 </dd>
1342
1343 <!-- OBJECT PROPERTIES -->
1344 <dd style="display: none; ">
1345 <dl>
1346 <div>
1347 <div>
1348 </div>
1349 </div>
1350 </dl>
1351 </dd>
1352
1353 <!-- OBJECT METHODS -->
1354 <dd style="display: none; ">
1355 <div></div>
1356 </dd>
1357
1358 <!-- OBJECT EVENT FIELDS -->
1359 <dd style="display: none; ">
1360 <div></div>
1361 </dd>
1362
1363 <!-- FUNCTION PARAMETERS -->
1364 <dd style="display: none; ">
1365 <div></div>
1366 </dd>
1367
1368 </div>
1369 </div>
1370 </dl>
1371
1372 <!-- RETURNS -->
1373 <h4>Returns</h4>
1374 <dl>
1375 <div>
1376 <div>
1377 <dt>
1378 <var style="display: none; ">paramName</var>
1379 <em>
1380
1381 <!-- TYPE -->
1382 <div style="display:inline">
1383 (
1384 <span class="optional" style="display: none; ">optional</spa n>
1385 <span class="enum" style="display: none; ">enumerated</span>
1386 <span id="typeTemplate">
1387 <span style="display: none; ">
1388 <a> Type</a>
1389 </span>
1390 <span>
1391 <span style="display: none; ">
1392 array of <span><span></span></span>
1393 </span>
1394 <span>string</span>
1395 <span style="display: none; "></span>
1396 </span>
1397 </span>
1398 )
1399 </div>
1400
1401 </em>
1402 </dt>
1403 <dd class="todo" style="display: none; ">
1404 Undocumented.
1405 </dd>
1406 <dd>The fully-qualified URL to the resource.</dd>
1407 <dd style="display: none; ">
1408 This parameter was added in version
1409 <b><span></span></b>.
1410 You must omit this parameter in earlier versions,
1411 and you may omit it in any version. If you require this
1412 parameter, the manifest key
1413 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1414 can ensure that your extension won't be run in an earlier browser ve rsion.
1415 </dd>
1416
1417 <!-- OBJECT PROPERTIES -->
1418 <dd style="display: none; ">
1419 <dl>
1420 <div>
1421 <div>
1422 </div>
1423 </div>
1424 </dl>
1425 </dd>
1426
1427 <!-- OBJECT METHODS -->
1428 <dd style="display: none; ">
1429 <div></div>
1430 </dd>
1431
1432 <!-- OBJECT EVENT FIELDS -->
1433 <dd style="display: none; ">
1434 <div></div>
1435 </dd>
1436
1437 <!-- FUNCTION PARAMETERS -->
1438 <dd style="display: none; ">
1439 <div></div>
1440 </dd>
1441
1442 </div>
1443 </div>
1444 </dl>
1445
1446 <!-- CALLBACK -->
1447 <div style="display: none; ">
1448 <div>
1449 <h4>Callback function</h4>
1450 <p>
1451 The callback <em>parameter</em> should specify a function
1452 that looks like this:
1453 </p>
1454 <p>
1455 If you specify the <em>callback</em> parameter, it should
1456 specify a function that looks like this:
1457 </p>
1458
1459 <!-- Note: intentionally longer 80 columns -->
1460 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
1461 <dl>
1462 <div>
1463 <div>
1464 </div>
1465 </div>
1466 </dl>
1467 </div>
1468 </div>
1469
1470 <!-- MIN_VERSION -->
1471 <p style="display: none; ">
1472 This function was added in version <b><span></span></b>.
1473 If you require this function, the manifest key
1474 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1475 can ensure that your extension won't be run in an earlier brow ser version.
1476 </p>
1477 </div> <!-- /description -->
1478
1479 </div><div class="apiItem">
1480 <a name="method-getViews"></a> <!-- method-anchor -->
1481 <h4>getViews</h4>
1482
1483 <div class="summary"><span>array of DOMWindow</span>
1484 <!-- Note: intentionally longer 80 columns -->
1485 <span>chrome.extension.getViews</span>(<span class="optional"> <span style="display: none; ">, </span><span>object</span>
1486 <var><span>fetchProperties</span></var></span>)</div>
1487
1488 <div class="description">
1489 <p class="todo" style="display: none; ">Undocumented.</p>
1490 <p>Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.</p>
1491
1492 <!-- PARAMETERS -->
1493 <h4>Parameters</h4>
1494 <dl>
1495 <div>
1496 <div>
1497 <dt>
1498 <var>fetchProperties</var>
1499 <em>
1500
1501 <!-- TYPE -->
1502 <div style="display:inline">
1503 (
1504 <span class="optional">optional</span>
1505 <span class="enum" style="display: none; ">enumerated</span>
1506 <span id="typeTemplate">
1507 <span style="display: none; ">
1508 <a> Type</a>
1509 </span>
1510 <span>
1511 <span style="display: none; ">
1512 array of <span><span></span></span>
1513 </span>
1514 <span>object</span>
1515 <span style="display: none; "></span>
1516 </span>
1517 </span>
1518 )
1519 </div>
1520
1521 </em>
1522 </dt>
1523 <dd class="todo">
1524 Undocumented.
1525 </dd>
1526 <dd style="display: none; ">
1527 Description of this parameter from the json schema.
1528 </dd>
1529 <dd style="display: none; ">
1530 This parameter was added in version
1531 <b><span></span></b>.
1532 You must omit this parameter in earlier versions,
1533 and you may omit it in any version. If you require this
1534 parameter, the manifest key
1535 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1536 can ensure that your extension won't be run in an earlier browser ve rsion.
1537 </dd>
1538
1539 <!-- OBJECT PROPERTIES -->
1540 <dd>
1541 <dl>
1542 <div>
1543 <div>
1544 <dt>
1545 <var>type</var>
1546 <em>
1547
1548 <!-- TYPE -->
1549 <div style="display:inline">
1550 (
1551 <span class="optional">optional</span>
1552 <span class="enum">enumerated</span>
1553 <span id="typeTemplate">
1554 <span style="display: none; ">
1555 <a> Type</a>
1556 </span>
1557 <span>
1558 <span style="display: none; ">
1559 array of <span><span></span></span>
1560 </span>
1561 <span>string</span>
1562 <span>["tab", "infobar", "notification", "popup"]</span>
1563 </span>
1564 </span>
1565 )
1566 </div>
1567
1568 </em>
1569 </dt>
1570 <dd class="todo" style="display: none; ">
1571 Undocumented.
1572 </dd>
1573 <dd>The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'infobar', 'notification', 'pop up'.</dd>
1574 <dd style="display: none; ">
1575 This parameter was added in version
1576 <b><span></span></b>.
1577 You must omit this parameter in earlier versions,
1578 and you may omit it in any version. If you require this
1579 parameter, the manifest key
1580 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1581 can ensure that your extension won't be run in an earlier browser ve rsion.
1582 </dd>
1583
1584 <!-- OBJECT PROPERTIES -->
1585 <dd style="display: none; ">
1586 <dl>
1587 <div>
1588 <div>
1589 </div>
1590 </div>
1591 </dl>
1592 </dd>
1593
1594 <!-- OBJECT METHODS -->
1595 <dd style="display: none; ">
1596 <div></div>
1597 </dd>
1598
1599 <!-- OBJECT EVENT FIELDS -->
1600 <dd style="display: none; ">
1601 <div></div>
1602 </dd>
1603
1604 <!-- FUNCTION PARAMETERS -->
1605 <dd style="display: none; ">
1606 <div></div>
1607 </dd>
1608
1609 </div>
1610 </div><div>
1611 <div>
1612 <dt>
1613 <var>windowId</var>
1614 <em>
1615
1616 <!-- TYPE -->
1617 <div style="display:inline">
1618 (
1619 <span class="optional">optional</span>
1620 <span class="enum" style="display: none; ">enumerated</span>
1621 <span id="typeTemplate">
1622 <span style="display: none; ">
1623 <a> Type</a>
1624 </span>
1625 <span>
1626 <span style="display: none; ">
1627 array of <span><span></span></span>
1628 </span>
1629 <span>integer</span>
1630 <span style="display: none; "></span>
1631 </span>
1632 </span>
1633 )
1634 </div>
1635
1636 </em>
1637 </dt>
1638 <dd class="todo" style="display: none; ">
1639 Undocumented.
1640 </dd>
1641 <dd>The window to restrict the search to. If omitted, returns all view s.</dd>
1642 <dd style="display: none; ">
1643 This parameter was added in version
1644 <b><span></span></b>.
1645 You must omit this parameter in earlier versions,
1646 and you may omit it in any version. If you require this
1647 parameter, the manifest key
1648 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1649 can ensure that your extension won't be run in an earlier browser ve rsion.
1650 </dd>
1651
1652 <!-- OBJECT PROPERTIES -->
1653 <dd style="display: none; ">
1654 <dl>
1655 <div>
1656 <div>
1657 </div>
1658 </div>
1659 </dl>
1660 </dd>
1661
1662 <!-- OBJECT METHODS -->
1663 <dd style="display: none; ">
1664 <div></div>
1665 </dd>
1666
1667 <!-- OBJECT EVENT FIELDS -->
1668 <dd style="display: none; ">
1669 <div></div>
1670 </dd>
1671
1672 <!-- FUNCTION PARAMETERS -->
1673 <dd style="display: none; ">
1674 <div></div>
1675 </dd>
1676
1677 </div>
1678 </div>
1679 </dl>
1680 </dd>
1681
1682 <!-- OBJECT METHODS -->
1683 <dd style="display: none; ">
1684 <div></div>
1685 </dd>
1686
1687 <!-- OBJECT EVENT FIELDS -->
1688 <dd style="display: none; ">
1689 <div></div>
1690 </dd>
1691
1692 <!-- FUNCTION PARAMETERS -->
1693 <dd style="display: none; ">
1694 <div></div>
1695 </dd>
1696
1697 </div>
1698 </div>
1699 </dl>
1700
1701 <!-- RETURNS -->
1702 <h4>Returns</h4>
1703 <dl>
1704 <div>
1705 <div>
1706 <dt>
1707 <var style="display: none; ">paramName</var>
1708 <em>
1709
1710 <!-- TYPE -->
1711 <div style="display:inline">
1712 (
1713 <span class="optional" style="display: none; ">optional</spa n>
1714 <span class="enum" style="display: none; ">enumerated</span>
1715 <span id="typeTemplate">
1716 <span style="display: none; ">
1717 <a> Type</a>
1718 </span>
1719 <span>
1720 <span>
1721 array of <span><span>
1722 <span style="display: none; ">
1723 <a> Type</a>
1724 </span>
1725 <span>
1726 <span style="display: none; ">
1727 array of <span><span></span></span>
1728 </span>
1729 <span>DOMWindow</span>
1730 <span style="display: none; "></span>
1731 </span>
1732 </span></span>
1733 </span>
1734 <span style="display: none; ">paramType</span>
1735 <span style="display: none; "></span>
1736 </span>
1737 </span>
1738 )
1739 </div>
1740
1741 </em>
1742 </dt>
1743 <dd class="todo" style="display: none; ">
1744 Undocumented.
1745 </dd>
1746 <dd>Array of global objects</dd>
1747 <dd style="display: none; ">
1748 This parameter was added in version
1749 <b><span></span></b>.
1750 You must omit this parameter in earlier versions,
1751 and you may omit it in any version. If you require this
1752 parameter, the manifest key
1753 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1754 can ensure that your extension won't be run in an earlier browser ve rsion.
1755 </dd>
1756
1757 <!-- OBJECT PROPERTIES -->
1758 <dd style="display: none; ">
1759 <dl>
1760 <div>
1761 <div>
1762 </div>
1763 </div>
1764 </dl>
1765 </dd>
1766
1767 <!-- OBJECT METHODS -->
1768 <dd style="display: none; ">
1769 <div></div>
1770 </dd>
1771
1772 <!-- OBJECT EVENT FIELDS -->
1773 <dd style="display: none; ">
1774 <div></div>
1775 </dd>
1776
1777 <!-- FUNCTION PARAMETERS -->
1778 <dd style="display: none; ">
1779 <div></div>
1780 </dd>
1781
1782 </div>
1783 </div>
1784 </dl>
1785
1786 <!-- CALLBACK -->
1787 <div style="display: none; ">
1788 <div>
1789 <h4>Callback function</h4>
1790 <p>
1791 The callback <em>parameter</em> should specify a function
1792 that looks like this:
1793 </p>
1794 <p>
1795 If you specify the <em>callback</em> parameter, it should
1796 specify a function that looks like this:
1797 </p>
1798
1799 <!-- Note: intentionally longer 80 columns -->
1800 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
1801 <dl>
1802 <div>
1803 <div>
1804 </div>
1805 </div>
1806 </dl>
1807 </div>
1808 </div>
1809
1810 <!-- MIN_VERSION -->
1811 <p style="display: none; ">
1812 This function was added in version <b><span></span></b>.
1813 If you require this function, the manifest key
1814 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1815 can ensure that your extension won't be run in an earlier brow ser version.
1816 </p>
1817 </div> <!-- /description -->
1818
1819 </div><div class="apiItem">
1820 <a name="method-isAllowedFileSchemeAccess"></a> <!-- method-anchor -->
1821 <h4>isAllowedFileSchemeAccess</h4>
1822
1823 <div class="summary"><span style="display: none; ">void</span>
1824 <!-- Note: intentionally longer 80 columns -->
1825 <span>chrome.extension.isAllowedFileSchemeAccess</span>(<span class="null"><span style="display: none; ">, </span><span>function</span>
1826 <var><span>callback</span></var></span>)</div>
1827
1828 <div class="description">
1829 <p class="todo" style="display: none; ">Undocumented.</p>
1830 <p>Retrieves the state of the extension's access to the 'file:// ' scheme (as determined by the user-controlled 'Allow access to File URLs' check box.</p>
1831
1832 <!-- PARAMETERS -->
1833 <h4>Parameters</h4>
1834 <dl>
1835 <div>
1836 <div>
1837 <dt>
1838 <var>callback</var>
1839 <em>
1840
1841 <!-- TYPE -->
1842 <div style="display:inline">
1843 (
1844 <span class="optional" style="display: none; ">optional</spa n>
1845 <span class="enum" style="display: none; ">enumerated</span>
1846 <span id="typeTemplate">
1847 <span style="display: none; ">
1848 <a> Type</a>
1849 </span>
1850 <span>
1851 <span style="display: none; ">
1852 array of <span><span></span></span>
1853 </span>
1854 <span>function</span>
1855 <span style="display: none; "></span>
1856 </span>
1857 </span>
1858 )
1859 </div>
1860
1861 </em>
1862 </dt>
1863 <dd class="todo">
1864 Undocumented.
1865 </dd>
1866 <dd style="display: none; ">
1867 Description of this parameter from the json schema.
1868 </dd>
1869 <dd style="display: none; ">
1870 This parameter was added in version
1871 <b><span></span></b>.
1872 You must omit this parameter in earlier versions,
1873 and you may omit it in any version. If you require this
1874 parameter, the manifest key
1875 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1876 can ensure that your extension won't be run in an earlier browser ve rsion.
1877 </dd>
1878
1879 <!-- OBJECT PROPERTIES -->
1880 <dd style="display: none; ">
1881 <dl>
1882 <div>
1883 <div>
1884 </div>
1885 </div>
1886 </dl>
1887 </dd>
1888
1889 <!-- OBJECT METHODS -->
1890 <dd style="display: none; ">
1891 <div></div>
1892 </dd>
1893
1894 <!-- OBJECT EVENT FIELDS -->
1895 <dd style="display: none; ">
1896 <div></div>
1897 </dd>
1898
1899 <!-- FUNCTION PARAMETERS -->
1900 <dd style="display: none; ">
1901 <div></div>
1902 </dd>
1903
1904 </div>
1905 </div>
1906 </dl>
1907
1908 <!-- RETURNS -->
1909 <h4 style="display: none; ">Returns</h4>
1910 <dl>
1911 <div style="display: none; ">
1912 <div>
1913 </div>
1914 </div>
1915 </dl>
1916
1917 <!-- CALLBACK -->
1918 <div>
1919 <div>
1920 <h4>Callback function</h4>
1921 <p>
1922 The callback <em>parameter</em> should specify a function
1923 that looks like this:
1924 </p>
1925 <p style="display: none; ">
1926 If you specify the <em>callback</em> parameter, it should
1927 specify a function that looks like this:
1928 </p>
1929
1930 <!-- Note: intentionally longer 80 columns -->
1931 <pre>function(<span>boolean isAllowedAccess</span>) <span clas s="subdued">{...}</span>;</pre>
1932 <dl>
1933 <div>
1934 <div>
1935 <dt>
1936 <var>isAllowedAccess</var>
1937 <em>
1938
1939 <!-- TYPE -->
1940 <div style="display:inline"> 931 <div style="display:inline">
1941 ( 932 (
1942 <span class="optional" style="display: none; ">optional</spa n> 933 <span class="optional" style="display: none; ">optional</spa n>
1943 <span class="enum" style="display: none; ">enumerated</span> 934 <span class="enum" style="display: none; ">enumerated</span>
1944 <span id="typeTemplate"> 935 <span id="typeTemplate">
936 <span>
937 <a href="experimental.contentSettings.html#type-ContentS etting">ContentSetting</a>
938 </span>
1945 <span style="display: none; "> 939 <span style="display: none; ">
1946 <a> Type</a> 940 <span>
1947 </span>
1948 <span>
1949 <span style="display: none; ">
1950 array of <span><span></span></span> 941 array of <span><span></span></span>
1951 </span> 942 </span>
1952 <span>boolean</span> 943 <span>paramType</span>
1953 <span style="display: none; "></span> 944 <span></span>
1954 </span> 945 </span>
1955 </span> 946 </span>
1956 ) 947 )
1957 </div> 948 </div>
1958 949
1959 </em> 950 </em>
1960 </dt> 951 </dt>
1961 <dd class="todo" style="display: none; "> 952 <dd class="todo" style="display: none; ">
1962 Undocumented. 953 Undocumented.
1963 </dd> 954 </dd>
1964 <dd>True if the extension can access the 'file://' scheme, false other wise.</dd> 955 <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. Default is <var>block</var>.</dd>
1965 <dd style="display: none; "> 956 <dd style="display: none; ">
1966 This parameter was added in version 957 This parameter was added in version
1967 <b><span></span></b>. 958 <b><span></span></b>.
1968 You must omit this parameter in earlier versions, 959 You must omit this parameter in earlier versions,
1969 and you may omit it in any version. If you require this 960 and you may omit it in any version. If you require this
1970 parameter, the manifest key 961 parameter, the manifest key
1971 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 962 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1972 can ensure that your extension won't be run in an earlier browser ve rsion. 963 can ensure that your extension won't be run in an earlier browser ve rsion.
1973 </dd> 964 </dd>
1974 965
(...skipping 16 matching lines...) Expand all
1991 <dd style="display: none; "> 982 <dd style="display: none; ">
1992 <div></div> 983 <div></div>
1993 </dd> 984 </dd>
1994 985
1995 <!-- FUNCTION PARAMETERS --> 986 <!-- FUNCTION PARAMETERS -->
1996 <dd style="display: none; "> 987 <dd style="display: none; ">
1997 <div></div> 988 <div></div>
1998 </dd> 989 </dd>
1999 990
2000 </div> 991 </div>
2001 </div> 992 </div><div>
2002 </dl> 993 <a name="property-notifications"></a>
2003 </div> 994 <h4>notifications</h4>
2004 </div> 995 <div class="summary">
2005 996 <!-- Note: intentionally longer 80 columns -->
2006 <!-- MIN_VERSION --> 997 <span>chrome.experimental.contentSettings.</span><span>notificat ions</span>
2007 <p> 998 </div>
2008 This function was added in version <b><span>12.0.706.0</span>< /b>. 999 <div>
2009 If you require this function, the manifest key
2010 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2011 can ensure that your extension won't be run in an earlier brow ser version.
2012 </p>
2013 </div> <!-- /description -->
2014
2015 </div><div class="apiItem">
2016 <a name="method-isAllowedIncognitoAccess"></a> <!-- method-anchor -->
2017 <h4>isAllowedIncognitoAccess</h4>
2018
2019 <div class="summary"><span style="display: none; ">void</span>
2020 <!-- Note: intentionally longer 80 columns -->
2021 <span>chrome.extension.isAllowedIncognitoAccess</span>(<span c lass="null"><span style="display: none; ">, </span><span>function</span>
2022 <var><span>callback</span></var></span>)</div>
2023
2024 <div class="description">
2025 <p class="todo" style="display: none; ">Undocumented.</p>
2026 <p>Retrieves the state of the extension's access to Incognito-mo de (as determined by the user-controlled 'Allowed in Incognito' checkbox.</p>
2027
2028 <!-- PARAMETERS -->
2029 <h4>Parameters</h4>
2030 <dl>
2031 <div>
2032 <div>
2033 <dt> 1000 <dt>
2034 <var>callback</var> 1001 <var>notifications</var>
2035 <em> 1002 <em>
2036 1003
2037 <!-- TYPE --> 1004 <!-- TYPE -->
2038 <div style="display:inline"> 1005 <div style="display:inline">
2039 ( 1006 (
2040 <span class="optional" style="display: none; ">optional</spa n> 1007 <span class="optional" style="display: none; ">optional</spa n>
2041 <span class="enum" style="display: none; ">enumerated</span> 1008 <span class="enum" style="display: none; ">enumerated</span>
2042 <span id="typeTemplate"> 1009 <span id="typeTemplate">
1010 <span>
1011 <a href="experimental.contentSettings.html#type-ContentS etting">ContentSetting</a>
1012 </span>
2043 <span style="display: none; "> 1013 <span style="display: none; ">
2044 <a> Type</a> 1014 <span>
2045 </span>
2046 <span>
2047 <span style="display: none; ">
2048 array of <span><span></span></span> 1015 array of <span><span></span></span>
2049 </span> 1016 </span>
2050 <span>function</span> 1017 <span>paramType</span>
2051 <span style="display: none; "></span> 1018 <span></span>
2052 </span> 1019 </span>
2053 </span> 1020 </span>
2054 ) 1021 )
2055 </div> 1022 </div>
2056 1023
2057 </em> 1024 </em>
2058 </dt> 1025 </dt>
2059 <dd class="todo"> 1026 <dd class="todo" style="display: none; ">
2060 Undocumented. 1027 Undocumented.
2061 </dd> 1028 </dd>
2062 <dd style="display: none; "> 1029 <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. Default is <var>ask</var>.</dd>
2063 Description of this parameter from the json schema.
2064 </dd>
2065 <dd style="display: none; "> 1030 <dd style="display: none; ">
2066 This parameter was added in version 1031 This parameter was added in version
2067 <b><span></span></b>. 1032 <b><span></span></b>.
2068 You must omit this parameter in earlier versions, 1033 You must omit this parameter in earlier versions,
2069 and you may omit it in any version. If you require this 1034 and you may omit it in any version. If you require this
2070 parameter, the manifest key 1035 parameter, the manifest key
2071 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1036 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2072 can ensure that your extension won't be run in an earlier browser ve rsion. 1037 can ensure that your extension won't be run in an earlier browser ve rsion.
2073 </dd> 1038 </dd>
2074 1039
(...skipping 16 matching lines...) Expand all
2091 <dd style="display: none; "> 1056 <dd style="display: none; ">
2092 <div></div> 1057 <div></div>
2093 </dd> 1058 </dd>
2094 1059
2095 <!-- FUNCTION PARAMETERS --> 1060 <!-- FUNCTION PARAMETERS -->
2096 <dd style="display: none; "> 1061 <dd style="display: none; ">
2097 <div></div> 1062 <div></div>
2098 </dd> 1063 </dd>
2099 1064
2100 </div> 1065 </div>
1066 </div>
1067
1068 </div> <!-- /apiGroup -->
1069
1070 <!-- METHODS -->
1071 <div id="methodsTemplate" class="apiGroup" style="display: none; ">
1072 <a></a>
1073 <h3>Methods</h3>
1074
1075 <!-- iterates over all functions -->
1076 <div class="apiItem">
1077 <a></a> <!-- method-anchor -->
1078 <h4>method name</h4>
1079
1080 <div class="summary"><span>void</span>
1081 <!-- Note: intentionally longer 80 columns -->
1082 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
1083 <var><span></span></var></span>)</div>
1084
1085 <div class="description">
1086 <p class="todo">Undocumented.</p>
1087 <p>
1088 A description from the json schema def of the function goes he re.
1089 </p>
1090
1091 <!-- PARAMETERS -->
1092 <h4>Parameters</h4>
1093 <dl>
1094 <div>
1095 <div>
1096 </div>
2101 </div> 1097 </div>
2102 </dl> 1098 </dl>
2103 1099
2104 <!-- RETURNS --> 1100 <!-- RETURNS -->
2105 <h4 style="display: none; ">Returns</h4> 1101 <h4>Returns</h4>
2106 <dl> 1102 <dl>
2107 <div style="display: none; "> 1103 <div>
2108 <div> 1104 <div>
2109 </div> 1105 </div>
2110 </div> 1106 </div>
2111 </dl> 1107 </dl>
2112 1108
2113 <!-- CALLBACK --> 1109 <!-- CALLBACK -->
2114 <div> 1110 <div>
2115 <div> 1111 <div>
2116 <h4>Callback function</h4> 1112 <h4>Callback function</h4>
2117 <p> 1113 <p>
2118 The callback <em>parameter</em> should specify a function 1114 The callback <em>parameter</em> should specify a function
2119 that looks like this: 1115 that looks like this:
2120 </p> 1116 </p>
2121 <p style="display: none; "> 1117 <p>
2122 If you specify the <em>callback</em> parameter, it should 1118 If you specify the <em>callback</em> parameter, it should
2123 specify a function that looks like this: 1119 specify a function that looks like this:
2124 </p> 1120 </p>
2125 1121
2126 <!-- Note: intentionally longer 80 columns --> 1122 <!-- Note: intentionally longer 80 columns -->
2127 <pre>function(<span>boolean isAllowedAccess</span>) <span clas s="subdued">{...}</span>;</pre> 1123 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
2128 <dl> 1124 <dl>
2129 <div> 1125 <div>
2130 <div> 1126 <div>
2131 <dt> 1127 </div>
2132 <var>isAllowedAccess</var>
2133 <em>
2134
2135 <!-- TYPE -->
2136 <div style="display:inline">
2137 (
2138 <span class="optional" style="display: none; ">optional</spa n>
2139 <span class="enum" style="display: none; ">enumerated</span>
2140 <span id="typeTemplate">
2141 <span style="display: none; ">
2142 <a> Type</a>
2143 </span>
2144 <span>
2145 <span style="display: none; ">
2146 array of <span><span></span></span>
2147 </span>
2148 <span>boolean</span>
2149 <span style="display: none; "></span>
2150 </span>
2151 </span>
2152 )
2153 </div>
2154
2155 </em>
2156 </dt>
2157 <dd class="todo" style="display: none; ">
2158 Undocumented.
2159 </dd>
2160 <dd>True if the extension has access to Incognito mode, false otherwis e.</dd>
2161 <dd style="display: none; ">
2162 This parameter was added in version
2163 <b><span></span></b>.
2164 You must omit this parameter in earlier versions,
2165 and you may omit it in any version. If you require this
2166 parameter, the manifest key
2167 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2168 can ensure that your extension won't be run in an earlier browser ve rsion.
2169 </dd>
2170
2171 <!-- OBJECT PROPERTIES -->
2172 <dd style="display: none; ">
2173 <dl>
2174 <div>
2175 <div>
2176 </div>
2177 </div>
2178 </dl>
2179 </dd>
2180
2181 <!-- OBJECT METHODS -->
2182 <dd style="display: none; ">
2183 <div></div>
2184 </dd>
2185
2186 <!-- OBJECT EVENT FIELDS -->
2187 <dd style="display: none; ">
2188 <div></div>
2189 </dd>
2190
2191 <!-- FUNCTION PARAMETERS -->
2192 <dd style="display: none; ">
2193 <div></div>
2194 </dd>
2195
2196 </div>
2197 </div> 1128 </div>
2198 </dl> 1129 </dl>
2199 </div> 1130 </div>
2200 </div> 1131 </div>
2201 1132
2202 <!-- MIN_VERSION --> 1133 <!-- MIN_VERSION -->
2203 <p> 1134 <p>
2204 This function was added in version <b><span>12.0.706.0</span>< /b>. 1135 This function was added in version <b><span></span></b>.
2205 If you require this function, the manifest key 1136 If you require this function, the manifest key
2206 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 1137 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2207 can ensure that your extension won't be run in an earlier brow ser version. 1138 can ensure that your extension won't be run in an earlier brow ser version.
2208 </p> 1139 </p>
2209 </div> <!-- /description --> 1140 </div> <!-- /description -->
2210 1141
2211 </div><div class="apiItem"> 1142 </div> <!-- /apiItem -->
2212 <a name="method-sendRequest"></a> <!-- method-anchor -->
2213 <h4>sendRequest</h4>
2214 1143
2215 <div class="summary"><span style="display: none; ">void</span> 1144 </div> <!-- /apiGroup -->
2216 <!-- Note: intentionally longer 80 columns --> 1145
2217 <span>chrome.extension.sendRequest</span>(<span class="optiona l"><span style="display: none; ">, </span><span>string</span> 1146 <!-- EVENTS -->
2218 <var><span>extensionId</span></var></span><span class="nul l"><span>, </span><span>any</span> 1147 <div id="eventsTemplate" class="apiGroup" style="display: none; ">
2219 <var><span>request</span></var></span><span class="optiona l"><span>, </span><span>function</span> 1148 <a></a>
2220 <var><span>responseCallback</span></var></span>)</div> 1149 <h3>Events</h3>
1150 <!-- iterates over all events -->
1151 <div class="apiItem">
1152 <a></a>
1153 <h4>event name</h4>
1154
1155 <div class="summary">
1156 <!-- Note: intentionally longer 80 columns -->
1157 <span class="subdued">chrome.bookmarks</span><span>onEvent</span ><span class="subdued">.addListener</span>(function(<span>Type param1, Type para m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p aram2</span>));
1158 </div>
2221 1159
2222 <div class="description"> 1160 <div class="description">
2223 <p class="todo" style="display: none; ">Undocumented.</p> 1161 <p class="todo">Undocumented.</p>
2224 <p>Sends a single request to other listeners within the extensio n. Similar to chrome.extension.connect, but only sends a single request with an optional response. The <a href="extension.html#event-onRequest">chrome.extension .onRequest</a> event is fired in each page of the extension.</p> 1162 <p>
1163 A description from the json schema def of the event goes here.
1164 </p>
2225 1165
2226 <!-- PARAMETERS --> 1166 <!-- LISTENER PARAMETERS -->
2227 <h4>Parameters</h4> 1167 <div>
1168 <h4>Listener parameters</h4>
1169 <dl>
1170 <div>
1171 <div>
1172 </div>
1173 </div>
1174 </dl>
1175 </div>
1176
1177 <!-- EXTRA PARAMETERS -->
1178 <div>
1179 <h4>Extra parameters to addListener</h4>
1180 <dl>
1181 <div>
1182 <div>
1183 </div>
1184 </div>
1185 </dl>
1186 </div>
1187
1188 <!-- LISTENER RETURN VALUE -->
1189 <h4>Listener returns</h4>
2228 <dl> 1190 <dl>
2229 <div> 1191 <div>
2230 <div> 1192 <div>
1193 </div>
1194 </div>
1195 </dl>
1196
1197 </div> <!-- /description -->
1198 </div> <!-- /apiItem -->
1199
1200 </div> <!-- /apiGroup -->
1201
1202 <!-- TYPES -->
1203 <div class="apiGroup">
1204 <a name="types"></a>
1205 <h3 id="types">Types</h3>
1206
1207 <!-- iterates over all types -->
1208 <div class="apiItem">
1209 <a name="type-ResourceIdentifier"></a>
1210 <h4>ResourceIdentifier</h4>
1211
1212 <div>
2231 <dt> 1213 <dt>
2232 <var>extensionId</var> 1214 <var style="display: none; ">paramName</var>
2233 <em> 1215 <em>
2234 1216
2235 <!-- TYPE --> 1217 <!-- TYPE -->
2236 <div style="display:inline"> 1218 <div style="display:inline">
2237 ( 1219 (
2238 <span class="optional">optional</span> 1220 <span class="optional" style="display: none; ">optional</spa n>
2239 <span class="enum" style="display: none; ">enumerated</span> 1221 <span class="enum" style="display: none; ">enumerated</span>
2240 <span id="typeTemplate"> 1222 <span id="typeTemplate">
2241 <span style="display: none; "> 1223 <span style="display: none; ">
2242 <a> Type</a> 1224 <a> Type</a>
2243 </span> 1225 </span>
2244 <span> 1226 <span>
2245 <span style="display: none; "> 1227 <span style="display: none; ">
2246 array of <span><span></span></span> 1228 array of <span><span></span></span>
2247 </span> 1229 </span>
2248 <span>string</span> 1230 <span>object</span>
2249 <span style="display: none; "></span> 1231 <span style="display: none; "></span>
2250 </span> 1232 </span>
2251 </span> 1233 </span>
2252 ) 1234 )
2253 </div> 1235 </div>
2254 1236
2255 </em> 1237 </em>
2256 </dt> 1238 </dt>
2257 <dd class="todo" style="display: none; "> 1239 <dd class="todo" style="display: none; ">
2258 Undocumented. 1240 Undocumented.
2259 </dd> 1241 </dd>
2260 <dd>The extension ID of the extension you want to connect to. If omitt ed, default is your own extension.</dd> 1242 <dd>Currently, no content types use resource identifiers.</dd>
2261 <dd style="display: none; "> 1243 <dd style="display: none; ">
2262 This parameter was added in version 1244 This parameter was added in version
2263 <b><span></span></b>. 1245 <b><span></span></b>.
2264 You must omit this parameter in earlier versions, 1246 You must omit this parameter in earlier versions,
2265 and you may omit it in any version. If you require this 1247 and you may omit it in any version. If you require this
2266 parameter, the manifest key 1248 parameter, the manifest key
2267 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1249 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2268 can ensure that your extension won't be run in an earlier browser ve rsion. 1250 can ensure that your extension won't be run in an earlier browser ve rsion.
2269 </dd> 1251 </dd>
2270 1252
2271 <!-- OBJECT PROPERTIES --> 1253 <!-- OBJECT PROPERTIES -->
2272 <dd style="display: none; "> 1254 <dd>
2273 <dl> 1255 <dl>
2274 <div> 1256 <div>
2275 <div> 1257 <div>
2276 </div>
2277 </div>
2278 </dl>
2279 </dd>
2280
2281 <!-- OBJECT METHODS -->
2282 <dd style="display: none; ">
2283 <div></div>
2284 </dd>
2285
2286 <!-- OBJECT EVENT FIELDS -->
2287 <dd style="display: none; ">
2288 <div></div>
2289 </dd>
2290
2291 <!-- FUNCTION PARAMETERS -->
2292 <dd style="display: none; ">
2293 <div></div>
2294 </dd>
2295
2296 </div>
2297 </div><div>
2298 <div>
2299 <dt> 1258 <dt>
2300 <var>request</var> 1259 <var>id</var>
2301 <em> 1260 <em>
2302 1261
2303 <!-- TYPE --> 1262 <!-- TYPE -->
2304 <div style="display:inline"> 1263 <div style="display:inline">
2305 ( 1264 (
2306 <span class="optional" style="display: none; ">optional</spa n> 1265 <span class="optional" style="display: none; ">optional</spa n>
2307 <span class="enum" style="display: none; ">enumerated</span> 1266 <span class="enum" style="display: none; ">enumerated</span>
2308 <span id="typeTemplate"> 1267 <span id="typeTemplate">
2309 <span style="display: none; "> 1268 <span style="display: none; ">
2310 <a> Type</a> 1269 <a> Type</a>
2311 </span> 1270 </span>
2312 <span> 1271 <span>
2313 <span style="display: none; "> 1272 <span style="display: none; ">
2314 array of <span><span></span></span> 1273 array of <span><span></span></span>
2315 </span> 1274 </span>
2316 <span>any</span> 1275 <span>string</span>
2317 <span style="display: none; "></span> 1276 <span style="display: none; "></span>
2318 </span> 1277 </span>
2319 </span> 1278 </span>
2320 ) 1279 )
2321 </div> 1280 </div>
2322 1281
2323 </em> 1282 </em>
2324 </dt> 1283 </dt>
2325 <dd class="todo"> 1284 <dd class="todo" style="display: none; ">
2326 Undocumented. 1285 Undocumented.
2327 </dd> 1286 </dd>
2328 <dd style="display: none; "> 1287 <dd>The resource identifier for the given content type.</dd>
2329 Description of this parameter from the json schema.
2330 </dd>
2331 <dd style="display: none; "> 1288 <dd style="display: none; ">
2332 This parameter was added in version 1289 This parameter was added in version
2333 <b><span></span></b>. 1290 <b><span></span></b>.
2334 You must omit this parameter in earlier versions, 1291 You must omit this parameter in earlier versions,
2335 and you may omit it in any version. If you require this 1292 and you may omit it in any version. If you require this
2336 parameter, the manifest key 1293 parameter, the manifest key
2337 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1294 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2338 can ensure that your extension won't be run in an earlier browser ve rsion. 1295 can ensure that your extension won't be run in an earlier browser ve rsion.
2339 </dd> 1296 </dd>
2340 1297
(...skipping 16 matching lines...) Expand all
2357 <dd style="display: none; "> 1314 <dd style="display: none; ">
2358 <div></div> 1315 <div></div>
2359 </dd> 1316 </dd>
2360 1317
2361 <!-- FUNCTION PARAMETERS --> 1318 <!-- FUNCTION PARAMETERS -->
2362 <dd style="display: none; "> 1319 <dd style="display: none; ">
2363 <div></div> 1320 <div></div>
2364 </dd> 1321 </dd>
2365 1322
2366 </div> 1323 </div>
2367 </div><div> 1324 </div><div>
2368 <div> 1325 <div>
2369 <dt> 1326 <dt>
2370 <var>responseCallback</var> 1327 <var>description</var>
2371 <em> 1328 <em>
2372 1329
2373 <!-- TYPE --> 1330 <!-- TYPE -->
2374 <div style="display:inline"> 1331 <div style="display:inline">
2375 ( 1332 (
2376 <span class="optional">optional</span> 1333 <span class="optional" style="display: none; ">optional</spa n>
2377 <span class="enum" style="display: none; ">enumerated</span> 1334 <span class="enum" style="display: none; ">enumerated</span>
2378 <span id="typeTemplate"> 1335 <span id="typeTemplate">
2379 <span style="display: none; "> 1336 <span style="display: none; ">
2380 <a> Type</a> 1337 <a> Type</a>
2381 </span> 1338 </span>
2382 <span> 1339 <span>
2383 <span style="display: none; "> 1340 <span style="display: none; ">
2384 array of <span><span></span></span> 1341 array of <span><span></span></span>
2385 </span> 1342 </span>
2386 <span>function</span> 1343 <span>string</span>
2387 <span style="display: none; "></span> 1344 <span style="display: none; "></span>
2388 </span> 1345 </span>
2389 </span> 1346 </span>
2390 ) 1347 )
2391 </div> 1348 </div>
2392 1349
2393 </em> 1350 </em>
2394 </dt> 1351 </dt>
2395 <dd class="todo"> 1352 <dd class="todo" style="display: none; ">
2396 Undocumented. 1353 Undocumented.
2397 </dd> 1354 </dd>
2398 <dd style="display: none; "> 1355 <dd>A human readable description of the resource.</dd>
2399 Description of this parameter from the json schema.
2400 </dd>
2401 <dd style="display: none; "> 1356 <dd style="display: none; ">
2402 This parameter was added in version 1357 This parameter was added in version
2403 <b><span></span></b>. 1358 <b><span></span></b>.
2404 You must omit this parameter in earlier versions, 1359 You must omit this parameter in earlier versions,
2405 and you may omit it in any version. If you require this 1360 and you may omit it in any version. If you require this
2406 parameter, the manifest key 1361 parameter, the manifest key
2407 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1362 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2408 can ensure that your extension won't be run in an earlier browser ve rsion. 1363 can ensure that your extension won't be run in an earlier browser ve rsion.
2409 </dd> 1364 </dd>
2410 1365
(...skipping 11 matching lines...) Expand all
2422 <dd style="display: none; "> 1377 <dd style="display: none; ">
2423 <div></div> 1378 <div></div>
2424 </dd> 1379 </dd>
2425 1380
2426 <!-- OBJECT EVENT FIELDS --> 1381 <!-- OBJECT EVENT FIELDS -->
2427 <dd style="display: none; "> 1382 <dd style="display: none; ">
2428 <div></div> 1383 <div></div>
2429 </dd> 1384 </dd>
2430 1385
2431 <!-- FUNCTION PARAMETERS --> 1386 <!-- FUNCTION PARAMETERS -->
2432 <dd> 1387 <dd style="display: none; ">
2433 <div> 1388 <div></div>
2434 <h5>Parameters</h5> 1389 </dd>
2435 <dl> 1390
2436 <div> 1391 </div>
1392 </div>
1393 </dl>
1394 </dd>
1395
1396 <!-- OBJECT METHODS -->
1397 <dd style="display: none; ">
1398 <div></div>
1399 </dd>
1400
1401 <!-- OBJECT EVENT FIELDS -->
1402 <dd style="display: none; ">
1403 <div></div>
1404 </dd>
1405
1406 <!-- FUNCTION PARAMETERS -->
1407 <dd style="display: none; ">
1408 <div></div>
1409 </dd>
1410
1411 </div>
1412
1413 </div><div class="apiItem">
1414 <a name="type-Pattern"></a>
1415 <h4>Pattern</h4>
1416
2437 <div> 1417 <div>
2438 <dt> 1418 <dt>
2439 <var>response</var> 1419 <var style="display: none; ">paramName</var>
2440 <em> 1420 <em>
2441 1421
2442 <!-- TYPE --> 1422 <!-- TYPE -->
2443 <div style="display:inline"> 1423 <div style="display:inline">
2444 ( 1424 (
2445 <span class="optional" style="display: none; ">optional</spa n> 1425 <span class="optional" style="display: none; ">optional</spa n>
2446 <span class="enum" style="display: none; ">enumerated</span> 1426 <span class="enum" style="display: none; ">enumerated</span>
2447 <span id="typeTemplate"> 1427 <span id="typeTemplate">
2448 <span style="display: none; "> 1428 <span style="display: none; ">
2449 <a> Type</a> 1429 <a> Type</a>
2450 </span> 1430 </span>
2451 <span> 1431 <span>
2452 <span style="display: none; "> 1432 <span style="display: none; ">
2453 array of <span><span></span></span> 1433 array of <span><span></span></span>
2454 </span> 1434 </span>
2455 <span>any</span> 1435 <span>object</span>
2456 <span style="display: none; "></span> 1436 <span style="display: none; "></span>
2457 </span> 1437 </span>
2458 </span> 1438 </span>
2459 ) 1439 )
2460 </div> 1440 </div>
2461 1441
2462 </em> 1442 </em>
2463 </dt> 1443 </dt>
2464 <dd class="todo" style="display: none; "> 1444 <dd class="todo">
2465 Undocumented. 1445 Undocumented.
2466 </dd> 1446 </dd>
2467 <dd>The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called wit h no arguments and <a href="extension.html#property-lastError">chrome.extension. lastError</a> will be set to the error message.</dd> 1447 <dd style="display: none; ">
1448 Description of this parameter from the json schema.
1449 </dd>
2468 <dd style="display: none; "> 1450 <dd style="display: none; ">
2469 This parameter was added in version 1451 This parameter was added in version
2470 <b><span></span></b>. 1452 <b><span></span></b>.
2471 You must omit this parameter in earlier versions, 1453 You must omit this parameter in earlier versions,
2472 and you may omit it in any version. If you require this 1454 and you may omit it in any version. If you require this
2473 parameter, the manifest key 1455 parameter, the manifest key
2474 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1456 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2475 can ensure that your extension won't be run in an earlier browser ve rsion. 1457 can ensure that your extension won't be run in an earlier browser ve rsion.
2476 </dd> 1458 </dd>
2477 1459
2478 <!-- OBJECT PROPERTIES --> 1460 <!-- OBJECT PROPERTIES -->
2479 <dd style="display: none; "> 1461 <dd>
2480 <dl> 1462 <dl>
2481 <div> 1463 <div>
2482 <div> 1464 <div>
2483 </div>
2484 </div>
2485 </dl>
2486 </dd>
2487
2488 <!-- OBJECT METHODS -->
2489 <dd style="display: none; ">
2490 <div></div>
2491 </dd>
2492
2493 <!-- OBJECT EVENT FIELDS -->
2494 <dd style="display: none; ">
2495 <div></div>
2496 </dd>
2497
2498 <!-- FUNCTION PARAMETERS -->
2499 <dd style="display: none; ">
2500 <div></div>
2501 </dd>
2502
2503 </div>
2504 </div>
2505 </dl>
2506 </div>
2507 </dd>
2508
2509 </div>
2510 </div>
2511 </dl>
2512
2513 <!-- RETURNS -->
2514 <h4 style="display: none; ">Returns</h4>
2515 <dl>
2516 <div style="display: none; ">
2517 <div>
2518 </div>
2519 </div>
2520 </dl>
2521
2522 <!-- CALLBACK -->
2523 <div>
2524 <div>
2525 <h4>Callback function</h4>
2526 <p style="display: none; ">
2527 The callback <em>parameter</em> should specify a function
2528 that looks like this:
2529 </p>
2530 <p>
2531 If you specify the <em>callback</em> parameter, it should
2532 specify a function that looks like this:
2533 </p>
2534
2535 <!-- Note: intentionally longer 80 columns -->
2536 <pre>function(<span>any response</span>) <span class="subdued" >{...}</span>;</pre>
2537 <dl>
2538 <div>
2539 <div>
2540 <dt> 1465 <dt>
2541 <var>response</var> 1466 <var>pattern</var>
2542 <em> 1467 <em>
2543 1468
2544 <!-- TYPE --> 1469 <!-- TYPE -->
2545 <div style="display:inline"> 1470 <div style="display:inline">
2546 ( 1471 (
2547 <span class="optional" style="display: none; ">optional</spa n> 1472 <span class="optional" style="display: none; ">optional</spa n>
2548 <span class="enum" style="display: none; ">enumerated</span> 1473 <span class="enum" style="display: none; ">enumerated</span>
2549 <span id="typeTemplate"> 1474 <span id="typeTemplate">
2550 <span style="display: none; "> 1475 <span style="display: none; ">
2551 <a> Type</a> 1476 <a> Type</a>
2552 </span> 1477 </span>
2553 <span> 1478 <span>
2554 <span style="display: none; "> 1479 <span style="display: none; ">
2555 array of <span><span></span></span> 1480 array of <span><span></span></span>
2556 </span> 1481 </span>
2557 <span>any</span> 1482 <span>string</span>
2558 <span style="display: none; "></span> 1483 <span style="display: none; "></span>
2559 </span> 1484 </span>
2560 </span> 1485 </span>
2561 ) 1486 )
2562 </div> 1487 </div>
2563 1488
2564 </em> 1489 </em>
2565 </dt> 1490 </dt>
2566 <dd class="todo" style="display: none; "> 1491 <dd class="todo" style="display: none; ">
2567 Undocumented. 1492 Undocumented.
2568 </dd> 1493 </dd>
2569 <dd>The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called wit h no arguments and <a href="extension.html#property-lastError">chrome.extension. lastError</a> will be set to the error message.</dd> 1494 <dd>The pattern string. The pattern should never be constructed direct ly, but should always be derived from an URL using the methods in the <var>conte ntSettings.patterns</var> module.</dd>
2570 <dd style="display: none; "> 1495 <dd style="display: none; ">
2571 This parameter was added in version 1496 This parameter was added in version
2572 <b><span></span></b>. 1497 <b><span></span></b>.
2573 You must omit this parameter in earlier versions, 1498 You must omit this parameter in earlier versions,
2574 and you may omit it in any version. If you require this 1499 and you may omit it in any version. If you require this
2575 parameter, the manifest key 1500 parameter, the manifest key
2576 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1501 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2577 can ensure that your extension won't be run in an earlier browser ve rsion. 1502 can ensure that your extension won't be run in an earlier browser ve rsion.
2578 </dd> 1503 </dd>
2579 1504
(...skipping 16 matching lines...) Expand all
2596 <dd style="display: none; "> 1521 <dd style="display: none; ">
2597 <div></div> 1522 <div></div>
2598 </dd> 1523 </dd>
2599 1524
2600 <!-- FUNCTION PARAMETERS --> 1525 <!-- FUNCTION PARAMETERS -->
2601 <dd style="display: none; "> 1526 <dd style="display: none; ">
2602 <div></div> 1527 <div></div>
2603 </dd> 1528 </dd>
2604 1529
2605 </div> 1530 </div>
2606 </div> 1531 </div>
2607 </dl> 1532 </dl>
2608 </div> 1533 </dd>
2609 </div>
2610 1534
2611 <!-- MIN_VERSION --> 1535 <!-- OBJECT METHODS -->
2612 <p style="display: none; "> 1536 <dd style="display: none; ">
2613 This function was added in version <b><span></span></b>. 1537 <div></div>
2614 If you require this function, the manifest key 1538 </dd>
2615 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 1539
2616 can ensure that your extension won't be run in an earlier brow ser version. 1540 <!-- OBJECT EVENT FIELDS -->
2617 </p> 1541 <dd style="display: none; ">
2618 </div> <!-- /description --> 1542 <div></div>
1543 </dd>
1544
1545 <!-- FUNCTION PARAMETERS -->
1546 <dd style="display: none; ">
1547 <div></div>
1548 </dd>
1549
1550 </div>
2619 1551
2620 </div><div class="apiItem"> 1552 </div><div class="apiItem">
2621 <a name="method-setUpdateUrlData"></a> <!-- method-anchor --> 1553 <a name="type-ContentSettingRule"></a>
2622 <h4>setUpdateUrlData</h4> 1554 <h4>ContentSettingRule</h4>
2623 1555
2624 <div class="summary"><span style="display: none; ">void</span> 1556 <div>
2625 <!-- Note: intentionally longer 80 columns -->
2626 <span>chrome.extension.setUpdateUrlData</span>(<span class="nu ll"><span style="display: none; ">, </span><span>string</span>
2627 <var><span>data</span></var></span>)</div>
2628
2629 <div class="description">
2630 <p class="todo" style="display: none; ">Undocumented.</p>
2631 <p>Sets the value of the ap CGI parameter used in the extension' s update URL. This value is ignored for extensions that are hosted in the Chrom e Extension Gallery.</p>
2632
2633 <!-- PARAMETERS -->
2634 <h4>Parameters</h4>
2635 <dl>
2636 <div>
2637 <div>
2638 <dt> 1557 <dt>
2639 <var>data</var> 1558 <var style="display: none; ">paramName</var>
2640 <em> 1559 <em>
2641 1560
2642 <!-- TYPE --> 1561 <!-- TYPE -->
2643 <div style="display:inline"> 1562 <div style="display:inline">
2644 ( 1563 (
2645 <span class="optional" style="display: none; ">optional</spa n> 1564 <span class="optional" style="display: none; ">optional</spa n>
2646 <span class="enum" style="display: none; ">enumerated</span> 1565 <span class="enum" style="display: none; ">enumerated</span>
2647 <span id="typeTemplate"> 1566 <span id="typeTemplate">
2648 <span style="display: none; "> 1567 <span style="display: none; ">
2649 <a> Type</a> 1568 <a> Type</a>
2650 </span> 1569 </span>
2651 <span> 1570 <span>
2652 <span style="display: none; "> 1571 <span style="display: none; ">
2653 array of <span><span></span></span> 1572 array of <span><span></span></span>
2654 </span> 1573 </span>
2655 <span>string</span> 1574 <span>object</span>
2656 <span style="display: none; "></span> 1575 <span style="display: none; "></span>
2657 </span> 1576 </span>
2658 </span> 1577 </span>
2659 ) 1578 )
2660 </div> 1579 </div>
2661 1580
2662 </em> 1581 </em>
2663 </dt> 1582 </dt>
2664 <dd class="todo"> 1583 <dd class="todo">
2665 Undocumented. 1584 Undocumented.
2666 </dd> 1585 </dd>
2667 <dd style="display: none; "> 1586 <dd style="display: none; ">
2668 Description of this parameter from the json schema. 1587 Description of this parameter from the json schema.
2669 </dd> 1588 </dd>
2670 <dd style="display: none; "> 1589 <dd style="display: none; ">
2671 This parameter was added in version 1590 This parameter was added in version
2672 <b><span></span></b>. 1591 <b><span></span></b>.
2673 You must omit this parameter in earlier versions, 1592 You must omit this parameter in earlier versions,
2674 and you may omit it in any version. If you require this 1593 and you may omit it in any version. If you require this
2675 parameter, the manifest key 1594 parameter, the manifest key
2676 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1595 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2677 can ensure that your extension won't be run in an earlier browser ve rsion. 1596 can ensure that your extension won't be run in an earlier browser ve rsion.
2678 </dd> 1597 </dd>
2679 1598
2680 <!-- OBJECT PROPERTIES --> 1599 <!-- OBJECT PROPERTIES -->
2681 <dd style="display: none; "> 1600 <dd>
2682 <dl> 1601 <dl>
2683 <div> 1602 <div>
2684 <div> 1603 <div>
2685 </div>
2686 </div>
2687 </dl>
2688 </dd>
2689
2690 <!-- OBJECT METHODS -->
2691 <dd style="display: none; ">
2692 <div></div>
2693 </dd>
2694
2695 <!-- OBJECT EVENT FIELDS -->
2696 <dd style="display: none; ">
2697 <div></div>
2698 </dd>
2699
2700 <!-- FUNCTION PARAMETERS -->
2701 <dd style="display: none; ">
2702 <div></div>
2703 </dd>
2704
2705 </div>
2706 </div>
2707 </dl>
2708
2709 <!-- RETURNS -->
2710 <h4 style="display: none; ">Returns</h4>
2711 <dl>
2712 <div style="display: none; ">
2713 <div>
2714 </div>
2715 </div>
2716 </dl>
2717
2718 <!-- CALLBACK -->
2719 <div style="display: none; ">
2720 <div>
2721 <h4>Callback function</h4>
2722 <p>
2723 The callback <em>parameter</em> should specify a function
2724 that looks like this:
2725 </p>
2726 <p>
2727 If you specify the <em>callback</em> parameter, it should
2728 specify a function that looks like this:
2729 </p>
2730
2731 <!-- Note: intentionally longer 80 columns -->
2732 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
2733 <dl>
2734 <div>
2735 <div>
2736 </div>
2737 </div>
2738 </dl>
2739 </div>
2740 </div>
2741
2742 <!-- MIN_VERSION -->
2743 <p style="display: none; ">
2744 This function was added in version <b><span></span></b>.
2745 If you require this function, the manifest key
2746 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2747 can ensure that your extension won't be run in an earlier brow ser version.
2748 </p>
2749 </div> <!-- /description -->
2750
2751 </div> <!-- /apiItem -->
2752
2753 </div> <!-- /apiGroup -->
2754
2755 <!-- EVENTS -->
2756 <div id="eventsTemplate" class="apiGroup">
2757 <a name="global-events"></a>
2758 <h3>Events</h3>
2759 <!-- iterates over all events -->
2760 <div class="apiItem">
2761 <a name="event-onConnect"></a>
2762 <h4>onConnect</h4>
2763
2764 <div class="summary">
2765 <!-- Note: intentionally longer 80 columns -->
2766 <span class="subdued">chrome.extension.</span><span>onConnect</s pan><span class="subdued">.addListener</span>(function(<span>Port port</span>) < span class="subdued">{...}</span><span></span>));
2767 </div>
2768
2769 <div class="description">
2770 <p class="todo" style="display: none; ">Undocumented.</p>
2771 <p>Fired when a connection is made from either an extension proc ess or a content script.</p>
2772
2773 <!-- LISTENER PARAMETERS -->
2774 <div>
2775 <h4>Listener parameters</h4>
2776 <dl>
2777 <div>
2778 <div>
2779 <dt> 1604 <dt>
2780 <var>port</var> 1605 <var>topLevelPattern</var>
2781 <em> 1606 <em>
2782 1607
2783 <!-- TYPE --> 1608 <!-- TYPE -->
2784 <div style="display:inline"> 1609 <div style="display:inline">
2785 ( 1610 (
2786 <span class="optional" style="display: none; ">optional</spa n> 1611 <span class="optional" style="display: none; ">optional</spa n>
2787 <span class="enum" style="display: none; ">enumerated</span> 1612 <span class="enum" style="display: none; ">enumerated</span>
2788 <span id="typeTemplate"> 1613 <span id="typeTemplate">
2789 <span> 1614 <span>
2790 <a href="extension.html#type-Port">Port</a> 1615 <a href="experimental.contentSettings.html#type-Pattern" >Pattern</a>
2791 </span> 1616 </span>
2792 <span style="display: none; "> 1617 <span style="display: none; ">
2793 <span> 1618 <span>
2794 array of <span><span></span></span> 1619 array of <span><span></span></span>
2795 </span> 1620 </span>
2796 <span>paramType</span> 1621 <span>paramType</span>
2797 <span></span> 1622 <span></span>
2798 </span> 1623 </span>
2799 </span> 1624 </span>
2800 ) 1625 )
2801 </div> 1626 </div>
2802 1627
2803 </em> 1628 </em>
2804 </dt> 1629 </dt>
2805 <dd class="todo"> 1630 <dd class="todo" style="display: none; ">
2806 Undocumented. 1631 Undocumented.
2807 </dd> 1632 </dd>
2808 <dd style="display: none; "> 1633 <dd>The pattern for the top-level frame URL.</dd>
2809 Description of this parameter from the json schema.
2810 </dd>
2811 <dd style="display: none; "> 1634 <dd style="display: none; ">
2812 This parameter was added in version 1635 This parameter was added in version
2813 <b><span></span></b>. 1636 <b><span></span></b>.
2814 You must omit this parameter in earlier versions, 1637 You must omit this parameter in earlier versions,
2815 and you may omit it in any version. If you require this 1638 and you may omit it in any version. If you require this
2816 parameter, the manifest key 1639 parameter, the manifest key
2817 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1640 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2818 can ensure that your extension won't be run in an earlier browser ve rsion. 1641 can ensure that your extension won't be run in an earlier browser ve rsion.
2819 </dd> 1642 </dd>
2820 1643
(...skipping 16 matching lines...) Expand all
2837 <dd style="display: none; "> 1660 <dd style="display: none; ">
2838 <div></div> 1661 <div></div>
2839 </dd> 1662 </dd>
2840 1663
2841 <!-- FUNCTION PARAMETERS --> 1664 <!-- FUNCTION PARAMETERS -->
2842 <dd style="display: none; "> 1665 <dd style="display: none; ">
2843 <div></div> 1666 <div></div>
2844 </dd> 1667 </dd>
2845 1668
2846 </div> 1669 </div>
2847 </div> 1670 </div><div>
2848 </dl>
2849 </div>
2850
2851 <!-- EXTRA PARAMETERS -->
2852 <div style="display: none; ">
2853 <h4>Extra parameters to addListener</h4>
2854 <dl>
2855 <div>
2856 <div>
2857 </div>
2858 </div>
2859 </dl>
2860 </div>
2861
2862 <!-- LISTENER RETURN VALUE -->
2863 <h4 style="display: none; ">Listener returns</h4>
2864 <dl>
2865 <div style="display: none; ">
2866 <div>
2867 </div>
2868 </div>
2869 </dl>
2870
2871 </div> <!-- /description -->
2872 </div><div class="apiItem">
2873 <a name="event-onConnectExternal"></a>
2874 <h4>onConnectExternal</h4>
2875
2876 <div class="summary">
2877 <!-- Note: intentionally longer 80 columns -->
2878 <span class="subdued">chrome.extension.</span><span>onConnectExt ernal</span><span class="subdued">.addListener</span>(function(<span>Port port</ span>) <span class="subdued">{...}</span><span></span>));
2879 </div>
2880
2881 <div class="description">
2882 <p class="todo" style="display: none; ">Undocumented.</p>
2883 <p>Fired when a connection is made from another extension.</p>
2884
2885 <!-- LISTENER PARAMETERS -->
2886 <div> 1671 <div>
2887 <h4>Listener parameters</h4>
2888 <dl>
2889 <div>
2890 <div>
2891 <dt> 1672 <dt>
2892 <var>port</var> 1673 <var>embeddedPattern</var>
2893 <em> 1674 <em>
2894 1675
2895 <!-- TYPE --> 1676 <!-- TYPE -->
2896 <div style="display:inline"> 1677 <div style="display:inline">
2897 ( 1678 (
2898 <span class="optional" style="display: none; ">optional</spa n> 1679 <span class="optional" style="display: none; ">optional</spa n>
2899 <span class="enum" style="display: none; ">enumerated</span> 1680 <span class="enum" style="display: none; ">enumerated</span>
2900 <span id="typeTemplate"> 1681 <span id="typeTemplate">
2901 <span> 1682 <span>
2902 <a href="extension.html#type-Port">Port</a> 1683 <a href="experimental.contentSettings.html#type-Pattern" >Pattern</a>
2903 </span> 1684 </span>
2904 <span style="display: none; "> 1685 <span style="display: none; ">
2905 <span> 1686 <span>
2906 array of <span><span></span></span> 1687 array of <span><span></span></span>
2907 </span> 1688 </span>
2908 <span>paramType</span> 1689 <span>paramType</span>
2909 <span></span> 1690 <span></span>
2910 </span> 1691 </span>
2911 </span> 1692 </span>
2912 ) 1693 )
2913 </div> 1694 </div>
2914 1695
2915 </em> 1696 </em>
2916 </dt> 1697 </dt>
2917 <dd class="todo"> 1698 <dd class="todo" style="display: none; ">
2918 Undocumented. 1699 Undocumented.
2919 </dd> 1700 </dd>
2920 <dd style="display: none; "> 1701 <dd>The pattern for the frame or object URL.</dd>
2921 Description of this parameter from the json schema.
2922 </dd>
2923 <dd style="display: none; "> 1702 <dd style="display: none; ">
2924 This parameter was added in version 1703 This parameter was added in version
2925 <b><span></span></b>. 1704 <b><span></span></b>.
2926 You must omit this parameter in earlier versions, 1705 You must omit this parameter in earlier versions,
2927 and you may omit it in any version. If you require this 1706 and you may omit it in any version. If you require this
2928 parameter, the manifest key 1707 parameter, the manifest key
2929 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1708 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2930 can ensure that your extension won't be run in an earlier browser ve rsion. 1709 can ensure that your extension won't be run in an earlier browser ve rsion.
2931 </dd> 1710 </dd>
2932 1711
(...skipping 16 matching lines...) Expand all
2949 <dd style="display: none; "> 1728 <dd style="display: none; ">
2950 <div></div> 1729 <div></div>
2951 </dd> 1730 </dd>
2952 1731
2953 <!-- FUNCTION PARAMETERS --> 1732 <!-- FUNCTION PARAMETERS -->
2954 <dd style="display: none; "> 1733 <dd style="display: none; ">
2955 <div></div> 1734 <div></div>
2956 </dd> 1735 </dd>
2957 1736
2958 </div> 1737 </div>
2959 </div> 1738 </div><div>
2960 </dl>
2961 </div>
2962
2963 <!-- EXTRA PARAMETERS -->
2964 <div style="display: none; ">
2965 <h4>Extra parameters to addListener</h4>
2966 <dl>
2967 <div>
2968 <div>
2969 </div>
2970 </div>
2971 </dl>
2972 </div>
2973
2974 <!-- LISTENER RETURN VALUE -->
2975 <h4 style="display: none; ">Listener returns</h4>
2976 <dl>
2977 <div style="display: none; ">
2978 <div>
2979 </div>
2980 </div>
2981 </dl>
2982
2983 </div> <!-- /description -->
2984 </div><div class="apiItem">
2985 <a name="event-onRequest"></a>
2986 <h4>onRequest</h4>
2987
2988 <div class="summary">
2989 <!-- Note: intentionally longer 80 columns -->
2990 <span class="subdued">chrome.extension.</span><span>onRequest</s pan><span class="subdued">.addListener</span>(function(<span>any request, Messag eSender sender, function sendResponse</span>) <span class="subdued">{...}</span> <span></span>));
2991 </div>
2992
2993 <div class="description">
2994 <p class="todo" style="display: none; ">Undocumented.</p>
2995 <p>Fired when a request is sent from either an extension process or a content script.</p>
2996
2997 <!-- LISTENER PARAMETERS -->
2998 <div> 1739 <div>
2999 <h4>Listener parameters</h4>
3000 <dl>
3001 <div>
3002 <div>
3003 <dt> 1740 <dt>
3004 <var>request</var> 1741 <var>resourceIdentifier</var>
3005 <em> 1742 <em>
3006 1743
3007 <!-- TYPE --> 1744 <!-- TYPE -->
3008 <div style="display:inline"> 1745 <div style="display:inline">
3009 ( 1746 (
3010 <span class="optional" style="display: none; ">optional</spa n> 1747 <span class="optional">optional</span>
3011 <span class="enum" style="display: none; ">enumerated</span> 1748 <span class="enum" style="display: none; ">enumerated</span>
3012 <span id="typeTemplate"> 1749 <span id="typeTemplate">
1750 <span>
1751 <a href="experimental.contentSettings.html#type-Resource Identifier">ResourceIdentifier</a>
1752 </span>
3013 <span style="display: none; "> 1753 <span style="display: none; ">
3014 <a> Type</a> 1754 <span>
3015 </span>
3016 <span>
3017 <span style="display: none; ">
3018 array of <span><span></span></span> 1755 array of <span><span></span></span>
3019 </span> 1756 </span>
3020 <span>any</span> 1757 <span>paramType</span>
3021 <span style="display: none; "></span> 1758 <span></span>
3022 </span> 1759 </span>
3023 </span> 1760 </span>
3024 ) 1761 )
3025 </div> 1762 </div>
3026 1763
3027 </em> 1764 </em>
3028 </dt> 1765 </dt>
3029 <dd class="todo" style="display: none; "> 1766 <dd class="todo" style="display: none; ">
3030 Undocumented. 1767 Undocumented.
3031 </dd> 1768 </dd>
3032 <dd>The request sent by the calling script.</dd> 1769 <dd>The resource identifier for the content type.</dd>
3033 <dd style="display: none; "> 1770 <dd style="display: none; ">
3034 This parameter was added in version 1771 This parameter was added in version
3035 <b><span></span></b>. 1772 <b><span></span></b>.
3036 You must omit this parameter in earlier versions, 1773 You must omit this parameter in earlier versions,
3037 and you may omit it in any version. If you require this 1774 and you may omit it in any version. If you require this
3038 parameter, the manifest key 1775 parameter, the manifest key
3039 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1776 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3040 can ensure that your extension won't be run in an earlier browser ve rsion. 1777 can ensure that your extension won't be run in an earlier browser ve rsion.
3041 </dd> 1778 </dd>
3042 1779
(...skipping 16 matching lines...) Expand all
3059 <dd style="display: none; "> 1796 <dd style="display: none; ">
3060 <div></div> 1797 <div></div>
3061 </dd> 1798 </dd>
3062 1799
3063 <!-- FUNCTION PARAMETERS --> 1800 <!-- FUNCTION PARAMETERS -->
3064 <dd style="display: none; "> 1801 <dd style="display: none; ">
3065 <div></div> 1802 <div></div>
3066 </dd> 1803 </dd>
3067 1804
3068 </div> 1805 </div>
3069 </div><div> 1806 </div><div>
3070 <div> 1807 <div>
3071 <dt> 1808 <dt>
3072 <var>sender</var> 1809 <var>setting</var>
3073 <em> 1810 <em>
3074 1811
3075 <!-- TYPE --> 1812 <!-- TYPE -->
3076 <div style="display:inline"> 1813 <div style="display:inline">
3077 ( 1814 (
3078 <span class="optional" style="display: none; ">optional</spa n> 1815 <span class="optional" style="display: none; ">optional</spa n>
3079 <span class="enum" style="display: none; ">enumerated</span> 1816 <span class="enum" style="display: none; ">enumerated</span>
3080 <span id="typeTemplate"> 1817 <span id="typeTemplate">
1818 <span style="display: none; ">
1819 <a> Type</a>
1820 </span>
3081 <span> 1821 <span>
3082 <a href="extension.html#type-MessageSender">MessageSende r</a> 1822 <span style="display: none; ">
3083 </span>
3084 <span style="display: none; ">
3085 <span>
3086 array of <span><span></span></span> 1823 array of <span><span></span></span>
3087 </span> 1824 </span>
3088 <span>paramType</span> 1825 <span>any</span>
3089 <span></span> 1826 <span style="display: none; "></span>
3090 </span> 1827 </span>
3091 </span> 1828 </span>
3092 ) 1829 )
3093 </div> 1830 </div>
3094 1831
3095 </em> 1832 </em>
3096 </dt> 1833 </dt>
3097 <dd class="todo"> 1834 <dd class="todo" style="display: none; ">
3098 Undocumented. 1835 Undocumented.
3099 </dd> 1836 </dd>
3100 <dd style="display: none; "> 1837 <dd>The setting applied by this rule. See the description of the indiv idual ContentSetting objects for the possible values.</dd>
3101 Description of this parameter from the json schema.
3102 </dd>
3103 <dd style="display: none; "> 1838 <dd style="display: none; ">
3104 This parameter was added in version 1839 This parameter was added in version
3105 <b><span></span></b>. 1840 <b><span></span></b>.
3106 You must omit this parameter in earlier versions, 1841 You must omit this parameter in earlier versions,
3107 and you may omit it in any version. If you require this 1842 and you may omit it in any version. If you require this
3108 parameter, the manifest key 1843 parameter, the manifest key
3109 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1844 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3110 can ensure that your extension won't be run in an earlier browser ve rsion. 1845 can ensure that your extension won't be run in an earlier browser ve rsion.
3111 </dd> 1846 </dd>
3112 1847
(...skipping 16 matching lines...) Expand all
3129 <dd style="display: none; "> 1864 <dd style="display: none; ">
3130 <div></div> 1865 <div></div>
3131 </dd> 1866 </dd>
3132 1867
3133 <!-- FUNCTION PARAMETERS --> 1868 <!-- FUNCTION PARAMETERS -->
3134 <dd style="display: none; "> 1869 <dd style="display: none; ">
3135 <div></div> 1870 <div></div>
3136 </dd> 1871 </dd>
3137 1872
3138 </div> 1873 </div>
3139 </div><div> 1874 </div>
3140 <div> 1875 </dl>
1876 </dd>
1877
1878 <!-- OBJECT METHODS -->
1879 <dd style="display: none; ">
1880 <div></div>
1881 </dd>
1882
1883 <!-- OBJECT EVENT FIELDS -->
1884 <dd style="display: none; ">
1885 <div></div>
1886 </dd>
1887
1888 <!-- FUNCTION PARAMETERS -->
1889 <dd style="display: none; ">
1890 <div></div>
1891 </dd>
1892
1893 </div>
1894
1895 </div><div class="apiItem">
1896 <a name="type-ContentSetting"></a>
1897 <h4>ContentSetting</h4>
1898
1899 <div>
3141 <dt> 1900 <dt>
3142 <var>sendResponse</var> 1901 <var style="display: none; ">paramName</var>
3143 <em> 1902 <em>
3144 1903
3145 <!-- TYPE --> 1904 <!-- TYPE -->
3146 <div style="display:inline"> 1905 <div style="display:inline">
3147 ( 1906 (
3148 <span class="optional" style="display: none; ">optional</spa n> 1907 <span class="optional" style="display: none; ">optional</spa n>
3149 <span class="enum" style="display: none; ">enumerated</span> 1908 <span class="enum" style="display: none; ">enumerated</span>
3150 <span id="typeTemplate"> 1909 <span id="typeTemplate">
3151 <span style="display: none; "> 1910 <span style="display: none; ">
3152 <a> Type</a> 1911 <a> Type</a>
3153 </span> 1912 </span>
3154 <span> 1913 <span>
3155 <span style="display: none; "> 1914 <span style="display: none; ">
3156 array of <span><span></span></span> 1915 array of <span><span></span></span>
3157 </span> 1916 </span>
3158 <span>function</span> 1917 <span>object</span>
3159 <span style="display: none; "></span> 1918 <span style="display: none; "></span>
3160 </span> 1919 </span>
3161 </span> 1920 </span>
3162 ) 1921 )
3163 </div> 1922 </div>
3164 1923
3165 </em> 1924 </em>
3166 </dt> 1925 </dt>
3167 <dd class="todo" style="display: none; "> 1926 <dd class="todo">
3168 Undocumented. 1927 Undocumented.
3169 </dd> 1928 </dd>
3170 <dd>Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response.</dd> 1929 <dd style="display: none; ">
1930 Description of this parameter from the json schema.
1931 </dd>
3171 <dd style="display: none; "> 1932 <dd style="display: none; ">
3172 This parameter was added in version 1933 This parameter was added in version
3173 <b><span></span></b>. 1934 <b><span></span></b>.
3174 You must omit this parameter in earlier versions, 1935 You must omit this parameter in earlier versions,
3175 and you may omit it in any version. If you require this 1936 and you may omit it in any version. If you require this
3176 parameter, the manifest key 1937 parameter, the manifest key
3177 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1938 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3178 can ensure that your extension won't be run in an earlier browser ve rsion. 1939 can ensure that your extension won't be run in an earlier browser ve rsion.
3179 </dd> 1940 </dd>
3180 1941
3181 <!-- OBJECT PROPERTIES --> 1942 <!-- OBJECT PROPERTIES -->
3182 <dd style="display: none; "> 1943 <dd style="display: none; ">
3183 <dl> 1944 <dl>
3184 <div> 1945 <div>
3185 <div> 1946 <div>
3186 </div> 1947 </div>
3187 </div> 1948 </div>
3188 </dl> 1949 </dl>
3189 </dd> 1950 </dd>
3190 1951
3191 <!-- OBJECT METHODS --> 1952 <!-- OBJECT METHODS -->
3192 <dd style="display: none; "> 1953 <dd>
3193 <div></div> 1954 <div class="apiGroup" style="">
3194 </dd> 1955 <a name="global-ContentSetting-methods"></a>
1956 <h3>Methods of ContentSetting</h3>
3195 1957
3196 <!-- OBJECT EVENT FIELDS --> 1958 <!-- iterates over all functions -->
3197 <dd style="display: none; "> 1959 <div class="apiItem">
3198 <div></div> 1960 <a name="method-ContentSetting-clear"></a> <!-- method-anchor -->
3199 </dd> 1961 <h4>clear</h4>
3200 1962
3201 <!-- FUNCTION PARAMETERS --> 1963 <div class="summary"><span style="display: none; ">void</span>
3202 <dd style="display: none; "> 1964 <!-- Note: intentionally longer 80 columns -->
3203 <div></div> 1965 <span>contentSetting.clear</span>(<span class="null"><span sty le="display: none; ">, </span><span>object</span>
3204 </dd> 1966 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
3205 1967 <var><span>callback</span></var></span>)</div>
3206 </div>
3207 </div>
3208 </dl>
3209 </div>
3210
3211 <!-- EXTRA PARAMETERS -->
3212 <div style="display: none; ">
3213 <h4>Extra parameters to addListener</h4>
3214 <dl>
3215 <div>
3216 <div>
3217 </div>
3218 </div>
3219 </dl>
3220 </div>
3221
3222 <!-- LISTENER RETURN VALUE -->
3223 <h4 style="display: none; ">Listener returns</h4>
3224 <dl>
3225 <div style="display: none; ">
3226 <div>
3227 </div>
3228 </div>
3229 </dl>
3230
3231 </div> <!-- /description -->
3232 </div><div class="apiItem">
3233 <a name="event-onRequestExternal"></a>
3234 <h4>onRequestExternal</h4>
3235
3236 <div class="summary">
3237 <!-- Note: intentionally longer 80 columns -->
3238 <span class="subdued">chrome.extension.</span><span>onRequestExt ernal</span><span class="subdued">.addListener</span>(function(<span>any request , MessageSender sender, function sendResponse</span>) <span class="subdued">{... }</span><span></span>));
3239 </div>
3240 1968
3241 <div class="description"> 1969 <div class="description">
3242 <p class="todo" style="display: none; ">Undocumented.</p> 1970 <p class="todo" style="display: none; ">Undocumented.</p>
3243 <p>Fired when a request is sent from another extension.</p> 1971 <p>Clear all content setting rules set by this extension.</p>
3244 1972
3245 <!-- LISTENER PARAMETERS --> 1973 <!-- PARAMETERS -->
3246 <div> 1974 <h4>Parameters</h4>
3247 <h4>Listener parameters</h4> 1975 <dl>
3248 <dl> 1976 <div>
3249 <div> 1977 <div>
3250 <div>
3251 <dt> 1978 <dt>
3252 <var>request</var> 1979 <var>details</var>
3253 <em> 1980 <em>
3254 1981
3255 <!-- TYPE --> 1982 <!-- TYPE -->
3256 <div style="display:inline"> 1983 <div style="display:inline">
3257 ( 1984 (
3258 <span class="optional" style="display: none; ">optional</spa n> 1985 <span class="optional" style="display: none; ">optional</spa n>
3259 <span class="enum" style="display: none; ">enumerated</span> 1986 <span class="enum" style="display: none; ">enumerated</span>
3260 <span id="typeTemplate"> 1987 <span id="typeTemplate">
3261 <span style="display: none; "> 1988 <span style="display: none; ">
3262 <a> Type</a> 1989 <a> Type</a>
3263 </span> 1990 </span>
3264 <span> 1991 <span>
3265 <span style="display: none; "> 1992 <span style="display: none; ">
3266 array of <span><span></span></span> 1993 array of <span><span></span></span>
3267 </span> 1994 </span>
3268 <span>any</span> 1995 <span>object</span>
3269 <span style="display: none; "></span> 1996 <span style="display: none; "></span>
3270 </span> 1997 </span>
3271 </span> 1998 </span>
3272 ) 1999 )
3273 </div> 2000 </div>
3274 2001
3275 </em> 2002 </em>
3276 </dt> 2003 </dt>
2004 <dd class="todo">
2005 Undocumented.
2006 </dd>
2007 <dd style="display: none; ">
2008 Description of this parameter from the json schema.
2009 </dd>
2010 <dd style="display: none; ">
2011 This parameter was added in version
2012 <b><span></span></b>.
2013 You must omit this parameter in earlier versions,
2014 and you may omit it in any version. If you require this
2015 parameter, the manifest key
2016 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2017 can ensure that your extension won't be run in an earlier browser ve rsion.
2018 </dd>
2019
2020 <!-- OBJECT PROPERTIES -->
2021 <dd>
2022 <dl>
2023 <div>
2024 <div>
2025 <dt>
2026 <var>scope</var>
2027 <em>
2028
2029 <!-- TYPE -->
2030 <div style="display:inline">
2031 (
2032 <span class="optional">optional</span>
2033 <span class="enum">enumerated</span>
2034 <span id="typeTemplate">
2035 <span style="display: none; ">
2036 <a> Type</a>
2037 </span>
2038 <span>
2039 <span style="display: none; ">
2040 array of <span><span></span></span>
2041 </span>
2042 <span>string</span>
2043 <span>["regular", "incognito_session_only"]</span>
2044 </span>
2045 </span>
2046 )
2047 </div>
2048
2049 </em>
2050 </dt>
3277 <dd class="todo" style="display: none; "> 2051 <dd class="todo" style="display: none; ">
3278 Undocumented. 2052 Undocumented.
3279 </dd> 2053 </dd>
3280 <dd>The request sent by the calling script.</dd> 2054 <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>
3281 <dd style="display: none; "> 2055 <dd style="display: none; ">
3282 This parameter was added in version 2056 This parameter was added in version
3283 <b><span></span></b>. 2057 <b><span></span></b>.
3284 You must omit this parameter in earlier versions, 2058 You must omit this parameter in earlier versions,
3285 and you may omit it in any version. If you require this 2059 and you may omit it in any version. If you require this
3286 parameter, the manifest key 2060 parameter, the manifest key
3287 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2061 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3288 can ensure that your extension won't be run in an earlier browser ve rsion. 2062 can ensure that your extension won't be run in an earlier browser ve rsion.
3289 </dd> 2063 </dd>
3290 2064
(...skipping 16 matching lines...) Expand all
3307 <dd style="display: none; "> 2081 <dd style="display: none; ">
3308 <div></div> 2082 <div></div>
3309 </dd> 2083 </dd>
3310 2084
3311 <!-- FUNCTION PARAMETERS --> 2085 <!-- FUNCTION PARAMETERS -->
3312 <dd style="display: none; "> 2086 <dd style="display: none; ">
3313 <div></div> 2087 <div></div>
3314 </dd> 2088 </dd>
3315 2089
3316 </div> 2090 </div>
3317 </div><div>
3318 <div>
3319 <dt>
3320 <var>sender</var>
3321 <em>
3322
3323 <!-- TYPE -->
3324 <div style="display:inline">
3325 (
3326 <span class="optional" style="display: none; ">optional</spa n>
3327 <span class="enum" style="display: none; ">enumerated</span>
3328 <span id="typeTemplate">
3329 <span>
3330 <a href="extension.html#type-MessageSender">MessageSende r</a>
3331 </span>
3332 <span style="display: none; ">
3333 <span>
3334 array of <span><span></span></span>
3335 </span>
3336 <span>paramType</span>
3337 <span></span>
3338 </span>
3339 </span>
3340 )
3341 </div>
3342
3343 </em>
3344 </dt>
3345 <dd class="todo">
3346 Undocumented.
3347 </dd>
3348 <dd style="display: none; ">
3349 Description of this parameter from the json schema.
3350 </dd>
3351 <dd style="display: none; ">
3352 This parameter was added in version
3353 <b><span></span></b>.
3354 You must omit this parameter in earlier versions,
3355 and you may omit it in any version. If you require this
3356 parameter, the manifest key
3357 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3358 can ensure that your extension won't be run in an earlier browser ve rsion.
3359 </dd>
3360
3361 <!-- OBJECT PROPERTIES -->
3362 <dd style="display: none; ">
3363 <dl>
3364 <div>
3365 <div>
3366 </div>
3367 </div> 2091 </div>
3368 </dl> 2092 </dl>
3369 </dd> 2093 </dd>
3370 2094
3371 <!-- OBJECT METHODS --> 2095 <!-- OBJECT METHODS -->
3372 <dd style="display: none; "> 2096 <dd style="display: none; ">
3373 <div></div> 2097 <div></div>
3374 </dd> 2098 </dd>
3375 2099
3376 <!-- OBJECT EVENT FIELDS --> 2100 <!-- OBJECT EVENT FIELDS -->
3377 <dd style="display: none; "> 2101 <dd style="display: none; ">
3378 <div></div> 2102 <div></div>
3379 </dd> 2103 </dd>
3380 2104
3381 <!-- FUNCTION PARAMETERS --> 2105 <!-- FUNCTION PARAMETERS -->
3382 <dd style="display: none; "> 2106 <dd style="display: none; ">
3383 <div></div> 2107 <div></div>
3384 </dd> 2108 </dd>
3385 2109
3386 </div> 2110 </div>
3387 </div><div> 2111 </div><div>
3388 <div> 2112 <div>
3389 <dt> 2113 <dt>
3390 <var>sendResponse</var> 2114 <var>callback</var>
3391 <em> 2115 <em>
3392 2116
3393 <!-- TYPE --> 2117 <!-- TYPE -->
3394 <div style="display:inline"> 2118 <div style="display:inline">
3395 ( 2119 (
3396 <span class="optional" style="display: none; ">optional</spa n> 2120 <span class="optional">optional</span>
3397 <span class="enum" style="display: none; ">enumerated</span> 2121 <span class="enum" style="display: none; ">enumerated</span>
3398 <span id="typeTemplate"> 2122 <span id="typeTemplate">
3399 <span style="display: none; "> 2123 <span style="display: none; ">
3400 <a> Type</a> 2124 <a> Type</a>
3401 </span> 2125 </span>
3402 <span> 2126 <span>
3403 <span style="display: none; "> 2127 <span style="display: none; ">
3404 array of <span><span></span></span> 2128 array of <span><span></span></span>
3405 </span> 2129 </span>
3406 <span>function</span> 2130 <span>function</span>
3407 <span style="display: none; "></span> 2131 <span style="display: none; "></span>
3408 </span> 2132 </span>
3409 </span> 2133 </span>
3410 ) 2134 )
3411 </div> 2135 </div>
3412 2136
3413 </em> 2137 </em>
3414 </dt> 2138 </dt>
3415 <dd class="todo" style="display: none; "> 2139 <dd class="todo">
3416 Undocumented. 2140 Undocumented.
3417 </dd> 2141 </dd>
3418 <dd>Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response.</dd> 2142 <dd style="display: none; ">
2143 Description of this parameter from the json schema.
2144 </dd>
3419 <dd style="display: none; "> 2145 <dd style="display: none; ">
3420 This parameter was added in version 2146 This parameter was added in version
3421 <b><span></span></b>. 2147 <b><span></span></b>.
3422 You must omit this parameter in earlier versions, 2148 You must omit this parameter in earlier versions,
3423 and you may omit it in any version. If you require this 2149 and you may omit it in any version. If you require this
3424 parameter, the manifest key 2150 parameter, the manifest key
3425 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2151 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3426 can ensure that your extension won't be run in an earlier browser ve rsion. 2152 can ensure that your extension won't be run in an earlier browser ve rsion.
3427 </dd> 2153 </dd>
3428 2154
(...skipping 16 matching lines...) Expand all
3445 <dd style="display: none; "> 2171 <dd style="display: none; ">
3446 <div></div> 2172 <div></div>
3447 </dd> 2173 </dd>
3448 2174
3449 <!-- FUNCTION PARAMETERS --> 2175 <!-- FUNCTION PARAMETERS -->
3450 <dd style="display: none; "> 2176 <dd style="display: none; ">
3451 <div></div> 2177 <div></div>
3452 </dd> 2178 </dd>
3453 2179
3454 </div> 2180 </div>
3455 </div> 2181 </div>
3456 </dl> 2182 </dl>
3457 </div>
3458 2183
3459 <!-- EXTRA PARAMETERS --> 2184 <!-- RETURNS -->
3460 <div style="display: none; "> 2185 <h4 style="display: none; ">Returns</h4>
3461 <h4>Extra parameters to addListener</h4>
3462 <dl>
3463 <div>
3464 <div>
3465 </div>
3466 </div>
3467 </dl>
3468 </div>
3469
3470 <!-- LISTENER RETURN VALUE -->
3471 <h4 style="display: none; ">Listener returns</h4>
3472 <dl> 2186 <dl>
3473 <div style="display: none; "> 2187 <div style="display: none; ">
3474 <div> 2188 <div>
3475 </div> 2189 </div>
3476 </div> 2190 </div>
3477 </dl> 2191 </dl>
3478 2192
2193 <!-- CALLBACK -->
2194 <div>
2195 <div>
2196 <h4>Callback function</h4>
2197 <p style="display: none; ">
2198 The callback <em>parameter</em> should specify a function
2199 that looks like this:
2200 </p>
2201 <p>
2202 If you specify the <em>callback</em> parameter, it should
2203 specify a function that looks like this:
2204 </p>
2205
2206 <!-- Note: intentionally longer 80 columns -->
2207 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
2208 <dl>
2209 <div style="display: none; ">
2210 <div>
2211 </div>
2212 </div>
2213 </dl>
2214 </div>
2215 </div>
2216
2217 <!-- MIN_VERSION -->
2218 <p style="display: none; ">
2219 This function was added in version <b><span></span></b>.
2220 If you require this function, the manifest key
2221 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2222 can ensure that your extension won't be run in an earlier brow ser version.
2223 </p>
3479 </div> <!-- /description --> 2224 </div> <!-- /description -->
3480 </div> <!-- /apiItem -->
3481 2225
3482 </div> <!-- /apiGroup --> 2226 </div><div class="apiItem">
2227 <a name="method-ContentSetting-get"></a> <!-- method-anchor -->
2228 <h4>get</h4>
3483 2229
3484 <!-- TYPES --> 2230 <div class="summary"><span style="display: none; ">void</span>
3485 <div class="apiGroup"> 2231 <!-- Note: intentionally longer 80 columns -->
3486 <a name="types"></a> 2232 <span>contentSetting.get</span>(<span class="null"><span style ="display: none; ">, </span><span>object</span>
3487 <h3 id="types">Types</h3> 2233 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
2234 <var><span>callback</span></var></span>)</div>
3488 2235
3489 <!-- iterates over all types --> 2236 <div class="description">
3490 <div class="apiItem"> 2237 <p class="todo" style="display: none; ">Undocumented.</p>
3491 <a name="type-MessageSender"></a> 2238 <p>Get the current content setting for a given pair of URLs.</p>
3492 <h4>MessageSender</h4>
3493 2239
3494 <div> 2240 <!-- PARAMETERS -->
2241 <h4>Parameters</h4>
2242 <dl>
2243 <div>
2244 <div>
3495 <dt> 2245 <dt>
3496 <var style="display: none; ">paramName</var> 2246 <var>details</var>
3497 <em> 2247 <em>
3498 2248
3499 <!-- TYPE --> 2249 <!-- TYPE -->
3500 <div style="display:inline"> 2250 <div style="display:inline">
3501 ( 2251 (
3502 <span class="optional" style="display: none; ">optional</spa n> 2252 <span class="optional" style="display: none; ">optional</spa n>
3503 <span class="enum" style="display: none; ">enumerated</span> 2253 <span class="enum" style="display: none; ">enumerated</span>
3504 <span id="typeTemplate"> 2254 <span id="typeTemplate">
3505 <span style="display: none; "> 2255 <span style="display: none; ">
3506 <a> Type</a> 2256 <a> Type</a>
3507 </span> 2257 </span>
3508 <span> 2258 <span>
3509 <span style="display: none; "> 2259 <span style="display: none; ">
3510 array of <span><span></span></span> 2260 array of <span><span></span></span>
3511 </span> 2261 </span>
3512 <span>object</span> 2262 <span>object</span>
3513 <span style="display: none; "></span> 2263 <span style="display: none; "></span>
3514 </span> 2264 </span>
3515 </span> 2265 </span>
3516 ) 2266 )
3517 </div> 2267 </div>
3518 2268
3519 </em> 2269 </em>
3520 </dt> 2270 </dt>
3521 <dd class="todo" style="display: none; "> 2271 <dd class="todo">
3522 Undocumented. 2272 Undocumented.
3523 </dd> 2273 </dd>
3524 <dd>An object containing information about the script context that sen t a message or request.</dd> 2274 <dd style="display: none; ">
2275 Description of this parameter from the json schema.
2276 </dd>
3525 <dd style="display: none; "> 2277 <dd style="display: none; ">
3526 This parameter was added in version 2278 This parameter was added in version
3527 <b><span></span></b>. 2279 <b><span></span></b>.
3528 You must omit this parameter in earlier versions, 2280 You must omit this parameter in earlier versions,
3529 and you may omit it in any version. If you require this 2281 and you may omit it in any version. If you require this
3530 parameter, the manifest key 2282 parameter, the manifest key
3531 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2283 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3532 can ensure that your extension won't be run in an earlier browser ve rsion. 2284 can ensure that your extension won't be run in an earlier browser ve rsion.
3533 </dd> 2285 </dd>
3534 2286
3535 <!-- OBJECT PROPERTIES --> 2287 <!-- OBJECT PROPERTIES -->
3536 <dd> 2288 <dd>
3537 <dl> 2289 <dl>
3538 <div> 2290 <div>
3539 <div> 2291 <div>
3540 <dt> 2292 <dt>
3541 <var>tab</var> 2293 <var>embeddedUrl</var>
3542 <em> 2294 <em>
3543 2295
3544 <!-- TYPE --> 2296 <!-- TYPE -->
3545 <div style="display:inline"> 2297 <div style="display:inline">
3546 ( 2298 (
3547 <span class="optional">optional</span> 2299 <span class="optional" style="display: none; ">optional</spa n>
3548 <span class="enum" style="display: none; ">enumerated</span> 2300 <span class="enum" style="display: none; ">enumerated</span>
3549 <span id="typeTemplate"> 2301 <span id="typeTemplate">
2302 <span style="display: none; ">
2303 <a> Type</a>
2304 </span>
3550 <span> 2305 <span>
3551 <a href="tabs.html#type-Tab">Tab</a> 2306 <span style="display: none; ">
3552 </span>
3553 <span style="display: none; ">
3554 <span>
3555 array of <span><span></span></span> 2307 array of <span><span></span></span>
3556 </span> 2308 </span>
3557 <span>paramType</span> 2309 <span>string</span>
3558 <span></span> 2310 <span style="display: none; "></span>
3559 </span> 2311 </span>
3560 </span> 2312 </span>
3561 ) 2313 )
3562 </div> 2314 </div>
3563 2315
3564 </em> 2316 </em>
3565 </dt> 2317 </dt>
3566 <dd class="todo" style="display: none; "> 2318 <dd class="todo" style="display: none; ">
3567 Undocumented. 2319 Undocumented.
3568 </dd> 2320 </dd>
3569 <dd>This property will <b>only</b> be present when the connection was opened from a tab or content script.</dd> 2321 <dd>The URL of the frame or object for which the content settings shou ld be retrieved.</dd>
3570 <dd style="display: none; "> 2322 <dd style="display: none; ">
3571 This parameter was added in version 2323 This parameter was added in version
3572 <b><span></span></b>. 2324 <b><span></span></b>.
3573 You must omit this parameter in earlier versions, 2325 You must omit this parameter in earlier versions,
3574 and you may omit it in any version. If you require this 2326 and you may omit it in any version. If you require this
3575 parameter, the manifest key 2327 parameter, the manifest key
3576 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2328 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3577 can ensure that your extension won't be run in an earlier browser ve rsion. 2329 can ensure that your extension won't be run in an earlier browser ve rsion.
3578 </dd> 2330 </dd>
3579 2331
(...skipping 19 matching lines...) Expand all
3599 2351
3600 <!-- FUNCTION PARAMETERS --> 2352 <!-- FUNCTION PARAMETERS -->
3601 <dd style="display: none; "> 2353 <dd style="display: none; ">
3602 <div></div> 2354 <div></div>
3603 </dd> 2355 </dd>
3604 2356
3605 </div> 2357 </div>
3606 </div><div> 2358 </div><div>
3607 <div> 2359 <div>
3608 <dt> 2360 <dt>
3609 <var>id</var> 2361 <var>topLevelUrl</var>
3610 <em> 2362 <em>
3611 2363
3612 <!-- TYPE --> 2364 <!-- TYPE -->
3613 <div style="display:inline"> 2365 <div style="display:inline">
3614 ( 2366 (
3615 <span class="optional" style="display: none; ">optional</spa n> 2367 <span class="optional" style="display: none; ">optional</spa n>
3616 <span class="enum" style="display: none; ">enumerated</span> 2368 <span class="enum" style="display: none; ">enumerated</span>
3617 <span id="typeTemplate"> 2369 <span id="typeTemplate">
3618 <span style="display: none; "> 2370 <span style="display: none; ">
3619 <a> Type</a> 2371 <a> Type</a>
3620 </span> 2372 </span>
3621 <span> 2373 <span>
3622 <span style="display: none; "> 2374 <span style="display: none; ">
3623 array of <span><span></span></span> 2375 array of <span><span></span></span>
3624 </span> 2376 </span>
3625 <span>string</span> 2377 <span>string</span>
3626 <span style="display: none; "></span> 2378 <span style="display: none; "></span>
3627 </span> 2379 </span>
3628 </span> 2380 </span>
3629 ) 2381 )
3630 </div> 2382 </div>
3631 2383
3632 </em> 2384 </em>
3633 </dt> 2385 </dt>
3634 <dd class="todo" style="display: none; "> 2386 <dd class="todo" style="display: none; ">
3635 Undocumented. 2387 Undocumented.
3636 </dd> 2388 </dd>
3637 <dd>The extension ID of the extension that opened the connection.</dd> 2389 <dd>The URL of the top-level frame.</dd>
3638 <dd style="display: none; "> 2390 <dd style="display: none; ">
3639 This parameter was added in version 2391 This parameter was added in version
3640 <b><span></span></b>. 2392 <b><span></span></b>.
3641 You must omit this parameter in earlier versions, 2393 You must omit this parameter in earlier versions,
3642 and you may omit it in any version. If you require this 2394 and you may omit it in any version. If you require this
3643 parameter, the manifest key 2395 parameter, the manifest key
3644 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2396 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3645 can ensure that your extension won't be run in an earlier browser ve rsion. 2397 can ensure that your extension won't be run in an earlier browser ve rsion.
3646 </dd> 2398 </dd>
3647 2399
(...skipping 16 matching lines...) Expand all
3664 <dd style="display: none; "> 2416 <dd style="display: none; ">
3665 <div></div> 2417 <div></div>
3666 </dd> 2418 </dd>
3667 2419
3668 <!-- FUNCTION PARAMETERS --> 2420 <!-- FUNCTION PARAMETERS -->
3669 <dd style="display: none; "> 2421 <dd style="display: none; ">
3670 <div></div> 2422 <div></div>
3671 </dd> 2423 </dd>
3672 2424
3673 </div> 2425 </div>
3674 </div> 2426 </div><div>
3675 </dl> 2427 <div>
3676 </dd>
3677
3678 <!-- OBJECT METHODS -->
3679 <dd style="display: none; ">
3680 <div></div>
3681 </dd>
3682
3683 <!-- OBJECT EVENT FIELDS -->
3684 <dd style="display: none; ">
3685 <div></div>
3686 </dd>
3687
3688 <!-- FUNCTION PARAMETERS -->
3689 <dd style="display: none; ">
3690 <div></div>
3691 </dd>
3692
3693 </div>
3694
3695 </div><div class="apiItem">
3696 <a name="type-Event"></a>
3697 <h4>Event</h4>
3698
3699 <div>
3700 <dt> 2428 <dt>
3701 <var style="display: none; ">paramName</var> 2429 <var>resourceIdentifier</var>
3702 <em> 2430 <em>
3703 2431
3704 <!-- TYPE --> 2432 <!-- TYPE -->
3705 <div style="display:inline"> 2433 <div style="display:inline">
3706 ( 2434 (
3707 <span class="optional" style="display: none; ">optional</spa n> 2435 <span class="optional">optional</span>
3708 <span class="enum" style="display: none; ">enumerated</span> 2436 <span class="enum" style="display: none; ">enumerated</span>
3709 <span id="typeTemplate"> 2437 <span id="typeTemplate">
2438 <span>
2439 <a href="experimental.contentSettings.html#type-Resource Identifier">ResourceIdentifier</a>
2440 </span>
3710 <span style="display: none; "> 2441 <span style="display: none; ">
3711 <a> Type</a> 2442 <span>
3712 </span>
3713 <span>
3714 <span style="display: none; ">
3715 array of <span><span></span></span> 2443 array of <span><span></span></span>
3716 </span> 2444 </span>
3717 <span>object</span> 2445 <span>paramType</span>
3718 <span style="display: none; "></span> 2446 <span></span>
3719 </span> 2447 </span>
3720 </span> 2448 </span>
3721 ) 2449 )
3722 </div> 2450 </div>
3723 2451
3724 </em> 2452 </em>
3725 </dt> 2453 </dt>
3726 <dd class="todo" style="display: none; "> 2454 <dd class="todo" style="display: none; ">
3727 Undocumented. 2455 Undocumented.
3728 </dd> 2456 </dd>
3729 <dd>An object which allows the addition and removal of listeners for a Chrome event.</dd> 2457 <dd>A more specific identifier of the type of content for which the se ttings should be retrieved.</dd>
3730 <dd style="display: none; "> 2458 <dd style="display: none; ">
3731 This parameter was added in version 2459 This parameter was added in version
3732 <b><span></span></b>. 2460 <b><span></span></b>.
3733 You must omit this parameter in earlier versions, 2461 You must omit this parameter in earlier versions,
3734 and you may omit it in any version. If you require this 2462 and you may omit it in any version. If you require this
3735 parameter, the manifest key 2463 parameter, the manifest key
3736 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2464 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3737 can ensure that your extension won't be run in an earlier browser ve rsion. 2465 can ensure that your extension won't be run in an earlier browser ve rsion.
3738 </dd> 2466 </dd>
3739 2467
3740 <!-- OBJECT PROPERTIES --> 2468 <!-- OBJECT PROPERTIES -->
3741 <dd> 2469 <dd style="display: none; ">
3742 <dl> 2470 <dl>
3743 <div> 2471 <div>
3744 <div> 2472 <div>
2473 </div>
2474 </div>
2475 </dl>
2476 </dd>
2477
2478 <!-- OBJECT METHODS -->
2479 <dd style="display: none; ">
2480 <div></div>
2481 </dd>
2482
2483 <!-- OBJECT EVENT FIELDS -->
2484 <dd style="display: none; ">
2485 <div></div>
2486 </dd>
2487
2488 <!-- FUNCTION PARAMETERS -->
2489 <dd style="display: none; ">
2490 <div></div>
2491 </dd>
2492
2493 </div>
2494 </div><div>
2495 <div>
3745 <dt> 2496 <dt>
3746 <var>addListener</var> 2497 <var>incognito</var>
3747 <em> 2498 <em>
3748 2499
3749 <!-- TYPE --> 2500 <!-- TYPE -->
3750 <div style="display:inline"> 2501 <div style="display:inline">
3751 ( 2502 (
3752 <span class="optional" style="display: none; ">optional</spa n> 2503 <span class="optional">optional</span>
3753 <span class="enum" style="display: none; ">enumerated</span> 2504 <span class="enum" style="display: none; ">enumerated</span>
3754 <span id="typeTemplate"> 2505 <span id="typeTemplate">
3755 <span style="display: none; "> 2506 <span style="display: none; ">
3756 <a> Type</a> 2507 <a> Type</a>
3757 </span> 2508 </span>
3758 <span> 2509 <span>
3759 <span style="display: none; "> 2510 <span style="display: none; ">
3760 array of <span><span></span></span> 2511 array of <span><span></span></span>
3761 </span> 2512 </span>
3762 <span>function</span> 2513 <span>boolean</span>
3763 <span style="display: none; "></span> 2514 <span style="display: none; "></span>
3764 </span> 2515 </span>
3765 </span> 2516 </span>
3766 ) 2517 )
3767 </div> 2518 </div>
3768 2519
3769 </em> 2520 </em>
3770 </dt> 2521 </dt>
3771 <dd class="todo"> 2522 <dd class="todo" style="display: none; ">
3772 Undocumented. 2523 Undocumented.
3773 </dd> 2524 </dd>
3774 <dd style="display: none; "> 2525 <dd>Whether to check the content settings for an incognito session. (d efault false)</dd>
3775 Description of this parameter from the json schema.
3776 </dd>
3777 <dd style="display: none; "> 2526 <dd style="display: none; ">
3778 This parameter was added in version 2527 This parameter was added in version
3779 <b><span></span></b>. 2528 <b><span></span></b>.
3780 You must omit this parameter in earlier versions, 2529 You must omit this parameter in earlier versions,
3781 and you may omit it in any version. If you require this 2530 and you may omit it in any version. If you require this
3782 parameter, the manifest key 2531 parameter, the manifest key
3783 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2532 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3784 can ensure that your extension won't be run in an earlier browser ve rsion. 2533 can ensure that your extension won't be run in an earlier browser ve rsion.
3785 </dd> 2534 </dd>
3786 2535
(...skipping 16 matching lines...) Expand all
3803 <dd style="display: none; "> 2552 <dd style="display: none; ">
3804 <div></div> 2553 <div></div>
3805 </dd> 2554 </dd>
3806 2555
3807 <!-- FUNCTION PARAMETERS --> 2556 <!-- FUNCTION PARAMETERS -->
3808 <dd style="display: none; "> 2557 <dd style="display: none; ">
3809 <div></div> 2558 <div></div>
3810 </dd> 2559 </dd>
3811 2560
3812 </div> 2561 </div>
3813 </div><div> 2562 </div>
3814 <div> 2563 </dl>
2564 </dd>
2565
2566 <!-- OBJECT METHODS -->
2567 <dd style="display: none; ">
2568 <div></div>
2569 </dd>
2570
2571 <!-- OBJECT EVENT FIELDS -->
2572 <dd style="display: none; ">
2573 <div></div>
2574 </dd>
2575
2576 <!-- FUNCTION PARAMETERS -->
2577 <dd style="display: none; ">
2578 <div></div>
2579 </dd>
2580
2581 </div>
2582 </div><div>
2583 <div>
3815 <dt> 2584 <dt>
3816 <var>removeListener</var> 2585 <var>callback</var>
3817 <em> 2586 <em>
3818 2587
3819 <!-- TYPE --> 2588 <!-- TYPE -->
3820 <div style="display:inline"> 2589 <div style="display:inline">
3821 ( 2590 (
3822 <span class="optional" style="display: none; ">optional</spa n> 2591 <span class="optional" style="display: none; ">optional</spa n>
3823 <span class="enum" style="display: none; ">enumerated</span> 2592 <span class="enum" style="display: none; ">enumerated</span>
3824 <span id="typeTemplate"> 2593 <span id="typeTemplate">
3825 <span style="display: none; "> 2594 <span style="display: none; ">
3826 <a> Type</a> 2595 <a> Type</a>
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
3873 <dd style="display: none; "> 2642 <dd style="display: none; ">
3874 <div></div> 2643 <div></div>
3875 </dd> 2644 </dd>
3876 2645
3877 <!-- FUNCTION PARAMETERS --> 2646 <!-- FUNCTION PARAMETERS -->
3878 <dd style="display: none; "> 2647 <dd style="display: none; ">
3879 <div></div> 2648 <div></div>
3880 </dd> 2649 </dd>
3881 2650
3882 </div> 2651 </div>
3883 </div><div> 2652 </div>
2653 </dl>
2654
2655 <!-- RETURNS -->
2656 <h4 style="display: none; ">Returns</h4>
2657 <dl>
2658 <div style="display: none; ">
2659 <div>
2660 </div>
2661 </div>
2662 </dl>
2663
2664 <!-- CALLBACK -->
3884 <div> 2665 <div>
2666 <div>
2667 <h4>Callback function</h4>
2668 <p>
2669 The callback <em>parameter</em> should specify a function
2670 that looks like this:
2671 </p>
2672 <p style="display: none; ">
2673 If you specify the <em>callback</em> parameter, it should
2674 specify a function that looks like this:
2675 </p>
2676
2677 <!-- Note: intentionally longer 80 columns -->
2678 <pre>function(<span>object details</span>) <span class="subdue d">{...}</span>;</pre>
2679 <dl>
2680 <div>
2681 <div>
3885 <dt> 2682 <dt>
3886 <var>hasListener</var> 2683 <var>details</var>
3887 <em> 2684 <em>
3888 2685
3889 <!-- TYPE --> 2686 <!-- TYPE -->
3890 <div style="display:inline"> 2687 <div style="display:inline">
3891 ( 2688 (
3892 <span class="optional" style="display: none; ">optional</spa n> 2689 <span class="optional" style="display: none; ">optional</spa n>
3893 <span class="enum" style="display: none; ">enumerated</span> 2690 <span class="enum" style="display: none; ">enumerated</span>
3894 <span id="typeTemplate"> 2691 <span id="typeTemplate">
3895 <span style="display: none; "> 2692 <span style="display: none; ">
3896 <a> Type</a> 2693 <a> Type</a>
3897 </span> 2694 </span>
3898 <span> 2695 <span>
3899 <span style="display: none; "> 2696 <span style="display: none; ">
3900 array of <span><span></span></span> 2697 array of <span><span></span></span>
3901 </span> 2698 </span>
3902 <span>function</span> 2699 <span>object</span>
3903 <span style="display: none; "></span> 2700 <span style="display: none; "></span>
3904 </span> 2701 </span>
3905 </span> 2702 </span>
3906 ) 2703 )
3907 </div> 2704 </div>
3908 2705
3909 </em> 2706 </em>
3910 </dt> 2707 </dt>
3911 <dd class="todo"> 2708 <dd class="todo">
3912 Undocumented. 2709 Undocumented.
3913 </dd> 2710 </dd>
3914 <dd style="display: none; "> 2711 <dd style="display: none; ">
3915 Description of this parameter from the json schema. 2712 Description of this parameter from the json schema.
3916 </dd> 2713 </dd>
3917 <dd style="display: none; "> 2714 <dd style="display: none; ">
3918 This parameter was added in version 2715 This parameter was added in version
3919 <b><span></span></b>. 2716 <b><span></span></b>.
3920 You must omit this parameter in earlier versions, 2717 You must omit this parameter in earlier versions,
3921 and you may omit it in any version. If you require this 2718 and you may omit it in any version. If you require this
3922 parameter, the manifest key 2719 parameter, the manifest key
3923 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2720 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3924 can ensure that your extension won't be run in an earlier browser ve rsion. 2721 can ensure that your extension won't be run in an earlier browser ve rsion.
3925 </dd> 2722 </dd>
3926 2723
3927 <!-- OBJECT PROPERTIES --> 2724 <!-- OBJECT PROPERTIES -->
3928 <dd style="display: none; "> 2725 <dd>
3929 <dl> 2726 <dl>
3930 <div> 2727 <div>
3931 <div> 2728 <div>
3932 </div>
3933 </div>
3934 </dl>
3935 </dd>
3936
3937 <!-- OBJECT METHODS -->
3938 <dd style="display: none; ">
3939 <div></div>
3940 </dd>
3941
3942 <!-- OBJECT EVENT FIELDS -->
3943 <dd style="display: none; ">
3944 <div></div>
3945 </dd>
3946
3947 <!-- FUNCTION PARAMETERS -->
3948 <dd style="display: none; ">
3949 <div></div>
3950 </dd>
3951
3952 </div>
3953 </div><div>
3954 <div>
3955 <dt> 2729 <dt>
3956 <var>hasListeners</var> 2730 <var>setting</var>
3957 <em> 2731 <em>
3958 2732
3959 <!-- TYPE --> 2733 <!-- TYPE -->
3960 <div style="display:inline"> 2734 <div style="display:inline">
3961 ( 2735 (
3962 <span class="optional" style="display: none; ">optional</spa n> 2736 <span class="optional" style="display: none; ">optional</spa n>
3963 <span class="enum" style="display: none; ">enumerated</span> 2737 <span class="enum" style="display: none; ">enumerated</span>
3964 <span id="typeTemplate"> 2738 <span id="typeTemplate">
3965 <span style="display: none; "> 2739 <span style="display: none; ">
3966 <a> Type</a> 2740 <a> Type</a>
3967 </span> 2741 </span>
3968 <span> 2742 <span>
3969 <span style="display: none; "> 2743 <span style="display: none; ">
3970 array of <span><span></span></span> 2744 array of <span><span></span></span>
3971 </span> 2745 </span>
3972 <span>function</span> 2746 <span>any</span>
3973 <span style="display: none; "></span> 2747 <span style="display: none; "></span>
3974 </span> 2748 </span>
3975 </span> 2749 </span>
3976 ) 2750 )
3977 </div> 2751 </div>
3978 2752
3979 </em> 2753 </em>
3980 </dt> 2754 </dt>
3981 <dd class="todo"> 2755 <dd class="todo" style="display: none; ">
3982 Undocumented. 2756 Undocumented.
3983 </dd> 2757 </dd>
3984 <dd style="display: none; "> 2758 <dd>The content setting. See the description of the individual Content Setting objects for the possible values.</dd>
3985 Description of this parameter from the json schema.
3986 </dd>
3987 <dd style="display: none; "> 2759 <dd style="display: none; ">
3988 This parameter was added in version 2760 This parameter was added in version
3989 <b><span></span></b>. 2761 <b><span></span></b>.
3990 You must omit this parameter in earlier versions, 2762 You must omit this parameter in earlier versions,
3991 and you may omit it in any version. If you require this 2763 and you may omit it in any version. If you require this
3992 parameter, the manifest key 2764 parameter, the manifest key
3993 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2765 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3994 can ensure that your extension won't be run in an earlier browser ve rsion. 2766 can ensure that your extension won't be run in an earlier browser ve rsion.
3995 </dd> 2767 </dd>
3996 2768
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
4033 <dd style="display: none; "> 2805 <dd style="display: none; ">
4034 <div></div> 2806 <div></div>
4035 </dd> 2807 </dd>
4036 2808
4037 <!-- FUNCTION PARAMETERS --> 2809 <!-- FUNCTION PARAMETERS -->
4038 <dd style="display: none; "> 2810 <dd style="display: none; ">
4039 <div></div> 2811 <div></div>
4040 </dd> 2812 </dd>
4041 2813
4042 </div> 2814 </div>
2815 </div>
2816 </dl>
2817 </div>
2818 </div>
2819
2820 <!-- MIN_VERSION -->
2821 <p style="display: none; ">
2822 This function was added in version <b><span></span></b>.
2823 If you require this function, the manifest key
2824 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2825 can ensure that your extension won't be run in an earlier brow ser version.
2826 </p>
2827 </div> <!-- /description -->
4043 2828
4044 </div><div class="apiItem"> 2829 </div><div class="apiItem">
4045 <a name="type-Port"></a> 2830 <a name="method-ContentSetting-set"></a> <!-- method-anchor -->
4046 <h4>Port</h4> 2831 <h4>set</h4>
4047 2832
4048 <div> 2833 <div class="summary"><span style="display: none; ">void</span>
2834 <!-- Note: intentionally longer 80 columns -->
2835 <span>contentSetting.set</span>(<span class="null"><span style ="display: none; ">, </span><span>object</span>
2836 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
2837 <var><span>callback</span></var></span>)</div>
2838
2839 <div class="description">
2840 <p class="todo" style="display: none; ">Undocumented.</p>
2841 <p>Apply a new content setting rule.</p>
2842
2843 <!-- PARAMETERS -->
2844 <h4>Parameters</h4>
2845 <dl>
2846 <div>
2847 <div>
4049 <dt> 2848 <dt>
4050 <var style="display: none; ">paramName</var> 2849 <var>details</var>
4051 <em> 2850 <em>
4052 2851
4053 <!-- TYPE --> 2852 <!-- TYPE -->
4054 <div style="display:inline"> 2853 <div style="display:inline">
4055 ( 2854 (
4056 <span class="optional" style="display: none; ">optional</spa n> 2855 <span class="optional" style="display: none; ">optional</spa n>
4057 <span class="enum" style="display: none; ">enumerated</span> 2856 <span class="enum" style="display: none; ">enumerated</span>
4058 <span id="typeTemplate"> 2857 <span id="typeTemplate">
4059 <span style="display: none; "> 2858 <span style="display: none; ">
4060 <a> Type</a> 2859 <a> Type</a>
4061 </span> 2860 </span>
4062 <span> 2861 <span>
4063 <span style="display: none; "> 2862 <span style="display: none; ">
4064 array of <span><span></span></span> 2863 array of <span><span></span></span>
4065 </span> 2864 </span>
4066 <span>object</span> 2865 <span>object</span>
4067 <span style="display: none; "></span> 2866 <span style="display: none; "></span>
4068 </span> 2867 </span>
4069 </span> 2868 </span>
4070 ) 2869 )
4071 </div> 2870 </div>
4072 2871
4073 </em> 2872 </em>
4074 </dt> 2873 </dt>
4075 <dd class="todo" style="display: none; "> 2874 <dd class="todo">
4076 Undocumented. 2875 Undocumented.
4077 </dd> 2876 </dd>
4078 <dd>An object which allows two way communication with other pages.</dd > 2877 <dd style="display: none; ">
2878 Description of this parameter from the json schema.
2879 </dd>
4079 <dd style="display: none; "> 2880 <dd style="display: none; ">
4080 This parameter was added in version 2881 This parameter was added in version
4081 <b><span></span></b>. 2882 <b><span></span></b>.
4082 You must omit this parameter in earlier versions, 2883 You must omit this parameter in earlier versions,
4083 and you may omit it in any version. If you require this 2884 and you may omit it in any version. If you require this
4084 parameter, the manifest key 2885 parameter, the manifest key
4085 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2886 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4086 can ensure that your extension won't be run in an earlier browser ve rsion. 2887 can ensure that your extension won't be run in an earlier browser ve rsion.
4087 </dd> 2888 </dd>
4088 2889
4089 <!-- OBJECT PROPERTIES --> 2890 <!-- OBJECT PROPERTIES -->
4090 <dd> 2891 <dd>
4091 <dl> 2892 <dl>
4092 <div> 2893 <div>
4093 <div> 2894 <div>
4094 <dt> 2895 <dt>
4095 <var>name</var> 2896 <var>topLevelPattern</var>
4096 <em> 2897 <em>
4097 2898
4098 <!-- TYPE --> 2899 <!-- TYPE -->
4099 <div style="display:inline"> 2900 <div style="display:inline">
4100 ( 2901 (
4101 <span class="optional" style="display: none; ">optional</spa n> 2902 <span class="optional" style="display: none; ">optional</spa n>
4102 <span class="enum" style="display: none; ">enumerated</span> 2903 <span class="enum" style="display: none; ">enumerated</span>
4103 <span id="typeTemplate"> 2904 <span id="typeTemplate">
2905 <span>
2906 <a href="experimental.contentSettings.html#type-Pattern" >Pattern</a>
2907 </span>
4104 <span style="display: none; "> 2908 <span style="display: none; ">
4105 <a> Type</a> 2909 <span>
4106 </span>
4107 <span>
4108 <span style="display: none; ">
4109 array of <span><span></span></span> 2910 array of <span><span></span></span>
4110 </span> 2911 </span>
4111 <span>string</span> 2912 <span>paramType</span>
4112 <span style="display: none; "></span> 2913 <span></span>
4113 </span> 2914 </span>
4114 </span> 2915 </span>
4115 ) 2916 )
4116 </div> 2917 </div>
4117 2918
4118 </em> 2919 </em>
4119 </dt> 2920 </dt>
4120 <dd class="todo"> 2921 <dd class="todo" style="display: none; ">
4121 Undocumented. 2922 Undocumented.
4122 </dd> 2923 </dd>
4123 <dd style="display: none; "> 2924 <dd>The pattern for the top-level frame URL.</dd>
4124 Description of this parameter from the json schema.
4125 </dd>
4126 <dd style="display: none; "> 2925 <dd style="display: none; ">
4127 This parameter was added in version 2926 This parameter was added in version
4128 <b><span></span></b>. 2927 <b><span></span></b>.
4129 You must omit this parameter in earlier versions, 2928 You must omit this parameter in earlier versions,
4130 and you may omit it in any version. If you require this 2929 and you may omit it in any version. If you require this
4131 parameter, the manifest key 2930 parameter, the manifest key
4132 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2931 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4133 can ensure that your extension won't be run in an earlier browser ve rsion. 2932 can ensure that your extension won't be run in an earlier browser ve rsion.
4134 </dd> 2933 </dd>
4135 2934
(...skipping 19 matching lines...) Expand all
4155 2954
4156 <!-- FUNCTION PARAMETERS --> 2955 <!-- FUNCTION PARAMETERS -->
4157 <dd style="display: none; "> 2956 <dd style="display: none; ">
4158 <div></div> 2957 <div></div>
4159 </dd> 2958 </dd>
4160 2959
4161 </div> 2960 </div>
4162 </div><div> 2961 </div><div>
4163 <div> 2962 <div>
4164 <dt> 2963 <dt>
4165 <var>onDisconnect</var> 2964 <var>embeddedPattern</var>
4166 <em> 2965 <em>
4167 2966
4168 <!-- TYPE --> 2967 <!-- TYPE -->
4169 <div style="display:inline"> 2968 <div style="display:inline">
4170 ( 2969 (
4171 <span class="optional" style="display: none; ">optional</spa n> 2970 <span class="optional" style="display: none; ">optional</spa n>
4172 <span class="enum" style="display: none; ">enumerated</span> 2971 <span class="enum" style="display: none; ">enumerated</span>
4173 <span id="typeTemplate"> 2972 <span id="typeTemplate">
4174 <span> 2973 <span>
4175 <a href="extension.html#type-Event">Event</a> 2974 <a href="experimental.contentSettings.html#type-Pattern" >Pattern</a>
4176 </span> 2975 </span>
4177 <span style="display: none; "> 2976 <span style="display: none; ">
4178 <span> 2977 <span>
4179 array of <span><span></span></span> 2978 array of <span><span></span></span>
4180 </span> 2979 </span>
4181 <span>paramType</span> 2980 <span>paramType</span>
4182 <span></span> 2981 <span></span>
4183 </span> 2982 </span>
4184 </span> 2983 </span>
4185 ) 2984 )
4186 </div> 2985 </div>
4187 2986
4188 </em> 2987 </em>
4189 </dt> 2988 </dt>
4190 <dd class="todo"> 2989 <dd class="todo" style="display: none; ">
4191 Undocumented. 2990 Undocumented.
4192 </dd> 2991 </dd>
4193 <dd style="display: none; "> 2992 <dd>The pattern for the frame or object URL.</dd>
4194 Description of this parameter from the json schema.
4195 </dd>
4196 <dd style="display: none; "> 2993 <dd style="display: none; ">
4197 This parameter was added in version 2994 This parameter was added in version
4198 <b><span></span></b>. 2995 <b><span></span></b>.
4199 You must omit this parameter in earlier versions, 2996 You must omit this parameter in earlier versions,
4200 and you may omit it in any version. If you require this 2997 and you may omit it in any version. If you require this
4201 parameter, the manifest key 2998 parameter, the manifest key
4202 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2999 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4203 can ensure that your extension won't be run in an earlier browser ve rsion. 3000 can ensure that your extension won't be run in an earlier browser ve rsion.
4204 </dd> 3001 </dd>
4205 3002
(...skipping 19 matching lines...) Expand all
4225 3022
4226 <!-- FUNCTION PARAMETERS --> 3023 <!-- FUNCTION PARAMETERS -->
4227 <dd style="display: none; "> 3024 <dd style="display: none; ">
4228 <div></div> 3025 <div></div>
4229 </dd> 3026 </dd>
4230 3027
4231 </div> 3028 </div>
4232 </div><div> 3029 </div><div>
4233 <div> 3030 <div>
4234 <dt> 3031 <dt>
4235 <var>onMessage</var> 3032 <var>resourceIdentifier</var>
4236 <em> 3033 <em>
4237 3034
4238 <!-- TYPE --> 3035 <!-- TYPE -->
4239 <div style="display:inline"> 3036 <div style="display:inline">
4240 ( 3037 (
4241 <span class="optional" style="display: none; ">optional</spa n> 3038 <span class="optional">optional</span>
4242 <span class="enum" style="display: none; ">enumerated</span> 3039 <span class="enum" style="display: none; ">enumerated</span>
4243 <span id="typeTemplate"> 3040 <span id="typeTemplate">
4244 <span> 3041 <span>
4245 <a href="extension.html#type-Event">Event</a> 3042 <a href="experimental.contentSettings.html#type-Resource Identifier">ResourceIdentifier</a>
4246 </span> 3043 </span>
4247 <span style="display: none; "> 3044 <span style="display: none; ">
4248 <span> 3045 <span>
4249 array of <span><span></span></span> 3046 array of <span><span></span></span>
4250 </span> 3047 </span>
4251 <span>paramType</span> 3048 <span>paramType</span>
4252 <span></span> 3049 <span></span>
4253 </span> 3050 </span>
4254 </span> 3051 </span>
4255 ) 3052 )
4256 </div> 3053 </div>
4257 3054
4258 </em> 3055 </em>
4259 </dt> 3056 </dt>
4260 <dd class="todo"> 3057 <dd class="todo" style="display: none; ">
4261 Undocumented. 3058 Undocumented.
4262 </dd> 3059 </dd>
4263 <dd style="display: none; "> 3060 <dd>The resource identifier for the content type.</dd>
4264 Description of this parameter from the json schema.
4265 </dd>
4266 <dd style="display: none; "> 3061 <dd style="display: none; ">
4267 This parameter was added in version 3062 This parameter was added in version
4268 <b><span></span></b>. 3063 <b><span></span></b>.
4269 You must omit this parameter in earlier versions, 3064 You must omit this parameter in earlier versions,
4270 and you may omit it in any version. If you require this 3065 and you may omit it in any version. If you require this
4271 parameter, the manifest key 3066 parameter, the manifest key
4272 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 3067 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4273 can ensure that your extension won't be run in an earlier browser ve rsion. 3068 can ensure that your extension won't be run in an earlier browser ve rsion.
4274 </dd> 3069 </dd>
4275 3070
(...skipping 19 matching lines...) Expand all
4295 3090
4296 <!-- FUNCTION PARAMETERS --> 3091 <!-- FUNCTION PARAMETERS -->
4297 <dd style="display: none; "> 3092 <dd style="display: none; ">
4298 <div></div> 3093 <div></div>
4299 </dd> 3094 </dd>
4300 3095
4301 </div> 3096 </div>
4302 </div><div> 3097 </div><div>
4303 <div> 3098 <div>
4304 <dt> 3099 <dt>
4305 <var>postMessage</var> 3100 <var>setting</var>
4306 <em> 3101 <em>
4307 3102
4308 <!-- TYPE --> 3103 <!-- TYPE -->
4309 <div style="display:inline"> 3104 <div style="display:inline">
4310 ( 3105 (
4311 <span class="optional" style="display: none; ">optional</spa n> 3106 <span class="optional" style="display: none; ">optional</spa n>
4312 <span class="enum" style="display: none; ">enumerated</span> 3107 <span class="enum" style="display: none; ">enumerated</span>
4313 <span id="typeTemplate"> 3108 <span id="typeTemplate">
4314 <span style="display: none; "> 3109 <span style="display: none; ">
4315 <a> Type</a> 3110 <a> Type</a>
4316 </span> 3111 </span>
4317 <span> 3112 <span>
4318 <span style="display: none; "> 3113 <span style="display: none; ">
4319 array of <span><span></span></span> 3114 array of <span><span></span></span>
4320 </span> 3115 </span>
4321 <span>function</span> 3116 <span>any</span>
4322 <span style="display: none; "></span> 3117 <span style="display: none; "></span>
4323 </span> 3118 </span>
4324 </span> 3119 </span>
4325 ) 3120 )
4326 </div> 3121 </div>
4327 3122
4328 </em> 3123 </em>
4329 </dt> 3124 </dt>
4330 <dd class="todo"> 3125 <dd class="todo" style="display: none; ">
4331 Undocumented. 3126 Undocumented.
4332 </dd> 3127 </dd>
4333 <dd style="display: none; "> 3128 <dd>The setting applied by this rule. See the description of the indiv idual ContentSetting objects for the possible values.</dd>
4334 Description of this parameter from the json schema.
4335 </dd>
4336 <dd style="display: none; "> 3129 <dd style="display: none; ">
4337 This parameter was added in version 3130 This parameter was added in version
4338 <b><span></span></b>. 3131 <b><span></span></b>.
4339 You must omit this parameter in earlier versions, 3132 You must omit this parameter in earlier versions,
4340 and you may omit it in any version. If you require this 3133 and you may omit it in any version. If you require this
4341 parameter, the manifest key 3134 parameter, the manifest key
4342 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 3135 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4343 can ensure that your extension won't be run in an earlier browser ve rsion. 3136 can ensure that your extension won't be run in an earlier browser ve rsion.
4344 </dd> 3137 </dd>
4345 3138
(...skipping 19 matching lines...) Expand all
4365 3158
4366 <!-- FUNCTION PARAMETERS --> 3159 <!-- FUNCTION PARAMETERS -->
4367 <dd style="display: none; "> 3160 <dd style="display: none; ">
4368 <div></div> 3161 <div></div>
4369 </dd> 3162 </dd>
4370 3163
4371 </div> 3164 </div>
4372 </div><div> 3165 </div><div>
4373 <div> 3166 <div>
4374 <dt> 3167 <dt>
4375 <var>sender</var> 3168 <var>scope</var>
4376 <em> 3169 <em>
4377 3170
4378 <!-- TYPE --> 3171 <!-- TYPE -->
4379 <div style="display:inline"> 3172 <div style="display:inline">
4380 ( 3173 (
4381 <span class="optional">optional</span> 3174 <span class="optional">optional</span>
4382 <span class="enum" style="display: none; ">enumerated</span> 3175 <span class="enum">enumerated</span>
4383 <span id="typeTemplate"> 3176 <span id="typeTemplate">
3177 <span style="display: none; ">
3178 <a> Type</a>
3179 </span>
4384 <span> 3180 <span>
4385 <a href="extension.html#type-MessageSender">MessageSende r</a> 3181 <span style="display: none; ">
4386 </span>
4387 <span style="display: none; ">
4388 <span>
4389 array of <span><span></span></span> 3182 array of <span><span></span></span>
4390 </span> 3183 </span>
4391 <span>paramType</span> 3184 <span>string</span>
4392 <span></span> 3185 <span>["regular", "incognito_session_only"]</span>
4393 </span> 3186 </span>
4394 </span> 3187 </span>
4395 ) 3188 )
4396 </div> 3189 </div>
4397 3190
4398 </em> 3191 </em>
4399 </dt> 3192 </dt>
4400 <dd class="todo" style="display: none; "> 3193 <dd class="todo" style="display: none; ">
4401 Undocumented. 3194 Undocumented.
4402 </dd> 3195 </dd>
4403 <dd>This property will <b>only</b> be present on ports passed to onCon nect/onConnectExternal listeners.</dd> 3196 <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>
4404 <dd style="display: none; "> 3197 <dd style="display: none; ">
4405 This parameter was added in version 3198 This parameter was added in version
4406 <b><span></span></b>. 3199 <b><span></span></b>.
4407 You must omit this parameter in earlier versions, 3200 You must omit this parameter in earlier versions,
4408 and you may omit it in any version. If you require this 3201 and you may omit it in any version. If you require this
4409 parameter, the manifest key 3202 parameter, the manifest key
4410 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 3203 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4411 can ensure that your extension won't be run in an earlier browser ve rsion. 3204 can ensure that your extension won't be run in an earlier browser ve rsion.
4412 </dd> 3205 </dd>
4413 3206
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
4450 <dd style="display: none; "> 3243 <dd style="display: none; ">
4451 <div></div> 3244 <div></div>
4452 </dd> 3245 </dd>
4453 3246
4454 <!-- FUNCTION PARAMETERS --> 3247 <!-- FUNCTION PARAMETERS -->
4455 <dd style="display: none; "> 3248 <dd style="display: none; ">
4456 <div></div> 3249 <div></div>
4457 </dd> 3250 </dd>
4458 3251
4459 </div> 3252 </div>
3253 </div><div>
3254 <div>
3255 <dt>
3256 <var>callback</var>
3257 <em>
3258
3259 <!-- TYPE -->
3260 <div style="display:inline">
3261 (
3262 <span class="optional">optional</span>
3263 <span class="enum" style="display: none; ">enumerated</span>
3264 <span id="typeTemplate">
3265 <span style="display: none; ">
3266 <a> Type</a>
3267 </span>
3268 <span>
3269 <span style="display: none; ">
3270 array of <span><span></span></span>
3271 </span>
3272 <span>function</span>
3273 <span style="display: none; "></span>
3274 </span>
3275 </span>
3276 )
3277 </div>
3278
3279 </em>
3280 </dt>
3281 <dd class="todo">
3282 Undocumented.
3283 </dd>
3284 <dd style="display: none; ">
3285 Description of this parameter from the json schema.
3286 </dd>
3287 <dd style="display: none; ">
3288 This parameter was added in version
3289 <b><span></span></b>.
3290 You must omit this parameter in earlier versions,
3291 and you may omit it in any version. If you require this
3292 parameter, the manifest key
3293 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3294 can ensure that your extension won't be run in an earlier browser ve rsion.
3295 </dd>
3296
3297 <!-- OBJECT PROPERTIES -->
3298 <dd style="display: none; ">
3299 <dl>
3300 <div>
3301 <div>
3302 </div>
3303 </div>
3304 </dl>
3305 </dd>
3306
3307 <!-- OBJECT METHODS -->
3308 <dd style="display: none; ">
3309 <div></div>
3310 </dd>
3311
3312 <!-- OBJECT EVENT FIELDS -->
3313 <dd style="display: none; ">
3314 <div></div>
3315 </dd>
3316
3317 <!-- FUNCTION PARAMETERS -->
3318 <dd style="display: none; ">
3319 <div></div>
3320 </dd>
3321
3322 </div>
3323 </div>
3324 </dl>
3325
3326 <!-- RETURNS -->
3327 <h4 style="display: none; ">Returns</h4>
3328 <dl>
3329 <div style="display: none; ">
3330 <div>
3331 </div>
3332 </div>
3333 </dl>
3334
3335 <!-- CALLBACK -->
3336 <div>
3337 <div>
3338 <h4>Callback function</h4>
3339 <p style="display: none; ">
3340 The callback <em>parameter</em> should specify a function
3341 that looks like this:
3342 </p>
3343 <p>
3344 If you specify the <em>callback</em> parameter, it should
3345 specify a function that looks like this:
3346 </p>
3347
3348 <!-- Note: intentionally longer 80 columns -->
3349 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
3350 <dl>
3351 <div style="display: none; ">
3352 <div>
3353 </div>
3354 </div>
3355 </dl>
3356 </div>
3357 </div>
3358
3359 <!-- MIN_VERSION -->
3360 <p style="display: none; ">
3361 This function was added in version <b><span></span></b>.
3362 If you require this function, the manifest key
3363 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
3364 can ensure that your extension won't be run in an earlier brow ser version.
3365 </p>
3366 </div> <!-- /description -->
3367
3368 </div> <!-- /apiItem -->
3369
3370 </div>
3371 </dd>
3372
3373 <!-- OBJECT EVENT FIELDS -->
3374 <dd style="display: none; ">
3375 <div></div>
3376 </dd>
3377
3378 <!-- FUNCTION PARAMETERS -->
3379 <dd style="display: none; ">
3380 <div></div>
3381 </dd>
3382
3383 </div>
4460 3384
4461 </div> <!-- /apiItem --> 3385 </div> <!-- /apiItem -->
4462 3386
4463 </div> <!-- /apiGroup --> 3387 </div> <!-- /apiGroup -->
4464 3388
4465 </div> <!-- /apiPage --> 3389 </div> <!-- /apiPage -->
4466 </div> <!-- /gc-pagecontent --> 3390 </div> <!-- /gc-pagecontent -->
4467 </div> <!-- /g-section --> 3391 </div> <!-- /g-section -->
4468 </div> <!-- /codesiteContent --> 3392 </div> <!-- /codesiteContent -->
4469 <div id="gc-footer" --=""> 3393 <div id="gc-footer" --="">
(...skipping 26 matching lines...) Expand all
4496 _uff=0; 3420 _uff=0;
4497 urchinTracker(); 3421 urchinTracker();
4498 } 3422 }
4499 catch(e) {/* urchinTracker not available. */} 3423 catch(e) {/* urchinTracker not available. */}
4500 </script> 3424 </script>
4501 <!-- end analytics --> 3425 <!-- end analytics -->
4502 </div> 3426 </div>
4503 </div> <!-- /gc-footer --> 3427 </div> <!-- /gc-footer -->
4504 </div> <!-- /gc-container --> 3428 </div> <!-- /gc-container -->
4505 </body></html> 3429 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/extension.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698