experimental.proxy.html revision 21d179b334e59e9a3bfcaed4c4430bef1bc5759d
1<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 2 1) The <head> information in this page is significant, should be uniform 3 across api docs and should be edited only with knowledge of the 4 templating mechanism. 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 6 browser, it will be re-generated from the template, json schema and 7 authored overview content. 8 4) The <body>.innerHTML is also generated by an offline step so that this 9 page may easily be indexed by search engines. 10--><html xmlns="http://www.w3.org/1999/xhtml"><head> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 14 <script type="text/javascript" src="/third_party/jstemplate/jstemplate_compiled.js"> 15 </script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script> 19 <title>chrome.experimental.proxy - Google Chrome Extensions - Google Code</title></head> 20 <body> <div id="gc-container" class="labs"> 21 <div id="devModeWarning"> 22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. 23 </div> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 25 <!-- In particular, sub-templates that recurse, must be used by allowing 26 jstemplate to make a copy of the template in this section which 27 are not operated on by way of the jsskip="true" --> 28 <div style="display:none"> 29 30 <!-- VALUE --> 31 <div id="valueTemplate"> 32 <dt> 33 <var>paramName</var> 34 <em> 35 36 <!-- TYPE --> 37 <div style="display:inline"> 38 ( 39 <span class="optional">optional</span> 40 <span class="enum">enumerated</span> 41 <span id="typeTemplate"> 42 <span> 43 <a> Type</a> 44 </span> 45 <span> 46 <span> 47 array of <span><span></span></span> 48 </span> 49 <span>paramType</span> 50 <span></span> 51 </span> 52 </span> 53 ) 54 </div> 55 56 </em> 57 </dt> 58 <dd class="todo"> 59 Undocumented. 60 </dd> 61 <dd> 62 Description of this parameter from the json schema. 63 </dd> 64 <dd> 65 This parameter was added in version 66 <b><span></span></b>. 67 You must omit this parameter in earlier versions, 68 and you may omit it in any version. If you require this 69 parameter, the manifest key 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 72 </dd> 73 74 <!-- OBJECT PROPERTIES --> 75 <dd> 76 <dl> 77 <div> 78 <div> 79 </div> 80 </div> 81 </dl> 82 </dd> 83 84 <!-- FUNCTION PARAMETERS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 </div> <!-- /VALUE --> 90 91 <div id="functionParametersTemplate"> 92 <h5>Parameters</h5> 93 <dl> 94 <div> 95 <div> 96 </div> 97 </div> 98 </dl> 99 </div> 100 </div> <!-- /SUBTEMPLATES --> 101 102 <a id="top"></a> 103 <div id="skipto"> 104 <a href="#gc-pagecontent">Skip to page content</a> 105 <a href="#gc-toc">Skip to main navigation</a> 106 </div> 107 <!-- API HEADER --> 108 <table id="header" width="100%" cellspacing="0" border="0"> 109 <tbody><tr> 110 <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> 111 <td valign="middle" width="100%" style="padding-left:0.6em;"> 112 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 113 <div id="gsc-search-box"> 114 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 115 <input type="hidden" name="ie" value="UTF-8"> 116 <input type="text" name="q" value="" size="55"> 117 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 118 <br> 119 <span class="greytext">e.g. "page action" or "tabs"</span> 120 </div> 121 </form> 122 123 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 124 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 125 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 126 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 127 </td> 128 </tr> 129 </tbody></table> 130 131 <div id="codesiteContent" class=""> 132 133 <a id="gc-topnav-anchor"></a> 134 <div id="gc-topnav"> 135 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 136 <ul id="home" class="gc-topnav-tabs"> 137 <li id="home_link"> 138 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 139 </li> 140 <li id="docs_link"> 141 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 142 </li> 143 <li id="faq_link"> 144 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 145 </li> 146 <li id="samples_link"> 147 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 148 </li> 149 <li id="group_link"> 150 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 151 </li> 152 </ul> 153 </div> <!-- end gc-topnav --> 154 155 <div class="g-section g-tpl-170"> 156 <!-- SIDENAV --> 157 <div class="g-unit g-first" id="gc-toc"> 158 <ul> 159 <li><a href="getstarted.html">Getting Started</a></li> 160 <li><a href="overview.html">Overview</a></li> 161 <li><a href="whats_new.html">What's New?</a></li> 162 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 163 <ul> 164 <li>Browser UI 165 <ul> 166 <li><a href="browserAction.html">Browser Actions</a></li> 167 <li><a href="contextMenus.html">Context Menus</a></li> 168 <li><a href="notifications.html">Desktop Notifications</a></li> 169 <li><a href="omnibox.html">Omnibox</a></li> 170 <li><a href="options.html">Options Pages</a></li> 171 <li><a href="override.html">Override Pages</a></li> 172 <li><a href="pageAction.html">Page Actions</a></li> 173 </ul> 174 </li> 175 <li>Browser Interaction 176 <ul> 177 <li><a href="bookmarks.html">Bookmarks</a></li> 178 <li><a href="cookies.html">Cookies</a></li> 179 <li><a href="events.html">Events</a></li> 180 <li><a href="history.html">History</a></li> 181 <li><a href="management.html">Management</a></li> 182 <li><a href="tabs.html">Tabs</a></li> 183 <li><a href="windows.html">Windows</a></li> 184 </ul> 185 </li> 186 <li>Implementation 187 <ul> 188 <li><a href="a11y.html">Accessibility</a></li> 189 <li><a href="background_pages.html">Background Pages</a></li> 190 <li><a href="content_scripts.html">Content Scripts</a></li> 191 <li><a href="xhr.html">Cross-Origin XHR</a></li> 192 <li><a href="idle.html">Idle</a></li> 193 <li><a href="i18n.html">Internationalization</a></li> 194 <li><a href="messaging.html">Message Passing</a></li> 195 <li><a href="npapi.html">NPAPI Plugins</a></li> 196 </ul> 197 </li> 198 <li>Finishing 199 <ul> 200 <li><a href="hosting.html">Hosting</a></li> 201 <li><a href="external_extensions.html">Other Deployment Options</a></li> 202 </ul> 203 </li> 204 </ul> 205 </li> 206 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 207 <li><h2><a href="tutorials.html">Tutorials</a></h2> 208 <ul> 209 <li><a href="tut_debugging.html">Debugging</a></li> 210 <li><a href="tut_analytics.html">Google Analytics</a></li> 211 <li><a href="tut_oauth.html">OAuth</a></li> 212 </ul> 213 </li> 214 <li><h2>Reference</h2> 215 <ul> 216 <li>Formats 217 <ul> 218 <li><a href="manifest.html">Manifest Files</a></li> 219 <li><a href="match_patterns.html">Match Patterns</a></li> 220 </ul> 221 </li> 222 <li><a href="permission_warnings.html">Permission Warnings</a></li> 223 <li><a href="api_index.html">chrome.* APIs</a></li> 224 <li><a href="api_other.html">Other APIs</a></li> 225 </ul> 226 </li> 227 <li><h2><a href="samples.html">Samples</a></h2></li> 228 <div class="line"> </div> 229 <li><h2>More</h2> 230 <ul> 231 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 232 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 233 <li><a href="themes.html">Themes</a></li> 234 </ul> 235 </li> 236 </ul> 237 </div> 238 <script> 239 initToggles(); 240 </script> 241 242 <div class="g-unit" id="gc-pagecontent"> 243 <div id="pageTitle"> 244 <h1 class="page_title">chrome.experimental.proxy</h1> 245 </div> 246 <!-- TABLE OF CONTENTS --> 247 <div id="toc"> 248 <h2>Contents</h2> 249 <ol> 250 <li style="display: none; "> 251 <a>h2Name</a> 252 <ol> 253 <li> 254 <a>h3Name</a> 255 </li> 256 </ol> 257 </li> 258 <li> 259 <a href="#apiReference">API reference: chrome.experimental.proxy</a> 260 <ol> 261 <li style="display: none; "> 262 <a href="#properties">Properties</a> 263 <ol> 264 <li> 265 <a href="#property-anchor">propertyName</a> 266 </li> 267 </ol> 268 </li> 269 <li> 270 <a href="#methods">Methods</a> 271 <ol> 272 <li> 273 <a href="#method-useCustomProxySettings">useCustomProxySettings</a> 274 </li> 275 </ol> 276 </li> 277 <li style="display: none; "> 278 <a href="#events">Events</a> 279 <ol> 280 <li> 281 <a href="#event-anchor">eventName</a> 282 </li> 283 </ol> 284 </li> 285 <li> 286 <a href="#types">Types</a> 287 <ol> 288 <li> 289 <a href="#type-ProxyServer">ProxyServer</a> 290 </li><li> 291 <a href="#type-ProxyRules">ProxyRules</a> 292 </li><li> 293 <a href="#type-PacScript">PacScript</a> 294 </li><li> 295 <a href="#type-ProxyConfig">ProxyConfig</a> 296 </li> 297 </ol> 298 </li> 299 </ol> 300 </li> 301 </ol> 302 </div> 303 <!-- /TABLE OF CONTENTS --> 304 305 <!-- Standard content lead-in for experimental API pages --> 306 <p id="classSummary"> 307 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 308 </p> 309 310 <!-- STATIC CONTENT PLACEHOLDER --> 311 <div id="static"></div> 312 313 <!-- API PAGE --> 314 <div class="apiPage"> 315 <a name="apiReference"></a> 316 <h2>API reference: chrome.experimental.proxy</h2> 317 318 <!-- PROPERTIES --> 319 <div class="apiGroup" style="display: none; "> 320 <a name="properties"></a> 321 <h3 id="properties">Properties</h3> 322 323 <div> 324 <a></a> 325 <h4>getLastError</h4> 326 <div class="summary"> 327 <!-- Note: intentionally longer 80 columns --> 328 <span>chrome.extension</span><span>lastError</span> 329 </div> 330 <div> 331 </div> 332 </div> 333 334 </div> <!-- /apiGroup --> 335 336 <!-- METHODS --> 337 <div class="apiGroup" id="methods"> 338 <a name="methods"></a> 339 <h3>Methods</h3> 340 341 <!-- iterates over all functions --> 342 <div class="apiItem"> 343 <a name="method-useCustomProxySettings"></a> <!-- method-anchor --> 344 <h4>useCustomProxySettings</h4> 345 346 <div class="summary"><span style="display: none; ">void</span> 347 <!-- Note: intentionally longer 80 columns --> 348 <span>chrome.experimental.proxy.useCustomProxySettings</span>(<span class="null"><span style="display: none; ">, </span><span>ProxyConfig</span> 349 <var><span>config</span></var></span>)</div> 350 351 <div class="description"> 352 <p class="todo" style="display: none; ">Undocumented.</p> 353 <p>Apply the given proxy configuration.</p> 354 355 <!-- PARAMETERS --> 356 <h4>Parameters</h4> 357 <dl> 358 <div> 359 <div> 360 <dt> 361 <var>config</var> 362 <em> 363 364 <!-- TYPE --> 365 <div style="display:inline"> 366 ( 367 <span class="optional" style="display: none; ">optional</span> 368 <span class="enum" style="display: none; ">enumerated</span> 369 <span id="typeTemplate"> 370 <span> 371 <a href="experimental.proxy.html#type-ProxyConfig">ProxyConfig</a> 372 </span> 373 <span style="display: none; "> 374 <span> 375 array of <span><span></span></span> 376 </span> 377 <span>paramType</span> 378 <span></span> 379 </span> 380 </span> 381 ) 382 </div> 383 384 </em> 385 </dt> 386 <dd class="todo"> 387 Undocumented. 388 </dd> 389 <dd style="display: none; "> 390 Description of this parameter from the json schema. 391 </dd> 392 <dd style="display: none; "> 393 This parameter was added in version 394 <b><span></span></b>. 395 You must omit this parameter in earlier versions, 396 and you may omit it in any version. If you require this 397 parameter, the manifest key 398 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 399 can ensure that your extension won't be run in an earlier browser version. 400 </dd> 401 402 <!-- OBJECT PROPERTIES --> 403 <dd style="display: none; "> 404 <dl> 405 <div> 406 <div> 407 </div> 408 </div> 409 </dl> 410 </dd> 411 412 <!-- FUNCTION PARAMETERS --> 413 <dd style="display: none; "> 414 <div></div> 415 </dd> 416 417 </div> 418 </div> 419 </dl> 420 421 <!-- RETURNS --> 422 <h4 style="display: none; ">Returns</h4> 423 <dl> 424 <div style="display: none; "> 425 <div> 426 </div> 427 </div> 428 </dl> 429 430 <!-- CALLBACK --> 431 <div style="display: none; "> 432 <div> 433 <h4>Callback function</h4> 434 <p> 435 The callback <em>parameter</em> should specify a function 436 that looks like this: 437 </p> 438 <p> 439 If you specify the <em>callback</em> parameter, it should 440 specify a function that looks like this: 441 </p> 442 443 <!-- Note: intentionally longer 80 columns --> 444 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 445 <dl> 446 <div> 447 <div> 448 </div> 449 </div> 450 </dl> 451 </div> 452 </div> 453 454 <!-- MIN_VERSION --> 455 <p style="display: none; "> 456 This function was added in version <b><span></span></b>. 457 If you require this function, the manifest key 458 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 459 can ensure that your extension won't be run in an earlier browser version. 460 </p> 461 </div> <!-- /description --> 462 463 </div> <!-- /apiItem --> 464 465 </div> <!-- /apiGroup --> 466 467 <!-- EVENTS --> 468 <div class="apiGroup" style="display: none; "> 469 <a name="events"></a> 470 <h3 id="events">Events</h3> 471 472 <!-- iterates over all events --> 473 <div class="apiItem"> 474 <a></a> 475 <h4>event name</h4> 476 477 <div class="summary"> 478 <!-- Note: intentionally longer 80 columns --> 479 <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>); 480 </div> 481 482 <div class="description"> 483 <p class="todo">Undocumented.</p> 484 <p> 485 A description from the json schema def of the event goes here. 486 </p> 487 488 <!-- PARAMETERS --> 489 <h4>Parameters</h4> 490 <dl> 491 <div> 492 <div> 493 </div> 494 </div> 495 </dl> 496 497 </div> <!-- /decription --> 498 499 </div> <!-- /apiItem --> 500 501 </div> <!-- /apiGroup --> 502 503 <!-- TYPES --> 504 <div class="apiGroup"> 505 <a name="types"></a> 506 <h3 id="types">Types</h3> 507 508 <!-- iterates over all types --> 509 <div class="apiItem"> 510 <a name="type-ProxyServer"></a> 511 <h4>ProxyServer</h4> 512 513 <div> 514 <dt> 515 <var style="display: none; ">paramName</var> 516 <em> 517 518 <!-- TYPE --> 519 <div style="display:inline"> 520 ( 521 <span class="optional" style="display: none; ">optional</span> 522 <span class="enum" style="display: none; ">enumerated</span> 523 <span id="typeTemplate"> 524 <span style="display: none; "> 525 <a> Type</a> 526 </span> 527 <span> 528 <span style="display: none; "> 529 array of <span><span></span></span> 530 </span> 531 <span>object</span> 532 <span style="display: none; "></span> 533 </span> 534 </span> 535 ) 536 </div> 537 538 </em> 539 </dt> 540 <dd class="todo" style="display: none; "> 541 Undocumented. 542 </dd> 543 <dd>An object encapsulating a single proxy server's specification.</dd> 544 <dd style="display: none; "> 545 This parameter was added in version 546 <b><span></span></b>. 547 You must omit this parameter in earlier versions, 548 and you may omit it in any version. If you require this 549 parameter, the manifest key 550 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 551 can ensure that your extension won't be run in an earlier browser version. 552 </dd> 553 554 <!-- OBJECT PROPERTIES --> 555 <dd> 556 <dl> 557 <div> 558 <div> 559 <dt> 560 <var>scheme</var> 561 <em> 562 563 <!-- TYPE --> 564 <div style="display:inline"> 565 ( 566 <span class="optional">optional</span> 567 <span class="enum">enumerated</span> 568 <span id="typeTemplate"> 569 <span style="display: none; "> 570 <a> Type</a> 571 </span> 572 <span> 573 <span style="display: none; "> 574 array of <span><span></span></span> 575 </span> 576 <span>string</span> 577 <span>["http", "socks", "socks4", "socks5"]</span> 578 </span> 579 </span> 580 ) 581 </div> 582 583 </em> 584 </dt> 585 <dd class="todo" style="display: none; "> 586 Undocumented. 587 </dd> 588 <dd>The scheme (protocol) of the proxy server itself.</dd> 589 <dd style="display: none; "> 590 This parameter was added in version 591 <b><span></span></b>. 592 You must omit this parameter in earlier versions, 593 and you may omit it in any version. If you require this 594 parameter, the manifest key 595 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 596 can ensure that your extension won't be run in an earlier browser version. 597 </dd> 598 599 <!-- OBJECT PROPERTIES --> 600 <dd style="display: none; "> 601 <dl> 602 <div> 603 <div> 604 </div> 605 </div> 606 </dl> 607 </dd> 608 609 <!-- FUNCTION PARAMETERS --> 610 <dd style="display: none; "> 611 <div></div> 612 </dd> 613 614 </div> 615 </div><div> 616 <div> 617 <dt> 618 <var>host</var> 619 <em> 620 621 <!-- TYPE --> 622 <div style="display:inline"> 623 ( 624 <span class="optional" style="display: none; ">optional</span> 625 <span class="enum" style="display: none; ">enumerated</span> 626 <span id="typeTemplate"> 627 <span style="display: none; "> 628 <a> Type</a> 629 </span> 630 <span> 631 <span style="display: none; "> 632 array of <span><span></span></span> 633 </span> 634 <span>string</span> 635 <span style="display: none; "></span> 636 </span> 637 </span> 638 ) 639 </div> 640 641 </em> 642 </dt> 643 <dd class="todo" style="display: none; "> 644 Undocumented. 645 </dd> 646 <dd>The URI of the proxy server.</dd> 647 <dd style="display: none; "> 648 This parameter was added in version 649 <b><span></span></b>. 650 You must omit this parameter in earlier versions, 651 and you may omit it in any version. If you require this 652 parameter, the manifest key 653 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 654 can ensure that your extension won't be run in an earlier browser version. 655 </dd> 656 657 <!-- OBJECT PROPERTIES --> 658 <dd style="display: none; "> 659 <dl> 660 <div> 661 <div> 662 </div> 663 </div> 664 </dl> 665 </dd> 666 667 <!-- FUNCTION PARAMETERS --> 668 <dd style="display: none; "> 669 <div></div> 670 </dd> 671 672 </div> 673 </div><div> 674 <div> 675 <dt> 676 <var>port</var> 677 <em> 678 679 <!-- TYPE --> 680 <div style="display:inline"> 681 ( 682 <span class="optional">optional</span> 683 <span class="enum" style="display: none; ">enumerated</span> 684 <span id="typeTemplate"> 685 <span style="display: none; "> 686 <a> Type</a> 687 </span> 688 <span> 689 <span style="display: none; "> 690 array of <span><span></span></span> 691 </span> 692 <span>integer</span> 693 <span style="display: none; "></span> 694 </span> 695 </span> 696 ) 697 </div> 698 699 </em> 700 </dt> 701 <dd class="todo" style="display: none; "> 702 Undocumented. 703 </dd> 704 <dd>The port of the proxy server.</dd> 705 <dd style="display: none; "> 706 This parameter was added in version 707 <b><span></span></b>. 708 You must omit this parameter in earlier versions, 709 and you may omit it in any version. If you require this 710 parameter, the manifest key 711 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 712 can ensure that your extension won't be run in an earlier browser version. 713 </dd> 714 715 <!-- OBJECT PROPERTIES --> 716 <dd style="display: none; "> 717 <dl> 718 <div> 719 <div> 720 </div> 721 </div> 722 </dl> 723 </dd> 724 725 <!-- FUNCTION PARAMETERS --> 726 <dd style="display: none; "> 727 <div></div> 728 </dd> 729 730 </div> 731 </div> 732 </dl> 733 </dd> 734 735 <!-- FUNCTION PARAMETERS --> 736 <dd style="display: none; "> 737 <div></div> 738 </dd> 739 740 </div> 741 742 </div><div class="apiItem"> 743 <a name="type-ProxyRules"></a> 744 <h4>ProxyRules</h4> 745 746 <div> 747 <dt> 748 <var style="display: none; ">paramName</var> 749 <em> 750 751 <!-- TYPE --> 752 <div style="display:inline"> 753 ( 754 <span class="optional" style="display: none; ">optional</span> 755 <span class="enum" style="display: none; ">enumerated</span> 756 <span id="typeTemplate"> 757 <span style="display: none; "> 758 <a> Type</a> 759 </span> 760 <span> 761 <span style="display: none; "> 762 array of <span><span></span></span> 763 </span> 764 <span>object</span> 765 <span style="display: none; "></span> 766 </span> 767 </span> 768 ) 769 </div> 770 771 </em> 772 </dt> 773 <dd class="todo" style="display: none; "> 774 Undocumented. 775 </dd> 776 <dd>An object encapsulating the set of proxy rules for all protocols.</dd> 777 <dd style="display: none; "> 778 This parameter was added in version 779 <b><span></span></b>. 780 You must omit this parameter in earlier versions, 781 and you may omit it in any version. If you require this 782 parameter, the manifest key 783 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 784 can ensure that your extension won't be run in an earlier browser version. 785 </dd> 786 787 <!-- OBJECT PROPERTIES --> 788 <dd> 789 <dl> 790 <div> 791 <div> 792 <dt> 793 <var>singleProxy</var> 794 <em> 795 796 <!-- TYPE --> 797 <div style="display:inline"> 798 ( 799 <span class="optional">optional</span> 800 <span class="enum" style="display: none; ">enumerated</span> 801 <span id="typeTemplate"> 802 <span> 803 <a href="experimental.proxy.html#type-ProxyServer">ProxyServer</a> 804 </span> 805 <span style="display: none; "> 806 <span> 807 array of <span><span></span></span> 808 </span> 809 <span>paramType</span> 810 <span></span> 811 </span> 812 </span> 813 ) 814 </div> 815 816 </em> 817 </dt> 818 <dd class="todo" style="display: none; "> 819 Undocumented. 820 </dd> 821 <dd>The proxy server to be used for all per-URL requests (i.e., http, https, and ftp).</dd> 822 <dd style="display: none; "> 823 This parameter was added in version 824 <b><span></span></b>. 825 You must omit this parameter in earlier versions, 826 and you may omit it in any version. If you require this 827 parameter, the manifest key 828 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 829 can ensure that your extension won't be run in an earlier browser version. 830 </dd> 831 832 <!-- OBJECT PROPERTIES --> 833 <dd style="display: none; "> 834 <dl> 835 <div> 836 <div> 837 </div> 838 </div> 839 </dl> 840 </dd> 841 842 <!-- FUNCTION PARAMETERS --> 843 <dd style="display: none; "> 844 <div></div> 845 </dd> 846 847 </div> 848 </div><div> 849 <div> 850 <dt> 851 <var>proxyForHttp</var> 852 <em> 853 854 <!-- TYPE --> 855 <div style="display:inline"> 856 ( 857 <span class="optional">optional</span> 858 <span class="enum" style="display: none; ">enumerated</span> 859 <span id="typeTemplate"> 860 <span> 861 <a href="experimental.proxy.html#type-ProxyServer">ProxyServer</a> 862 </span> 863 <span style="display: none; "> 864 <span> 865 array of <span><span></span></span> 866 </span> 867 <span>paramType</span> 868 <span></span> 869 </span> 870 </span> 871 ) 872 </div> 873 874 </em> 875 </dt> 876 <dd class="todo" style="display: none; "> 877 Undocumented. 878 </dd> 879 <dd>The proxy server to be used for HTTP requests.</dd> 880 <dd style="display: none; "> 881 This parameter was added in version 882 <b><span></span></b>. 883 You must omit this parameter in earlier versions, 884 and you may omit it in any version. If you require this 885 parameter, the manifest key 886 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 887 can ensure that your extension won't be run in an earlier browser version. 888 </dd> 889 890 <!-- OBJECT PROPERTIES --> 891 <dd style="display: none; "> 892 <dl> 893 <div> 894 <div> 895 </div> 896 </div> 897 </dl> 898 </dd> 899 900 <!-- FUNCTION PARAMETERS --> 901 <dd style="display: none; "> 902 <div></div> 903 </dd> 904 905 </div> 906 </div><div> 907 <div> 908 <dt> 909 <var>proxyForHttps</var> 910 <em> 911 912 <!-- TYPE --> 913 <div style="display:inline"> 914 ( 915 <span class="optional">optional</span> 916 <span class="enum" style="display: none; ">enumerated</span> 917 <span id="typeTemplate"> 918 <span> 919 <a href="experimental.proxy.html#type-ProxyServer">ProxyServer</a> 920 </span> 921 <span style="display: none; "> 922 <span> 923 array of <span><span></span></span> 924 </span> 925 <span>paramType</span> 926 <span></span> 927 </span> 928 </span> 929 ) 930 </div> 931 932 </em> 933 </dt> 934 <dd class="todo" style="display: none; "> 935 Undocumented. 936 </dd> 937 <dd>The proxy server to be used for HTTPS requests.</dd> 938 <dd style="display: none; "> 939 This parameter was added in version 940 <b><span></span></b>. 941 You must omit this parameter in earlier versions, 942 and you may omit it in any version. If you require this 943 parameter, the manifest key 944 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 945 can ensure that your extension won't be run in an earlier browser version. 946 </dd> 947 948 <!-- OBJECT PROPERTIES --> 949 <dd style="display: none; "> 950 <dl> 951 <div> 952 <div> 953 </div> 954 </div> 955 </dl> 956 </dd> 957 958 <!-- FUNCTION PARAMETERS --> 959 <dd style="display: none; "> 960 <div></div> 961 </dd> 962 963 </div> 964 </div><div> 965 <div> 966 <dt> 967 <var>proxyForFtp</var> 968 <em> 969 970 <!-- TYPE --> 971 <div style="display:inline"> 972 ( 973 <span class="optional">optional</span> 974 <span class="enum" style="display: none; ">enumerated</span> 975 <span id="typeTemplate"> 976 <span> 977 <a href="experimental.proxy.html#type-ProxyServer">ProxyServer</a> 978 </span> 979 <span style="display: none; "> 980 <span> 981 array of <span><span></span></span> 982 </span> 983 <span>paramType</span> 984 <span></span> 985 </span> 986 </span> 987 ) 988 </div> 989 990 </em> 991 </dt> 992 <dd class="todo" style="display: none; "> 993 Undocumented. 994 </dd> 995 <dd>The proxy server to be used for FTP requests.</dd> 996 <dd style="display: none; "> 997 This parameter was added in version 998 <b><span></span></b>. 999 You must omit this parameter in earlier versions, 1000 and you may omit it in any version. If you require this 1001 parameter, the manifest key 1002 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1003 can ensure that your extension won't be run in an earlier browser version. 1004 </dd> 1005 1006 <!-- OBJECT PROPERTIES --> 1007 <dd style="display: none; "> 1008 <dl> 1009 <div> 1010 <div> 1011 </div> 1012 </div> 1013 </dl> 1014 </dd> 1015 1016 <!-- FUNCTION PARAMETERS --> 1017 <dd style="display: none; "> 1018 <div></div> 1019 </dd> 1020 1021 </div> 1022 </div><div> 1023 <div> 1024 <dt> 1025 <var>socksProxy</var> 1026 <em> 1027 1028 <!-- TYPE --> 1029 <div style="display:inline"> 1030 ( 1031 <span class="optional">optional</span> 1032 <span class="enum" style="display: none; ">enumerated</span> 1033 <span id="typeTemplate"> 1034 <span> 1035 <a href="experimental.proxy.html#type-ProxyServer">ProxyServer</a> 1036 </span> 1037 <span style="display: none; "> 1038 <span> 1039 array of <span><span></span></span> 1040 </span> 1041 <span>paramType</span> 1042 <span></span> 1043 </span> 1044 </span> 1045 ) 1046 </div> 1047 1048 </em> 1049 </dt> 1050 <dd class="todo" style="display: none; "> 1051 Undocumented. 1052 </dd> 1053 <dd>The proxy server to be used for SOCKS requests.</dd> 1054 <dd style="display: none; "> 1055 This parameter was added in version 1056 <b><span></span></b>. 1057 You must omit this parameter in earlier versions, 1058 and you may omit it in any version. If you require this 1059 parameter, the manifest key 1060 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1061 can ensure that your extension won't be run in an earlier browser version. 1062 </dd> 1063 1064 <!-- OBJECT PROPERTIES --> 1065 <dd style="display: none; "> 1066 <dl> 1067 <div> 1068 <div> 1069 </div> 1070 </div> 1071 </dl> 1072 </dd> 1073 1074 <!-- FUNCTION PARAMETERS --> 1075 <dd style="display: none; "> 1076 <div></div> 1077 </dd> 1078 1079 </div> 1080 </div> 1081 </dl> 1082 </dd> 1083 1084 <!-- FUNCTION PARAMETERS --> 1085 <dd style="display: none; "> 1086 <div></div> 1087 </dd> 1088 1089 </div> 1090 1091 </div><div class="apiItem"> 1092 <a name="type-PacScript"></a> 1093 <h4>PacScript</h4> 1094 1095 <div> 1096 <dt> 1097 <var style="display: none; ">paramName</var> 1098 <em> 1099 1100 <!-- TYPE --> 1101 <div style="display:inline"> 1102 ( 1103 <span class="optional" style="display: none; ">optional</span> 1104 <span class="enum" style="display: none; ">enumerated</span> 1105 <span id="typeTemplate"> 1106 <span style="display: none; "> 1107 <a> Type</a> 1108 </span> 1109 <span> 1110 <span style="display: none; "> 1111 array of <span><span></span></span> 1112 </span> 1113 <span>object</span> 1114 <span style="display: none; "></span> 1115 </span> 1116 </span> 1117 ) 1118 </div> 1119 1120 </em> 1121 </dt> 1122 <dd class="todo" style="display: none; "> 1123 Undocumented. 1124 </dd> 1125 <dd>An object holding proxy auto-config information. Only one of the fields should be non-empty.</dd> 1126 <dd style="display: none; "> 1127 This parameter was added in version 1128 <b><span></span></b>. 1129 You must omit this parameter in earlier versions, 1130 and you may omit it in any version. If you require this 1131 parameter, the manifest key 1132 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1133 can ensure that your extension won't be run in an earlier browser version. 1134 </dd> 1135 1136 <!-- OBJECT PROPERTIES --> 1137 <dd> 1138 <dl> 1139 <div> 1140 <div> 1141 <dt> 1142 <var>url</var> 1143 <em> 1144 1145 <!-- TYPE --> 1146 <div style="display:inline"> 1147 ( 1148 <span class="optional">optional</span> 1149 <span class="enum" style="display: none; ">enumerated</span> 1150 <span id="typeTemplate"> 1151 <span style="display: none; "> 1152 <a> Type</a> 1153 </span> 1154 <span> 1155 <span style="display: none; "> 1156 array of <span><span></span></span> 1157 </span> 1158 <span>string</span> 1159 <span style="display: none; "></span> 1160 </span> 1161 </span> 1162 ) 1163 </div> 1164 1165 </em> 1166 </dt> 1167 <dd class="todo" style="display: none; "> 1168 Undocumented. 1169 </dd> 1170 <dd>URL of he PAC file to be used.</dd> 1171 <dd style="display: none; "> 1172 This parameter was added in version 1173 <b><span></span></b>. 1174 You must omit this parameter in earlier versions, 1175 and you may omit it in any version. If you require this 1176 parameter, the manifest key 1177 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1178 can ensure that your extension won't be run in an earlier browser version. 1179 </dd> 1180 1181 <!-- OBJECT PROPERTIES --> 1182 <dd style="display: none; "> 1183 <dl> 1184 <div> 1185 <div> 1186 </div> 1187 </div> 1188 </dl> 1189 </dd> 1190 1191 <!-- FUNCTION PARAMETERS --> 1192 <dd style="display: none; "> 1193 <div></div> 1194 </dd> 1195 1196 </div> 1197 </div> 1198 </dl> 1199 </dd> 1200 1201 <!-- FUNCTION PARAMETERS --> 1202 <dd style="display: none; "> 1203 <div></div> 1204 </dd> 1205 1206 </div> 1207 1208 </div><div class="apiItem"> 1209 <a name="type-ProxyConfig"></a> 1210 <h4>ProxyConfig</h4> 1211 1212 <div> 1213 <dt> 1214 <var style="display: none; ">paramName</var> 1215 <em> 1216 1217 <!-- TYPE --> 1218 <div style="display:inline"> 1219 ( 1220 <span class="optional" style="display: none; ">optional</span> 1221 <span class="enum" style="display: none; ">enumerated</span> 1222 <span id="typeTemplate"> 1223 <span style="display: none; "> 1224 <a> Type</a> 1225 </span> 1226 <span> 1227 <span style="display: none; "> 1228 array of <span><span></span></span> 1229 </span> 1230 <span>object</span> 1231 <span style="display: none; "></span> 1232 </span> 1233 </span> 1234 ) 1235 </div> 1236 1237 </em> 1238 </dt> 1239 <dd class="todo" style="display: none; "> 1240 Undocumented. 1241 </dd> 1242 <dd>An object encapsulating a complete proxy configuration.</dd> 1243 <dd style="display: none; "> 1244 This parameter was added in version 1245 <b><span></span></b>. 1246 You must omit this parameter in earlier versions, 1247 and you may omit it in any version. If you require this 1248 parameter, the manifest key 1249 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1250 can ensure that your extension won't be run in an earlier browser version. 1251 </dd> 1252 1253 <!-- OBJECT PROPERTIES --> 1254 <dd> 1255 <dl> 1256 <div> 1257 <div> 1258 <dt> 1259 <var>rules</var> 1260 <em> 1261 1262 <!-- TYPE --> 1263 <div style="display:inline"> 1264 ( 1265 <span class="optional">optional</span> 1266 <span class="enum" style="display: none; ">enumerated</span> 1267 <span id="typeTemplate"> 1268 <span> 1269 <a href="experimental.proxy.html#type-ProxyRules">ProxyRules</a> 1270 </span> 1271 <span style="display: none; "> 1272 <span> 1273 array of <span><span></span></span> 1274 </span> 1275 <span>paramType</span> 1276 <span></span> 1277 </span> 1278 </span> 1279 ) 1280 </div> 1281 1282 </em> 1283 </dt> 1284 <dd class="todo" style="display: none; "> 1285 Undocumented. 1286 </dd> 1287 <dd>The proxy rules describing this configuration.</dd> 1288 <dd style="display: none; "> 1289 This parameter was added in version 1290 <b><span></span></b>. 1291 You must omit this parameter in earlier versions, 1292 and you may omit it in any version. If you require this 1293 parameter, the manifest key 1294 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1295 can ensure that your extension won't be run in an earlier browser version. 1296 </dd> 1297 1298 <!-- OBJECT PROPERTIES --> 1299 <dd style="display: none; "> 1300 <dl> 1301 <div> 1302 <div> 1303 </div> 1304 </div> 1305 </dl> 1306 </dd> 1307 1308 <!-- FUNCTION PARAMETERS --> 1309 <dd style="display: none; "> 1310 <div></div> 1311 </dd> 1312 1313 </div> 1314 </div><div> 1315 <div> 1316 <dt> 1317 <var>pacScript</var> 1318 <em> 1319 1320 <!-- TYPE --> 1321 <div style="display:inline"> 1322 ( 1323 <span class="optional">optional</span> 1324 <span class="enum" style="display: none; ">enumerated</span> 1325 <span id="typeTemplate"> 1326 <span> 1327 <a href="experimental.proxy.html#type-PacScript">PacScript</a> 1328 </span> 1329 <span style="display: none; "> 1330 <span> 1331 array of <span><span></span></span> 1332 </span> 1333 <span>paramType</span> 1334 <span></span> 1335 </span> 1336 </span> 1337 ) 1338 </div> 1339 1340 </em> 1341 </dt> 1342 <dd class="todo" style="display: none; "> 1343 Undocumented. 1344 </dd> 1345 <dd>The proxy auto-config (PAC) script for this configuration.</dd> 1346 <dd style="display: none; "> 1347 This parameter was added in version 1348 <b><span></span></b>. 1349 You must omit this parameter in earlier versions, 1350 and you may omit it in any version. If you require this 1351 parameter, the manifest key 1352 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1353 can ensure that your extension won't be run in an earlier browser version. 1354 </dd> 1355 1356 <!-- OBJECT PROPERTIES --> 1357 <dd style="display: none; "> 1358 <dl> 1359 <div> 1360 <div> 1361 </div> 1362 </div> 1363 </dl> 1364 </dd> 1365 1366 <!-- FUNCTION PARAMETERS --> 1367 <dd style="display: none; "> 1368 <div></div> 1369 </dd> 1370 1371 </div> 1372 </div><div> 1373 <div> 1374 <dt> 1375 <var>mode</var> 1376 <em> 1377 1378 <!-- TYPE --> 1379 <div style="display:inline"> 1380 ( 1381 <span class="optional" style="display: none; ">optional</span> 1382 <span class="enum">enumerated</span> 1383 <span id="typeTemplate"> 1384 <span style="display: none; "> 1385 <a> Type</a> 1386 </span> 1387 <span> 1388 <span style="display: none; "> 1389 array of <span><span></span></span> 1390 </span> 1391 <span>string</span> 1392 <span>["direct", "auto_detect", "pac_script", "fixed_servers", "system"]</span> 1393 </span> 1394 </span> 1395 ) 1396 </div> 1397 1398 </em> 1399 </dt> 1400 <dd class="todo" style="display: none; "> 1401 Undocumented. 1402 </dd> 1403 <dd>'direct' = Never use a proxy<br>'auto_detect' = Auto detect proxy settings<br>'pac_script' = Use specified PAC script<br>'fixed_servers' = Manually specify proxy servers<br>'system' = Use system proxy settings</dd> 1404 <dd style="display: none; "> 1405 This parameter was added in version 1406 <b><span></span></b>. 1407 You must omit this parameter in earlier versions, 1408 and you may omit it in any version. If you require this 1409 parameter, the manifest key 1410 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1411 can ensure that your extension won't be run in an earlier browser version. 1412 </dd> 1413 1414 <!-- OBJECT PROPERTIES --> 1415 <dd style="display: none; "> 1416 <dl> 1417 <div> 1418 <div> 1419 </div> 1420 </div> 1421 </dl> 1422 </dd> 1423 1424 <!-- FUNCTION PARAMETERS --> 1425 <dd style="display: none; "> 1426 <div></div> 1427 </dd> 1428 1429 </div> 1430 </div> 1431 </dl> 1432 </dd> 1433 1434 <!-- FUNCTION PARAMETERS --> 1435 <dd style="display: none; "> 1436 <div></div> 1437 </dd> 1438 1439 </div> 1440 1441 </div> <!-- /apiItem --> 1442 1443 </div> <!-- /apiGroup --> 1444 1445 </div> <!-- /apiPage --> 1446 </div> <!-- /gc-pagecontent --> 1447 </div> <!-- /g-section --> 1448 </div> <!-- /codesiteContent --> 1449 <div id="gc-footer" --=""> 1450 <div class="text"> 1451 <p> 1452 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 1453 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 1454 Attribution 3.0 License</a>, and code samples are licensed under the 1455 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 1456 </p> 1457 <p> 1458 ©2010 Google 1459 </p> 1460 1461<!-- begin analytics --> 1462<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 1463<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 1464 1465<script type="text/javascript"> 1466 // chrome doc tracking 1467 try { 1468 var engdocs = _gat._getTracker("YT-10763712-2"); 1469 engdocs._trackPageview(); 1470 } catch(err) {} 1471 1472 // code.google.com site-wide tracking 1473 try { 1474 _uacct="UA-18071-1"; 1475 _uanchor=1; 1476 _uff=0; 1477 urchinTracker(); 1478 } 1479 catch(e) {/* urchinTracker not available. */} 1480</script> 1481<!-- end analytics --> 1482 </div> 1483 </div> <!-- /gc-footer --> 1484 </div> <!-- /gc-container --> 1485</body></html> 1486
