chrome/common/extensions/docs/experimental.proxy.html - Issue 6992022: Move Proxy Settings API out of experimental

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

Issue 6992022: Move Proxy Settings API out of experimental (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Addressed Bernhard's comment Created 9 years, 7 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

« chrome/common/extensions/docs/examples/extensions/proxy_configuration/proxy_form_controller.js ('K') | « chrome/common/extensions/docs/experimental.extension.html ('k') | chrome/common/extensions/docs/permission_warnings.html » ('j') | chrome/common/extensions/docs/static/proxy.html » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
	(Empty)
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

2 1) The <head> information in this page is significant, should be uniform

3 across api docs and should be edited only with knowledge of the

4 templating mechanism.

5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

6 browser, it will be re-generated from the template, json schema and

7 authored overview content.

8 4) The <body>.innerHTML is also generated by an offline step so that this

9 page may easily be indexed by search engines.

10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>

11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">

15 </script>

16 <script type="text/javascript" src="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>Proxy Settings - 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_versio n</a>

71 can ensure that your extension won't be run in an earlier browser ve rsion.

72 </dd>

73

74 <!-- OBJECT PROPERTIES -->

75 <dd>

76 <dl>

77 <div>

78 <div>

79 </div>

80 </div>

81 </dl>

82 </dd>

83

84 <!-- OBJECT METHODS -->

85 <dd>

86 <div></div>

87 </dd>

88

89 <!-- OBJECT EVENT FIELDS -->

90 <dd>

91 <div></div>

92 </dd>

93

94 <!-- FUNCTION PARAMETERS -->

95 <dd>

96 <div></div>

97 </dd>

98

99 </div> <!-- /VALUE -->

100

101 <div id="functionParametersTemplate">

102 <h5>Parameters</h5>

103 <dl>

104 <div>

105 <div>

106 </div>

107 </div>

108 </dl>

109 </div>

110 </div> <!-- /SUBTEMPLATES -->

111

112 <a id="top"></a>

113 <div id="skipto">

114 <a href="#gc-pagecontent">Skip to page content</a>

115 <a href="#gc-toc">Skip to main navigation</a>

116 </div>

117 <!-- API HEADER -->

118 <table id="header" width="100%" cellspacing="0" border="0">

119 <tbody><tr>

120 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>

121 <td valign="middle" width="100%" style="padding-left:0.6em;">

122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">

123 <div id="gsc-search-box">

124 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">

125 <input type="hidden" name="ie" value="UTF-8">

126 <input type="text" name="q" value="" size="55">

127 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">

128 <br>

129 <span class="greytext">e.g. "page action" or "tabs"</span>

130 </div>

131 </form>

132

133 <script type="text/javascript" src="http://www.google.com/jsapi"></scr ipt>

134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13 n?form=cse&t13n_langs=en"></script>

136 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&lang=en"></script>

137 </td>

138 </tr>

139 </tbody></table>

140

141 <div id="codesiteContent" class="">

142

143 <a id="gc-topnav-anchor"></a>

144 <div id="gc-topnav">

145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>

146 <ul id="home" class="gc-topnav-tabs">

147 <li id="home_link">

148 <a href="index.html" title="Google Chrome Extensions home page">Home </a>

149 </li>

150 <li id="docs_link">

151 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>

152 </li>

153 <li id="faq_link">

154 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>

155 </li>

156 <li id="samples_link">

157 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>

158 </li>

159 <li id="group_link">

160 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>

161 </li>

162 </ul>

163 </div> <!-- end gc-topnav -->

164

165 <div class="g-section g-tpl-170">

166 <!-- SIDENAV -->

167 <div class="g-unit g-first" id="gc-toc">

168 <ul>

169 <li><a href="getstarted.html">Getting Started</a></li>

170 <li><a href="overview.html">Overview</a></li>

171 <li><a href="whats_new.html">What's New?</a></li>

172 <li><h2><a href="devguide.html">Developer's Guide</a></h2>

173 <ul>

174 <li>Browser UI

175 <ul>

176 <li><a href="browserAction.html">Browser Actions</a></li>

177 <li><a href="contextMenus.html">Context Menus</a></li>

178 <li><a href="notifications.html">Desktop Notifications</a></li >

179 <li><a href="omnibox.html">Omnibox</a></li>

180 <li><a href="options.html">Options Pages</a></li>

181 <li><a href="override.html">Override Pages</a></li>

182 <li><a href="pageAction.html">Page Actions</a></li>

183 </ul>

184 </li>

185 <li>Browser Interaction

186 <ul>

187 <li><a href="bookmarks.html">Bookmarks</a></li>

188 <li><a href="cookies.html">Cookies</a></li>

189 <li><a href="events.html">Events</a></li>

190 <li><a href="history.html">History</a></li>

191 <li><a href="management.html">Management</a></li>

192 <li><a href="tabs.html">Tabs</a></li>

193 <li><a href="windows.html">Windows</a></li>

194 </ul>

195 </li>

196 <li>Implementation

197 <ul>

198 <li><a href="a11y.html">Accessibility</a></li>

199 <li><a href="background_pages.html">Background Pages</a></li>

200 <li><a href="content_scripts.html">Content Scripts</a></li>

201 <li><a href="xhr.html">Cross-Origin XHR</a></li>

202 <li><a href="idle.html">Idle</a></li>

203 <li><a href="i18n.html">Internationalization</a></li>

204 <li><a href="messaging.html">Message Passing</a></li>

205 <li><a href="npapi.html">NPAPI Plugins</a></li>

206 </ul>

207 </li>

208 <li>Finishing

209 <ul>

210 <li><a href="hosting.html">Hosting</a></li>

211 <li><a href="external_extensions.html">Other Deployment Option s</a></li>

212 </ul>

213 </li>

214 </ul>

215 </li>

216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

217 <li><h2><a href="tutorials.html">Tutorials</a></h2>

218 <ul>

219 <li><a href="tut_debugging.html">Debugging</a></li>

220 <li><a href="tut_analytics.html">Google Analytics</a></li>

221 <li><a href="tut_oauth.html">OAuth</a></li>

222 </ul>

223 </li>

224 <li><h2>Reference</h2>

225 <ul>

226 <li>Formats

227 <ul>

228 <li><a href="manifest.html">Manifest Files</a></li>

229 <li><a href="match_patterns.html">Match Patterns</a></li>

230 </ul>

231 </li>

232 <li><a href="permission_warnings.html">Permission Warnings</a></li >

233 <li><a href="api_index.html">chrome.* APIs</a></li>

234 <li><a href="api_other.html">Other APIs</a></li>

235 </ul>

236 </li>

237 <li><h2><a href="samples.html">Samples</a></h2></li>

238 <div class="line"> </div>

239 <li><h2>More</h2>

240 <ul>

241 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>

242 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>

243 <li><a href="themes.html">Themes</a></li>

244 </ul>

245 </li>

246 </ul>

247 </div>

248 <script>

249 initToggles();

250 </script>

251

252 <div class="g-unit" id="gc-pagecontent">

253 <div id="pageTitle">

254 <h1 class="page_title">Proxy Settings</h1>

255 </div>

256 <!-- TABLE OF CONTENTS -->

257 <div id="toc">

258 <h2>Contents</h2>

259 <ol>

260 <li>

261 <a href="#manifest">Manifest</a>

262 <ol>

263 <li style="display: none; ">

264 <a>h3Name</a>

265 </li>

266 </ol>

267 </li><li>

268 <a href="#description">Objects and properties</a>

269 <ol>

270 <li>

271 <a href="#proxy_modes">Proxy modes</a>

272 </li><li>

273 <a href="#proxy_rules">Proxy rules</a>

274 </li><li>

275 <a href="#proxy_server_objects">Proxy server objects</a>

276 </li><li>

277 <a href="#bypass_list">Bypass list</a>

278 </li>

279 </ol>

280 </li><li>

281 <a href="#precedence">Precedence</a>

282 <ol>

283 <li style="display: none; ">

284 <a>h3Name</a>

285 </li>

286 </ol>

287 </li><li>

288 <a href="#overview-examples">Examples</a>

289 <ol>

290 <li style="display: none; ">

291 <a>h3Name</a>

292 </li>

293 </ol>

294 </li>

295 <li>

296 <a href="#apiReference">API reference: chrome.experimental.proxy </a>

297 <ol>

298 <li>

299 <a href="#properties">Properties</a>

300 <ol>

301 <li>

302 <a href="#property-settings">settings</a>

303 </li>

304 </ol>

305 </li>

306 <li style="display: none; ">

307 <a>Methods</a>

308 <ol>

309 <li>

310 <a href="#method-anchor">methodName</a>

311 </li>

312 </ol>

313 </li>

314 <li>

315 <a href="#global-events">Events</a>

316 <ol>

317 <li>

318 <a href="#event-onProxyError">onProxyError</a>

319 </li>

320 </ol>

321 </li>

322 <li>

323 <a href="#types">Types</a>

324 <ol>

