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

Side by Side Diff: chrome/common/extensions/docs/permissions.html

Issue 10829301: Extension docs: Manual merge crrev.com/143652 (Closed) Base URL: svn://svn.chromium.org/chrome/branches/1180/src/
Patch Set: Created 8 years, 4 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 224 matching lines...) Expand 10 before | Expand all | Expand 10 after
235 <a href="#event-onAdded">onAdded</a> 235 <a href="#event-onAdded">onAdded</a>
236 </li><li> 236 </li><li>
237 <a href="#event-onRemoved">onRemoved</a> 237 <a href="#event-onRemoved">onRemoved</a>
238 </li> 238 </li>
239 </ol> 239 </ol>
240 </li> 240 </li>
241 <li> 241 <li>
242 <a href="#types">Types</a> 242 <a href="#types">Types</a>
243 <ol> 243 <ol>
244 <li> 244 <li>
245 <a href="#type-Permissions">null</a> 245 <a href="#type-permissions.Permissions">Permissions</a>
246 <ol> 246 <ol>
247 </ol> 247 </ol>
248 </li> 248 </li>
249 </ol> 249 </ol>
250 </li> 250 </li>
251 </ol> 251 </ol>
252 </li> 252 </li>
253 </ol> 253 </ol>
254 </div> 254 </div>
255 <!-- /TABLE OF CONTENTS --> 255 <!-- /TABLE OF CONTENTS -->
(...skipping 168 matching lines...) Expand 10 before | Expand all | Expand 10 after
424 <!-- METHODS --> 424 <!-- METHODS -->
425 <div id="methodsTemplate" class="apiGroup"> 425 <div id="methodsTemplate" class="apiGroup">
426 <a name="global-methods"></a> 426 <a name="global-methods"></a>
427 <h3>Methods</h3> 427 <h3>Methods</h3>
428 <!-- iterates over all functions --> 428 <!-- iterates over all functions -->
429 <div class="apiItem"> 429 <div class="apiItem">
430 <a name="method-contains"></a> <!-- method-anchor --> 430 <a name="method-contains"></a> <!-- method-anchor -->
431 <h4>contains</h4> 431 <h4>contains</h4>
432 <div class="summary"> 432 <div class="summary">
433 <!-- Note: intentionally longer 80 columns --> 433 <!-- Note: intentionally longer 80 columns -->
434 <span>chrome.permissions.contains</span>(<span class="null"><s pan>Permissions</span> 434 <span>chrome.permissions.contains</span>(<span class="null"><s pan>permissions.Permissions</span>
435 <var><span>permissions</span></var></span><span class="nul l"><span>, </span><span>function</span> 435 <var><span>permissions</span></var></span><span class="nul l"><span>, </span><span>function</span>
436 <var><span>callback</span></var></span>)</div> 436 <var><span>callback</span></var></span>)</div>
437 <div class="description"> 437 <div class="description">
438 <p>Checks if the extension has the specified permissions.</p> 438 <p>Checks if the extension has the specified permissions.</p>
439 <!-- PARAMETERS --> 439 <!-- PARAMETERS -->
440 <h4>Parameters</h4> 440 <h4>Parameters</h4>
441 <dl> 441 <dl>
442 <div> 442 <div>
443 <div> 443 <div>
444 <dt> 444 <dt>
445 <var>permissions</var> 445 <var>permissions</var>
446 <em> 446 <em>
447 <!-- TYPE --> 447 <!-- TYPE -->
448 <div style="display:inline"> 448 <div style="display:inline">
449 ( 449 (
450 <span id="typeTemplate"> 450 <span id="typeTemplate">
451 <span> 451 <span>
452 <a href="permissions.html#type-Permissions">Permissions< /a> 452 <a href="permissions.html#type-permissions.Permissions"> permissions.Permissions</a>
453 </span> 453 </span>
454 </span> 454 </span>
455 ) 455 )
456 </div> 456 </div>
457 </em> 457 </em>
458 </dt> 458 </dt>
459 <dd class="todo"> 459 <dd class="todo">
460 Undocumented. 460 Undocumented.
461 </dd> 461 </dd>
462 <!-- OBJECT PROPERTIES --> 462 <!-- OBJECT PROPERTIES -->
(...skipping 77 matching lines...) Expand 10 before | Expand all | Expand 10 after
540 <dl> 540 <dl>
541 </dl> 541 </dl>
542 <!-- CALLBACK --> 542 <!-- CALLBACK -->
543 <!-- MIN_VERSION --> 543 <!-- MIN_VERSION -->
544 </div> <!-- /description --> 544 </div> <!-- /description -->
545 </div><div class="apiItem"> 545 </div><div class="apiItem">
546 <a name="method-remove"></a> <!-- method-anchor --> 546 <a name="method-remove"></a> <!-- method-anchor -->
547 <h4>remove</h4> 547 <h4>remove</h4>
548 <div class="summary"> 548 <div class="summary">
549 <!-- Note: intentionally longer 80 columns --> 549 <!-- Note: intentionally longer 80 columns -->
550 <span>chrome.permissions.remove</span>(<span class="null"><spa n>Permissions</span> 550 <span>chrome.permissions.remove</span>(<span class="null"><spa n>permissions.Permissions</span>
551 <var><span>permissions</span></var></span><span class="opt ional"><span>, </span><span>function</span> 551 <var><span>permissions</span></var></span><span class="opt ional"><span>, </span><span>function</span>
552 <var><span>callback</span></var></span>)</div> 552 <var><span>callback</span></var></span>)</div>
553 <div class="description"> 553 <div class="description">
554 <p>Removes access to the specified permissions. If there are any problems removing the permissions, <a href="extension.html#property-lastError"> chrome.extension.lastError</a> will be set.</p> 554 <p>Removes access to the specified permissions. If there are any problems removing the permissions, <a href="extension.html#property-lastError"> chrome.extension.lastError</a> will be set.</p>
555 <!-- PARAMETERS --> 555 <!-- PARAMETERS -->
556 <h4>Parameters</h4> 556 <h4>Parameters</h4>
557 <dl> 557 <dl>
558 <div> 558 <div>
559 <div> 559 <div>
560 <dt> 560 <dt>
561 <var>permissions</var> 561 <var>permissions</var>
562 <em> 562 <em>
563 <!-- TYPE --> 563 <!-- TYPE -->
564 <div style="display:inline"> 564 <div style="display:inline">
565 ( 565 (
566 <span id="typeTemplate"> 566 <span id="typeTemplate">
567 <span> 567 <span>
568 <a href="permissions.html#type-Permissions">Permissions< /a> 568 <a href="permissions.html#type-permissions.Permissions"> permissions.Permissions</a>
569 </span> 569 </span>
570 </span> 570 </span>
571 ) 571 )
572 </div> 572 </div>
573 </em> 573 </em>
574 </dt> 574 </dt>
575 <dd class="todo"> 575 <dd class="todo">
576 Undocumented. 576 Undocumented.
577 </dd> 577 </dd>
578 <!-- OBJECT PROPERTIES --> 578 <!-- OBJECT PROPERTIES -->
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
612 <dl> 612 <dl>
613 </dl> 613 </dl>
614 <!-- CALLBACK --> 614 <!-- CALLBACK -->
615 <!-- MIN_VERSION --> 615 <!-- MIN_VERSION -->
616 </div> <!-- /description --> 616 </div> <!-- /description -->
617 </div><div class="apiItem"> 617 </div><div class="apiItem">
618 <a name="method-request"></a> <!-- method-anchor --> 618 <a name="method-request"></a> <!-- method-anchor -->
619 <h4>request</h4> 619 <h4>request</h4>
620 <div class="summary"> 620 <div class="summary">
621 <!-- Note: intentionally longer 80 columns --> 621 <!-- Note: intentionally longer 80 columns -->
622 <span>chrome.permissions.request</span>(<span class="null"><sp an>Permissions</span> 622 <span>chrome.permissions.request</span>(<span class="null"><sp an>permissions.Permissions</span>
623 <var><span>permissions</span></var></span><span class="opt ional"><span>, </span><span>function</span> 623 <var><span>permissions</span></var></span><span class="opt ional"><span>, </span><span>function</span>
624 <var><span>callback</span></var></span>)</div> 624 <var><span>callback</span></var></span>)</div>
625 <div class="description"> 625 <div class="description">
626 <p>Requests access to the specified permissions. These permissio ns must be defined in the optional_permissions field of the manifest. If there a re any problems requesting the permissions, <a href="extension.html#property-las tError">chrome.extension.lastError</a> will be set.</p> 626 <p>Requests access to the specified permissions. These permissio ns must be defined in the optional_permissions field of the manifest. If there a re any problems requesting the permissions, <a href="extension.html#property-las tError">chrome.extension.lastError</a> will be set.</p>
627 <!-- PARAMETERS --> 627 <!-- PARAMETERS -->
628 <h4>Parameters</h4> 628 <h4>Parameters</h4>
629 <dl> 629 <dl>
630 <div> 630 <div>
631 <div> 631 <div>
632 <dt> 632 <dt>
633 <var>permissions</var> 633 <var>permissions</var>
634 <em> 634 <em>
635 <!-- TYPE --> 635 <!-- TYPE -->
636 <div style="display:inline"> 636 <div style="display:inline">
637 ( 637 (
638 <span id="typeTemplate"> 638 <span id="typeTemplate">
639 <span> 639 <span>
640 <a href="permissions.html#type-Permissions">Permissions< /a> 640 <a href="permissions.html#type-permissions.Permissions"> permissions.Permissions</a>
641 </span> 641 </span>
642 </span> 642 </span>
643 ) 643 )
644 </div> 644 </div>
645 </em> 645 </em>
646 </dt> 646 </dt>
647 <dd class="todo"> 647 <dd class="todo">
648 Undocumented. 648 Undocumented.
649 </dd> 649 </dd>
650 <!-- OBJECT PROPERTIES --> 650 <!-- OBJECT PROPERTIES -->
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after
691 <!-- EVENTS --> 691 <!-- EVENTS -->
692 <div id="eventsTemplate" class="apiGroup"> 692 <div id="eventsTemplate" class="apiGroup">
693 <a name="global-events"></a> 693 <a name="global-events"></a>
694 <h3>Events</h3> 694 <h3>Events</h3>
695 <!-- iterates over all events --> 695 <!-- iterates over all events -->
696 <div class="apiItem"> 696 <div class="apiItem">
697 <a name="event-onAdded"></a> 697 <a name="event-onAdded"></a>
698 <h4>onAdded</h4> 698 <h4>onAdded</h4>
699 <div class="summary"> 699 <div class="summary">
700 <!-- Note: intentionally longer 80 columns --> 700 <!-- Note: intentionally longer 80 columns -->
701 <span class="subdued">chrome.permissions.</span><span>onAdded</s pan><span class="subdued">.addListener</span>(function(<span>Permissions permiss ions</span>) <span class="subdued">{...}</span><span></span>); 701 <span class="subdued">chrome.permissions.</span><span>onAdded</s pan><span class="subdued">.addListener</span>(function(<span>permissions.Permiss ions permissions</span>) <span class="subdued">{...}</span><span></span>);
702 </div> 702 </div>
703 <div class="description"> 703 <div class="description">
704 <p>Fired when the extension acquires new permissions.</p> 704 <p>Fired when the extension acquires new permissions.</p>
705 <!-- LISTENER PARAMETERS --> 705 <!-- LISTENER PARAMETERS -->
706 <div> 706 <div>
707 <h4>Listener parameters</h4> 707 <h4>Listener parameters</h4>
708 <dl> 708 <dl>
709 <div> 709 <div>
710 <div> 710 <div>
711 <dt> 711 <dt>
712 <var>permissions</var> 712 <var>permissions</var>
713 <em> 713 <em>
714 <!-- TYPE --> 714 <!-- TYPE -->
715 <div style="display:inline"> 715 <div style="display:inline">
716 ( 716 (
717 <span id="typeTemplate"> 717 <span id="typeTemplate">
718 <span> 718 <span>
719 <a href="permissions.html#type-Permissions">Permissions< /a> 719 <a href="permissions.html#type-permissions.Permissions"> permissions.Permissions</a>
720 </span> 720 </span>
721 </span> 721 </span>
722 ) 722 )
723 </div> 723 </div>
724 </em> 724 </em>
725 </dt> 725 </dt>
726 <dd>The newly acquired permissions.</dd> 726 <dd>The newly acquired permissions.</dd>
727 <!-- OBJECT PROPERTIES --> 727 <!-- OBJECT PROPERTIES -->
728 <!-- OBJECT METHODS --> 728 <!-- OBJECT METHODS -->
729 <!-- OBJECT EVENT FIELDS --> 729 <!-- OBJECT EVENT FIELDS -->
730 <!-- FUNCTION PARAMETERS --> 730 <!-- FUNCTION PARAMETERS -->
731 </div> 731 </div>
732 </div> 732 </div>
733 </dl> 733 </dl>
734 </div> 734 </div>
735 <!-- EXTRA PARAMETERS --> 735 <!-- EXTRA PARAMETERS -->
736 <!-- LISTENER RETURN VALUE --> 736 <!-- LISTENER RETURN VALUE -->
737 <dl> 737 <dl>
738 </dl> 738 </dl>
739 </div> <!-- /description --> 739 </div> <!-- /description -->
740 <!-- /description --> 740 <!-- /description -->
741 </div><div class="apiItem"> 741 </div><div class="apiItem">
742 <a name="event-onRemoved"></a> 742 <a name="event-onRemoved"></a>
743 <h4>onRemoved</h4> 743 <h4>onRemoved</h4>
744 <div class="summary"> 744 <div class="summary">
745 <!-- Note: intentionally longer 80 columns --> 745 <!-- Note: intentionally longer 80 columns -->
746 <span class="subdued">chrome.permissions.</span><span>onRemoved< /span><span class="subdued">.addListener</span>(function(<span>Permissions permi ssions</span>) <span class="subdued">{...}</span><span></span>); 746 <span class="subdued">chrome.permissions.</span><span>onRemoved< /span><span class="subdued">.addListener</span>(function(<span>permissions.Permi ssions permissions</span>) <span class="subdued">{...}</span><span></span>);
747 </div> 747 </div>
748 <div class="description"> 748 <div class="description">
749 <p>Fired when access to permissions has been removed from the ex tension.</p> 749 <p>Fired when access to permissions has been removed from the ex tension.</p>
750 <!-- LISTENER PARAMETERS --> 750 <!-- LISTENER PARAMETERS -->
751 <div> 751 <div>
752 <h4>Listener parameters</h4> 752 <h4>Listener parameters</h4>
753 <dl> 753 <dl>
754 <div> 754 <div>
755 <div> 755 <div>
756 <dt> 756 <dt>
757 <var>permissions</var> 757 <var>permissions</var>
758 <em> 758 <em>
759 <!-- TYPE --> 759 <!-- TYPE -->
760 <div style="display:inline"> 760 <div style="display:inline">
761 ( 761 (
762 <span id="typeTemplate"> 762 <span id="typeTemplate">
763 <span> 763 <span>
764 <a href="permissions.html#type-Permissions">Permissions< /a> 764 <a href="permissions.html#type-permissions.Permissions"> permissions.Permissions</a>
765 </span> 765 </span>
766 </span> 766 </span>
767 ) 767 )
768 </div> 768 </div>
769 </em> 769 </em>
770 </dt> 770 </dt>
771 <dd>The permissions that have been removed.</dd> 771 <dd>The permissions that have been removed.</dd>
772 <!-- OBJECT PROPERTIES --> 772 <!-- OBJECT PROPERTIES -->
773 <!-- OBJECT METHODS --> 773 <!-- OBJECT METHODS -->
774 <!-- OBJECT EVENT FIELDS --> 774 <!-- OBJECT EVENT FIELDS -->
775 <!-- FUNCTION PARAMETERS --> 775 <!-- FUNCTION PARAMETERS -->
776 </div> 776 </div>
777 </div> 777 </div>
778 </dl> 778 </dl>
779 </div> 779 </div>
780 <!-- EXTRA PARAMETERS --> 780 <!-- EXTRA PARAMETERS -->
781 <!-- LISTENER RETURN VALUE --> 781 <!-- LISTENER RETURN VALUE -->
782 <dl> 782 <dl>
783 </dl> 783 </dl>
784 </div> <!-- /description --> 784 </div> <!-- /description -->
785 <!-- /description --> 785 <!-- /description -->
786 </div> <!-- /apiItem --> 786 </div> <!-- /apiItem -->
787 </div> <!-- /apiGroup --> 787 </div> <!-- /apiGroup -->
788 <!-- TYPES --> 788 <!-- TYPES -->
789 <div class="apiGroup"> 789 <div class="apiGroup">
790 <a name="types"></a> 790 <a name="types"></a>
791 <h3 id="types">Types</h3> 791 <h3 id="types">Types</h3>
792 <!-- iterates over all types --> 792 <!-- iterates over all types -->
793 <div class="apiItem"> 793 <div class="apiItem">
794 <a name="type-Permissions"></a> 794 <a name="type-permissions.Permissions"></a>
795 <h4>Permissions</h4> 795 <h4>permissions.Permissions</h4>
796 <div> 796 <div>
797 <dt> 797 <dt>
798 <em> 798 <em>
799 <!-- TYPE --> 799 <!-- TYPE -->
800 <div style="display:inline"> 800 <div style="display:inline">
801 ( 801 (
802 <span id="typeTemplate"> 802 <span id="typeTemplate">
803 <span> 803 <span>
804 <span>object</span> 804 <span>object</span>
805 </span> 805 </span>
(...skipping 117 matching lines...) Expand 10 before | Expand all | Expand 10 after
923 _uff=0; 923 _uff=0;
924 urchinTracker(); 924 urchinTracker();
925 } 925 }
926 catch(e) {/* urchinTracker not available. */} 926 catch(e) {/* urchinTracker not available. */}
927 </script> 927 </script>
928 <!-- end analytics --> 928 <!-- end analytics -->
929 </div> 929 </div>
930 </div> <!-- /gc-footer --> 930 </div> <!-- /gc-footer -->
931 </div> <!-- /gc-container --> 931 </div> <!-- /gc-container -->
932 </body></html> 932 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/pageAction.html ('k') | chrome/common/extensions/docs/privacy.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698