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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 6549015: Extension half of the proxy error event (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/chrome/common/extensions/docs
Patch Set: Created 9 years, 10 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/browser/extensions/extension_proxy_api.h ('K') | « chrome/common/extensions/api/extension_api.json ('k') | chrome/test/data/extensions/api_test/proxy/events/manifest.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 297 matching lines...) Expand 10 before | Expand all | Expand 10 after
308 <ol> 308 <ol>
309 <li> 309 <li>
310 <a href="#method-getCurrentProxySettings">getCurrentProx ySettings</a> 310 <a href="#method-getCurrentProxySettings">getCurrentProx ySettings</a>
311 </li><li> 311 </li><li>
312 <a href="#method-removeCustomProxySettings">removeCustom ProxySettings</a> 312 <a href="#method-removeCustomProxySettings">removeCustom ProxySettings</a>
313 </li><li> 313 </li><li>
314 <a href="#method-useCustomProxySettings">useCustomProxyS ettings</a> 314 <a href="#method-useCustomProxySettings">useCustomProxyS ettings</a>
315 </li> 315 </li>
316 </ol> 316 </ol>
317 </li> 317 </li>
318 <li style="display: none; "> 318 <li>
319 <a>Events</a> 319 <a href="#global-events">Events</a>
320 <ol> 320 <ol>
321 <li> 321 <li>
322 <a href="#event-anchor">eventName</a> 322 <a href="#event-onProxyError">onProxyError</a>
323 </li> 323 </li>
324 </ol> 324 </ol>
325 </li> 325 </li>
326 <li> 326 <li>
327 <a href="#types">Types</a> 327 <a href="#types">Types</a>
328 <ol> 328 <ol>
329 <li> 329 <li>
330 <a href="#type-ProxyServer">ProxyServer</a> 330 <a href="#type-ProxyServer">ProxyServer</a>
331 </li><li> 331 </li><li>
332 <a href="#type-ProxyRules">ProxyRules</a> 332 <a href="#type-ProxyRules">ProxyRules</a>
(...skipping 114 matching lines...) Expand 10 before | Expand all | Expand 10 after
447 proxy server. 447 proxy server.
448 </p> 448 </p>
449 449
450 <h3 id="proxy_server_objects">Proxy server objects</h3> 450 <h3 id="proxy_server_objects">Proxy server objects</h3>
451 451
452 <p> 452 <p>
453 A proxy server is configured in a 453 A proxy server is configured in a
454 <a href="#type-ProxyServer"><code>ProxyServer</code></a> object. The connection 454 <a href="#type-ProxyServer"><code>ProxyServer</code></a> object. The connection
455 to the proxy server (defined by the <code>host</code> attribute) uses the 455 to the proxy server (defined by the <code>host</code> attribute) uses the
456 protocol defined in the <code>scheme</code> attribute. If no <code>scheme</code> 456 protocol defined in the <code>scheme</code> attribute. If no <code>scheme</code>
457 is specified, the proxy connection usually defaults to <code>http</code>. Only 457 is specified, the proxy connection defaults to <code>http</code>.
458 the <code>fallbackProxy</code> defaults to <code>socks5</code>.
459 </p> 458 </p>
460 459
461 <p> 460 <p>
462 If no <code>port</code> is defined in a 461 If no <code>port</code> is defined in a
463 <a href="#type-ProxyServer"><code>ProxyServer</code></a> object, the port is 462 <a href="#type-ProxyServer"><code>ProxyServer</code></a> object, the port is
464 derived from the scheme. The default ports are: 463 derived from the scheme. The default ports are:
465 </p><table> 464 </p><table>
466 <tbody><tr><th>Scheme</th><th>Port</th></tr> 465 <tbody><tr><th>Scheme</th><th>Port</th></tr>
467 <tr><td>http</td><td>80</td></tr> 466 <tr><td>http</td><td>80</td></tr>
468 <tr><td>https</td><td>443</td></tr> 467 <tr><td>https</td><td>443</td></tr>
(...skipping 110 matching lines...) Expand 10 before | Expand all | Expand 10 after
579 mode: "pac_script", 578 mode: "pac_script",
580 pacScript: { 579 pacScript: {
581 data: "function FindProxyForURL(url, host) {\n" + 580 data: "function FindProxyForURL(url, host) {\n" +
582 " if (host == 'foobar.com')\n" + 581 " if (host == 'foobar.com')\n" +
583 " return 'PROXY blackhole:80';\n" + 582 " return 'PROXY blackhole:80';\n" +
584 " return 'DIRECT';\n" + 583 " return 'DIRECT';\n" +
585 "}" 584 "}"
586 } 585 }
587 }; 586 };
588 var incognito = false; 587 var incognito = false;
589 chrome.experimental.proxy.useCurrentProxySettings(config, incognito); 588 chrome.experimental.proxy.useCustomProxySettings(config, incognito);
590 </pre> 589 </pre>
591 590
592 <p> 591 <p>
593 The next snippet queries the current proxy settings. 592 The next snippet queries the current proxy settings.
594 </p> 593 </p>
595 594
596 <pre>var incognito = false; 595 <pre>var incognito = false;
597 chrome.experimental.proxy.getCurrentProxySettings( 596 chrome.experimental.proxy.getCurrentProxySettings(
598 incognito, 597 incognito,
599 function (config) {console.log(JSON.stringify(config));} 598 function (config) {console.log(JSON.stringify(config));}
(...skipping 632 matching lines...) Expand 10 before | Expand all | Expand 10 after
1232 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 1231 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1233 can ensure that your extension won't be run in an earlier brow ser version. 1232 can ensure that your extension won't be run in an earlier brow ser version.
1234 </p> 1233 </p>
1235 </div> <!-- /description --> 1234 </div> <!-- /description -->
1236 1235
1237 </div> <!-- /apiItem --> 1236 </div> <!-- /apiItem -->
1238 1237
1239 </div> <!-- /apiGroup --> 1238 </div> <!-- /apiGroup -->
1240 1239
1241 <!-- EVENTS --> 1240 <!-- EVENTS -->
1242 <div id="eventsTemplate" class="apiGroup" style="display: none; "> 1241 <div id="eventsTemplate" class="apiGroup">
1243 <a></a> 1242 <a name="global-events"></a>
1244 <h3>Events</h3> 1243 <h3>Events</h3>
1245 <!-- iterates over all events --> 1244 <!-- iterates over all events -->
1246 <div class="apiItem"> 1245 <div class="apiItem">
1247 <a></a> 1246 <a name="event-onProxyError"></a>
1248 <h4>event name</h4> 1247 <h4>onProxyError</h4>
1249 1248
1250 <div class="summary"> 1249 <div class="summary">
1251 <!-- Note: intentionally longer 80 columns --> 1250 <!-- Note: intentionally longer 80 columns -->
1252 <span class="subdued">chrome.bookmarks</span><span>onEvent</span ><span class="subdued">.addListener</span>(function(<span>Type param1, Type para m2</span>) <span class="subdued">{...}</span>); 1251 <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>);
1253 </div> 1252 </div>
1254 1253
1255 <div class="description"> 1254 <div class="description">
1256 <p class="todo">Undocumented.</p> 1255 <p class="todo" style="display: none; ">Undocumented.</p>
1257 <p> 1256 <p>Notifies about proxy errors.</p>
1258 A description from the json schema def of the event goes here.
1259 </p>
1260 1257
1261 <!-- PARAMETERS --> 1258 <!-- PARAMETERS -->
1262 <div> 1259 <div>
1263 <h4>Parameters</h4> 1260 <h4>Parameters</h4>
1264 <dl> 1261 <dl>
1265 <div> 1262 <div>
1266 <div> 1263 <div>
1267 </div> 1264 <dt>
1265 <var>details</var>
1266 <em>
1267
1268 <!-- TYPE -->
1269 <div style="display:inline">
1270 (
1271 <span class="optional" style="display: none; ">optional</spa n>
1272 <span class="enum" style="display: none; ">enumerated</span>
1273 <span id="typeTemplate">
1274 <span style="display: none; ">
1275 <a> Type</a>
1276 </span>
1277 <span>
1278 <span style="display: none; ">
1279 array of <span><span></span></span>
1280 </span>
1281 <span>object</span>
1282 <span style="display: none; "></span>
1283 </span>
1284 </span>
1285 )
1286 </div>
1287
1288 </em>
1289 </dt>
1290 <dd class="todo">
1291 Undocumented.
1292 </dd>
1293 <dd style="display: none; ">
1294 Description of this parameter from the json schema.
1295 </dd>
1296 <dd style="display: none; ">
1297 This parameter was added in version
1298 <b><span></span></b>.
1299 You must omit this parameter in earlier versions,
1300 and you may omit it in any version. If you require this
1301 parameter, the manifest key
1302 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1303 can ensure that your extension won't be run in an earlier browser ve rsion.
1304 </dd>
1305
1306 <!-- OBJECT PROPERTIES -->
1307 <dd>
1308 <dl>
1309 <div>
1310 <div>
1311 <dt>
1312 <var>fatal</var>
1313 <em>
1314
1315 <!-- TYPE -->
1316 <div style="display:inline">
1317 (
1318 <span class="optional" style="display: none; ">optional</spa n>
1319 <span class="enum" style="display: none; ">enumerated</span>
1320 <span id="typeTemplate">
1321 <span style="display: none; ">
1322 <a> Type</a>
1323 </span>
1324 <span>
1325 <span style="display: none; ">
1326 array of <span><span></span></span>
1327 </span>
1328 <span>boolean</span>
1329 <span style="display: none; "></span>
1330 </span>
1331 </span>
1332 )
1333 </div>
1334
1335 </em>
1336 </dt>
1337 <dd class="todo" style="display: none; ">
1338 Undocumented.
1339 </dd>
1340 <dd>If true, the error was fatal and the network transaction was abort ed. Otherwise, a direct connection is used instead.</dd>
1341 <dd style="display: none; ">
1342 This parameter was added in version
1343 <b><span></span></b>.
1344 You must omit this parameter in earlier versions,
1345 and you may omit it in any version. If you require this
1346 parameter, the manifest key
1347 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1348 can ensure that your extension won't be run in an earlier browser ve rsion.
1349 </dd>
1350
1351 <!-- OBJECT PROPERTIES -->
1352 <dd style="display: none; ">
1353 <dl>
1354 <div>
1355 <div>
1356 </div>
1357 </div>
1358 </dl>
1359 </dd>
1360
1361 <!-- OBJECT METHODS -->
1362 <dd style="display: none; ">
1363 <div></div>
1364 </dd>
1365
1366 <!-- OBJECT EVENT FIELDS -->
1367 <dd style="display: none; ">
1368 <div></div>
1369 </dd>
1370
1371 <!-- FUNCTION PARAMETERS -->
1372 <dd style="display: none; ">
1373 <div></div>
1374 </dd>
1375
1376 </div>
1377 </div><div>
1378 <div>
1379 <dt>
1380 <var>error</var>
1381 <em>
1382
1383 <!-- TYPE -->
1384 <div style="display:inline">
1385 (
1386 <span class="optional" style="display: none; ">optional</spa n>
1387 <span class="enum" style="display: none; ">enumerated</span>
1388 <span id="typeTemplate">
1389 <span style="display: none; ">
1390 <a> Type</a>
1391 </span>
1392 <span>
1393 <span style="display: none; ">
1394 array of <span><span></span></span>
1395 </span>
1396 <span>string</span>
1397 <span style="display: none; "></span>
1398 </span>
1399 </span>
1400 )
1401 </div>
1402
1403 </em>
1404 </dt>
1405 <dd class="todo" style="display: none; ">
1406 Undocumented.
1407 </dd>
1408 <dd>The error description.</dd>
1409 <dd style="display: none; ">
1410 This parameter was added in version
1411 <b><span></span></b>.
1412 You must omit this parameter in earlier versions,
1413 and you may omit it in any version. If you require this
1414 parameter, the manifest key
1415 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1416 can ensure that your extension won't be run in an earlier browser ve rsion.
1417 </dd>
1418
1419 <!-- OBJECT PROPERTIES -->
1420 <dd style="display: none; ">
1421 <dl>
1422 <div>
1423 <div>
1424 </div>
1425 </div>
1426 </dl>
1427 </dd>
1428
1429 <!-- OBJECT METHODS -->
1430 <dd style="display: none; ">
1431 <div></div>
1432 </dd>
1433
1434 <!-- OBJECT EVENT FIELDS -->
1435 <dd style="display: none; ">
1436 <div></div>
1437 </dd>
1438
1439 <!-- FUNCTION PARAMETERS -->
1440 <dd style="display: none; ">
1441 <div></div>
1442 </dd>
1443
1444 </div>
1445 </div><div>
1446 <div>
1447 <dt>
1448 <var>details</var>
1449 <em>
1450
1451 <!-- TYPE -->
1452 <div style="display:inline">
1453 (
1454 <span class="optional" style="display: none; ">optional</spa n>
1455 <span class="enum" style="display: none; ">enumerated</span>
1456 <span id="typeTemplate">
1457 <span style="display: none; ">
1458 <a> Type</a>
1459 </span>
1460 <span>
1461 <span style="display: none; ">
1462 array of <span><span></span></span>
1463 </span>
1464 <span>string</span>
1465 <span style="display: none; "></span>
1466 </span>
1467 </span>
1468 )
1469 </div>
1470
1471 </em>
1472 </dt>
1473 <dd class="todo" style="display: none; ">
1474 Undocumented.
1475 </dd>
1476 <dd>Additional details about the error such as a JavaScript runtime er ror.</dd>
1477 <dd style="display: none; ">
1478 This parameter was added in version
1479 <b><span></span></b>.
1480 You must omit this parameter in earlier versions,
1481 and you may omit it in any version. If you require this
1482 parameter, the manifest key
1483 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1484 can ensure that your extension won't be run in an earlier browser ve rsion.
1485 </dd>
1486
1487 <!-- OBJECT PROPERTIES -->
1488 <dd style="display: none; ">
1489 <dl>
1490 <div>
1491 <div>
1492 </div>
1493 </div>
1494 </dl>
1495 </dd>
1496
1497 <!-- OBJECT METHODS -->
1498 <dd style="display: none; ">
1499 <div></div>
1500 </dd>
1501
1502 <!-- OBJECT EVENT FIELDS -->
1503 <dd style="display: none; ">
1504 <div></div>
1505 </dd>
1506
1507 <!-- FUNCTION PARAMETERS -->
1508 <dd style="display: none; ">
1509 <div></div>
1510 </dd>
1511
1512 </div>
1513 </div>
1514 </dl>
1515 </dd>
1516
1517 <!-- OBJECT METHODS -->
1518 <dd style="display: none; ">
1519 <div></div>
1520 </dd>
1521
1522 <!-- OBJECT EVENT FIELDS -->
1523 <dd style="display: none; ">
1524 <div></div>
1525 </dd>
1526
1527 <!-- FUNCTION PARAMETERS -->
1528 <dd style="display: none; ">
1529 <div></div>
1530 </dd>
1531
1532 </div>
1268 </div> 1533 </div>
1269 </dl> 1534 </dl>
1270 </div> 1535 </div>
1271 </div> <!-- /decription --> 1536 </div> <!-- /decription -->
1272 1537
1273 </div> <!-- /apiItem --> 1538 </div> <!-- /apiItem -->
1274 1539
1275 </div> <!-- /apiGroup --> 1540 </div> <!-- /apiGroup -->
1276 1541
1277 <!-- TYPES --> 1542 <!-- TYPES -->
(...skipping 1279 matching lines...) Expand 10 before | Expand all | Expand 10 after
2557 _uff=0; 2822 _uff=0;
2558 urchinTracker(); 2823 urchinTracker();
2559 } 2824 }
2560 catch(e) {/* urchinTracker not available. */} 2825 catch(e) {/* urchinTracker not available. */}
2561 </script> 2826 </script>
2562 <!-- end analytics --> 2827 <!-- end analytics -->
2563 </div> 2828 </div>
2564 </div> <!-- /gc-footer --> 2829 </div> <!-- /gc-footer -->
2565 </div> <!-- /gc-container --> 2830 </div> <!-- /gc-container -->
2566 </body></html> 2831 </body></html>
OLDNEW
« chrome/browser/extensions/extension_proxy_api.h ('K') | « chrome/common/extensions/api/extension_api.json ('k') | chrome/test/data/extensions/api_test/proxy/events/manifest.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698