325 <li>

326 <a href="#type-ProxyServer">ProxyServer</a>

327 </li><li>

328 <a href="#type-ProxyRules">ProxyRules</a>

329 </li><li>

330 <a href="#type-PacScript">PacScript</a>

331 </li><li>

332 <a href="#type-ProxyConfig">ProxyConfig</a>

333 </li>

334 </ol>

335 </li>

336 </ol>

337 </li>

338 </ol>

339 </div>

340 <!-- /TABLE OF CONTENTS -->

341

342 <!-- Standard content lead-in for experimental API pages -->

343 <p id="classSummary" style="display: none; ">

344 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.

345 </p>

346

347 <!-- STATIC CONTENT PLACEHOLDER -->

348 <div id="static"><div id="pageData-name" class="pageData">Proxy Settings </div>

349

350 <!-- BEGIN AUTHORED CONTENT -->

351 <p id="classSummary">

352 Use the <code>chrome.experimental.proxysettings</code> module to manage Chrome's

353 proxy settings. This module is still experimental. For information on how to use

354 experimental APIs, see the <a href="experimental.html">chrome.experimental.*

355 APIs</a> page.

356 </p>

357

358 <h2 id="manifest">Manifest</h2>

359 <p>You must declare the "proxy" permission

360 in the <a href="manifest.html">extension manifest</a>

361 to use the proxy settings API.

362 For example:</p>

363 <pre>{

364 "name": "My extension",

365 ...

366 <b>"permissions": [

367 "experimental", "proxy"

368 ]</b>,

369 ...

370 }</pre>

371

372 <h2 id="description">Objects and properties</h2>

373

374 <p>

375 Proxy settings are defined in a

376 <a href="#type-ProxyConfig"><code>ProxyConfig</code></a> object. Depending on

377 Chrome's proxy settings, the settings may contain

378 <a href="#type-ProxyRules"><code>ProxyRules</code></a> or a <a href="#type-PacSc ript"><code>PacScript</code></a>.

379 </p>

380

381 <h3 id="proxy_modes">Proxy modes</h3>

382

383 <p>

384 A ProxyConfig object's <code>mode</code> attribute determines the overall

385 behavior of Chrome with regards to proxy usage. It can take the following

386 values:

387 </p><dl>

388 <dt><code>direct</code></dt>

389 <dd>In <code>direct</code> mode all connections are created directly, without

390 any proxy involved. This mode allows no further parameters in the

391 <code>ProxyConfig</code> object.</dd>

392

393 <dt><code>auto_detect</code></dt>

394 <dd>In <code>auto_detect</code> mode the proxy configuration is determined by

395 a PAC script that can be downloaded at

396 <a href="http://wpad/wpad.dat">http://wpad/wpad.dat</a>.

397 This mode allows no further parameters in the <code>ProxyConfig</code>

398 object.</dd>

399

400 <dt><code>pac_script</code></dt>

401 <dd>In <code>pac_script</code> mode the proxy configuration is determined by

402 a PAC script that is either retrieved from the URL specified in the

403 <a href="#type-PacScript"><code>PacScript</code></a> object or

404 taken literally from the <code>data</code> element specified in the

405 <a href="#type-PacScript"><code>PacScript</code></a> object.

406 Besides this, this mode allows no further parameters in the

407 <code>ProxyConfig</code> object.</dd>

408

409 <dt><code>fixed_servers</code></dt>

410 <dd>In <code>fixed_servers</code> mode the proxy configuration is codified in

411 a <a href="#type-ProxyRules><code>ProxyRules"><code>ProxyRules</code> </a>

412 object. Its structure is described in <a href="#proxy_rules">Proxy rules</a>.

413 Besides this, the <code>fixed_servers</code> mode allows no further parameters

414 in the <code>ProxyConfig</code> object.</dd>

415

416 <dt><code>system</code></dt>

417 <dd>In <code>system</code> mode the proxy configuration is taken from the

418 operating system. This mode allows no further parameters in the

419 <code>ProxyConfig</code> object. Note that the <code>system</code> mode is

420 different from setting no proxy configuration. In the latter case, Chrome

421 falls back to the system settings only if no command-line options influence

422 the proxy configuration.</dd>

423 </dl>

424 <p></p>

425

426 <h3 id="proxy_rules">Proxy rules</h3>

427

428 <p>

429 The <a href="#type-ProxyRules"><code>ProxyRules</code></a> object can contain

430 either a <code>singleProxy</code> attribute or a subset of

431 <code>proxyForHttp</code>, <code>proxyForHttps</code>, <code>proxyForFtp</code>,

432 and <code>fallbackProxy</code>.

433 </p>

434

435 <p>

436 In the first case, HTTP, HTTPS and FTP traffic is proxied through the specified

437 proxy server. Other traffic is sent directly. In the latter case the behavior is

438 slightly more subtle: If a proxy server is configured for the HTTP, HTTPS or FTP

439 protocol, the respective traffic is proxied through the specified server. If no

440 such proxy server is specified or traffic uses a different protocol than HTTP,

441 HTTPS or FTP, the <code>fallbackProxy</code> is used. If no

442 <code>fallbackProxy</code> is specified, traffic is sent directly without a

443 proxy server.

444 </p>

445

446 <h3 id="proxy_server_objects">Proxy server objects</h3>

447

448 <p>

449 A proxy server is configured in a

450 <a href="#type-ProxyServer"><code>ProxyServer</code></a> object. The connection

451 to the proxy server (defined by the <code>host</code> attribute) uses the

452 protocol defined in the <code>scheme</code> attribute. If no <code>scheme</code>

453 is specified, the proxy connection defaults to <code>http</code>.

454 </p>

455

456 <p>

457 If no <code>port</code> is defined in a

458 <a href="#type-ProxyServer"><code>ProxyServer</code></a> object, the port is

459 derived from the scheme. The default ports are:

460 </p><table>

461 <tbody><tr><th>Scheme</th><th>Port</th></tr>

462 <tr><td>http</td><td>80</td></tr>

463 <tr><td>https</td><td>443</td></tr>

464 <tr><td>socks4</td><td>1080</td></tr>

465 <tr><td>socks5</td><td>1080</td></tr>

466 </tbody></table>

467 <p></p>

468

469 <h3 id="bypass_list">Bypass list</h3>

470

471 <p>

472 Individual servers may be excluded from being proxied with the

473 <code>bypassList</code>. This list may contain the following entries:

474 </p><dl>

