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 207 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
218 <a href="#method-getBackgroundPage">getBackgroundPage</a> | 218 <a href="#method-getBackgroundPage">getBackgroundPage</a> |
219 </li><li> | 219 </li><li> |
220 <a href="#method-getURL">getURL</a> | 220 <a href="#method-getURL">getURL</a> |
221 </li><li> | 221 </li><li> |
222 <a href="#method-getViews">getViews</a> | 222 <a href="#method-getViews">getViews</a> |
223 </li><li> | 223 </li><li> |
224 <a href="#method-isAllowedFileSchemeAccess">isAllowedFileSchemeA
ccess</a> | 224 <a href="#method-isAllowedFileSchemeAccess">isAllowedFileSchemeA
ccess</a> |
225 </li><li> | 225 </li><li> |
226 <a href="#method-isAllowedIncognitoAccess">isAllowedIncognitoAcc
ess</a> | 226 <a href="#method-isAllowedIncognitoAccess">isAllowedIncognitoAcc
ess</a> |
227 </li><li> | 227 </li><li> |
| 228 <a href="#method-sendMessage">sendMessage</a> |
| 229 </li><li> |
228 <a href="#method-sendRequest">sendRequest</a> | 230 <a href="#method-sendRequest">sendRequest</a> |
229 </li><li> | 231 </li><li> |
230 <a href="#method-setUpdateUrlData">setUpdateUrlData</a> | 232 <a href="#method-setUpdateUrlData">setUpdateUrlData</a> |
231 </li> | 233 </li> |
232 </ol> | 234 </ol> |
233 </li> | 235 </li> |
234 <li> | 236 <li> |
235 <a href="#global-events">Events</a> | 237 <a href="#global-events">Events</a> |
236 <ol> | 238 <ol> |
237 <li> | 239 <li> |
238 <a href="#event-onConnect">onConnect</a> | 240 <a href="#event-onConnect">onConnect</a> |
239 </li><li> | 241 </li><li> |
240 <a href="#event-onConnectExternal">onConnectExternal</a> | 242 <a href="#event-onConnectExternal">onConnectExternal</a> |
241 </li><li> | 243 </li><li> |
| 244 <a href="#event-onMessage">onMessage</a> |
| 245 </li><li> |
| 246 <a href="#event-onMessageExternal">onMessageExternal</a> |
| 247 </li><li> |
242 <a href="#event-onRequest">onRequest</a> | 248 <a href="#event-onRequest">onRequest</a> |
243 </li><li> | 249 </li><li> |
244 <a href="#event-onRequestExternal">onRequestExternal</a> | 250 <a href="#event-onRequestExternal">onRequestExternal</a> |
245 </li> | 251 </li> |
246 </ol> | 252 </ol> |
247 </li> | 253 </li> |
248 <li> | 254 <li> |
249 <a href="#types">Types</a> | 255 <a href="#types">Types</a> |
250 <ol> | 256 <ol> |
251 <li> | 257 <li> |
(...skipping 700 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
952 </div> | 958 </div> |
953 <!-- MIN_VERSION --> | 959 <!-- MIN_VERSION --> |
954 <p> | 960 <p> |
955 This function was added in version <b><span>12.0.706.0</span><
/b>. | 961 This function was added in version <b><span>12.0.706.0</span><
/b>. |
956 If you require this function, the manifest key | 962 If you require this function, the manifest key |
957 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> | 963 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> |
958 can ensure that your extension won't be run in an earlier brow
ser version. | 964 can ensure that your extension won't be run in an earlier brow
ser version. |
959 </p> | 965 </p> |
960 </div> <!-- /description --> | 966 </div> <!-- /description --> |
961 </div><div class="apiItem"> | 967 </div><div class="apiItem"> |
| 968 <a name="method-sendMessage"></a> <!-- method-anchor --> |
| 969 <h4>sendMessage</h4> |
| 970 <div class="summary"> |
| 971 <!-- Note: intentionally longer 80 columns --> |
| 972 <span>chrome.extension.sendMessage</span>(<span class="optiona
l"><span>string</span> |
| 973 <var><span>extensionId</span></var></span><span class="nul
l"><span>, </span><span>any</span> |
| 974 <var><span>message</span></var></span><span class="optiona
l"><span>, </span><span>function</span> |
| 975 <var><span>responseCallback</span></var></span>)</div> |
| 976 <div class="description"> |
| 977 <p>Sends a single message to other listeners within the extensio
n. Similar to chrome.extension.connect, but only sends a single message with an
optional response. The <a href="extension.html#event-onMessage">chrome.extension
.onMessage</a> event is fired in each page of the extension.</p> |
| 978 <!-- PARAMETERS --> |
| 979 <h4>Parameters</h4> |
| 980 <dl> |
| 981 <div> |
| 982 <div> |
| 983 <dt> |
| 984 <var>extensionId</var> |
| 985 <em> |
| 986 <!-- TYPE --> |
| 987 <div style="display:inline"> |
| 988 ( |
| 989 <span class="optional">optional</span> |
| 990 <span id="typeTemplate"> |
| 991 <span> |
| 992 <span>string</span> |
| 993 </span> |
| 994 </span> |
| 995 ) |
| 996 </div> |
| 997 </em> |
| 998 </dt> |
| 999 <dd>The extension ID of the extension you want to connect to. If omitt
ed, default is your own extension.</dd> |
| 1000 <!-- OBJECT PROPERTIES --> |
| 1001 <!-- OBJECT METHODS --> |
| 1002 <!-- OBJECT EVENT FIELDS --> |
| 1003 <!-- FUNCTION PARAMETERS --> |
| 1004 </div> |
| 1005 </div><div> |
| 1006 <div> |
| 1007 <dt> |
| 1008 <var>message</var> |
| 1009 <em> |
| 1010 <!-- TYPE --> |
| 1011 <div style="display:inline"> |
| 1012 ( |
| 1013 <span id="typeTemplate"> |
| 1014 <span> |
| 1015 <span>any</span> |
| 1016 </span> |
| 1017 </span> |
| 1018 ) |
| 1019 </div> |
| 1020 </em> |
| 1021 </dt> |
| 1022 <dd class="todo"> |
| 1023 Undocumented. |
| 1024 </dd> |
| 1025 <!-- OBJECT PROPERTIES --> |
| 1026 <!-- OBJECT METHODS --> |
| 1027 <!-- OBJECT EVENT FIELDS --> |
| 1028 <!-- FUNCTION PARAMETERS --> |
| 1029 </div> |
| 1030 </div><div> |
| 1031 <div> |
| 1032 <dt> |
| 1033 <var>responseCallback</var> |
| 1034 <em> |
| 1035 <!-- TYPE --> |
| 1036 <div style="display:inline"> |
| 1037 ( |
| 1038 <span class="optional">optional</span> |
| 1039 <span id="typeTemplate"> |
| 1040 <span> |
| 1041 <span>function</span> |
| 1042 </span> |
| 1043 </span> |
| 1044 ) |
| 1045 </div> |
| 1046 </em> |
| 1047 </dt> |
| 1048 <dd class="todo"> |
| 1049 Undocumented. |
| 1050 </dd> |
| 1051 <!-- OBJECT PROPERTIES --> |
| 1052 <!-- OBJECT METHODS --> |
| 1053 <!-- OBJECT EVENT FIELDS --> |
| 1054 <!-- FUNCTION PARAMETERS --> |
| 1055 <dd> |
| 1056 <div> |
| 1057 <h5>Parameters</h5> |
| 1058 <dl> |
| 1059 <div> |
| 1060 <div> |
| 1061 <dt> |
| 1062 <var>response</var> |
| 1063 <em> |
| 1064 <!-- TYPE --> |
| 1065 <div style="display:inline"> |
| 1066 ( |
| 1067 <span id="typeTemplate"> |
| 1068 <span> |
| 1069 <span>any</span> |
| 1070 </span> |
| 1071 </span> |
| 1072 ) |
| 1073 </div> |
| 1074 </em> |
| 1075 </dt> |
| 1076 <dd>The JSON response object sent by the handler of the message. If an
error occurs while connecting to the extension, the callback will be called wit
h no arguments and <a href="extension.html#property-lastError">chrome.extension.
lastError</a> will be set to the error message.</dd> |
| 1077 <!-- OBJECT PROPERTIES --> |
| 1078 <!-- OBJECT METHODS --> |
| 1079 <!-- OBJECT EVENT FIELDS --> |
| 1080 <!-- FUNCTION PARAMETERS --> |
| 1081 </div> |
| 1082 </div> |
| 1083 </dl> |
| 1084 </div> |
| 1085 </dd> |
| 1086 </div> |
| 1087 </div> |
| 1088 </dl> |
| 1089 <!-- RETURNS --> |
| 1090 <dl> |
| 1091 </dl> |
| 1092 <!-- CALLBACK --> |
| 1093 <div> |
| 1094 <div> |
| 1095 <h4>Callback function</h4> |
| 1096 <p> |
| 1097 If you specify the <em>callback</em> parameter, it should |
| 1098 specify a function that looks like this: |
| 1099 </p> |
| 1100 <!-- Note: intentionally longer 80 columns --> |
| 1101 <pre>function(<span>any response</span>) <span class="subdued"
>{...}</span>;</pre> |
| 1102 <dl> |
| 1103 <div> |
| 1104 <div> |
| 1105 <dt> |
| 1106 <var>response</var> |
| 1107 <em> |
| 1108 <!-- TYPE --> |
| 1109 <div style="display:inline"> |
| 1110 ( |
| 1111 <span id="typeTemplate"> |
| 1112 <span> |
| 1113 <span>any</span> |
| 1114 </span> |
| 1115 </span> |
| 1116 ) |
| 1117 </div> |
| 1118 </em> |
| 1119 </dt> |
| 1120 <dd>The JSON response object sent by the handler of the message. If an
error occurs while connecting to the extension, the callback will be called wit
h no arguments and <a href="extension.html#property-lastError">chrome.extension.
lastError</a> will be set to the error message.</dd> |
| 1121 <!-- OBJECT PROPERTIES --> |
| 1122 <!-- OBJECT METHODS --> |
| 1123 <!-- OBJECT EVENT FIELDS --> |
| 1124 <!-- FUNCTION PARAMETERS --> |
| 1125 </div> |
| 1126 </div> |
| 1127 </dl> |
| 1128 </div> |
| 1129 </div> |
| 1130 <!-- MIN_VERSION --> |
| 1131 </div> <!-- /description --> |
| 1132 </div><div class="apiItem"> |
962 <a name="method-sendRequest"></a> <!-- method-anchor --> | 1133 <a name="method-sendRequest"></a> <!-- method-anchor --> |
963 <h4>sendRequest</h4> | 1134 <h4>sendRequest</h4> |
964 <div class="summary"> | 1135 <div class="summary"> |
965 <!-- Note: intentionally longer 80 columns --> | 1136 <!-- Note: intentionally longer 80 columns --> |
966 <span>chrome.extension.sendRequest</span>(<span class="optiona
l"><span>string</span> | 1137 <span>chrome.extension.sendRequest</span>(<span class="optiona
l"><span>string</span> |
967 <var><span>extensionId</span></var></span><span class="nul
l"><span>, </span><span>any</span> | 1138 <var><span>extensionId</span></var></span><span class="nul
l"><span>, </span><span>any</span> |
968 <var><span>request</span></var></span><span class="optiona
l"><span>, </span><span>function</span> | 1139 <var><span>request</span></var></span><span class="optiona
l"><span>, </span><span>function</span> |
969 <var><span>responseCallback</span></var></span>)</div> | 1140 <var><span>responseCallback</span></var></span>)</div> |
970 <div class="description"> | 1141 <div class="description"> |
971 <p>Sends a single request to other listeners within the extensio
n. Similar to chrome.extension.connect, but only sends a single request with an
optional response. The <a href="extension.html#event-onRequest">chrome.extension
.onRequest</a> event is fired in each page of the extension.</p> | 1142 <p>Deprecated: Please use sendMessage.</p> |
972 <!-- PARAMETERS --> | 1143 <!-- PARAMETERS --> |
973 <h4>Parameters</h4> | 1144 <h4>Parameters</h4> |
974 <dl> | 1145 <dl> |
975 <div> | 1146 <div> |
976 <div> | 1147 <div> |
977 <dt> | 1148 <dt> |
978 <var>extensionId</var> | 1149 <var>extensionId</var> |
979 <em> | 1150 <em> |
980 <!-- TYPE --> | 1151 <!-- TYPE --> |
981 <div style="display:inline"> | 1152 <div style="display:inline"> |
(...skipping 279 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1261 </div> | 1432 </div> |
1262 </div> | 1433 </div> |
1263 </dl> | 1434 </dl> |
1264 </div> | 1435 </div> |
1265 <!-- EXTRA PARAMETERS --> | 1436 <!-- EXTRA PARAMETERS --> |
1266 <!-- LISTENER RETURN VALUE --> | 1437 <!-- LISTENER RETURN VALUE --> |
1267 <dl> | 1438 <dl> |
1268 </dl> | 1439 </dl> |
1269 </div> <!-- /description --> | 1440 </div> <!-- /description --> |
1270 </div><div class="apiItem"> | 1441 </div><div class="apiItem"> |
| 1442 <a name="event-onMessage"></a> |
| 1443 <h4>onMessage</h4> |
| 1444 <div class="summary"> |
| 1445 <!-- Note: intentionally longer 80 columns --> |
| 1446 <span class="subdued">chrome.extension.</span><span>onMessage</s
pan><span class="subdued">.addListener</span>(function(<span>object details</spa
n>) <span class="subdued">{...}</span><span></span>); |
| 1447 </div> |
| 1448 <div class="description"> |
| 1449 <p>Fired when a message is sent from either an extension process
or a content script.</p> |
| 1450 <!-- LISTENER PARAMETERS --> |
| 1451 <div> |
| 1452 <h4>Listener parameters</h4> |
| 1453 <dl> |
| 1454 <div> |
| 1455 <div> |
| 1456 <dt> |
| 1457 <var>details</var> |
| 1458 <em> |
| 1459 <!-- TYPE --> |
| 1460 <div style="display:inline"> |
| 1461 ( |
| 1462 <span id="typeTemplate"> |
| 1463 <span> |
| 1464 <span>object</span> |
| 1465 </span> |
| 1466 </span> |
| 1467 ) |
| 1468 </div> |
| 1469 </em> |
| 1470 </dt> |
| 1471 <dd class="todo"> |
| 1472 Undocumented. |
| 1473 </dd> |
| 1474 <!-- OBJECT PROPERTIES --> |
| 1475 <dd> |
| 1476 <dl> |
| 1477 <div> |
| 1478 <div> |
| 1479 <dt> |
| 1480 <var>message</var> |
| 1481 <em> |
| 1482 <!-- TYPE --> |
| 1483 <div style="display:inline"> |
| 1484 ( |
| 1485 <span id="typeTemplate"> |
| 1486 <span> |
| 1487 <span>any</span> |
| 1488 </span> |
| 1489 </span> |
| 1490 ) |
| 1491 </div> |
| 1492 </em> |
| 1493 </dt> |
| 1494 <dd>The message sent by the calling script.</dd> |
| 1495 <!-- OBJECT PROPERTIES --> |
| 1496 <!-- OBJECT METHODS --> |
| 1497 <!-- OBJECT EVENT FIELDS --> |
| 1498 <!-- FUNCTION PARAMETERS --> |
| 1499 </div> |
| 1500 </div><div> |
| 1501 <div> |
| 1502 <dt> |
| 1503 <var>sender</var> |
| 1504 <em> |
| 1505 <!-- TYPE --> |
| 1506 <div style="display:inline"> |
| 1507 ( |
| 1508 <span id="typeTemplate"> |
| 1509 <span> |
| 1510 <a href="extension.html#type-MessageSender">MessageSende
r</a> |
| 1511 </span> |
| 1512 </span> |
| 1513 ) |
| 1514 </div> |
| 1515 </em> |
| 1516 </dt> |
| 1517 <dd class="todo"> |
| 1518 Undocumented. |
| 1519 </dd> |
| 1520 <!-- OBJECT PROPERTIES --> |
| 1521 <!-- OBJECT METHODS --> |
| 1522 <!-- OBJECT EVENT FIELDS --> |
| 1523 <!-- FUNCTION PARAMETERS --> |
| 1524 </div> |
| 1525 </div><div> |
| 1526 <div> |
| 1527 <dt> |
| 1528 <var>sendResponse</var> |
| 1529 <em> |
| 1530 <!-- TYPE --> |
| 1531 <div style="display:inline"> |
| 1532 ( |
| 1533 <span id="typeTemplate"> |
| 1534 <span> |
| 1535 <span>function</span> |
| 1536 </span> |
| 1537 </span> |
| 1538 ) |
| 1539 </div> |
| 1540 </em> |
| 1541 </dt> |
| 1542 <dd>Function to call (at most once) when you have a response. The argu
ment should be any JSON-ifiable object. If you have more than one <code>onMessag
e</code> listener in the same document, then only one may send a response. This
function becomes invalid when the event listener returns, unless you return true
from the event listener to indicate you wish to send a response asynchronously
(this will keep the message channel open to the other end until <code>sendRespon
se</code> is called).</dd> |
| 1543 <!-- OBJECT PROPERTIES --> |
| 1544 <!-- OBJECT METHODS --> |
| 1545 <!-- OBJECT EVENT FIELDS --> |
| 1546 <!-- FUNCTION PARAMETERS --> |
| 1547 </div> |
| 1548 </div> |
| 1549 </dl> |
| 1550 </dd> |
| 1551 <!-- OBJECT METHODS --> |
| 1552 <!-- OBJECT EVENT FIELDS --> |
| 1553 <!-- FUNCTION PARAMETERS --> |
| 1554 </div> |
| 1555 </div> |
| 1556 </dl> |
| 1557 </div> |
| 1558 <!-- EXTRA PARAMETERS --> |
| 1559 <!-- LISTENER RETURN VALUE --> |
| 1560 <h4>Listener returns</h4> |
| 1561 <dl> |
| 1562 <div> |
| 1563 <div> |
| 1564 <dt> |
| 1565 <em> |
| 1566 <!-- TYPE --> |
| 1567 <div style="display:inline"> |
| 1568 ( |
| 1569 <span class="optional">optional</span> |
| 1570 <span id="typeTemplate"> |
| 1571 <span> |
| 1572 <span>boolean</span> |
| 1573 </span> |
| 1574 </span> |
| 1575 ) |
| 1576 </div> |
| 1577 </em> |
| 1578 </dt> |
| 1579 <dd>Return true from the event listener if you wish to call <code>send
Response</code> after the event listener returns.</dd> |
| 1580 <!-- OBJECT PROPERTIES --> |
| 1581 <!-- OBJECT METHODS --> |
| 1582 <!-- OBJECT EVENT FIELDS --> |
| 1583 <!-- FUNCTION PARAMETERS --> |
| 1584 </div> |
| 1585 </div> |
| 1586 </dl> |
| 1587 </div> <!-- /description --> |
| 1588 </div><div class="apiItem"> |
| 1589 <a name="event-onMessageExternal"></a> |
| 1590 <h4>onMessageExternal</h4> |
| 1591 <div class="summary"> |
| 1592 <!-- Note: intentionally longer 80 columns --> |
| 1593 <span class="subdued">chrome.extension.</span><span>onMessageExt
ernal</span><span class="subdued">.addListener</span>(function(<span>object deta
ils</span>) <span class="subdued">{...}</span><span></span>); |
| 1594 </div> |
| 1595 <div class="description"> |
| 1596 <p>Fired when a message is sent from another extension.</p> |
| 1597 <!-- LISTENER PARAMETERS --> |
| 1598 <div> |
| 1599 <h4>Listener parameters</h4> |
| 1600 <dl> |
| 1601 <div> |
| 1602 <div> |
| 1603 <dt> |
| 1604 <var>details</var> |
| 1605 <em> |
| 1606 <!-- TYPE --> |
| 1607 <div style="display:inline"> |
| 1608 ( |
| 1609 <span id="typeTemplate"> |
| 1610 <span> |
| 1611 <span>object</span> |
| 1612 </span> |
| 1613 </span> |
| 1614 ) |
| 1615 </div> |
| 1616 </em> |
| 1617 </dt> |
| 1618 <dd class="todo"> |
| 1619 Undocumented. |
| 1620 </dd> |
| 1621 <!-- OBJECT PROPERTIES --> |
| 1622 <dd> |
| 1623 <dl> |
| 1624 <div> |
| 1625 <div> |
| 1626 <dt> |
| 1627 <var>message</var> |
| 1628 <em> |
| 1629 <!-- TYPE --> |
| 1630 <div style="display:inline"> |
| 1631 ( |
| 1632 <span id="typeTemplate"> |
| 1633 <span> |
| 1634 <span>any</span> |
| 1635 </span> |
| 1636 </span> |
| 1637 ) |
| 1638 </div> |
| 1639 </em> |
| 1640 </dt> |
| 1641 <dd>The message sent by the calling script.</dd> |
| 1642 <!-- OBJECT PROPERTIES --> |
| 1643 <!-- OBJECT METHODS --> |
| 1644 <!-- OBJECT EVENT FIELDS --> |
| 1645 <!-- FUNCTION PARAMETERS --> |
| 1646 </div> |
| 1647 </div><div> |
| 1648 <div> |
| 1649 <dt> |
| 1650 <var>sender</var> |
| 1651 <em> |
| 1652 <!-- TYPE --> |
| 1653 <div style="display:inline"> |
| 1654 ( |
| 1655 <span id="typeTemplate"> |
| 1656 <span> |
| 1657 <a href="extension.html#type-MessageSender">MessageSende
r</a> |
| 1658 </span> |
| 1659 </span> |
| 1660 ) |
| 1661 </div> |
| 1662 </em> |
| 1663 </dt> |
| 1664 <dd class="todo"> |
| 1665 Undocumented. |
| 1666 </dd> |
| 1667 <!-- OBJECT PROPERTIES --> |
| 1668 <!-- OBJECT METHODS --> |
| 1669 <!-- OBJECT EVENT FIELDS --> |
| 1670 <!-- FUNCTION PARAMETERS --> |
| 1671 </div> |
| 1672 </div><div> |
| 1673 <div> |
| 1674 <dt> |
| 1675 <var>sendResponse</var> |
| 1676 <em> |
| 1677 <!-- TYPE --> |
| 1678 <div style="display:inline"> |
| 1679 ( |
| 1680 <span id="typeTemplate"> |
| 1681 <span> |
| 1682 <span>function</span> |
| 1683 </span> |
| 1684 </span> |
| 1685 ) |
| 1686 </div> |
| 1687 </em> |
| 1688 </dt> |
| 1689 <dd>Function to call (at most once) when you have a response. The argu
ment should be any JSON-ifiable object. If you have more than one <code>onMessag
e</code> listener in the same document, then only one may send a response. This
function becomes invalid when the event listener returns, unless you return true
from the event listener to indicate you wish to send a response asynchronously
(this will keep the message channel open to the other end until <code>sendRespon
se</code> is called).</dd> |
| 1690 <!-- OBJECT PROPERTIES --> |
| 1691 <!-- OBJECT METHODS --> |
| 1692 <!-- OBJECT EVENT FIELDS --> |
| 1693 <!-- FUNCTION PARAMETERS --> |
| 1694 </div> |
| 1695 </div> |
| 1696 </dl> |
| 1697 </dd> |
| 1698 <!-- OBJECT METHODS --> |
| 1699 <!-- OBJECT EVENT FIELDS --> |
| 1700 <!-- FUNCTION PARAMETERS --> |
| 1701 </div> |
| 1702 </div> |
| 1703 </dl> |
| 1704 </div> |
| 1705 <!-- EXTRA PARAMETERS --> |
| 1706 <!-- LISTENER RETURN VALUE --> |
| 1707 <h4>Listener returns</h4> |
| 1708 <dl> |
| 1709 <div> |
| 1710 <div> |
| 1711 <dt> |
| 1712 <em> |
| 1713 <!-- TYPE --> |
| 1714 <div style="display:inline"> |
| 1715 ( |
| 1716 <span class="optional">optional</span> |
| 1717 <span id="typeTemplate"> |
| 1718 <span> |
| 1719 <span>boolean</span> |
| 1720 </span> |
| 1721 </span> |
| 1722 ) |
| 1723 </div> |
| 1724 </em> |
| 1725 </dt> |
| 1726 <dd>Return true from the event listener if you wish to call <code>send
Response</code> after the event listener returns.</dd> |
| 1727 <!-- OBJECT PROPERTIES --> |
| 1728 <!-- OBJECT METHODS --> |
| 1729 <!-- OBJECT EVENT FIELDS --> |
| 1730 <!-- FUNCTION PARAMETERS --> |
| 1731 </div> |
| 1732 </div> |
| 1733 </dl> |
| 1734 </div> <!-- /description --> |
| 1735 </div><div class="apiItem"> |
1271 <a name="event-onRequest"></a> | 1736 <a name="event-onRequest"></a> |
1272 <h4>onRequest</h4> | 1737 <h4>onRequest</h4> |
1273 <div class="summary"> | 1738 <div class="summary"> |
1274 <!-- Note: intentionally longer 80 columns --> | 1739 <!-- Note: intentionally longer 80 columns --> |
1275 <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>
<span></span>); | 1740 <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>
<span></span>); |
1276 </div> | 1741 </div> |
1277 <div class="description"> | 1742 <div class="description"> |
1278 <p>Fired when a request is sent from either an extension process
or a content script.</p> | 1743 <p>Deprecated: please use onMessage.</p> |
1279 <!-- LISTENER PARAMETERS --> | 1744 <!-- LISTENER PARAMETERS --> |
1280 <div> | 1745 <div> |
1281 <h4>Listener parameters</h4> | 1746 <h4>Listener parameters</h4> |
1282 <dl> | 1747 <dl> |
1283 <div> | 1748 <div> |
1284 <div> | 1749 <div> |
1285 <dt> | 1750 <dt> |
1286 <var>request</var> | 1751 <var>request</var> |
1287 <em> | 1752 <em> |
1288 <!-- TYPE --> | 1753 <!-- TYPE --> |
(...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1360 </dl> | 1825 </dl> |
1361 </div> <!-- /description --> | 1826 </div> <!-- /description --> |
1362 </div><div class="apiItem"> | 1827 </div><div class="apiItem"> |
1363 <a name="event-onRequestExternal"></a> | 1828 <a name="event-onRequestExternal"></a> |
1364 <h4>onRequestExternal</h4> | 1829 <h4>onRequestExternal</h4> |
1365 <div class="summary"> | 1830 <div class="summary"> |
1366 <!-- Note: intentionally longer 80 columns --> | 1831 <!-- Note: intentionally longer 80 columns --> |
1367 <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><span></span>); | 1832 <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><span></span>); |
1368 </div> | 1833 </div> |
1369 <div class="description"> | 1834 <div class="description"> |
1370 <p>Fired when a request is sent from another extension.</p> | 1835 <p>Deprecated: please use onMessageExternal.</p> |
1371 <!-- LISTENER PARAMETERS --> | 1836 <!-- LISTENER PARAMETERS --> |
1372 <div> | 1837 <div> |
1373 <h4>Listener parameters</h4> | 1838 <h4>Listener parameters</h4> |
1374 <dl> | 1839 <dl> |
1375 <div> | 1840 <div> |
1376 <div> | 1841 <div> |
1377 <dt> | 1842 <dt> |
1378 <var>request</var> | 1843 <var>request</var> |
1379 <em> | 1844 <em> |
1380 <!-- TYPE --> | 1845 <!-- TYPE --> |
(...skipping 468 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1849 _uff=0; | 2314 _uff=0; |
1850 urchinTracker(); | 2315 urchinTracker(); |
1851 } | 2316 } |
1852 catch(e) {/* urchinTracker not available. */} | 2317 catch(e) {/* urchinTracker not available. */} |
1853 </script> | 2318 </script> |
1854 <!-- end analytics --> | 2319 <!-- end analytics --> |
1855 </div> | 2320 </div> |
1856 </div> <!-- /gc-footer --> | 2321 </div> <!-- /gc-footer --> |
1857 </div> <!-- /gc-container --> | 2322 </div> <!-- /gc-container --> |
1858 </body></html> | 2323 </body></html> |
OLD | NEW |