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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 6468002: Implementation of getCurrentProxySettings for proxy settings API. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/out/Debug
Patch Set: Removed todo and ask mpcomplete now. 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
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/samples.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 262 matching lines...) Expand 10 before | Expand all | Expand 10 after
273 <ol> 273 <ol>
274 <li> 274 <li>
275 <a href="#property-anchor">propertyName</a> 275 <a href="#property-anchor">propertyName</a>
276 </li> 276 </li>
277 </ol> 277 </ol>
278 </li> 278 </li>
279 <li> 279 <li>
280 <a href="#global-methods">Methods</a> 280 <a href="#global-methods">Methods</a>
281 <ol> 281 <ol>
282 <li> 282 <li>
283 <a href="#method-getCurrentProxySettings">getCurrentProx ySettings</a>
284 </li><li>
283 <a href="#method-removeCustomProxySettings">removeCustom ProxySettings</a> 285 <a href="#method-removeCustomProxySettings">removeCustom ProxySettings</a>
284 </li><li> 286 </li><li>
285 <a href="#method-useCustomProxySettings">useCustomProxyS ettings</a> 287 <a href="#method-useCustomProxySettings">useCustomProxyS ettings</a>
286 </li> 288 </li>
287 </ol> 289 </ol>
288 </li> 290 </li>
289 <li style="display: none; "> 291 <li style="display: none; ">
290 <a>Events</a> 292 <a>Events</a>
291 <ol> 293 <ol>
292 <li> 294 <li>
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after
345 347
346 </div> <!-- /apiGroup --> 348 </div> <!-- /apiGroup -->
347 349
348 <!-- METHODS --> 350 <!-- METHODS -->
349 <div id="methodsTemplate" class="apiGroup"> 351 <div id="methodsTemplate" class="apiGroup">
350 <a name="global-methods"></a> 352 <a name="global-methods"></a>
351 <h3>Methods</h3> 353 <h3>Methods</h3>
352 354
353 <!-- iterates over all functions --> 355 <!-- iterates over all functions -->
354 <div class="apiItem"> 356 <div class="apiItem">
357 <a name="method-getCurrentProxySettings"></a> <!-- method-anchor - ->
358 <h4>getCurrentProxySettings</h4>
359
360 <div class="summary"><span style="display: none; ">void</span>
361 <!-- Note: intentionally longer 80 columns -->
362 <span>chrome.experimental.proxy.getCurrentProxySettings</span> (<span class="null"><span style="display: none; ">, </span><span>boolean</span>
363 <var><span>incognito</span></var></span><span class="null" ><span>, </span><span>function</span>
364 <var><span>callback</span></var></span>)</div>
365
366 <div class="description">
367 <p class="todo" style="display: none; ">Undocumented.</p>
368 <p>Returns the currently effective proxy settings. These can ori ginate from default values, command line options, the extension settings API, po licies and possibly other sources in the future.</p>
369
370 <!-- PARAMETERS -->
371 <h4>Parameters</h4>
372 <dl>
373 <div>
374 <div>
375 <dt>
376 <var>incognito</var>
377 <em>
378
379 <!-- TYPE -->
380 <div style="display:inline">
381 (
382 <span class="optional" style="display: none; ">optional</spa n>
383 <span class="enum" style="display: none; ">enumerated</span>
384 <span id="typeTemplate">
385 <span style="display: none; ">
386 <a> Type</a>
387 </span>
388 <span>
389 <span style="display: none; ">
390 array of <span><span></span></span>
391 </span>
392 <span>boolean</span>
393 <span style="display: none; "></span>
394 </span>
395 </span>
396 )
397 </div>
398
399 </em>
400 </dt>
401 <dd class="todo" style="display: none; ">
402 Undocumented.
403 </dd>
404 <dd>See incognito parameter of useCustomProxySettings.</dd>
405 <dd style="display: none; ">
406 This parameter was added in version
407 <b><span></span></b>.
408 You must omit this parameter in earlier versions,
409 and you may omit it in any version. If you require this
410 parameter, the manifest key
411 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
412 can ensure that your extension won't be run in an earlier browser ve rsion.
413 </dd>
414
415 <!-- OBJECT PROPERTIES -->
416 <dd style="display: none; ">
417 <dl>
418 <div>
419 <div>
420 </div>
421 </div>
422 </dl>
423 </dd>
424
425 <!-- OBJECT METHODS -->
426 <dd style="display: none; ">
427 <div></div>
428 </dd>
429
430 <!-- OBJECT EVENT FIELDS -->
431 <dd style="display: none; ">
432 <div></div>
433 </dd>
434
435 <!-- FUNCTION PARAMETERS -->
436 <dd style="display: none; ">
437 <div></div>
438 </dd>
439
440 </div>
441 </div><div>
442 <div>
443 <dt>
444 <var>callback</var>
445 <em>
446
447 <!-- TYPE -->
448 <div style="display:inline">
449 (
450 <span class="optional" style="display: none; ">optional</spa n>
451 <span class="enum" style="display: none; ">enumerated</span>
452 <span id="typeTemplate">
453 <span style="display: none; ">
454 <a> Type</a>
455 </span>
456 <span>
457 <span style="display: none; ">
458 array of <span><span></span></span>
459 </span>
460 <span>function</span>
461 <span style="display: none; "></span>
462 </span>
463 </span>
464 )
465 </div>
466
467 </em>
468 </dt>
469 <dd class="todo">
470 Undocumented.
471 </dd>
472 <dd style="display: none; ">
473 Description of this parameter from the json schema.
474 </dd>
475 <dd style="display: none; ">
476 This parameter was added in version
477 <b><span></span></b>.
478 You must omit this parameter in earlier versions,
479 and you may omit it in any version. If you require this
480 parameter, the manifest key
481 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
482 can ensure that your extension won't be run in an earlier browser ve rsion.
483 </dd>
484
485 <!-- OBJECT PROPERTIES -->
486 <dd style="display: none; ">
487 <dl>
488 <div>
489 <div>
490 </div>
491 </div>
492 </dl>
493 </dd>
494
495 <!-- OBJECT METHODS -->
496 <dd style="display: none; ">
497 <div></div>
498 </dd>
499
500 <!-- OBJECT EVENT FIELDS -->
501 <dd style="display: none; ">
502 <div></div>
503 </dd>
504
505 <!-- FUNCTION PARAMETERS -->
506 <dd style="display: none; ">
507 <div></div>
508 </dd>
509
510 </div>
511 </div>
512 </dl>
513
514 <!-- RETURNS -->
515 <h4 style="display: none; ">Returns</h4>
516 <dl>
517 <div style="display: none; ">
518 <div>
519 </div>
520 </div>
521 </dl>
522
523 <!-- CALLBACK -->
524 <div>
525 <div>
526 <h4>Callback function</h4>
527 <p>
528 The callback <em>parameter</em> should specify a function
529 that looks like this:
530 </p>
531 <p style="display: none; ">
532 If you specify the <em>callback</em> parameter, it should
533 specify a function that looks like this:
534 </p>
535
536 <!-- Note: intentionally longer 80 columns -->
537 <pre>function(<span>ProxyConfig config</span>) <span class="su bdued">{...}</span>;</pre>
538 <dl>
539 <div>
540 <div>
541 <dt>
542 <var>config</var>
543 <em>
544
545 <!-- TYPE -->
546 <div style="display:inline">
547 (
548 <span class="optional" style="display: none; ">optional</spa n>
549 <span class="enum" style="display: none; ">enumerated</span>
550 <span id="typeTemplate">
551 <span>
552 <a href="experimental.proxy.html#type-ProxyConfig">Proxy Config</a>
553 </span>
554 <span style="display: none; ">
555 <span>
556 array of <span><span></span></span>
557 </span>
558 <span>paramType</span>
559 <span></span>
560 </span>
561 </span>
562 )
563 </div>
564
565 </em>
566 </dt>
567 <dd class="todo" style="display: none; ">
568 Undocumented.
569 </dd>
570 <dd>Configuration, not necessarily a literal copy of the configuration passed to useCustomProxySettings.</dd>
571 <dd style="display: none; ">
572 This parameter was added in version
573 <b><span></span></b>.
574 You must omit this parameter in earlier versions,
575 and you may omit it in any version. If you require this
576 parameter, the manifest key
577 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
578 can ensure that your extension won't be run in an earlier browser ve rsion.
579 </dd>
580
581 <!-- OBJECT PROPERTIES -->
582 <dd style="display: none; ">
583 <dl>
584 <div>
585 <div>
586 </div>
587 </div>
588 </dl>
589 </dd>
590
591 <!-- OBJECT METHODS -->
592 <dd style="display: none; ">
593 <div></div>
594 </dd>
595
596 <!-- OBJECT EVENT FIELDS -->
597 <dd style="display: none; ">
598 <div></div>
599 </dd>
600
601 <!-- FUNCTION PARAMETERS -->
602 <dd style="display: none; ">
603 <div></div>
604 </dd>
605
606 </div>
607 </div>
608 </dl>
609 </div>
610 </div>
611
612 <!-- MIN_VERSION -->
613 <p style="display: none; ">
614 This function was added in version <b><span></span></b>.
615 If you require this function, the manifest key
616 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
617 can ensure that your extension won't be run in an earlier brow ser version.
618 </p>
619 </div> <!-- /description -->
620
621 </div><div class="apiItem">
355 <a name="method-removeCustomProxySettings"></a> <!-- method-anchor --> 622 <a name="method-removeCustomProxySettings"></a> <!-- method-anchor -->
356 <h4>removeCustomProxySettings</h4> 623 <h4>removeCustomProxySettings</h4>
357 624
358 <div class="summary"><span style="display: none; ">void</span> 625 <div class="summary"><span style="display: none; ">void</span>
359 <!-- Note: intentionally longer 80 columns --> 626 <!-- Note: intentionally longer 80 columns -->
360 <span>chrome.experimental.proxy.removeCustomProxySettings</spa n>(<span class="optional"><span style="display: none; ">, </span><span>boolean</ span> 627 <span>chrome.experimental.proxy.removeCustomProxySettings</spa n>(<span class="optional"><span style="display: none; ">, </span><span>boolean</ span>
361 <var><span>incognito</span></var></span>)</div> 628 <var><span>incognito</span></var></span>)</div>
362 629
363 <div class="description"> 630 <div class="description">
364 <p class="todo" style="display: none; ">Undocumented.</p> 631 <p class="todo" style="display: none; ">Undocumented.</p>
(...skipping 422 matching lines...) Expand 10 before | Expand all | Expand 10 after
787 <span class="enum">enumerated</span> 1054 <span class="enum">enumerated</span>
788 <span id="typeTemplate"> 1055 <span id="typeTemplate">
789 <span style="display: none; "> 1056 <span style="display: none; ">
790 <a> Type</a> 1057 <a> Type</a>
791 </span> 1058 </span>
792 <span> 1059 <span>
793 <span style="display: none; "> 1060 <span style="display: none; ">
794 array of <span><span></span></span> 1061 array of <span><span></span></span>
795 </span> 1062 </span>
796 <span>string</span> 1063 <span>string</span>
797 <span>["http", "socks", "socks4", "socks5"]</span> 1064 <span>["http", "https", "socks", "socks4", "socks5"]</sp an>
798 </span> 1065 </span>
799 </span> 1066 </span>
800 ) 1067 )
801 </div> 1068 </div>
802 1069
803 </em> 1070 </em>
804 </dt> 1071 </dt>
805 <dd class="todo" style="display: none; "> 1072 <dd class="todo" style="display: none; ">
806 Undocumented. 1073 Undocumented.
807 </dd> 1074 </dd>
(...skipping 1048 matching lines...) Expand 10 before | Expand all | Expand 10 after
1856 _uff=0; 2123 _uff=0;
1857 urchinTracker(); 2124 urchinTracker();
1858 } 2125 }
1859 catch(e) {/* urchinTracker not available. */} 2126 catch(e) {/* urchinTracker not available. */}
1860 </script> 2127 </script>
1861 <!-- end analytics --> 2128 <!-- end analytics -->
1862 </div> 2129 </div>
1863 </div> <!-- /gc-footer --> 2130 </div> <!-- /gc-footer -->
1864 </div> <!-- /gc-container --> 2131 </div> <!-- /gc-container -->
1865 </body></html> 2132 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698