475 <dt><code>[<em><scheme></em>://]<em><host-pattern></em>[:<em><p ort></em>]</code></dt>

476 <dd>Match all hostnames that match the pattern <em><host-pattern></em>.< br>

477 Examples: <code>"foobar.com", "foobar.com", ".foobar.com", "*foobar.com:99",

478 "https://x.*.y.com:99"</code></dd>

479

480 <dt><code>[<em><scheme></em>://]<em><ip-literal></em>[:<em><por t></em>]</code></dt>

481 <dd>Match URLs that are IP address literals.<br>

482 Conceptually this is the similar to the first case, but with special cases

483 to handle IP literal canonicalization. For example, matching

484 on "[0:0:0::1]" is the same as matching on "[::1]" because

485 the IPv6 canonicalization is done internally.<br>

486 Examples: <code>"127.0.1", "[0:0::1]", "[::1]", "http://[::1]:99"</code></dd>

487

488 <dt><code><em><ip-literal></em>/<em><prefix-length-in-bits></em></ code></dt>

489 <dd>Match any URL containing an IP literal within the given range. The IP

490 range is specified using CIDR notation.<br>

491 Examples: <code>"192.168.1.1/16", "fefe:13::abc/33"</code></dd>

492

493 <dt><code><local></code></dt>

494 <dd>Match local addresses. An address is local if the host is "127.0.0.1",

495 "::1", or "localhost".<br>

496 Example: <code>"<local>"</code></dd>

497 </dl>

498

499

500 <h2 id="precedence">Precedence</h2>

501

502 <p>

503 Chrome manages settings on different layers. The following list describes the

504 layers that may influence the effective proxy settings, in increasing order of

505 precedence.

506 </p><ol>

507 <li>System settings provided by the operating system</li>

508 <li>Command line parameters</li>

509 <li>Preferences set by extensions</li>

510 <li>Policies</li>

511 </ol>

512 <p></p>

513

514 <p>

515 As the list implies, policies might overrule any changes that you specify with

516 the proxy settings API.

517 </p>

518

519 <p>

520 Chrome allows using different proxy settings for regular windows and incognito

521 windows. The following example illustrates the behavior. Assume that no policy

522 overrides the proxy settings and that an extension can set proxy settings for

523 regular windows <b>(R)</b> and proxy settings for incognito windows <b>(I)</b>.

524 </p>

525

526 <p>

527 </p><ul>

528 <li>If only <b>(R)</b> is set, these settings are effective for both regular

529 and incognito windows.</li>

530 <li>If only <b>(I)</b> is set, these settings are effective for only incognito

531 windows. Regular windows use the proxy settings determined by the lower layers

532 (command-line options and system settings).</li>

533 <li>If both <b>(R)</b> and <b>(I)</b> are set, the respective settings are

534 used for regular and incognito windows.</li>

535 </ul>

536 <p></p>

537

538 <p>

539 If two extensions want to set proxy settings, the extension installed last takes

540 precedence over the other extensions. If the extension installed last sets only

541 <b>(I)</b>, the settings of regular windows can be defined by more recently

542 installed extensions.

543 </p>

544

545

546

547 <h2 id="overview-examples">Examples</h2>

548

549 <p>

550 The following code sets a SOCKS 5 proxy for HTTP connections to all servers but

551 foobar.com and uses direct connections for all other protocols. The settings

552 apply to regular and incognito windows.

553 </p>

554

555 <pre>var config = {

556 mode: "fixed_servers",

557 rules: {

558 httpProxy: {

559 scheme: "socks5",

560 host: "1.2.3.4"

561 },

562 bypassList: ["foobar.com"]

563 }

564 };

565 chrome.experimental.proxy.settings.set(

566 {value: config, scope: 'regular'},

567 function() {});

568 </pre>

569

570 <p>

571 The following code sets a custom pac script.

572 </p>

573

574 <pre>var config = {

575 mode: "pac_script",

576 pacScript: {

577 data: "function FindProxyForURL(url, host) {\n" +

578 " if (host == 'foobar.com')\n" +

579 " return 'PROXY blackhole:80';\n" +

580 " return 'DIRECT';\n" +

581 "}"

582 }

583 };

584 chrome.experimental.proxy.settings.set(

585 {value: config, scope: 'regular'},

586 function() {});

587 </pre>

588

589 <p>

590 The next snippet queries the current proxy settings.

591 </p>

592

593 <pre>chrome.experimental.proxy.settings.get(

594 {'incognito': false},

595 function(config) {console.log(JSON.stringify(config));});

596 </pre>

597

598 <p>

599 Note that the <code>value</code> object passed to <code>set()</code> is not

600 identical to the <code>value</code> object passed to callback function of

601 <code>get()</code>. The latter will contain a <code>rules.httpProxy.port</code>

602 element.

603 </p>

604

605 <!-- END AUTHORED CONTENT -->

606 </div>

607

608 <!-- API PAGE -->

609 <div class="apiPage">

610 <a name="apiReference"></a>

611 <h2>API reference: chrome.experimental.proxy</h2>

612

613 <!-- PROPERTIES -->

614 <div class="apiGroup">

615 <a name="properties"></a>

616 <h3 id="properties">Properties</h3>

617

618 <div>

619 <a name="property-settings"></a>

620 <h4>settings</h4>

621 <div class="summary">

622 <!-- Note: intentionally longer 80 columns -->

623 <span>chrome.experimental.proxy.</span><span>settings</span>

624 </div>

625 <div>

626 <dt>

627 <var>settings</var>

628 <em>

629

630 <!-- TYPE -->

631 <div style="display:inline">

632 (

633 <span class="optional" style="display: none; ">optional</spa n>

634 <span class="enum" style="display: none; ">enumerated</span>

635 <span id="typeTemplate">

636 <span>

637 <a href="experimental.extension.html#type-Preference">Pr eference</a>

638 </span>

639 <span style="display: none; ">

640 <span>

641 array of <span><span></span></span>

642 </span>

643 <span>paramType</span>

644 <span></span>

645 </span>

646 </span>

647 )

648 </div>

649

650 </em>

651 </dt>

652 <dd class="todo" style="display: none; ">

653 Undocumented.

654 </dd>

655 <dd>Proxy settings to be used. The value of this preference is a Proxy Config object.</dd>

656 <dd style="display: none; ">

657 This parameter was added in version

658 <b><span></span></b>.

659 You must omit this parameter in earlier versions,

660 and you may omit it in any version. If you require this

661 parameter, the manifest key

662 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

663 can ensure that your extension won't be run in an earlier browser ve rsion.

664 </dd>

665

666 <!-- OBJECT PROPERTIES -->

667 <dd style="display: none; ">

668 <dl>

669 <div>

670 <div>

671 </div>

672 </div>

673 </dl>

674 </dd>

675

676 <!-- OBJECT METHODS -->

677 <dd style="display: none; ">

678 <div></div>

679 </dd>

680

681 <!-- OBJECT EVENT FIELDS -->

682 <dd style="display: none; ">

683 <div></div>

684 </dd>

685

686 <!-- FUNCTION PARAMETERS -->

687 <dd style="display: none; ">

688 <div></div>

689 </dd>

690

691 </div>

692 </div>

693

694 </div> <!-- /apiGroup -->

695

696 <!-- METHODS -->

697 <div id="methodsTemplate" class="apiGroup" style="display: none; ">

698 <a></a>

699 <h3>Methods</h3>

700

701 <!-- iterates over all functions -->

702 <div class="apiItem">

703 <a></a> <!-- method-anchor -->

704 <h4>method name</h4>

705

706 <div class="summary"><span>void</span>

707 <!-- Note: intentionally longer 80 columns -->

708 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>

709 <var><span></span></var></span>)</div>

710

711 <div class="description">

712 <p class="todo">Undocumented.</p>

713 <p>

714 A description from the json schema def of the function goes he re.

715 </p>

716

717 <!-- PARAMETERS -->

718 <h4>Parameters</h4>

719 <dl>

720 <div>

721 <div>

722 </div>

723 </div>

724 </dl>

725

726 <!-- RETURNS -->

727 <h4>Returns</h4>

728 <dl>

729 <div>

730 <div>

731 </div>

732 </div>

733 </dl>

734

735 <!-- CALLBACK -->

736 <div>

737 <div>

738 <h4>Callback function</h4>

739 <p>

740 The callback <em>parameter</em> should specify a function

741 that looks like this:

742 </p>

743 <p>

744 If you specify the <em>callback</em> parameter, it should

745 specify a function that looks like this:

746 </p>

747

748 <!-- Note: intentionally longer 80 columns -->

749 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>

750 <dl>

751 <div>

752 <div>

753 </div>

754 </div>

755 </dl>

756 </div>

757 </div>

758

759 <!-- MIN_VERSION -->

760 <p>

761 This function was added in version <b><span></span></b>.

762 If you require this function, the manifest key

763 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>

764 can ensure that your extension won't be run in an earlier brow ser version.

765 </p>

766 </div> <!-- /description -->

767

768 </div> <!-- /apiItem -->

769

770 </div> <!-- /apiGroup -->

771

772 <!-- EVENTS -->

773 <div id="eventsTemplate" class="apiGroup">

774 <a name="global-events"></a>

775 <h3>Events</h3>

776 <!-- iterates over all events -->

777 <div class="apiItem">

778 <a name="event-onProxyError"></a>

779 <h4>onProxyError</h4>

780

781 <div class="summary">

782 <!-- Note: intentionally longer 80 columns -->

783 <span class="subdued">chrome.experimental.proxy.</span><span>onP roxyError</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>));

784 </div>

785

786 <div class="description">

787 <p class="todo" style="display: none; ">Undocumented.</p>

788 <p>Notifies about proxy errors.</p>

789

790 <!-- LISTENER PARAMETERS -->

791 <div>

792 <h4>Listener parameters</h4>

793 <dl>

794 <div>

795 <div>

796 <dt>

797 <var>details</var>

798 <em>

799

800 <!-- TYPE -->

801 <div style="display:inline">

802 (

803 <span class="optional" style="display: none; ">optional</spa n>

804 <span class="enum" style="display: none; ">enumerated</span>

805 <span id="typeTemplate">

806 <span style="display: none; ">

807 <a> Type</a>

808 </span>

809 <span>

810 <span style="display: none; ">

811 array of <span><span></span></span>

812 </span>

813 <span>object</span>

814 <span style="display: none; "></span>

815 </span>

816 </span>

817 )

818 </div>

819

820 </em>

821 </dt>

822 <dd class="todo">

823 Undocumented.

824 </dd>

825 <dd style="display: none; ">

826 Description of this parameter from the json schema.

827 </dd>

828 <dd style="display: none; ">

829 This parameter was added in version

830 <b><span></span></b>.

831 You must omit this parameter in earlier versions,

832 and you may omit it in any version. If you require this

833 parameter, the manifest key

834 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

835 can ensure that your extension won't be run in an earlier browser ve rsion.

836 </dd>

837

838 <!-- OBJECT PROPERTIES -->

839 <dd>

840 <dl>

841 <div>

842 <div>

843 <dt>

844 <var>fatal</var>

845 <em>

846

847 <!-- TYPE -->

848 <div style="display:inline">

849 (

850 <span class="optional" style="display: none; ">optional</spa n>

851 <span class="enum" style="display: none; ">enumerated</span>

852 <span id="typeTemplate">

853 <span style="display: none; ">

854 <a> Type</a>

855 </span>

856 <span>

857 <span style="display: none; ">

858 array of <span><span></span></span>

859 </span>

860 <span>boolean</span>

861 <span style="display: none; "></span>

862 </span>

863 </span>

864 )

