OLD | NEW |
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 199 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
210 </li><li jsinstance="2"> | 210 </li><li jsinstance="2"> |
211 <a href="#event-onRequest">onRequest</a> | 211 <a href="#event-onRequest">onRequest</a> |
212 </li><li jsinstance="*3"> | 212 </li><li jsinstance="*3"> |
213 <a href="#event-onRequestExternal">onRequestExternal</a> | 213 <a href="#event-onRequestExternal">onRequestExternal</a> |
214 </li> | 214 </li> |
215 </ol> | 215 </ol> |
216 </li> | 216 </li> |
217 <li> | 217 <li> |
218 <a href="#types">Types</a> | 218 <a href="#types">Types</a> |
219 <ol> | 219 <ol> |
220 <li jsinstance="*0"> | 220 <li jsinstance="0"> |
221 <a href="#type-Port">Port</a> | 221 <a href="#type-Port">Port</a> |
| 222 </li><li jsinstance="*1"> |
| 223 <a href="#type-MessageSender">MessageSender</a> |
222 </li> | 224 </li> |
223 </ol> | 225 </ol> |
224 </li> | 226 </li> |
225 </ol> | 227 </ol> |
226 </li> | 228 </li> |
227 </div> | 229 </div> |
228 </ol> | 230 </ol> |
229 </div> | 231 </div> |
230 <!-- /TABLE OF CONTENTS --> | 232 <!-- /TABLE OF CONTENTS --> |
231 | 233 |
(...skipping 1272 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1504 </dl> | 1506 </dl> |
1505 | 1507 |
1506 </div> <!-- /decription --> | 1508 </div> <!-- /decription --> |
1507 | 1509 |
1508 </div><div class="apiItem" jsinstance="2"> | 1510 </div><div class="apiItem" jsinstance="2"> |
1509 <a name="event-onRequest"></a> | 1511 <a name="event-onRequest"></a> |
1510 <h4>onRequest</h4> | 1512 <h4>onRequest</h4> |
1511 | 1513 |
1512 <div class="summary"> | 1514 <div class="summary"> |
1513 <!-- Note: intentionally longer 80 columns --> | 1515 <!-- Note: intentionally longer 80 columns --> |
1514 <span class="subdued">chrome.extension.</span><span>onRequest</s
pan><span class="subdued">.addListener</span>(function(<span>any request, functi
on sendResponse</span>) <span class="subdued">{...}</span>); | 1516 <span class="subdued">chrome.extension.</span><span>onRequest</s
pan><span class="subdued">.addListener</span>(function(<span>any request, Messag
eSender sender, function sendResponse</span>) <span class="subdued">{...}</span>
); |
1515 </div> | 1517 </div> |
1516 | 1518 |
1517 <div class="description"> | 1519 <div class="description"> |
1518 <p class="todo" style="display: none; ">Undocumented.</p> | 1520 <p class="todo" style="display: none; ">Undocumented.</p> |
1519 <p>Fired when a request is sent from either an extension process
or a content script.</p> | 1521 <p>Fired when a request is sent from either an extension process
or a content script.</p> |
1520 | 1522 |
1521 <!-- PARAMETERS --> | 1523 <!-- PARAMETERS --> |
1522 <h4>Parameters</h4> | 1524 <h4>Parameters</h4> |
1523 <dl> | 1525 <dl> |
1524 <div jsinstance="0"> | 1526 <div jsinstance="0"> |
(...skipping 15 matching lines...) Expand all Loading... |
1540 array of <span><span></span></span> | 1542 array of <span><span></span></span> |
1541 </span> | 1543 </span> |
1542 <span>any</span> | 1544 <span>any</span> |
1543 </span> | 1545 </span> |
1544 </span> | 1546 </span> |
1545 ) | 1547 ) |
1546 </div> | 1548 </div> |
1547 | 1549 |
1548 </em> | 1550 </em> |
1549 </dt> | 1551 </dt> |
| 1552 <dd class="todo" style="display: none; "> |
| 1553 Undocumented. |
| 1554 </dd> |
| 1555 <dd>The request sent by the calling script.</dd> |
| 1556 |
| 1557 <!-- OBJECT PROPERTIES --> |
| 1558 <dd style="display: none; "> |
| 1559 <dl> |
| 1560 <div> |
| 1561 <div> |
| 1562 </div> |
| 1563 </div> |
| 1564 </dl> |
| 1565 </dd> |
| 1566 </div> |
| 1567 </div><div jsinstance="1"> |
| 1568 <div> |
| 1569 <dt> |
| 1570 <var>sender</var> |
| 1571 <em> |
| 1572 |
| 1573 <!-- TYPE --> |
| 1574 <div style="display:inline"> |
| 1575 ( |
| 1576 <span class="optional" style="display: none; ">optional</spa
n> |
| 1577 <span id="typeTemplate"> |
| 1578 <span> |
| 1579 <a href="extension.html#type-MessageSender">MessageSende
r</a> |
| 1580 </span> |
| 1581 <span style="display: none; "> |
| 1582 <span> |
| 1583 array of <span><span></span></span> |
| 1584 </span> |
| 1585 <span>paramType</span> |
| 1586 </span> |
| 1587 </span> |
| 1588 ) |
| 1589 </div> |
| 1590 |
| 1591 </em> |
| 1592 </dt> |
1550 <dd class="todo"> | 1593 <dd class="todo"> |
1551 Undocumented. | 1594 Undocumented. |
1552 </dd> | 1595 </dd> |
1553 <dd style="display: none; "> | 1596 <dd style="display: none; "> |
1554 Description of this parameter from the json schema. | 1597 Description of this parameter from the json schema. |
1555 </dd> | 1598 </dd> |
1556 | 1599 |
1557 <!-- OBJECT PROPERTIES --> | 1600 <!-- OBJECT PROPERTIES --> |
1558 <dd style="display: none; "> | 1601 <dd style="display: none; "> |
1559 <dl> | 1602 <dl> |
1560 <div> | 1603 <div> |
1561 <div> | 1604 <div> |
1562 </div> | 1605 </div> |
1563 </div> | 1606 </div> |
1564 </dl> | 1607 </dl> |
1565 </dd> | 1608 </dd> |
1566 </div> | 1609 </div> |
1567 </div><div jsinstance="*1"> | 1610 </div><div jsinstance="*2"> |
1568 <div> | 1611 <div> |
1569 <dt> | 1612 <dt> |
1570 <var>sendResponse</var> | 1613 <var>sendResponse</var> |
1571 <em> | 1614 <em> |
1572 | 1615 |
1573 <!-- TYPE --> | 1616 <!-- TYPE --> |
1574 <div style="display:inline"> | 1617 <div style="display:inline"> |
1575 ( | 1618 ( |
1576 <span class="optional" style="display: none; ">optional</spa
n> | 1619 <span class="optional" style="display: none; ">optional</spa
n> |
1577 <span id="typeTemplate"> | 1620 <span id="typeTemplate"> |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1609 </dl> | 1652 </dl> |
1610 | 1653 |
1611 </div> <!-- /decription --> | 1654 </div> <!-- /decription --> |
1612 | 1655 |
1613 </div><div class="apiItem" jsinstance="*3"> | 1656 </div><div class="apiItem" jsinstance="*3"> |
1614 <a name="event-onRequestExternal"></a> | 1657 <a name="event-onRequestExternal"></a> |
1615 <h4>onRequestExternal</h4> | 1658 <h4>onRequestExternal</h4> |
1616 | 1659 |
1617 <div class="summary"> | 1660 <div class="summary"> |
1618 <!-- Note: intentionally longer 80 columns --> | 1661 <!-- Note: intentionally longer 80 columns --> |
1619 <span class="subdued">chrome.extension.</span><span>onRequestExt
ernal</span><span class="subdued">.addListener</span>(function(<span>any request
, function sendResponse</span>) <span class="subdued">{...}</span>); | 1662 <span class="subdued">chrome.extension.</span><span>onRequestExt
ernal</span><span class="subdued">.addListener</span>(function(<span>any request
, MessageSender sender, function sendResponse</span>) <span class="subdued">{...
}</span>); |
1620 </div> | 1663 </div> |
1621 | 1664 |
1622 <div class="description"> | 1665 <div class="description"> |
1623 <p class="todo" style="display: none; ">Undocumented.</p> | 1666 <p class="todo" style="display: none; ">Undocumented.</p> |
1624 <p>Fired when a request is sent from another extension.</p> | 1667 <p>Fired when a request is sent from another extension.</p> |
1625 | 1668 |
1626 <!-- PARAMETERS --> | 1669 <!-- PARAMETERS --> |
1627 <h4>Parameters</h4> | 1670 <h4>Parameters</h4> |
1628 <dl> | 1671 <dl> |
1629 <div jsinstance="0"> | 1672 <div jsinstance="0"> |
(...skipping 15 matching lines...) Expand all Loading... |
1645 array of <span><span></span></span> | 1688 array of <span><span></span></span> |
1646 </span> | 1689 </span> |
1647 <span>any</span> | 1690 <span>any</span> |
1648 </span> | 1691 </span> |
1649 </span> | 1692 </span> |
1650 ) | 1693 ) |
1651 </div> | 1694 </div> |
1652 | 1695 |
1653 </em> | 1696 </em> |
1654 </dt> | 1697 </dt> |
| 1698 <dd class="todo" style="display: none; "> |
| 1699 Undocumented. |
| 1700 </dd> |
| 1701 <dd>The request sent by the calling script.</dd> |
| 1702 |
| 1703 <!-- OBJECT PROPERTIES --> |
| 1704 <dd style="display: none; "> |
| 1705 <dl> |
| 1706 <div> |
| 1707 <div> |
| 1708 </div> |
| 1709 </div> |
| 1710 </dl> |
| 1711 </dd> |
| 1712 </div> |
| 1713 </div><div jsinstance="1"> |
| 1714 <div> |
| 1715 <dt> |
| 1716 <var>sender</var> |
| 1717 <em> |
| 1718 |
| 1719 <!-- TYPE --> |
| 1720 <div style="display:inline"> |
| 1721 ( |
| 1722 <span class="optional" style="display: none; ">optional</spa
n> |
| 1723 <span id="typeTemplate"> |
| 1724 <span> |
| 1725 <a href="extension.html#type-MessageSender">MessageSende
r</a> |
| 1726 </span> |
| 1727 <span style="display: none; "> |
| 1728 <span> |
| 1729 array of <span><span></span></span> |
| 1730 </span> |
| 1731 <span>paramType</span> |
| 1732 </span> |
| 1733 </span> |
| 1734 ) |
| 1735 </div> |
| 1736 |
| 1737 </em> |
| 1738 </dt> |
1655 <dd class="todo"> | 1739 <dd class="todo"> |
1656 Undocumented. | 1740 Undocumented. |
1657 </dd> | 1741 </dd> |
1658 <dd style="display: none; "> | 1742 <dd style="display: none; "> |
1659 Description of this parameter from the json schema. | 1743 Description of this parameter from the json schema. |
1660 </dd> | 1744 </dd> |
1661 | 1745 |
1662 <!-- OBJECT PROPERTIES --> | 1746 <!-- OBJECT PROPERTIES --> |
1663 <dd style="display: none; "> | 1747 <dd style="display: none; "> |
1664 <dl> | 1748 <dl> |
1665 <div> | 1749 <div> |
1666 <div> | 1750 <div> |
1667 </div> | 1751 </div> |
1668 </div> | 1752 </div> |
1669 </dl> | 1753 </dl> |
1670 </dd> | 1754 </dd> |
1671 </div> | 1755 </div> |
1672 </div><div jsinstance="*1"> | 1756 </div><div jsinstance="*2"> |
1673 <div> | 1757 <div> |
1674 <dt> | 1758 <dt> |
1675 <var>sendResponse</var> | 1759 <var>sendResponse</var> |
1676 <em> | 1760 <em> |
1677 | 1761 |
1678 <!-- TYPE --> | 1762 <!-- TYPE --> |
1679 <div style="display:inline"> | 1763 <div style="display:inline"> |
1680 ( | 1764 ( |
1681 <span class="optional" style="display: none; ">optional</spa
n> | 1765 <span class="optional" style="display: none; ">optional</spa
n> |
1682 <span id="typeTemplate"> | 1766 <span id="typeTemplate"> |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1718 </div> <!-- /apiItem --> | 1802 </div> <!-- /apiItem --> |
1719 | 1803 |
1720 </div> <!-- /apiGroup --> | 1804 </div> <!-- /apiGroup --> |
1721 | 1805 |
1722 <!-- TYPES --> | 1806 <!-- TYPES --> |
1723 <div class="apiGroup"> | 1807 <div class="apiGroup"> |
1724 <a name="types.sort(sortByName)"></a> | 1808 <a name="types.sort(sortByName)"></a> |
1725 <h3 id="types">Types</h3> | 1809 <h3 id="types">Types</h3> |
1726 | 1810 |
1727 <!-- iterates over all types --> | 1811 <!-- iterates over all types --> |
1728 <div class="apiItem" jsinstance="*0"> | 1812 <div class="apiItem" jsinstance="0"> |
1729 <a name="type-Port"></a> | 1813 <a name="type-Port"></a> |
1730 <h4>Port</h4> | 1814 <h4>Port</h4> |
1731 | 1815 |
1732 <div> | 1816 <div> |
1733 <dt> | 1817 <dt> |
1734 <var style="display: none; ">paramName</var> | 1818 <var style="display: none; ">paramName</var> |
1735 <em> | 1819 <em> |
1736 | 1820 |
1737 <!-- TYPE --> | 1821 <!-- TYPE --> |
1738 <div style="display:inline"> | 1822 <div style="display:inline"> |
(...skipping 199 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1938 <div> | 2022 <div> |
1939 <dt> | 2023 <dt> |
1940 <var>sender</var> | 2024 <var>sender</var> |
1941 <em> | 2025 <em> |
1942 | 2026 |
1943 <!-- TYPE --> | 2027 <!-- TYPE --> |
1944 <div style="display:inline"> | 2028 <div style="display:inline"> |
1945 ( | 2029 ( |
1946 <span class="optional">optional</span> | 2030 <span class="optional">optional</span> |
1947 <span id="typeTemplate"> | 2031 <span id="typeTemplate"> |
| 2032 <span> |
| 2033 <a href="extension.html#type-MessageSender">MessageSende
r</a> |
| 2034 </span> |
| 2035 <span style="display: none; "> |
| 2036 <span> |
| 2037 array of <span><span></span></span> |
| 2038 </span> |
| 2039 <span>paramType</span> |
| 2040 </span> |
| 2041 </span> |
| 2042 ) |
| 2043 </div> |
| 2044 |
| 2045 </em> |
| 2046 </dt> |
| 2047 <dd class="todo" style="display: none; "> |
| 2048 Undocumented. |
| 2049 </dd> |
| 2050 <dd>This property will <b>only</b> be present on ports passed to onCon
nect/onConnectExternal listeners.</dd> |
| 2051 |
| 2052 <!-- OBJECT PROPERTIES --> |
| 2053 <dd style="display: none; "> |
| 2054 <dl> |
| 2055 <div> |
| 2056 <div> |
| 2057 </div> |
| 2058 </div> |
| 2059 </dl> |
| 2060 </dd> |
| 2061 </div> |
| 2062 </div> |
| 2063 </dl> |
| 2064 </dd> |
| 2065 </div> |
| 2066 |
| 2067 </div><div class="apiItem" jsinstance="*1"> |
| 2068 <a name="type-MessageSender"></a> |
| 2069 <h4>MessageSender</h4> |
| 2070 |
| 2071 <div> |
| 2072 <dt> |
| 2073 <var style="display: none; ">paramName</var> |
| 2074 <em> |
| 2075 |
| 2076 <!-- TYPE --> |
| 2077 <div style="display:inline"> |
| 2078 ( |
| 2079 <span class="optional" style="display: none; ">optional</spa
n> |
| 2080 <span id="typeTemplate"> |
1948 <span style="display: none; "> | 2081 <span style="display: none; "> |
1949 <a> Type</a> | 2082 <a> Type</a> |
1950 </span> | 2083 </span> |
1951 <span> | 2084 <span> |
1952 <span style="display: none; "> | 2085 <span style="display: none; "> |
1953 array of <span><span></span></span> | 2086 array of <span><span></span></span> |
1954 </span> | 2087 </span> |
1955 <span>object</span> | 2088 <span>object</span> |
1956 </span> | 2089 </span> |
1957 </span> | 2090 </span> |
1958 ) | 2091 ) |
1959 </div> | 2092 </div> |
1960 | 2093 |
1961 </em> | 2094 </em> |
1962 </dt> | 2095 </dt> |
1963 <dd class="todo" style="display: none; "> | 2096 <dd class="todo" style="display: none; "> |
1964 Undocumented. | 2097 Undocumented. |
1965 </dd> | 2098 </dd> |
1966 <dd>This property will <b>only</b> be present on ports passed to onCon
nect/onConnectExternal listeners.</dd> | 2099 <dd>An object containing information about the script context that sen
t a message or request.</dd> |
1967 | 2100 |
1968 <!-- OBJECT PROPERTIES --> | 2101 <!-- OBJECT PROPERTIES --> |
1969 <dd> | 2102 <dd> |
1970 <dl> | 2103 <dl> |
1971 <div jsinstance="0"> | 2104 <div jsinstance="0"> |
1972 <div> | 2105 <div> |
1973 <dt> | 2106 <dt> |
1974 <var>tab</var> | 2107 <var>tab</var> |
1975 <em> | 2108 <em> |
1976 | 2109 |
(...skipping 70 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2047 <div> | 2180 <div> |
2048 </div> | 2181 </div> |
2049 </div> | 2182 </div> |
2050 </dl> | 2183 </dl> |
2051 </dd> | 2184 </dd> |
2052 </div> | 2185 </div> |
2053 </div> | 2186 </div> |
2054 </dl> | 2187 </dl> |
2055 </dd> | 2188 </dd> |
2056 </div> | 2189 </div> |
2057 </div> | |
2058 </dl> | |
2059 </dd> | |
2060 </div> | |
2061 | 2190 |
2062 </div> <!-- /apiItem --> | 2191 </div> <!-- /apiItem --> |
2063 | 2192 |
2064 </div> <!-- /apiGroup --> | 2193 </div> <!-- /apiGroup --> |
2065 | 2194 |
2066 </div> <!-- /apiPage --> | 2195 </div> <!-- /apiPage --> |
2067 </div> <!-- /mainColumn --> | 2196 </div> <!-- /mainColumn --> |
2068 </div> <!-- /pageContent --> | 2197 </div> <!-- /pageContent --> |
2069 <div id="pageFooter" --=""> | 2198 <div id="pageFooter" --=""> |
2070 <p> | 2199 <p> |
(...skipping 25 matching lines...) Expand all Loading... |
2096 urchinTracker(); | 2225 urchinTracker(); |
2097 } | 2226 } |
2098 catch(e) {/* urchinTracker not available. */} | 2227 catch(e) {/* urchinTracker not available. */} |
2099 </script> | 2228 </script> |
2100 <!-- end analytics --> | 2229 <!-- end analytics --> |
2101 | 2230 |
2102 </div> <!-- /pageFooter --> | 2231 </div> <!-- /pageFooter --> |
2103 </div> <!-- /container --> | 2232 </div> <!-- /container --> |
2104 </body></html> | 2233 </body></html> |
2105 | 2234 |
OLD | NEW |