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

Side by Side Diff: chrome/common/extensions/docs/extension.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 233 matching lines...) Expand 10 before | Expand all | Expand 10 after
244 <a href="#event-onMessage">onMessage</a> 244 <a href="#event-onMessage">onMessage</a>
245 </li><li> 245 </li><li>
246 <a href="#event-onMessageExternal">onMessageExternal</a> 246 <a href="#event-onMessageExternal">onMessageExternal</a>
247 </li> 247 </li>
248 </ol> 248 </ol>
249 </li> 249 </li>
250 <li> 250 <li>
251 <a href="#types">Types</a> 251 <a href="#types">Types</a>
252 <ol> 252 <ol>
253 <li> 253 <li>
254 <a href="#type-MessageSender">null</a> 254 <a href="#type-extension.MessageSender">MessageSender</a>
255 <ol> 255 <ol>
256 </ol> 256 </ol>
257 </li><li> 257 </li><li>
258 <a href="#type-Port">null</a> 258 <a href="#type-extension.Port">Port</a>
259 <ol> 259 <ol>
260 </ol> 260 </ol>
261 </li> 261 </li>
262 </ol> 262 </ol>
263 </li> 263 </li>
264 </ol> 264 </ol>
265 </li> 265 </li>
266 </ol> 266 </ol>
267 </div> 267 </div>
268 <!-- /TABLE OF CONTENTS --> 268 <!-- /TABLE OF CONTENTS -->
(...skipping 142 matching lines...) Expand 10 before | Expand all | Expand 10 after
411 </div> 411 </div>
412 </div> <!-- /apiGroup --> 412 </div> <!-- /apiGroup -->
413 <!-- METHODS --> 413 <!-- METHODS -->
414 <div id="methodsTemplate" class="apiGroup"> 414 <div id="methodsTemplate" class="apiGroup">
415 <a name="global-methods"></a> 415 <a name="global-methods"></a>
416 <h3>Methods</h3> 416 <h3>Methods</h3>
417 <!-- iterates over all functions --> 417 <!-- iterates over all functions -->
418 <div class="apiItem"> 418 <div class="apiItem">
419 <a name="method-connect"></a> <!-- method-anchor --> 419 <a name="method-connect"></a> <!-- method-anchor -->
420 <h4>connect</h4> 420 <h4>connect</h4>
421 <div class="summary"><span>Port</span> 421 <div class="summary"><span>extension.Port</span>
422 <!-- Note: intentionally longer 80 columns --> 422 <!-- Note: intentionally longer 80 columns -->
423 <span>chrome.extension.connect</span>(<span class="optional">< span>string</span> 423 <span>chrome.extension.connect</span>(<span class="optional">< span>string</span>
424 <var><span>extensionId</span></var></span><span class="opt ional"><span>, </span><span>object</span> 424 <var><span>extensionId</span></var></span><span class="opt ional"><span>, </span><span>object</span>
425 <var><span>connectInfo</span></var></span>)</div> 425 <var><span>connectInfo</span></var></span>)</div>
426 <div class="description"> 426 <div class="description">
427 <p>Attempts to connect to other listeners within the extension ( such as the extension's background page). This is primarily useful for content s cripts connecting to their extension processes. Extensions may connect to conten t scripts embedded in tabs via <a href="tabs.html#method-connect"><code>chrome.t abs.connect()</code></a>.</p> 427 <p>Attempts to connect to other listeners within the extension ( such as the extension's background page). This is primarily useful for content s cripts connecting to their extension processes. Extensions may connect to conten t scripts embedded in tabs via <a href="tabs.html#method-connect"><code>chrome.t abs.connect()</code></a>.</p>
428 <!-- PARAMETERS --> 428 <!-- PARAMETERS -->
429 <h4>Parameters</h4> 429 <h4>Parameters</h4>
430 <dl> 430 <dl>
431 <div> 431 <div>
(...skipping 82 matching lines...) Expand 10 before | Expand all | Expand 10 after
514 <dl> 514 <dl>
515 <div> 515 <div>
516 <div> 516 <div>
517 <dt> 517 <dt>
518 <em> 518 <em>
519 <!-- TYPE --> 519 <!-- TYPE -->
520 <div style="display:inline"> 520 <div style="display:inline">
521 ( 521 (
522 <span id="typeTemplate"> 522 <span id="typeTemplate">
523 <span> 523 <span>
524 <a href="extension.html#type-Port">Port</a> 524 <a href="extension.html#type-extension.Port">extension.P ort</a>
525 </span> 525 </span>
526 </span> 526 </span>
527 ) 527 )
528 </div> 528 </div>
529 </em> 529 </em>
530 </dt> 530 </dt>
531 <dd>Port through which messages can be sent and received with the exte nsion. The port's <a href="extension.html#type-Port">onDisconnect</a> event is f ired if extension does not exist. </dd> 531 <dd>Port through which messages can be sent and received with the exte nsion. The port's <a href="extension.html#type-Port">onDisconnect</a> event is f ired if extension does not exist. </dd>
532 <!-- OBJECT PROPERTIES --> 532 <!-- OBJECT PROPERTIES -->
533 <!-- OBJECT METHODS --> 533 <!-- OBJECT METHODS -->
534 <!-- OBJECT EVENT FIELDS --> 534 <!-- OBJECT EVENT FIELDS -->
(...skipping 525 matching lines...) Expand 10 before | Expand all | Expand 10 after
1060 <!-- EVENTS --> 1060 <!-- EVENTS -->
1061 <div id="eventsTemplate" class="apiGroup"> 1061 <div id="eventsTemplate" class="apiGroup">
1062 <a name="global-events"></a> 1062 <a name="global-events"></a>
1063 <h3>Events</h3> 1063 <h3>Events</h3>
1064 <!-- iterates over all events --> 1064 <!-- iterates over all events -->
1065 <div class="apiItem"> 1065 <div class="apiItem">
1066 <a name="event-onConnect"></a> 1066 <a name="event-onConnect"></a>
1067 <h4>onConnect</h4> 1067 <h4>onConnect</h4>
1068 <div class="summary"> 1068 <div class="summary">
1069 <!-- Note: intentionally longer 80 columns --> 1069 <!-- Note: intentionally longer 80 columns -->
1070 <span class="subdued">chrome.extension.</span><span>onConnect</s pan><span class="subdued">.addListener</span>(function(<span>Port port</span>) < span class="subdued">{...}</span><span></span>); 1070 <span class="subdued">chrome.extension.</span><span>onConnect</s pan><span class="subdued">.addListener</span>(function(<span>extension.Port port </span>) <span class="subdued">{...}</span><span></span>);
1071 </div> 1071 </div>
1072 <div class="description"> 1072 <div class="description">
1073 <p>Fired when a connection is made from either an extension proc ess or a content script.</p> 1073 <p>Fired when a connection is made from either an extension proc ess or a content script.</p>
1074 <!-- LISTENER PARAMETERS --> 1074 <!-- LISTENER PARAMETERS -->
1075 <div> 1075 <div>
1076 <h4>Listener parameters</h4> 1076 <h4>Listener parameters</h4>
1077 <dl> 1077 <dl>
1078 <div> 1078 <div>
1079 <div> 1079 <div>
1080 <dt> 1080 <dt>
1081 <var>port</var> 1081 <var>port</var>
1082 <em> 1082 <em>
1083 <!-- TYPE --> 1083 <!-- TYPE -->
1084 <div style="display:inline"> 1084 <div style="display:inline">
1085 ( 1085 (
1086 <span id="typeTemplate"> 1086 <span id="typeTemplate">
1087 <span> 1087 <span>
1088 <a href="extension.html#type-Port">Port</a> 1088 <a href="extension.html#type-extension.Port">extension.P ort</a>
1089 </span> 1089 </span>
1090 </span> 1090 </span>
1091 ) 1091 )
1092 </div> 1092 </div>
1093 </em> 1093 </em>
1094 </dt> 1094 </dt>
1095 <dd class="todo"> 1095 <dd class="todo">
1096 Undocumented. 1096 Undocumented.
1097 </dd> 1097 </dd>
1098 <!-- OBJECT PROPERTIES --> 1098 <!-- OBJECT PROPERTIES -->
1099 <!-- OBJECT METHODS --> 1099 <!-- OBJECT METHODS -->
1100 <!-- OBJECT EVENT FIELDS --> 1100 <!-- OBJECT EVENT FIELDS -->
1101 <!-- FUNCTION PARAMETERS --> 1101 <!-- FUNCTION PARAMETERS -->
1102 </div> 1102 </div>
1103 </div> 1103 </div>
1104 </dl> 1104 </dl>
1105 </div> 1105 </div>
1106 <!-- EXTRA PARAMETERS --> 1106 <!-- EXTRA PARAMETERS -->
1107 <!-- LISTENER RETURN VALUE --> 1107 <!-- LISTENER RETURN VALUE -->
1108 <dl> 1108 <dl>
1109 </dl> 1109 </dl>
1110 </div> <!-- /description --> 1110 </div> <!-- /description -->
1111 <!-- /description --> 1111 <!-- /description -->
1112 </div><div class="apiItem"> 1112 </div><div class="apiItem">
1113 <a name="event-onConnectExternal"></a> 1113 <a name="event-onConnectExternal"></a>
1114 <h4>onConnectExternal</h4> 1114 <h4>onConnectExternal</h4>
1115 <div class="summary"> 1115 <div class="summary">
1116 <!-- Note: intentionally longer 80 columns --> 1116 <!-- Note: intentionally longer 80 columns -->
1117 <span class="subdued">chrome.extension.</span><span>onConnectExt ernal</span><span class="subdued">.addListener</span>(function(<span>Port port</ span>) <span class="subdued">{...}</span><span></span>); 1117 <span class="subdued">chrome.extension.</span><span>onConnectExt ernal</span><span class="subdued">.addListener</span>(function(<span>extension.P ort port</span>) <span class="subdued">{...}</span><span></span>);
1118 </div> 1118 </div>
1119 <div class="description"> 1119 <div class="description">
1120 <p>Fired when a connection is made from another extension.</p> 1120 <p>Fired when a connection is made from another extension.</p>
1121 <!-- LISTENER PARAMETERS --> 1121 <!-- LISTENER PARAMETERS -->
1122 <div> 1122 <div>
1123 <h4>Listener parameters</h4> 1123 <h4>Listener parameters</h4>
1124 <dl> 1124 <dl>
1125 <div> 1125 <div>
1126 <div> 1126 <div>
1127 <dt> 1127 <dt>
1128 <var>port</var> 1128 <var>port</var>
1129 <em> 1129 <em>
1130 <!-- TYPE --> 1130 <!-- TYPE -->
1131 <div style="display:inline"> 1131 <div style="display:inline">
1132 ( 1132 (
1133 <span id="typeTemplate"> 1133 <span id="typeTemplate">
1134 <span> 1134 <span>
1135 <a href="extension.html#type-Port">Port</a> 1135 <a href="extension.html#type-extension.Port">extension.P ort</a>
1136 </span> 1136 </span>
1137 </span> 1137 </span>
1138 ) 1138 )
1139 </div> 1139 </div>
1140 </em> 1140 </em>
1141 </dt> 1141 </dt>
1142 <dd class="todo"> 1142 <dd class="todo">
1143 Undocumented. 1143 Undocumented.
1144 </dd> 1144 </dd>
1145 <!-- OBJECT PROPERTIES --> 1145 <!-- OBJECT PROPERTIES -->
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after
1218 </div><div> 1218 </div><div>
1219 <div> 1219 <div>
1220 <dt> 1220 <dt>
1221 <var>sender</var> 1221 <var>sender</var>
1222 <em> 1222 <em>
1223 <!-- TYPE --> 1223 <!-- TYPE -->
1224 <div style="display:inline"> 1224 <div style="display:inline">
1225 ( 1225 (
1226 <span id="typeTemplate"> 1226 <span id="typeTemplate">
1227 <span> 1227 <span>
1228 <a href="extension.html#type-MessageSender">MessageSende r</a> 1228 <a href="extension.html#type-extension.MessageSender">ex tension.MessageSender</a>
1229 </span> 1229 </span>
1230 </span> 1230 </span>
1231 ) 1231 )
1232 </div> 1232 </div>
1233 </em> 1233 </em>
1234 </dt> 1234 </dt>
1235 <dd class="todo"> 1235 <dd class="todo">
1236 Undocumented. 1236 Undocumented.
1237 </dd> 1237 </dd>
1238 <!-- OBJECT PROPERTIES --> 1238 <!-- OBJECT PROPERTIES -->
(...skipping 127 matching lines...) Expand 10 before | Expand all | Expand 10 after
1366 </div><div> 1366 </div><div>
1367 <div> 1367 <div>
1368 <dt> 1368 <dt>
1369 <var>sender</var> 1369 <var>sender</var>
1370 <em> 1370 <em>
1371 <!-- TYPE --> 1371 <!-- TYPE -->
1372 <div style="display:inline"> 1372 <div style="display:inline">
1373 ( 1373 (
1374 <span id="typeTemplate"> 1374 <span id="typeTemplate">
1375 <span> 1375 <span>
1376 <a href="extension.html#type-MessageSender">MessageSende r</a> 1376 <a href="extension.html#type-extension.MessageSender">ex tension.MessageSender</a>
1377 </span> 1377 </span>
1378 </span> 1378 </span>
1379 ) 1379 )
1380 </div> 1380 </div>
1381 </em> 1381 </em>
1382 </dt> 1382 </dt>
1383 <dd class="todo"> 1383 <dd class="todo">
1384 Undocumented. 1384 Undocumented.
1385 </dd> 1385 </dd>
1386 <!-- OBJECT PROPERTIES --> 1386 <!-- OBJECT PROPERTIES -->
(...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after
1453 </div> <!-- /description --> 1453 </div> <!-- /description -->
1454 <!-- /description --> 1454 <!-- /description -->
1455 </div> <!-- /apiItem --> 1455 </div> <!-- /apiItem -->
1456 </div> <!-- /apiGroup --> 1456 </div> <!-- /apiGroup -->
1457 <!-- TYPES --> 1457 <!-- TYPES -->
1458 <div class="apiGroup"> 1458 <div class="apiGroup">
1459 <a name="types"></a> 1459 <a name="types"></a>
1460 <h3 id="types">Types</h3> 1460 <h3 id="types">Types</h3>
1461 <!-- iterates over all types --> 1461 <!-- iterates over all types -->
1462 <div class="apiItem"> 1462 <div class="apiItem">
1463 <a name="type-MessageSender"></a> 1463 <a name="type-extension.MessageSender"></a>
1464 <h4>MessageSender</h4> 1464 <h4>extension.MessageSender</h4>
1465 <div> 1465 <div>
1466 <dt> 1466 <dt>
1467 <em> 1467 <em>
1468 <!-- TYPE --> 1468 <!-- TYPE -->
1469 <div style="display:inline"> 1469 <div style="display:inline">
1470 ( 1470 (
1471 <span id="typeTemplate"> 1471 <span id="typeTemplate">
1472 <span> 1472 <span>
1473 <span>object</span> 1473 <span>object</span>
1474 </span> 1474 </span>
(...skipping 10 matching lines...) Expand all
1485 <div> 1485 <div>
1486 <dt> 1486 <dt>
1487 <var>tab</var> 1487 <var>tab</var>
1488 <em> 1488 <em>
1489 <!-- TYPE --> 1489 <!-- TYPE -->
1490 <div style="display:inline"> 1490 <div style="display:inline">
1491 ( 1491 (
1492 <span class="optional">optional</span> 1492 <span class="optional">optional</span>
1493 <span id="typeTemplate"> 1493 <span id="typeTemplate">
1494 <span> 1494 <span>
1495 <a>tabs.Tab</a> 1495 <a href="tabs.html#type-tabs.Tab">tabs.Tab</a>
1496 </span> 1496 </span>
1497 </span> 1497 </span>
1498 ) 1498 )
1499 </div> 1499 </div>
1500 </em> 1500 </em>
1501 </dt> 1501 </dt>
1502 <dd>This property will <b>only</b> be present when the connection was opened from a tab or content script.</dd> 1502 <dd>This property will <b>only</b> be present when the connection was opened from a tab or content script.</dd>
1503 <!-- OBJECT PROPERTIES --> 1503 <!-- OBJECT PROPERTIES -->
1504 <!-- OBJECT METHODS --> 1504 <!-- OBJECT METHODS -->
1505 <!-- OBJECT EVENT FIELDS --> 1505 <!-- OBJECT EVENT FIELDS -->
(...skipping 23 matching lines...) Expand all
1529 <!-- FUNCTION PARAMETERS --> 1529 <!-- FUNCTION PARAMETERS -->
1530 </div> 1530 </div>
1531 </div> 1531 </div>
1532 </dl> 1532 </dl>
1533 </dd> 1533 </dd>
1534 <!-- OBJECT METHODS --> 1534 <!-- OBJECT METHODS -->
1535 <!-- OBJECT EVENT FIELDS --> 1535 <!-- OBJECT EVENT FIELDS -->
1536 <!-- FUNCTION PARAMETERS --> 1536 <!-- FUNCTION PARAMETERS -->
1537 </div> 1537 </div>
1538 </div><div class="apiItem"> 1538 </div><div class="apiItem">
1539 <a name="type-Port"></a> 1539 <a name="type-extension.Port"></a>
1540 <h4>Port</h4> 1540 <h4>extension.Port</h4>
1541 <div> 1541 <div>
1542 <dt> 1542 <dt>
1543 <em> 1543 <em>
1544 <!-- TYPE --> 1544 <!-- TYPE -->
1545 <div style="display:inline"> 1545 <div style="display:inline">
1546 ( 1546 (
1547 <span id="typeTemplate"> 1547 <span id="typeTemplate">
1548 <span> 1548 <span>
1549 <span>object</span> 1549 <span>object</span>
1550 </span> 1550 </span>
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after
1585 </div><div> 1585 </div><div>
1586 <div> 1586 <div>
1587 <dt> 1587 <dt>
1588 <var>onDisconnect</var> 1588 <var>onDisconnect</var>
1589 <em> 1589 <em>
1590 <!-- TYPE --> 1590 <!-- TYPE -->
1591 <div style="display:inline"> 1591 <div style="display:inline">
1592 ( 1592 (
1593 <span id="typeTemplate"> 1593 <span id="typeTemplate">
1594 <span> 1594 <span>
1595 <a>events.Event</a> 1595 <a href="events.html#type-events.Event">events.Event</a>
1596 </span> 1596 </span>
1597 </span> 1597 </span>
1598 ) 1598 )
1599 </div> 1599 </div>
1600 </em> 1600 </em>
1601 </dt> 1601 </dt>
1602 <dd class="todo"> 1602 <dd class="todo">
1603 Undocumented. 1603 Undocumented.
1604 </dd> 1604 </dd>
1605 <!-- OBJECT PROPERTIES --> 1605 <!-- OBJECT PROPERTIES -->
1606 <!-- OBJECT METHODS --> 1606 <!-- OBJECT METHODS -->
1607 <!-- OBJECT EVENT FIELDS --> 1607 <!-- OBJECT EVENT FIELDS -->
1608 <!-- FUNCTION PARAMETERS --> 1608 <!-- FUNCTION PARAMETERS -->
1609 </div> 1609 </div>
1610 </div><div> 1610 </div><div>
1611 <div> 1611 <div>
1612 <dt> 1612 <dt>
1613 <var>onMessage</var> 1613 <var>onMessage</var>
1614 <em> 1614 <em>
1615 <!-- TYPE --> 1615 <!-- TYPE -->
1616 <div style="display:inline"> 1616 <div style="display:inline">
1617 ( 1617 (
1618 <span id="typeTemplate"> 1618 <span id="typeTemplate">
1619 <span> 1619 <span>
1620 <a>events.Event</a> 1620 <a href="events.html#type-events.Event">events.Event</a>
1621 </span> 1621 </span>
1622 </span> 1622 </span>
1623 ) 1623 )
1624 </div> 1624 </div>
1625 </em> 1625 </em>
1626 </dt> 1626 </dt>
1627 <dd class="todo"> 1627 <dd class="todo">
1628 Undocumented. 1628 Undocumented.
1629 </dd> 1629 </dd>
1630 <!-- OBJECT PROPERTIES --> 1630 <!-- OBJECT PROPERTIES -->
(...skipping 30 matching lines...) Expand all
1661 <div> 1661 <div>
1662 <dt> 1662 <dt>
1663 <var>sender</var> 1663 <var>sender</var>
1664 <em> 1664 <em>
1665 <!-- TYPE --> 1665 <!-- TYPE -->
1666 <div style="display:inline"> 1666 <div style="display:inline">
1667 ( 1667 (
1668 <span class="optional">optional</span> 1668 <span class="optional">optional</span>
1669 <span id="typeTemplate"> 1669 <span id="typeTemplate">
1670 <span> 1670 <span>
1671 <a href="extension.html#type-MessageSender">MessageSende r</a> 1671 <a href="extension.html#type-extension.MessageSender">ex tension.MessageSender</a>
1672 </span> 1672 </span>
1673 </span> 1673 </span>
1674 ) 1674 )
1675 </div> 1675 </div>
1676 </em> 1676 </em>
1677 </dt> 1677 </dt>
1678 <dd>This property will <b>only</b> be present on ports passed to onCon nect/onConnectExternal listeners.</dd> 1678 <dd>This property will <b>only</b> be present on ports passed to onCon nect/onConnectExternal listeners.</dd>
1679 <!-- OBJECT PROPERTIES --> 1679 <!-- OBJECT PROPERTIES -->
1680 <!-- OBJECT METHODS --> 1680 <!-- OBJECT METHODS -->
1681 <!-- OBJECT EVENT FIELDS --> 1681 <!-- OBJECT EVENT FIELDS -->
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after
1730 _uff=0; 1730 _uff=0;
1731 urchinTracker(); 1731 urchinTracker();
1732 } 1732 }
1733 catch(e) {/* urchinTracker not available. */} 1733 catch(e) {/* urchinTracker not available. */}
1734 </script> 1734 </script>
1735 <!-- end analytics --> 1735 <!-- end analytics -->
1736 </div> 1736 </div>
1737 </div> <!-- /gc-footer --> 1737 </div> <!-- /gc-footer -->
1738 </div> <!-- /gc-container --> 1738 </div> <!-- /gc-container -->
1739 </body></html> 1739 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.speechInput.html ('k') | chrome/common/extensions/docs/fileBrowserHandler.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698