865 </div>

866

867 </em>

868 </dt>

869 <dd class="todo" style="display: none; ">

870 Undocumented.

871 </dd>

872 <dd>If true, the error was fatal and the network transaction was abort ed. Otherwise, a direct connection is used instead.</dd>

873 <dd style="display: none; ">

874 This parameter was added in version

875 <b><span></span></b>.

876 You must omit this parameter in earlier versions,

877 and you may omit it in any version. If you require this

878 parameter, the manifest key

879 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

880 can ensure that your extension won't be run in an earlier browser ve rsion.

881 </dd>

882

883 <!-- OBJECT PROPERTIES -->

884 <dd style="display: none; ">

885 <dl>

886 <div>

887 <div>

888 </div>

889 </div>

890 </dl>

891 </dd>

892

893 <!-- OBJECT METHODS -->

894 <dd style="display: none; ">

895 <div></div>

896 </dd>

897

898 <!-- OBJECT EVENT FIELDS -->

899 <dd style="display: none; ">

900 <div></div>

901 </dd>

902

903 <!-- FUNCTION PARAMETERS -->

904 <dd style="display: none; ">

905 <div></div>

906 </dd>

907

908 </div>

909 </div><div>

910 <div>

911 <dt>

912 <var>error</var>

913 <em>

914

915 <!-- TYPE -->

916 <div style="display:inline">

917 (

918 <span class="optional" style="display: none; ">optional</spa n>

919 <span class="enum" style="display: none; ">enumerated</span>

920 <span id="typeTemplate">

921 <span style="display: none; ">

922 <a> Type</a>

923 </span>

924 <span>

925 <span style="display: none; ">

926 array of <span><span></span></span>

927 </span>

928 <span>string</span>

929 <span style="display: none; "></span>

930 </span>

931 </span>

932 )

933 </div>

934

935 </em>

936 </dt>

937 <dd class="todo" style="display: none; ">

938 Undocumented.

939 </dd>

940 <dd>The error description.</dd>

941 <dd style="display: none; ">

942 This parameter was added in version

943 <b><span></span></b>.

944 You must omit this parameter in earlier versions,

945 and you may omit it in any version. If you require this

946 parameter, the manifest key

947 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

948 can ensure that your extension won't be run in an earlier browser ve rsion.

949 </dd>

950

951 <!-- OBJECT PROPERTIES -->

952 <dd style="display: none; ">

953 <dl>

954 <div>

955 <div>

956 </div>

957 </div>

958 </dl>

959 </dd>

960

961 <!-- OBJECT METHODS -->

962 <dd style="display: none; ">

963 <div></div>

964 </dd>

965

966 <!-- OBJECT EVENT FIELDS -->

967 <dd style="display: none; ">

968 <div></div>

969 </dd>

970

971 <!-- FUNCTION PARAMETERS -->

972 <dd style="display: none; ">

973 <div></div>

974 </dd>

975

976 </div>

977 </div><div>

978 <div>

979 <dt>

980 <var>details</var>

981 <em>

982

983 <!-- TYPE -->

984 <div style="display:inline">

985 (

986 <span class="optional" style="display: none; ">optional</spa n>

987 <span class="enum" style="display: none; ">enumerated</span>

988 <span id="typeTemplate">

989 <span style="display: none; ">

990 <a> Type</a>

991 </span>

992 <span>

993 <span style="display: none; ">

994 array of <span><span></span></span>

995 </span>

996 <span>string</span>

997 <span style="display: none; "></span>

998 </span>

999 </span>

1000 )

1001 </div>

1002

1003 </em>

1004 </dt>

1005 <dd class="todo" style="display: none; ">

1006 Undocumented.

1007 </dd>

1008 <dd>Additional details about the error such as a JavaScript runtime er ror.</dd>

1009 <dd style="display: none; ">

1010 This parameter was added in version

1011 <b><span></span></b>.

1012 You must omit this parameter in earlier versions,

1013 and you may omit it in any version. If you require this

1014 parameter, the manifest key

1015 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1016 can ensure that your extension won't be run in an earlier browser ve rsion.

1017 </dd>

1018

1019 <!-- OBJECT PROPERTIES -->

1020 <dd style="display: none; ">

1021 <dl>

1022 <div>

1023 <div>

1024 </div>

1025 </div>

1026 </dl>

1027 </dd>

1028

1029 <!-- OBJECT METHODS -->

1030 <dd style="display: none; ">

1031 <div></div>

1032 </dd>

1033

1034 <!-- OBJECT EVENT FIELDS -->

1035 <dd style="display: none; ">

1036 <div></div>

1037 </dd>

1038

1039 <!-- FUNCTION PARAMETERS -->

1040 <dd style="display: none; ">

1041 <div></div>

1042 </dd>

1043

1044 </div>

1045 </div>

1046 </dl>

1047 </dd>

1048

1049 <!-- OBJECT METHODS -->

1050 <dd style="display: none; ">

1051 <div></div>

1052 </dd>

1053

1054 <!-- OBJECT EVENT FIELDS -->

1055 <dd style="display: none; ">

1056 <div></div>

1057 </dd>

1058

1059 <!-- FUNCTION PARAMETERS -->

1060 <dd style="display: none; ">

1061 <div></div>

1062 </dd>

1063

1064 </div>

1065 </div>

1066 </dl>

1067 </div>

1068

1069 <!-- EXTRA PARAMETERS -->

1070 <div style="display: none; ">

1071 <h4>Extra parameters to addListener</h4>

1072 <dl>

1073 <div>

1074 <div>

1075 </div>

1076 </div>

1077 </dl>

1078 </div>

1079

1080 <!-- LISTENER RETURN VALUE -->

1081 <h4 style="display: none; ">Listener returns</h4>

1082 <dl>

1083 <div style="display: none; ">

1084 <div>

1085 </div>

1086 </div>

1087 </dl>

1088

1089 </div> <!-- /description -->

1090 </div> <!-- /apiItem -->

1091

1092 </div> <!-- /apiGroup -->

1093

1094 <!-- TYPES -->

1095 <div class="apiGroup">

1096 <a name="types"></a>

1097 <h3 id="types">Types</h3>

1098

1099 <!-- iterates over all types -->

1100 <div class="apiItem">

1101 <a name="type-ProxyServer"></a>

1102 <h4>ProxyServer</h4>

1103

1104 <div>

1105 <dt>

1106 <var style="display: none; ">paramName</var>

1107 <em>

1108

1109 <!-- TYPE -->

1110 <div style="display:inline">

1111 (

1112 <span class="optional" style="display: none; ">optional</spa n>

1113 <span class="enum" style="display: none; ">enumerated</span>

1114 <span id="typeTemplate">

1115 <span style="display: none; ">

1116 <a> Type</a>

1117 </span>

1118 <span>

1119 <span style="display: none; ">

1120 array of <span><span></span></span>

1121 </span>

1122 <span>object</span>

1123 <span style="display: none; "></span>

1124 </span>

1125 </span>

1126 )

1127 </div>

1128

1129 </em>

1130 </dt>

1131 <dd class="todo" style="display: none; ">

1132 Undocumented.

1133 </dd>

1134 <dd>An object encapsulating a single proxy server's specification.</dd >

1135 <dd style="display: none; ">

1136 This parameter was added in version

1137 <b><span></span></b>.

1138 You must omit this parameter in earlier versions,

1139 and you may omit it in any version. If you require this

1140 parameter, the manifest key

1141 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1142 can ensure that your extension won't be run in an earlier browser ve rsion.

1143 </dd>

1144

1145 <!-- OBJECT PROPERTIES -->

1146 <dd>

1147 <dl>

1148 <div>

1149 <div>

1150 <dt>

1151 <var>scheme</var>

1152 <em>

1153

1154 <!-- TYPE -->

1155 <div style="display:inline">

1156 (

1157 <span class="optional">optional</span>

1158 <span class="enum">enumerated</span>

1159 <span id="typeTemplate">

1160 <span style="display: none; ">

1161 <a> Type</a>

1162 </span>

1163 <span>

1164 <span style="display: none; ">

1165 array of <span><span></span></span>

1166 </span>

1167 <span>string</span>

1168 <span>["http", "https", "socks4", "socks5"]</span>

1169 </span>

1170 </span>

1171 )

1172 </div>

1173

1174 </em>

1175 </dt>

1176 <dd class="todo" style="display: none; ">

1177 Undocumented.

1178 </dd>

1179 <dd>The scheme (protocol) of the proxy server itself. Defaults to 'htt p'.</dd>

1180 <dd style="display: none; ">

1181 This parameter was added in version

1182 <b><span></span></b>.

1183 You must omit this parameter in earlier versions,

1184 and you may omit it in any version. If you require this

1185 parameter, the manifest key

1186 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1187 can ensure that your extension won't be run in an earlier browser ve rsion.

