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

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

Issue 3597016: Expands the chrome.experimental.processes extension API.... (Closed) Base URL: svn://chrome-svn/chrome/trunk/src/
Patch Set: '' Created 10 years, 2 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
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 239 matching lines...) Expand 10 before | Expand all | Expand 10 after
250 <ol> 250 <ol>
251 <li> 251 <li>
252 <a href="#property-anchor">propertyName</a> 252 <a href="#property-anchor">propertyName</a>
253 </li> 253 </li>
254 </ol> 254 </ol>
255 </li> 255 </li>
256 <li> 256 <li>
257 <a href="#methods">Methods</a> 257 <a href="#methods">Methods</a>
258 <ol> 258 <ol>
259 <li> 259 <li>
260 <a href="#method-getProcessForTab">getProcessForTab</a> 260 <a href="#method-getProcessIdForTab">getProcessIdForTab< /a>
261 </li> 261 </li>
262 </ol> 262 </ol>
263 </li> 263 </li>
264 <li style="display: none; "> 264 <li>
265 <a href="#events">Events</a> 265 <a href="#events">Events</a>
266 <ol> 266 <ol>
267 <li> 267 <li>
268 <a href="#event-anchor">eventName</a> 268 <a href="#event-onUpdated">onUpdated</a>
269 </li> 269 </li>
270 </ol> 270 </ol>
271 </li> 271 </li>
272 <li> 272 <li>
273 <a href="#types">Types</a> 273 <a href="#types">Types</a>
274 <ol> 274 <ol>
275 <li> 275 <li>
276 <a href="#type-Process">Process</a> 276 <a href="#type-Process">Process</a>
277 </li> 277 </li>
278 </ol> 278 </ol>
(...skipping 47 matching lines...) Expand 10 before | Expand all | Expand 10 after
326 326
327 </div> <!-- /apiGroup --> 327 </div> <!-- /apiGroup -->
328 328
329 <!-- METHODS --> 329 <!-- METHODS -->
330 <div class="apiGroup" id="methods"> 330 <div class="apiGroup" id="methods">
331 <a name="methods"></a> 331 <a name="methods"></a>
332 <h3>Methods</h3> 332 <h3>Methods</h3>
333 333
334 <!-- iterates over all functions --> 334 <!-- iterates over all functions -->
335 <div class="apiItem"> 335 <div class="apiItem">
336 <a name="method-getProcessForTab"></a> <!-- method-anchor --> 336 <a name="method-getProcessIdForTab"></a> <!-- method-anchor -->
337 <h4>getProcessForTab</h4> 337 <h4>getProcessIdForTab</h4>
338 338
339 <div class="summary"><span style="display: none; ">void</span> 339 <div class="summary"><span style="display: none; ">void</span>
340 <!-- Note: intentionally longer 80 columns --> 340 <!-- Note: intentionally longer 80 columns -->
341 <span>chrome.experimental.processes.getProcessForTab</span>(<s pan class="null"><span style="display: none; ">, </span><span>integer</span> 341 <span>chrome.experimental.processes.getProcessIdForTab</span>( <span class="null"><span style="display: none; ">, </span><span>integer</span>
342 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>function</span> 342 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>function</span>
343 <var><span>callback</span></var></span>)</div> 343 <var><span>callback</span></var></span>)</div>
344 344
345 <div class="description"> 345 <div class="description">
346 <p class="todo" style="display: none; ">Undocumented.</p> 346 <p class="todo" style="display: none; ">Undocumented.</p>
347 <p>Returns details about the current renderer process of the spe cified tab.</p> 347 <p>Returns the ID of the renderer process for the specified tab. </p>
348 348
349 <!-- PARAMETERS --> 349 <!-- PARAMETERS -->
350 <h4>Parameters</h4> 350 <h4>Parameters</h4>
351 <dl> 351 <dl>
352 <div> 352 <div>
353 <div> 353 <div>
354 <dt> 354 <dt>
355 <var>tabId</var> 355 <var>tabId</var>
356 <em> 356 <em>
357 357
(...skipping 130 matching lines...) Expand 10 before | Expand all | Expand 10 after
488 <p> 488 <p>
489 The callback <em>parameter</em> should specify a function 489 The callback <em>parameter</em> should specify a function
490 that looks like this: 490 that looks like this:
491 </p> 491 </p>
492 <p style="display: none; "> 492 <p style="display: none; ">
493 If you specify the <em>callback</em> parameter, it should 493 If you specify the <em>callback</em> parameter, it should
494 specify a function that looks like this: 494 specify a function that looks like this:
495 </p> 495 </p>
496 496
497 <!-- Note: intentionally longer 80 columns --> 497 <!-- Note: intentionally longer 80 columns -->
498 <pre>function(<span>Process process</span>) <span class="subdu ed">{...}</span>;</pre> 498 <pre>function(<span>integer processId</span>) <span class="sub dued">{...}</span>;</pre>
499 <dl> 499 <dl>
500 <div> 500 <div>
501 <div> 501 <div>
502 <dt> 502 <dt>
503 <var>process</var> 503 <var>processId</var>
504 <em> 504 <em>
505 505
506 <!-- TYPE --> 506 <!-- TYPE -->
507 <div style="display:inline"> 507 <div style="display:inline">
508 ( 508 (
509 <span class="optional" style="display: none; ">optional</spa n> 509 <span class="optional" style="display: none; ">optional</spa n>
510 <span class="enum" style="display: none; ">enumerated</span> 510 <span class="enum" style="display: none; ">enumerated</span>
511 <span id="typeTemplate"> 511 <span id="typeTemplate">
512 <span style="display: none; ">
513 <a> Type</a>
514 </span>
512 <span> 515 <span>
513 <a href="experimental.processes.html#type-Process">Proce ss</a> 516 <span style="display: none; ">
514 </span>
515 <span style="display: none; ">
516 <span>
517 array of <span><span></span></span> 517 array of <span><span></span></span>
518 </span> 518 </span>
519 <span>paramType</span> 519 <span>integer</span>
520 <span></span> 520 <span style="display: none; "></span>
521 </span> 521 </span>
522 </span> 522 </span>
523 ) 523 )
524 </div> 524 </div>
525 525
526 </em> 526 </em>
527 </dt> 527 </dt>
528 <dd class="todo" style="display: none; "> 528 <dd class="todo" style="display: none; ">
529 Undocumented. 529 Undocumented.
530 </dd> 530 </dd>
531 <dd>Details about the tab's process.</dd> 531 <dd>Process ID of the tab's renderer process.</dd>
532 <dd style="display: none; "> 532 <dd style="display: none; ">
533 This parameter was added in version 533 This parameter was added in version
534 <b><span></span></b>. 534 <b><span></span></b>.
535 You must omit this parameter in earlier versions, 535 You must omit this parameter in earlier versions,
536 and you may omit it in any version. If you require this 536 and you may omit it in any version. If you require this
537 parameter, the manifest key 537 parameter, the manifest key
538 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 538 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
539 can ensure that your extension won't be run in an earlier browser ve rsion. 539 can ensure that your extension won't be run in an earlier browser ve rsion.
540 </dd> 540 </dd>
541 541
(...skipping 25 matching lines...) Expand all
567 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 567 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
568 can ensure that your extension won't be run in an earlier brow ser version. 568 can ensure that your extension won't be run in an earlier brow ser version.
569 </p> 569 </p>
570 </div> <!-- /description --> 570 </div> <!-- /description -->
571 571
572 </div> <!-- /apiItem --> 572 </div> <!-- /apiItem -->
573 573
574 </div> <!-- /apiGroup --> 574 </div> <!-- /apiGroup -->
575 575
576 <!-- EVENTS --> 576 <!-- EVENTS -->
577 <div class="apiGroup" style="display: none; "> 577 <div class="apiGroup">
578 <a name="events"></a> 578 <a name="events"></a>
579 <h3 id="events">Events</h3> 579 <h3 id="events">Events</h3>
580 580
581 <!-- iterates over all events --> 581 <!-- iterates over all events -->
582 <div class="apiItem"> 582 <div class="apiItem">
583 <a></a> 583 <a name="event-onUpdated"></a>
584 <h4>event name</h4> 584 <h4>onUpdated</h4>
585 585
586 <div class="summary"> 586 <div class="summary">
587 <!-- Note: intentionally longer 80 columns --> 587 <!-- Note: intentionally longer 80 columns -->
588 <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>); 588 <span class="subdued">chrome.experimental.processes.</span><span >onUpdated</span><span class="subdued">.addListener</span>(function(<span>object processes</span>) <span class="subdued">{...}</span>);
589 </div> 589 </div>
590 590
591 <div class="description"> 591 <div class="description">
592 <p class="todo">Undocumented.</p> 592 <p class="todo" style="display: none; ">Undocumented.</p>
593 <p> 593 <p>Fires each time the Task Manager updates its process statisti cs, providing the dictionary of updated Process objects, indexed by process ID.< /p>
594 A description from the json schema def of the event goes here.
595 </p>
596 594
597 <!-- PARAMETERS --> 595 <!-- PARAMETERS -->
598 <h4>Parameters</h4> 596 <h4>Parameters</h4>
599 <dl> 597 <dl>
600 <div> 598 <div>
601 <div> 599 <div>
602 </div> 600 <dt>
601 <var>processes</var>
602 <em>
603
604 <!-- TYPE -->
605 <div style="display:inline">
606 (
607 <span class="optional" style="display: none; ">optional</spa n>
608 <span class="enum" style="display: none; ">enumerated</span>
609 <span id="typeTemplate">
610 <span style="display: none; ">
611 <a> Type</a>
612 </span>
613 <span>
614 <span style="display: none; ">
615 array of <span><span></span></span>
616 </span>
617 <span>object</span>
618 <span style="display: none; "></span>
619 </span>
620 </span>
621 )
622 </div>
623
624 </em>
625 </dt>
626 <dd class="todo">
627 Undocumented.
628 </dd>
629 <dd style="display: none; ">
630 Description of this parameter from the json schema.
631 </dd>
632 <dd style="display: none; ">
633 This parameter was added in version
634 <b><span></span></b>.
635 You must omit this parameter in earlier versions,
636 and you may omit it in any version. If you require this
637 parameter, the manifest key
638 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
639 can ensure that your extension won't be run in an earlier browser ve rsion.
640 </dd>
641
642 <!-- OBJECT PROPERTIES -->
643 <dd>
644 <dl>
645 <div style="display: none; ">
646 <div>
647 </div>
648 </div>
649 </dl>
650 </dd>
651
652 <!-- FUNCTION PARAMETERS -->
653 <dd style="display: none; ">
654 <div></div>
655 </dd>
656
657 </div>
603 </div> 658 </div>
604 </dl> 659 </dl>
605 660
606 </div> <!-- /decription --> 661 </div> <!-- /decription -->
607 662
608 </div> <!-- /apiItem --> 663 </div> <!-- /apiItem -->
609 664
610 </div> <!-- /apiGroup --> 665 </div> <!-- /apiGroup -->
611 666
612 <!-- TYPES --> 667 <!-- TYPES -->
(...skipping 74 matching lines...) Expand 10 before | Expand all | Expand 10 after
687 </span> 742 </span>
688 </span> 743 </span>
689 ) 744 )
690 </div> 745 </div>
691 746
692 </em> 747 </em>
693 </dt> 748 </dt>
694 <dd class="todo" style="display: none; "> 749 <dd class="todo" style="display: none; ">
695 Undocumented. 750 Undocumented.
696 </dd> 751 </dd>
697 <dd>The internal ID of the process.</dd> 752 <dd>The ID of the process, as provided by the OS.</dd>
698 <dd style="display: none; "> 753 <dd style="display: none; ">
699 This parameter was added in version 754 This parameter was added in version
700 <b><span></span></b>. 755 <b><span></span></b>.
701 You must omit this parameter in earlier versions, 756 You must omit this parameter in earlier versions,
702 and you may omit it in any version. If you require this 757 and you may omit it in any version. If you require this
703 parameter, the manifest key 758 parameter, the manifest key
704 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 759 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
705 can ensure that your extension won't be run in an earlier browser ve rsion. 760 can ensure that your extension won't be run in an earlier browser ve rsion.
706 </dd> 761 </dd>
707 762
708 <!-- OBJECT PROPERTIES --> 763 <!-- OBJECT PROPERTIES -->
709 <dd style="display: none; "> 764 <dd style="display: none; ">
710 <dl> 765 <dl>
711 <div> 766 <div>
712 <div> 767 <div>
713 </div> 768 </div>
714 </div> 769 </div>
715 </dl> 770 </dl>
716 </dd> 771 </dd>
717 772
718 <!-- FUNCTION PARAMETERS --> 773 <!-- FUNCTION PARAMETERS -->
719 <dd style="display: none; "> 774 <dd style="display: none; ">
720 <div></div> 775 <div></div>
721 </dd> 776 </dd>
722 777
723 </div> 778 </div>
779 </div><div>
780 <div>
781 <dt>
782 <var>type</var>
783 <em>
784
785 <!-- TYPE -->
786 <div style="display:inline">
787 (
788 <span class="optional" style="display: none; ">optional</spa n>
789 <span class="enum">enumerated</span>
790 <span id="typeTemplate">
791 <span style="display: none; ">
792 <a> Type</a>
793 </span>
794 <span>
795 <span style="display: none; ">
796 array of <span><span></span></span>
797 </span>
798 <span>string</span>
799 <span>["browser", "renderer", "plugin", "extension"]</sp an>
800 </span>
801 </span>
802 )
803 </div>
804
805 </em>
806 </dt>
807 <dd class="todo" style="display: none; ">
808 Undocumented.
809 </dd>
810 <dd>The type of process.</dd>
811 <dd style="display: none; ">
812 This parameter was added in version
813 <b><span></span></b>.
814 You must omit this parameter in earlier versions,
815 and you may omit it in any version. If you require this
816 parameter, the manifest key
817 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
818 can ensure that your extension won't be run in an earlier browser ve rsion.
819 </dd>
820
821 <!-- OBJECT PROPERTIES -->
822 <dd style="display: none; ">
823 <dl>
824 <div>
825 <div>
826 </div>
724 </div> 827 </div>
725 </dl> 828 </dl>
726 </dd> 829 </dd>
727 830
728 <!-- FUNCTION PARAMETERS --> 831 <!-- FUNCTION PARAMETERS -->
729 <dd style="display: none; "> 832 <dd style="display: none; ">
730 <div></div> 833 <div></div>
731 </dd> 834 </dd>
732 835
733 </div> 836 </div>
837 </div><div>
838 <div>
839 <dt>
840 <var>cpu</var>
841 <em>
842
843 <!-- TYPE -->
844 <div style="display:inline">
845 (
846 <span class="optional" style="display: none; ">optional</spa n>
847 <span class="enum" style="display: none; ">enumerated</span>
848 <span id="typeTemplate">
849 <span style="display: none; ">
850 <a> Type</a>
851 </span>
852 <span>
853 <span style="display: none; ">
854 array of <span><span></span></span>
855 </span>
856 <span>number</span>
857 <span style="display: none; "></span>
858 </span>
859 </span>
860 )
861 </div>
862
863 </em>
864 </dt>
865 <dd class="todo" style="display: none; ">
866 Undocumented.
867 </dd>
868 <dd>The most recent measurement of the process's CPU usage, between 0 and 100%.</dd>
869 <dd style="display: none; ">
870 This parameter was added in version
871 <b><span></span></b>.
872 You must omit this parameter in earlier versions,
873 and you may omit it in any version. If you require this
874 parameter, the manifest key
875 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
876 can ensure that your extension won't be run in an earlier browser ve rsion.
877 </dd>
878
879 <!-- OBJECT PROPERTIES -->
880 <dd style="display: none; ">
881 <dl>
882 <div>
883 <div>
884 </div>
885 </div>
886 </dl>
887 </dd>
888
889 <!-- FUNCTION PARAMETERS -->
890 <dd style="display: none; ">
891 <div></div>
892 </dd>
893
894 </div>
895 </div><div>
896 <div>
897 <dt>
898 <var>network</var>
899 <em>
900
901 <!-- TYPE -->
902 <div style="display:inline">
903 (
904 <span class="optional" style="display: none; ">optional</spa n>
905 <span class="enum" style="display: none; ">enumerated</span>
906 <span id="typeTemplate">
907 <span style="display: none; ">
908 <a> Type</a>
909 </span>
910 <span>
911 <span style="display: none; ">
912 array of <span><span></span></span>
913 </span>
914 <span>number</span>
915 <span style="display: none; "></span>
916 </span>
917 </span>
918 )
919 </div>
920
921 </em>
922 </dt>
923 <dd class="todo" style="display: none; ">
924 Undocumented.
925 </dd>
926 <dd>The most recent measurement of the process's network usage, in kB/ s.</dd>
927 <dd style="display: none; ">
928 This parameter was added in version
929 <b><span></span></b>.
930 You must omit this parameter in earlier versions,
931 and you may omit it in any version. If you require this
932 parameter, the manifest key
933 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
934 can ensure that your extension won't be run in an earlier browser ve rsion.
935 </dd>
936
937 <!-- OBJECT PROPERTIES -->
938 <dd style="display: none; ">
939 <dl>
940 <div>
941 <div>
942 </div>
943 </div>
944 </dl>
945 </dd>
946
947 <!-- FUNCTION PARAMETERS -->
948 <dd style="display: none; ">
949 <div></div>
950 </dd>
951
952 </div>
953 </div><div>
954 <div>
955 <dt>
956 <var>privateMemory</var>
957 <em>
958
959 <!-- TYPE -->
960 <div style="display:inline">
961 (
962 <span class="optional" style="display: none; ">optional</spa n>
963 <span class="enum" style="display: none; ">enumerated</span>
964 <span id="typeTemplate">
965 <span style="display: none; ">
966 <a> Type</a>
967 </span>
968 <span>
969 <span style="display: none; ">
970 array of <span><span></span></span>
971 </span>
972 <span>number</span>
973 <span style="display: none; "></span>
974 </span>
975 </span>
976 )
977 </div>
978
979 </em>
980 </dt>
981 <dd class="todo" style="display: none; ">
982 Undocumented.
983 </dd>
984 <dd>The most recent measurement of the process's private memory usage, in bytes.</dd>
985 <dd style="display: none; ">
986 This parameter was added in version
987 <b><span></span></b>.
988 You must omit this parameter in earlier versions,
989 and you may omit it in any version. If you require this
990 parameter, the manifest key
991 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
992 can ensure that your extension won't be run in an earlier browser ve rsion.
993 </dd>
994
995 <!-- OBJECT PROPERTIES -->
996 <dd style="display: none; ">
997 <dl>
998 <div>
999 <div>
1000 </div>
1001 </div>
1002 </dl>
1003 </dd>
1004
1005 <!-- FUNCTION PARAMETERS -->
1006 <dd style="display: none; ">
1007 <div></div>
1008 </dd>
1009
1010 </div>
1011 </div><div>
1012 <div>
1013 <dt>
1014 <var>sharedMemory</var>
1015 <em>
1016
1017 <!-- TYPE -->
1018 <div style="display:inline">
1019 (
1020 <span class="optional" style="display: none; ">optional</spa n>
1021 <span class="enum" style="display: none; ">enumerated</span>
1022 <span id="typeTemplate">
1023 <span style="display: none; ">
1024 <a> Type</a>
1025 </span>
1026 <span>
1027 <span style="display: none; ">
1028 array of <span><span></span></span>
1029 </span>
1030 <span>number</span>
1031 <span style="display: none; "></span>
1032 </span>
1033 </span>
1034 )
1035 </div>
1036
1037 </em>
1038 </dt>
1039 <dd class="todo" style="display: none; ">
1040 Undocumented.
1041 </dd>
1042 <dd>The most recent measurement of the process's shared memory usage, in bytes.</dd>
1043 <dd style="display: none; ">
1044 This parameter was added in version
1045 <b><span></span></b>.
1046 You must omit this parameter in earlier versions,
1047 and you may omit it in any version. If you require this
1048 parameter, the manifest key
1049 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1050 can ensure that your extension won't be run in an earlier browser ve rsion.
1051 </dd>
1052
1053 <!-- OBJECT PROPERTIES -->
1054 <dd style="display: none; ">
1055 <dl>
1056 <div>
1057 <div>
1058 </div>
1059 </div>
1060 </dl>
1061 </dd>
1062
1063 <!-- FUNCTION PARAMETERS -->
1064 <dd style="display: none; ">
1065 <div></div>
1066 </dd>
1067
1068 </div>
1069 </div>
1070 </dl>
1071 </dd>
1072
1073 <!-- FUNCTION PARAMETERS -->
1074 <dd style="display: none; ">
1075 <div></div>
1076 </dd>
1077
1078 </div>
734 1079
735 </div> <!-- /apiItem --> 1080 </div> <!-- /apiItem -->
736 1081
737 </div> <!-- /apiGroup --> 1082 </div> <!-- /apiGroup -->
738 1083
739 </div> <!-- /apiPage --> 1084 </div> <!-- /apiPage -->
740 </div> <!-- /gc-pagecontent --> 1085 </div> <!-- /gc-pagecontent -->
741 </div> <!-- /g-section --> 1086 </div> <!-- /g-section -->
742 </div> <!-- /codesiteContent --> 1087 </div> <!-- /codesiteContent -->
743 <div id="gc-footer" --=""> 1088 <div id="gc-footer" --="">
(...skipping 26 matching lines...) Expand all
770 _uff=0; 1115 _uff=0;
771 urchinTracker(); 1116 urchinTracker();
772 } 1117 }
773 catch(e) {/* urchinTracker not available. */} 1118 catch(e) {/* urchinTracker not available. */}
774 </script> 1119 </script>
775 <!-- end analytics --> 1120 <!-- end analytics -->
776 </div> 1121 </div>
777 </div> <!-- /gc-footer --> 1122 </div> <!-- /gc-footer -->
778 </div> <!-- /gc-container --> 1123 </div> <!-- /gc-container -->
779 </body></html> 1124 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698