1188 </dd>

1189

1190 <!-- OBJECT PROPERTIES -->

1191 <dd style="display: none; ">

1192 <dl>

1193 <div>

1194 <div>

1195 </div>

1196 </div>

1197 </dl>

1198 </dd>

1199

1200 <!-- OBJECT METHODS -->

1201 <dd style="display: none; ">

1202 <div></div>

1203 </dd>

1204

1205 <!-- OBJECT EVENT FIELDS -->

1206 <dd style="display: none; ">

1207 <div></div>

1208 </dd>

1209

1210 <!-- FUNCTION PARAMETERS -->

1211 <dd style="display: none; ">

1212 <div></div>

1213 </dd>

1214

1215 </div>

1216 </div><div>

1217 <div>

1218 <dt>

1219 <var>host</var>

1220 <em>

1221

1222 <!-- TYPE -->

1223 <div style="display:inline">

1224 (

1225 <span class="optional" style="display: none; ">optional</spa n>

1226 <span class="enum" style="display: none; ">enumerated</span>

1227 <span id="typeTemplate">

1228 <span style="display: none; ">

1229 <a> Type</a>

1230 </span>

1231 <span>

1232 <span style="display: none; ">

1233 array of <span><span></span></span>

1234 </span>

1235 <span>string</span>

1236 <span style="display: none; "></span>

1237 </span>

1238 </span>

1239 )

1240 </div>

1241

1242 </em>

1243 </dt>

1244 <dd class="todo" style="display: none; ">

1245 Undocumented.

1246 </dd>

1247 <dd>The URI of the proxy server. This must be an ASCII hostname (in Pu nycode format). IDNA is not supported, yet.</dd>

1248 <dd style="display: none; ">

1249 This parameter was added in version

1250 <b><span></span></b>.

1251 You must omit this parameter in earlier versions,

1252 and you may omit it in any version. If you require this

1253 parameter, the manifest key

1254 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1255 can ensure that your extension won't be run in an earlier browser ve rsion.

1256 </dd>

1257

1258 <!-- OBJECT PROPERTIES -->

1259 <dd style="display: none; ">

1260 <dl>

1261 <div>

1262 <div>

1263 </div>

1264 </div>

1265 </dl>

1266 </dd>

1267

1268 <!-- OBJECT METHODS -->

1269 <dd style="display: none; ">

1270 <div></div>

1271 </dd>

1272

1273 <!-- OBJECT EVENT FIELDS -->

1274 <dd style="display: none; ">

1275 <div></div>

1276 </dd>

1277

1278 <!-- FUNCTION PARAMETERS -->

1279 <dd style="display: none; ">

1280 <div></div>

1281 </dd>

1282

1283 </div>

1284 </div><div>

1285 <div>

1286 <dt>

1287 <var>port</var>

1288 <em>

1289

1290 <!-- TYPE -->

1291 <div style="display:inline">

1292 (

1293 <span class="optional">optional</span>

1294 <span class="enum" style="display: none; ">enumerated</span>

1295 <span id="typeTemplate">

1296 <span style="display: none; ">

1297 <a> Type</a>

1298 </span>

1299 <span>

1300 <span style="display: none; ">

1301 array of <span><span></span></span>

1302 </span>

1303 <span>integer</span>

1304 <span style="display: none; "></span>

1305 </span>

1306 </span>

1307 )

1308 </div>

1309

1310 </em>

1311 </dt>

1312 <dd class="todo" style="display: none; ">

1313 Undocumented.

1314 </dd>

1315 <dd>The port of the proxy server. Defaults to a port that depends on t he scheme.</dd>

1316 <dd style="display: none; ">

1317 This parameter was added in version

1318 <b><span></span></b>.

1319 You must omit this parameter in earlier versions,

1320 and you may omit it in any version. If you require this

1321 parameter, the manifest key

1322 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1323 can ensure that your extension won't be run in an earlier browser ve rsion.

1324 </dd>

1325

1326 <!-- OBJECT PROPERTIES -->

1327 <dd style="display: none; ">

1328 <dl>

1329 <div>

1330 <div>

1331 </div>

1332 </div>

1333 </dl>

1334 </dd>

1335

1336 <!-- OBJECT METHODS -->

1337 <dd style="display: none; ">

1338 <div></div>

1339 </dd>

1340

1341 <!-- OBJECT EVENT FIELDS -->

1342 <dd style="display: none; ">

1343 <div></div>

1344 </dd>

1345

1346 <!-- FUNCTION PARAMETERS -->

1347 <dd style="display: none; ">

1348 <div></div>

1349 </dd>

1350

1351 </div>

1352 </div>

1353 </dl>

1354 </dd>

1355

1356 <!-- OBJECT METHODS -->

1357 <dd style="display: none; ">

1358 <div></div>

1359 </dd>

1360

1361 <!-- OBJECT EVENT FIELDS -->

1362 <dd style="display: none; ">

1363 <div></div>

1364 </dd>

1365

1366 <!-- FUNCTION PARAMETERS -->

1367 <dd style="display: none; ">

1368 <div></div>

1369 </dd>

1370

1371 </div>

1372

1373 </div><div class="apiItem">

1374 <a name="type-ProxyRules"></a>

1375 <h4>ProxyRules</h4>

1376

1377 <div>

1378 <dt>

1379 <var style="display: none; ">paramName</var>

1380 <em>

1381

1382 <!-- TYPE -->

1383 <div style="display:inline">

1384 (

1385 <span class="optional" style="display: none; ">optional</spa n>

1386 <span class="enum" style="display: none; ">enumerated</span>

1387 <span id="typeTemplate">

1388 <span style="display: none; ">

1389 <a> Type</a>

1390 </span>

1391 <span>

1392 <span style="display: none; ">

1393 array of <span><span></span></span>

1394 </span>

1395 <span>object</span>

1396 <span style="display: none; "></span>

1397 </span>

1398 </span>

1399 )

1400 </div>

1401

1402 </em>

1403 </dt>

1404 <dd class="todo" style="display: none; ">

1405 Undocumented.

1406 </dd>

1407 <dd>An object encapsulating the set of proxy rules for all protocols. Use either 'singleProxy' or (a subset of) 'proxyForHttp', 'proxyForHttps', 'prox yForFtp' and 'fallbackProxy'.</dd>

1408 <dd style="display: none; ">

1409 This parameter was added in version

1410 <b><span></span></b>.

1411 You must omit this parameter in earlier versions,

1412 and you may omit it in any version. If you require this

1413 parameter, the manifest key

1414 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1415 can ensure that your extension won't be run in an earlier browser ve rsion.

1416 </dd>

1417

1418 <!-- OBJECT PROPERTIES -->

1419 <dd>

1420 <dl>

1421 <div>

1422 <div>

1423 <dt>

1424 <var>singleProxy</var>

1425 <em>

1426

1427 <!-- TYPE -->

1428 <div style="display:inline">

1429 (

1430 <span class="optional">optional</span>

1431 <span class="enum" style="display: none; ">enumerated</span>

1432 <span id="typeTemplate">

1433 <span>

1434 <a href="experimental.proxy.html#type-ProxyServer">Proxy Server</a>

1435 </span>

1436 <span style="display: none; ">

1437 <span>

1438 array of <span><span></span></span>

1439 </span>

1440 <span>paramType</span>

1441 <span></span>

1442 </span>

1443 </span>

1444 )

1445 </div>

1446

1447 </em>

1448 </dt>

1449 <dd class="todo" style="display: none; ">

1450 Undocumented.

1451 </dd>

1452 <dd>The proxy server to be used for all per-URL requests (that is http , https, and ftp).</dd>

1453 <dd style="display: none; ">

1454 This parameter was added in version

1455 <b><span></span></b>.

1456 You must omit this parameter in earlier versions,

1457 and you may omit it in any version. If you require this

1458 parameter, the manifest key

1459 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1460 can ensure that your extension won't be run in an earlier browser ve rsion.

1461 </dd>

1462

1463 <!-- OBJECT PROPERTIES -->

1464 <dd style="display: none; ">

1465 <dl>

1466 <div>

1467 <div>

1468 </div>

1469 </div>

1470 </dl>

1471 </dd>

1472

1473 <!-- OBJECT METHODS -->

1474 <dd style="display: none; ">

1475 <div></div>

1476 </dd>

1477

1478 <!-- OBJECT EVENT FIELDS -->

1479 <dd style="display: none; ">

1480 <div></div>

1481 </dd>

1482

1483 <!-- FUNCTION PARAMETERS -->

1484 <dd style="display: none; ">

1485 <div></div>

1486 </dd>

1487

1488 </div>

1489 </div><div>

1490 <div>

1491 <dt>

1492 <var>proxyForHttp</var>

1493 <em>

1494

1495 <!-- TYPE -->

1496 <div style="display:inline">

1497 (

1498 <span class="optional">optional</span>

1499 <span class="enum" style="display: none; ">enumerated</span>

1500 <span id="typeTemplate">

1501 <span>

1502 <a href="experimental.proxy.html#type-ProxyServer">Proxy Server</a>

1503 </span>

1504 <span style="display: none; ">

1505 <span>

1506 array of <span><span></span></span>

1507 </span>

1508 <span>paramType</span>

1509 <span></span>

1510 </span>

1511 </span>

1512 )

1513 </div>

1514

1515 </em>

1516 </dt>

1517 <dd class="todo" style="display: none; ">

1518 Undocumented.

1519 </dd>

1520 <dd>The proxy server to be used for HTTP requests.</dd>

1521 <dd style="display: none; ">

1522 This parameter was added in version

1523 <b><span></span></b>.

1524 You must omit this parameter in earlier versions,

1525 and you may omit it in any version. If you require this

1526 parameter, the manifest key

1527 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1528 can ensure that your extension won't be run in an earlier browser ve rsion.

1529 </dd>

1530

1531 <!-- OBJECT PROPERTIES -->

1532 <dd style="display: none; ">

1533 <dl>

1534 <div>

1535 <div>

1536 </div>

1537 </div>

1538 </dl>

1539 </dd>

1540

1541 <!-- OBJECT METHODS -->

1542 <dd style="display: none; ">

1543 <div></div>

1544 </dd>

1545

1546 <!-- OBJECT EVENT FIELDS -->

1547 <dd style="display: none; ">

1548 <div></div>

1549 </dd>

1550

1551 <!-- FUNCTION PARAMETERS -->

1552 <dd style="display: none; ">

1553 <div></div>

1554 </dd>

1555

1556 </div>

1557 </div><div>

1558 <div>

1559 <dt>

1560 <var>proxyForHttps</var>

1561 <em>

1562

1563 <!-- TYPE -->

1564 <div style="display:inline">

1565 (

1566 <span class="optional">optional</span>

1567 <span class="enum" style="display: none; ">enumerated</span>

1568 <span id="typeTemplate">

1569 <span>

1570 <a href="experimental.proxy.html#type-ProxyServer">Proxy Server</a>

1571 </span>

1572 <span style="display: none; ">

1573 <span>

1574 array of <span><span></span></span>

1575 </span>

1576 <span>paramType</span>

1577 <span></span>

1578 </span>

1579 </span>

1580 )

1581 </div>

1582

1583 </em>

1584 </dt>

1585 <dd class="todo" style="display: none; ">

1586 Undocumented.

1587 </dd>

1588 <dd>The proxy server to be used for HTTPS requests.</dd>

1589 <dd style="display: none; ">

1590 This parameter was added in version

1591 <b><span></span></b>.

1592 You must omit this parameter in earlier versions,

1593 and you may omit it in any version. If you require this

1594 parameter, the manifest key

1595 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1596 can ensure that your extension won't be run in an earlier browser ve rsion.

1597 </dd>

1598

1599 <!-- OBJECT PROPERTIES -->

1600 <dd style="display: none; ">

1601 <dl>

1602 <div>

1603 <div>

1604 </div>

1605 </div>

1606 </dl>

1607 </dd>

1608

1609 <!-- OBJECT METHODS -->

1610 <dd style="display: none; ">

1611 <div></div>

1612 </dd>

1613

1614 <!-- OBJECT EVENT FIELDS -->

1615 <dd style="display: none; ">

1616 <div></div>

1617 </dd>

1618

1619 <!-- FUNCTION PARAMETERS -->

1620 <dd style="display: none; ">

1621 <div></div>

1622 </dd>

1623

1624 </div>

1625 </div><div>

1626 <div>

1627 <dt>

1628 <var>proxyForFtp</var>

1629 <em>

1630

1631 <!-- TYPE -->

1632 <div style="display:inline">

1633 (

1634 <span class="optional">optional</span>

1635 <span class="enum" style="display: none; ">enumerated</span>

1636 <span id="typeTemplate">

1637 <span>

1638 <a href="experimental.proxy.html#type-ProxyServer">Proxy Server</a>

1639 </span>

1640 <span style="display: none; ">

1641 <span>

1642 array of <span><span></span></span>

1643 </span>

1644 <span>paramType</span>

1645 <span></span>

1646 </span>

1647 </span>

1648 )

1649 </div>

1650

1651 </em>

1652 </dt>

1653 <dd class="todo" style="display: none; ">

1654 Undocumented.

1655 </dd>

1656 <dd>The proxy server to be used for FTP requests.</dd>

1657 <dd style="display: none; ">

1658 This parameter was added in version

1659 <b><span></span></b>.

1660 You must omit this parameter in earlier versions,

1661 and you may omit it in any version. If you require this

1662 parameter, the manifest key

1663 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1664 can ensure that your extension won't be run in an earlier browser ve rsion.

1665 </dd>

1666

1667 <!-- OBJECT PROPERTIES -->

1668 <dd style="display: none; ">

1669 <dl>

1670 <div>

1671 <div>

1672 </div>

1673 </div>

1674 </dl>

1675 </dd>

1676

1677 <!-- OBJECT METHODS -->

1678 <dd style="display: none; ">

1679 <div></div>

1680 </dd>

1681

1682 <!-- OBJECT EVENT FIELDS -->

1683 <dd style="display: none; ">

1684 <div></div>

1685 </dd>

1686

1687 <!-- FUNCTION PARAMETERS -->

1688 <dd style="display: none; ">

1689 <div></div>

1690 </dd>

1691

1692 </div>

1693 </div><div>

1694 <div>

1695 <dt>

1696 <var>fallbackProxy</var>

1697 <em>

1698

1699 <!-- TYPE -->

1700 <div style="display:inline">

1701 (

1702 <span class="optional">optional</span>

1703 <span class="enum" style="display: none; ">enumerated</span>

1704 <span id="typeTemplate">

1705 <span>

1706 <a href="experimental.proxy.html#type-ProxyServer">Proxy Server</a>

1707 </span>

1708 <span style="display: none; ">

1709 <span>

1710 array of <span><span></span></span>

1711 </span>

1712 <span>paramType</span>

1713 <span></span>

1714 </span>

1715 </span>

1716 )

1717 </div>

1718

1719 </em>

1720 </dt>

1721 <dd class="todo" style="display: none; ">

1722 Undocumented.

1723 </dd>

1724 <dd>The proxy server to be used for everthing else or if any of the sp ecific proxyFor... is not specified.</dd>

1725 <dd style="display: none; ">

1726 This parameter was added in version

1727 <b><span></span></b>.

1728 You must omit this parameter in earlier versions,

1729 and you may omit it in any version. If you require this

1730 parameter, the manifest key

1731 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1732 can ensure that your extension won't be run in an earlier browser ve rsion.

1733 </dd>

1734

1735 <!-- OBJECT PROPERTIES -->

1736 <dd style="display: none; ">

1737 <dl>

1738 <div>

1739 <div>

1740 </div>

1741 </div>

1742 </dl>

1743 </dd>

1744

1745 <!-- OBJECT METHODS -->

1746 <dd style="display: none; ">

1747 <div></div>

1748 </dd>

1749

1750 <!-- OBJECT EVENT FIELDS -->

1751 <dd style="display: none; ">

1752 <div></div>

1753 </dd>

1754

1755 <!-- FUNCTION PARAMETERS -->

1756 <dd style="display: none; ">

1757 <div></div>

1758 </dd>

1759

1760 </div>

1761 </div><div>

1762 <div>

1763 <dt>

1764 <var>bypassList</var>

1765 <em>

1766

1767 <!-- TYPE -->

1768 <div style="display:inline">

1769 (

1770 <span class="optional">optional</span>

1771 <span class="enum" style="display: none; ">enumerated</span>

1772 <span id="typeTemplate">

1773 <span style="display: none; ">

1774 <a> Type</a>

1775 </span>

1776 <span>

1777 <span>

1778 array of <span><span>

1779 <span style="display: none; ">

1780 <a> Type</a>

1781 </span>

1782 <span>

1783 <span style="display: none; ">

1784 array of <span><span></span></span>

1785 </span>

1786 <span>string</span>

1787 <span style="display: none; "></span>

1788 </span>

1789 </span></span>

1790 </span>

1791 <span style="display: none; ">paramType</span>

1792 <span style="display: none; "></span>

1793 </span>

1794 </span>

1795 )

1796 </div>

1797

1798 </em>

1799 </dt>

1800 <dd class="todo" style="display: none; ">

1801 Undocumented.

1802 </dd>

1803 <dd>List of servers to connect to without a proxy server.</dd>

1804 <dd style="display: none; ">

1805 This parameter was added in version

1806 <b><span></span></b>.

1807 You must omit this parameter in earlier versions,

1808 and you may omit it in any version. If you require this

1809 parameter, the manifest key

1810 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1811 can ensure that your extension won't be run in an earlier browser ve rsion.

1812 </dd>

1813

1814 <!-- OBJECT PROPERTIES -->

1815 <dd style="display: none; ">

1816 <dl>

1817 <div>

1818 <div>

1819 </div>

1820 </div>

1821 </dl>

1822 </dd>

1823

1824 <!-- OBJECT METHODS -->

1825 <dd style="display: none; ">

1826 <div></div>

1827 </dd>

1828

1829 <!-- OBJECT EVENT FIELDS -->

1830 <dd style="display: none; ">

1831 <div></div>

1832 </dd>

1833

1834 <!-- FUNCTION PARAMETERS -->

1835 <dd style="display: none; ">

1836 <div></div>

1837 </dd>

1838

1839 </div>

1840 </div>

1841 </dl>

1842 </dd>

1843

1844 <!-- OBJECT METHODS -->

1845 <dd style="display: none; ">

1846 <div></div>

1847 </dd>

1848

1849 <!-- OBJECT EVENT FIELDS -->

1850 <dd style="display: none; ">

1851 <div></div>

1852 </dd>

1853

1854 <!-- FUNCTION PARAMETERS -->

1855 <dd style="display: none; ">

1856 <div></div>

1857 </dd>

1858

1859 </div>

1860

1861 </div><div class="apiItem">

1862 <a name="type-PacScript"></a>

1863 <h4>PacScript</h4>

1864

1865 <div>

1866 <dt>

1867 <var style="display: none; ">paramName</var>

1868 <em>

1869

1870 <!-- TYPE -->

1871 <div style="display:inline">

1872 (

1873 <span class="optional" style="display: none; ">optional</spa n>

1874 <span class="enum" style="display: none; ">enumerated</span>

1875 <span id="typeTemplate">

1876 <span style="display: none; ">

1877 <a> Type</a>

1878 </span>

1879 <span>

1880 <span style="display: none; ">

1881 array of <span><span></span></span>

1882 </span>

1883 <span>object</span>

1884 <span style="display: none; "></span>

1885 </span>

1886 </span>

1887 )

1888 </div>

1889

1890 </em>

1891 </dt>

1892 <dd class="todo" style="display: none; ">

1893 Undocumented.

1894 </dd>

1895 <dd>An object holding proxy auto-config information. Exactly one of th e fields should be non-empty.</dd>

1896 <dd style="display: none; ">

1897 This parameter was added in version

1898 <b><span></span></b>.

1899 You must omit this parameter in earlier versions,

1900 and you may omit it in any version. If you require this

1901 parameter, the manifest key

1902 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1903 can ensure that your extension won't be run in an earlier browser ve rsion.

1904 </dd>

1905

1906 <!-- OBJECT PROPERTIES -->

1907 <dd>

1908 <dl>

1909 <div>

1910 <div>

1911 <dt>

1912 <var>url</var>

1913 <em>

1914

1915 <!-- TYPE -->

1916 <div style="display:inline">

1917 (

1918 <span class="optional">optional</span>

1919 <span class="enum" style="display: none; ">enumerated</span>

1920 <span id="typeTemplate">

1921 <span style="display: none; ">

1922 <a> Type</a>

1923 </span>

1924 <span>

1925 <span style="display: none; ">

1926 array of <span><span></span></span>

1927 </span>

1928 <span>string</span>

1929 <span style="display: none; "></span>

1930 </span>

1931 </span>

1932 )

1933 </div>

1934

1935 </em>

1936 </dt>

1937 <dd class="todo" style="display: none; ">

1938 Undocumented.

1939 </dd>

1940 <dd>URL of the PAC file to be used.</dd>

1941 <dd style="display: none; ">

1942 This parameter was added in version

1943 <b><span></span></b>.

1944 You must omit this parameter in earlier versions,

1945 and you may omit it in any version. If you require this

1946 parameter, the manifest key

1947 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1948 can ensure that your extension won't be run in an earlier browser ve rsion.

1949 </dd>

1950

1951 <!-- OBJECT PROPERTIES -->

1952 <dd style="display: none; ">

1953 <dl>

1954 <div>

1955 <div>

1956 </div>

1957 </div>

1958 </dl>

1959 </dd>

1960

1961 <!-- OBJECT METHODS -->

1962 <dd style="display: none; ">

1963 <div></div>

1964 </dd>

1965

1966 <!-- OBJECT EVENT FIELDS -->

1967 <dd style="display: none; ">

1968 <div></div>

1969 </dd>

1970

1971 <!-- FUNCTION PARAMETERS -->

1972 <dd style="display: none; ">

1973 <div></div>

1974 </dd>

1975

1976 </div>

1977 </div><div>

1978 <div>

1979 <dt>

1980 <var>data</var>

1981 <em>

1982

1983 <!-- TYPE -->

1984 <div style="display:inline">

1985 (

1986 <span class="optional">optional</span>

1987 <span class="enum" style="display: none; ">enumerated</span>

1988 <span id="typeTemplate">

1989 <span style="display: none; ">

1990 <a> Type</a>

1991 </span>

1992 <span>

1993 <span style="display: none; ">

1994 array of <span><span></span></span>

1995 </span>

1996 <span>string</span>

1997 <span style="display: none; "></span>

1998 </span>

1999 </span>

2000 )

2001 </div>

2002

2003 </em>

2004 </dt>

2005 <dd class="todo" style="display: none; ">

2006 Undocumented.

2007 </dd>

2008 <dd>A PAC script.</dd>

2009 <dd style="display: none; ">

2010 This parameter was added in version

2011 <b><span></span></b>.

2012 You must omit this parameter in earlier versions,

2013 and you may omit it in any version. If you require this

2014 parameter, the manifest key

2015 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2016 can ensure that your extension won't be run in an earlier browser ve rsion.

2017 </dd>

2018

2019 <!-- OBJECT PROPERTIES -->

2020 <dd style="display: none; ">

2021 <dl>

2022 <div>

2023 <div>

2024 </div>

2025 </div>

2026 </dl>

2027 </dd>

2028

2029 <!-- OBJECT METHODS -->

2030 <dd style="display: none; ">

2031 <div></div>

2032 </dd>

2033

2034 <!-- OBJECT EVENT FIELDS -->

2035 <dd style="display: none; ">

2036 <div></div>

2037 </dd>

2038

2039 <!-- FUNCTION PARAMETERS -->

2040 <dd style="display: none; ">

2041 <div></div>

2042 </dd>

2043

2044 </div>

2045 </div><div>

2046 <div>

2047 <dt>

2048 <var>mandatory</var>

2049 <em>

2050

2051 <!-- TYPE -->

2052 <div style="display:inline">

2053 (

2054 <span class="optional">optional</span>

2055 <span class="enum" style="display: none; ">enumerated</span>

2056 <span id="typeTemplate">

2057 <span style="display: none; ">

2058 <a> Type</a>

2059 </span>

2060 <span>

2061 <span style="display: none; ">

2062 array of <span><span></span></span>

2063 </span>

2064 <span>boolean</span>

2065 <span style="display: none; "></span>

2066 </span>

2067 </span>

2068 )

2069 </div>

2070

2071 </em>

2072 </dt>

2073 <dd class="todo" style="display: none; ">

2074 Undocumented.

2075 </dd>

2076 <dd>If true, an invalid PAC script will prevent the network stack from falling back to direct connections. Defaults to false.</dd>

2077 <dd style="display: none; ">

2078 This parameter was added in version

2079 <b><span></span></b>.

2080 You must omit this parameter in earlier versions,

2081 and you may omit it in any version. If you require this

2082 parameter, the manifest key

2083 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2084 can ensure that your extension won't be run in an earlier browser ve rsion.

2085 </dd>

2086

2087 <!-- OBJECT PROPERTIES -->

2088 <dd style="display: none; ">

2089 <dl>

2090 <div>

2091 <div>

2092 </div>

2093 </div>

2094 </dl>

2095 </dd>

2096

2097 <!-- OBJECT METHODS -->

2098 <dd style="display: none; ">

2099 <div></div>

2100 </dd>

2101

2102 <!-- OBJECT EVENT FIELDS -->

2103 <dd style="display: none; ">

2104 <div></div>

2105 </dd>

2106

2107 <!-- FUNCTION PARAMETERS -->

2108 <dd style="display: none; ">

2109 <div></div>

2110 </dd>

2111

2112 </div>

2113 </div>

2114 </dl>

2115 </dd>

2116

2117 <!-- OBJECT METHODS -->

2118 <dd style="display: none; ">

2119 <div></div>

2120 </dd>

2121

2122 <!-- OBJECT EVENT FIELDS -->

2123 <dd style="display: none; ">

2124 <div></div>

2125 </dd>

2126

2127 <!-- FUNCTION PARAMETERS -->

2128 <dd style="display: none; ">

2129 <div></div>

2130 </dd>

2131

2132 </div>

2133

2134 </div><div class="apiItem">

2135 <a name="type-ProxyConfig"></a>

2136 <h4>ProxyConfig</h4>

2137

2138 <div>

2139 <dt>

2140 <var style="display: none; ">paramName</var>

2141 <em>

2142

2143 <!-- TYPE -->

2144 <div style="display:inline">

2145 (

2146 <span class="optional" style="display: none; ">optional</spa n>

2147 <span class="enum" style="display: none; ">enumerated</span>

2148 <span id="typeTemplate">

2149 <span style="display: none; ">

2150 <a> Type</a>

2151 </span>

2152 <span>

2153 <span style="display: none; ">

2154 array of <span><span></span></span>

2155 </span>

2156 <span>object</span>

2157 <span style="display: none; "></span>

2158 </span>

2159 </span>

2160 )

2161 </div>

2162

2163 </em>

2164 </dt>

2165 <dd class="todo" style="display: none; ">

2166 Undocumented.

2167 </dd>

2168 <dd>An object encapsulating a complete proxy configuration.</dd>

2169 <dd style="display: none; ">

2170 This parameter was added in version

2171 <b><span></span></b>.

2172 You must omit this parameter in earlier versions,

2173 and you may omit it in any version. If you require this

2174 parameter, the manifest key

2175 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2176 can ensure that your extension won't be run in an earlier browser ve rsion.

2177 </dd>

2178

2179 <!-- OBJECT PROPERTIES -->

2180 <dd>

2181 <dl>

2182 <div>

2183 <div>

2184 <dt>

2185 <var>rules</var>

2186 <em>

2187

2188 <!-- TYPE -->

2189 <div style="display:inline">

2190 (

2191 <span class="optional">optional</span>

2192 <span class="enum" style="display: none; ">enumerated</span>

2193 <span id="typeTemplate">

2194 <span>

2195 <a href="experimental.proxy.html#type-ProxyRules">ProxyR ules</a>

2196 </span>

2197 <span style="display: none; ">

2198 <span>

2199 array of <span><span></span></span>

2200 </span>

2201 <span>paramType</span>

2202 <span></span>

2203 </span>

2204 </span>

2205 )

2206 </div>

2207

2208 </em>

2209 </dt>

2210 <dd class="todo" style="display: none; ">

2211 Undocumented.

2212 </dd>

2213 <dd>The proxy rules describing this configuration. Use this for 'fixed _servers' mode.</dd>

2214 <dd style="display: none; ">

2215 This parameter was added in version

2216 <b><span></span></b>.

2217 You must omit this parameter in earlier versions,

2218 and you may omit it in any version. If you require this

2219 parameter, the manifest key

2220 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2221 can ensure that your extension won't be run in an earlier browser ve rsion.

2222 </dd>

2223

2224 <!-- OBJECT PROPERTIES -->

2225 <dd style="display: none; ">

2226 <dl>

2227 <div>

2228 <div>

2229 </div>

2230 </div>

2231 </dl>

2232 </dd>

2233

2234 <!-- OBJECT METHODS -->

2235 <dd style="display: none; ">

2236 <div></div>

2237 </dd>

2238

2239 <!-- OBJECT EVENT FIELDS -->

2240 <dd style="display: none; ">

2241 <div></div>

2242 </dd>

2243

2244 <!-- FUNCTION PARAMETERS -->

2245 <dd style="display: none; ">

2246 <div></div>

2247 </dd>

2248

2249 </div>

2250 </div><div>

2251 <div>

2252 <dt>

2253 <var>pacScript</var>

2254 <em>

2255

2256 <!-- TYPE -->

2257 <div style="display:inline">

2258 (

2259 <span class="optional">optional</span>

2260 <span class="enum" style="display: none; ">enumerated</span>

2261 <span id="typeTemplate">

2262 <span>

2263 <a href="experimental.proxy.html#type-PacScript">PacScri pt</a>

2264 </span>

2265 <span style="display: none; ">

2266 <span>

2267 array of <span><span></span></span>

2268 </span>

2269 <span>paramType</span>

2270 <span></span>

2271 </span>

2272 </span>

2273 )

2274 </div>

2275

2276 </em>

2277 </dt>

2278 <dd class="todo" style="display: none; ">

2279 Undocumented.

2280 </dd>

2281 <dd>The proxy auto-config (PAC) script for this configuration. Use thi s for 'pac_script' mode.</dd>

2282 <dd style="display: none; ">

2283 This parameter was added in version

2284 <b><span></span></b>.

2285 You must omit this parameter in earlier versions,

2286 and you may omit it in any version. If you require this

2287 parameter, the manifest key

2288 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2289 can ensure that your extension won't be run in an earlier browser ve rsion.

2290 </dd>

2291

2292 <!-- OBJECT PROPERTIES -->

2293 <dd style="display: none; ">

2294 <dl>

2295 <div>

2296 <div>

2297 </div>

2298 </div>

2299 </dl>

2300 </dd>

2301

2302 <!-- OBJECT METHODS -->

2303 <dd style="display: none; ">

2304 <div></div>

2305 </dd>

2306

2307 <!-- OBJECT EVENT FIELDS -->

2308 <dd style="display: none; ">

2309 <div></div>

2310 </dd>

2311

2312 <!-- FUNCTION PARAMETERS -->

2313 <dd style="display: none; ">

2314 <div></div>

2315 </dd>

2316

2317 </div>

2318 </div><div>

2319 <div>

2320 <dt>

2321 <var>mode</var>

2322 <em>

2323

2324 <!-- TYPE -->

2325 <div style="display:inline">

2326 (

2327 <span class="optional" style="display: none; ">optional</spa n>

2328 <span class="enum">enumerated</span>

2329 <span id="typeTemplate">

2330 <span style="display: none; ">

2331 <a> Type</a>

2332 </span>

2333 <span>

2334 <span style="display: none; ">

2335 array of <span><span></span></span>

2336 </span>

2337 <span>string</span>

2338 <span>["direct", "auto_detect", "pac_script", "fixed_ser vers", "system"]</span>

2339 </span>

2340 </span>

2341 )

2342 </div>

2343

2344 </em>

2345 </dt>

2346 <dd class="todo" style="display: none; ">

2347 Undocumented.

2348 </dd>

2349 <dd>'direct' = Never use a proxy<br>'auto_detect' = Auto detect proxy settings<br>'pac_script' = Use specified PAC script<br>'fixed_servers' = Manuall y specify proxy servers<br>'system' = Use system proxy settings</dd>

2350 <dd style="display: none; ">

2351 This parameter was added in version

2352 <b><span></span></b>.

2353 You must omit this parameter in earlier versions,

2354 and you may omit it in any version. If you require this

2355 parameter, the manifest key

2356 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2357 can ensure that your extension won't be run in an earlier browser ve rsion.

2358 </dd>

2359

2360 <!-- OBJECT PROPERTIES -->

2361 <dd style="display: none; ">

2362 <dl>

2363 <div>

2364 <div>

2365 </div>

2366 </div>

2367 </dl>

2368 </dd>

2369

2370 <!-- OBJECT METHODS -->

2371 <dd style="display: none; ">

2372 <div></div>

2373 </dd>

2374

2375 <!-- OBJECT EVENT FIELDS -->

2376 <dd style="display: none; ">

2377 <div></div>

2378 </dd>

2379

2380 <!-- FUNCTION PARAMETERS -->

2381 <dd style="display: none; ">

2382 <div></div>

2383 </dd>

2384

2385 </div>

2386 </div>

2387 </dl>

2388 </dd>

2389

2390 <!-- OBJECT METHODS -->

2391 <dd style="display: none; ">

2392 <div></div>

2393 </dd>

2394

2395 <!-- OBJECT EVENT FIELDS -->

2396 <dd style="display: none; ">

2397 <div></div>

2398 </dd>

2399

2400 <!-- FUNCTION PARAMETERS -->

2401 <dd style="display: none; ">

2402 <div></div>

2403 </dd>

2404

2405 </div>

2406

2407 </div> <!-- /apiItem -->

2408

2409 </div> <!-- /apiGroup -->

2410

2411 </div> <!-- /apiPage -->

2412 </div> <!-- /gc-pagecontent -->

2413 </div> <!-- /g-section -->

2414 </div> <!-- /codesiteContent -->

2415 <div id="gc-footer" --="">

2416 <div class="text">

2417 <p>

2418 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,

2419 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons

2420 Attribution 3.0 License</a>, and code samples are licensed under the

2421 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.

2422 </p>

2423 <p>

2424 ©2011 Google

2425 </p>

2426

2427 <!-- begin analytics -->

2428 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>

2429 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>

2430

2431 <script type="text/javascript">

2432 // chrome doc tracking

2433 try {

2434 var engdocs = _gat._getTracker("YT-10763712-2");

2435 engdocs._trackPageview();

2436 } catch(err) {}

2437

2438 // code.google.com site-wide tracking

2439 try {

2440 _uacct="UA-18071-1";

2441 _uanchor=1;

2442 _uff=0;

2443 urchinTracker();

2444 }

2445 catch(e) {/* urchinTracker not available. */}

2446 </script>

2447 <!-- end analytics -->

2448 </div>

2449 </div> <!-- /gc-footer -->

2450 </div> <!-- /gc-container -->

2451 </body></html>

OLD	NEW