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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 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
« no previous file with comments | « chrome/common/extensions/docs/experimental.webRequest.html ('k') | chrome/common/extensions/docs/extensions/a11y.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
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
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
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
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <meta name="description" content="Documentation for the chrome.extension modul e, which is part of the Google Chrome extension APIs."><title>chrome.extension - Google Chrome Extensions - Google Code</title></head>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">chrome.extension</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#content scripts">Support for content scripts</a>
196 <ol>
197 </ol>
198 </li>
199 <li>
200 <a href="#apiReference">API reference: chrome.extension</a>
201 <ol>
202 <li>
203 <a href="#properties">Properties</a>
204 <ol>
205 <li>
206 <a href="#property-lastError">lastError</a>
207 </li><li>
208 <a href="#property-inIncognitoContext">inIncognitoContext</a>
209 </li>
210 </ol>
211 </li>
212 <li>
213 <a href="#global-methods">Methods</a>
214 <ol>
215 <li>
216 <a href="#method-connect">connect</a>
217 </li><li>
218 <a href="#method-getBackgroundPage">getBackgroundPage</a>
219 </li><li>
220 <a href="#method-getURL">getURL</a>
221 </li><li>
222 <a href="#method-getViews">getViews</a>
223 </li><li>
224 <a href="#method-isAllowedFileSchemeAccess">isAllowedFileSchemeA ccess</a>
225 </li><li>
226 <a href="#method-isAllowedIncognitoAccess">isAllowedIncognitoAcc ess</a>
227 </li><li>
228 <a href="#method-sendMessage">sendMessage</a>
229 </li><li>
230 <a href="#method-setUpdateUrlData">setUpdateUrlData</a>
231 </li>
232 </ol>
233 </li>
234 <li>
235 <a href="#global-events">Events</a>
236 <ol>
237 <li>
238 <a href="#event-onConnect">onConnect</a>
239 </li><li>
240 <a href="#event-onConnectExternal">onConnectExternal</a>
241 </li><li>
242 <a href="#event-onMessage">onMessage</a>
243 </li><li>
244 <a href="#event-onMessageExternal">onMessageExternal</a>
245 </li>
246 </ol>
247 </li>
248 <li>
249 <a href="#types">Types</a>
250 <ol>
251 <li>
252 <a href="#type-MessageSender">MessageSender</a>
253 <ol>
254 </ol>
255 </li><li>
256 <a href="#type-Port">Port</a>
257 <ol>
258 </ol>
259 </li>
260 </ol>
261 </li>
262 </ol>
263 </li>
264 </ol>
265 </div>
266 <!-- /TABLE OF CONTENTS -->
267 <!-- Standard content lead-in for experimental API pages -->
268 <!-- STATIC CONTENT PLACEHOLDER -->
269 <div id="static"><!-- BEGIN AUTHORED CONTENT -->
270 <p id="classSummary">
271 The <code>chrome.extension</code> module
272 has utilities that can be used by any extension page.
273 It includes support for exchanging messages
274 between an extension and its content scripts
275 or between extensions,
276 as described in detail in
277 <a href="messaging.html">Message Passing</a>.
278 </p>
279 <h2 id="content scripts">Support for content scripts</h2>
280 <p>
281 Unlike the other chrome.* APIs,
282 parts of <code>chrome.extension</code>
283 can be used by content scripts:
284 </p>
285 <dl>
286 <dt>
287 <a href="#method-sendMessage"><code>sendMessage()</code></a> and
288 <a href="#event-onMessage"><code>onMessage</code></a>
289 </dt>
290 <dd>
291 Simple communication with extension pages
292 </dd>
293 <dt>
294 <a href="#method-connect"><code>connect()</code></a> and
295 <a href="#event-onConnect"><code>onConnect</code></a>
296 </dt>
297 <dd>
298 Extended communication with extension pages
299 </dd>
300 <dt>
301 <a href="#method-getURL"><code>getURL()</code></a>
302 </dt>
303 <dd>
304 Access to extension resources such as image files
305 </dd>
306 </dl>
307 <p>
308 For details, see
309 <a href="content_scripts.html">Content Scripts</a>.
310 </p>
311 <!-- END AUTHORED CONTENT -->
312 </div>
313 <!-- API PAGE -->
314 <div class="apiPage">
315 <a name="apiReference"></a>
316 <h2>API reference: chrome.extension</h2>
317 <!-- PROPERTIES -->
318 <div class="apiGroup">
319 <a name="properties"></a>
320 <h3 id="properties">Properties</h3>
321 <div>
322 <a name="property-lastError"></a>
323 <h4>lastError</h4>
324 <div class="summary">
325 <!-- Note: intentionally longer 80 columns -->
326 <span>chrome.extension.</span><span>lastError</span>
327 </div>
328 <div>
329 <dt>
330 <var>lastError</var>
331 <em>
332 <!-- TYPE -->
333 <div style="display:inline">
334 (
335 <span class="optional">optional</span>
336 <span id="typeTemplate">
337 <span>
338 <span>object</span>
339 </span>
340 </span>
341 )
342 </div>
343 </em>
344 </dt>
345 <dd>Set for the lifetime of a callback if an ansychronous extension ap i has resulted in an error. If no error has occured lastError will be <var>undef ined</var>.</dd>
346 <!-- OBJECT PROPERTIES -->
347 <dd>
348 <dl>
349 <div>
350 <div>
351 <dt>
352 <var>message</var>
353 <em>
354 <!-- TYPE -->
355 <div style="display:inline">
356 (
357 <span id="typeTemplate">
358 <span>
359 <span>string</span>
360 </span>
361 </span>
362 )
363 </div>
364 </em>
365 </dt>
366 <dd>Description of the error that has taken place.</dd>
367 <!-- OBJECT PROPERTIES -->
368 <!-- OBJECT METHODS -->
369 <!-- OBJECT EVENT FIELDS -->
370 <!-- FUNCTION PARAMETERS -->
371 </div>
372 </div>
373 </dl>
374 </dd>
375 <!-- OBJECT METHODS -->
376 <!-- OBJECT EVENT FIELDS -->
377 <!-- FUNCTION PARAMETERS -->
378 </div>
379 </div><div>
380 <a name="property-inIncognitoContext"></a>
381 <h4>inIncognitoContext</h4>
382 <div class="summary">
383 <!-- Note: intentionally longer 80 columns -->
384 <span>chrome.extension.</span><span>inIncognitoContext</span>
385 </div>
386 <div>
387 <dt>
388 <var>inIncognitoContext</var>
389 <em>
390 <!-- TYPE -->
391 <div style="display:inline">
392 (
393 <span class="optional">optional</span>
394 <span id="typeTemplate">
395 <span>
396 <span>boolean</span>
397 </span>
398 </span>
399 )
400 </div>
401 </em>
402 </dt>
403 <dd>True for content scripts running inside incognito tabs, and for ex tension pages running inside an incognito process. The latter only applies to ex tensions with 'split' incognito_behavior.</dd>
404 <!-- OBJECT PROPERTIES -->
405 <!-- OBJECT METHODS -->
406 <!-- OBJECT EVENT FIELDS -->
407 <!-- FUNCTION PARAMETERS -->
408 </div>
409 </div>
410 </div> <!-- /apiGroup -->
411 <!-- METHODS -->
412 <div id="methodsTemplate" class="apiGroup">
413 <a name="global-methods"></a>
414 <h3>Methods</h3>
415 <!-- iterates over all functions -->
416 <div class="apiItem">
417 <a name="method-connect"></a> <!-- method-anchor -->
418 <h4>connect</h4>
419 <div class="summary"><span>Port</span>
420 <!-- Note: intentionally longer 80 columns -->
421 <span>chrome.extension.connect</span>(<span class="optional">< span>string</span>
422 <var><span>extensionId</span></var></span><span class="opt ional"><span>, </span><span>object</span>
423 <var><span>connectInfo</span></var></span>)</div>
424 <div class="description">
425 <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>
426 <!-- PARAMETERS -->
427 <h4>Parameters</h4>
428 <dl>
429 <div>
430 <div>
431 <dt>
432 <var>extensionId</var>
433 <em>
434 <!-- TYPE -->
435 <div style="display:inline">
436 (
437 <span class="optional">optional</span>
438 <span id="typeTemplate">
439 <span>
440 <span>string</span>
441 </span>
442 </span>
443 )
444 </div>
445 </em>
446 </dt>
447 <dd>The extension ID of the extension you want to connect to. If omitt ed, default is your own extension.</dd>
448 <!-- OBJECT PROPERTIES -->
449 <!-- OBJECT METHODS -->
450 <!-- OBJECT EVENT FIELDS -->
451 <!-- FUNCTION PARAMETERS -->
452 </div>
453 </div><div>
454 <div>
455 <dt>
456 <var>connectInfo</var>
457 <em>
458 <!-- TYPE -->
459 <div style="display:inline">
460 (
461 <span class="optional">optional</span>
462 <span id="typeTemplate">
463 <span>
464 <span>object</span>
465 </span>
466 </span>
467 )
468 </div>
469 </em>
470 </dt>
471 <dd class="todo">
472 Undocumented.
473 </dd>
474 <!-- OBJECT PROPERTIES -->
475 <dd>
476 <dl>
477 <div>
478 <div>
479 <dt>
480 <var>name</var>
481 <em>
482 <!-- TYPE -->
483 <div style="display:inline">
484 (
485 <span class="optional">optional</span>
486 <span id="typeTemplate">
487 <span>
488 <span>string</span>
489 </span>
490 </span>
491 )
492 </div>
493 </em>
494 </dt>
495 <dd>Will be passed into onConnect for extension processes that are lis tening for the connection event.</dd>
496 <!-- OBJECT PROPERTIES -->
497 <!-- OBJECT METHODS -->
498 <!-- OBJECT EVENT FIELDS -->
499 <!-- FUNCTION PARAMETERS -->
500 </div>
501 </div>
502 </dl>
503 </dd>
504 <!-- OBJECT METHODS -->
505 <!-- OBJECT EVENT FIELDS -->
506 <!-- FUNCTION PARAMETERS -->
507 </div>
508 </div>
509 </dl>
510 <!-- RETURNS -->
511 <h4>Returns</h4>
512 <dl>
513 <div>
514 <div>
515 <dt>
516 <em>
517 <!-- TYPE -->
518 <div style="display:inline">
519 (
520 <span id="typeTemplate">
521 <span>
522 <a href="extension.html#type-Port">Port</a>
523 </span>
524 </span>
525 )
526 </div>
527 </em>
528 </dt>
529 <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>
530 <!-- OBJECT PROPERTIES -->
531 <!-- OBJECT METHODS -->
532 <!-- OBJECT EVENT FIELDS -->
533 <!-- FUNCTION PARAMETERS -->
534 </div>
535 </div>
536 </dl>
537 <!-- CALLBACK -->
538 <!-- MIN_VERSION -->
539 </div> <!-- /description -->
540 </div><div class="apiItem">
541 <a name="method-getBackgroundPage"></a> <!-- method-anchor -->
542 <h4>getBackgroundPage</h4>
543 <div class="summary"><span>global</span>
544 <!-- Note: intentionally longer 80 columns -->
545 <span>chrome.extension.getBackgroundPage</span>()</div>
546 <div class="description">
547 <p>Returns the JavaScript 'window' object for the background pag e running inside the current extension. Returns null if the extension has no bac kground page.</p>
548 <!-- PARAMETERS -->
549 <dl>
550 </dl>
551 <!-- RETURNS -->
552 <h4>Returns</h4>
553 <dl>
554 <div>
555 <div>
556 <dt>
557 <em>
558 <!-- TYPE -->
559 <div style="display:inline">
560 (
561 <span id="typeTemplate">
562 <span>
563 <span>global</span>
564 </span>
565 </span>
566 )
567 </div>
568 </em>
569 </dt>
570 <dd class="todo">
571 Undocumented.
572 </dd>
573 <!-- OBJECT PROPERTIES -->
574 <!-- OBJECT METHODS -->
575 <!-- OBJECT EVENT FIELDS -->
576 <!-- FUNCTION PARAMETERS -->
577 </div>
578 </div>
579 </dl>
580 <!-- CALLBACK -->
581 <!-- MIN_VERSION -->
582 </div> <!-- /description -->
583 </div><div class="apiItem">
584 <a name="method-getURL"></a> <!-- method-anchor -->
585 <h4>getURL</h4>
586 <div class="summary"><span>string</span>
587 <!-- Note: intentionally longer 80 columns -->
588 <span>chrome.extension.getURL</span>(<span class="null"><span> string</span>
589 <var><span>path</span></var></span>)</div>
590 <div class="description">
591 <p>Converts a relative path within an extension install director y to a fully-qualified URL.</p>
592 <!-- PARAMETERS -->
593 <h4>Parameters</h4>
594 <dl>
595 <div>
596 <div>
597 <dt>
598 <var>path</var>
599 <em>
600 <!-- TYPE -->
601 <div style="display:inline">
602 (
603 <span id="typeTemplate">
604 <span>
605 <span>string</span>
606 </span>
607 </span>
608 )
609 </div>
610 </em>
611 </dt>
612 <dd>A path to a resource within an extension expressed relative to its install directory.</dd>
613 <!-- OBJECT PROPERTIES -->
614 <!-- OBJECT METHODS -->
615 <!-- OBJECT EVENT FIELDS -->
616 <!-- FUNCTION PARAMETERS -->
617 </div>
618 </div>
619 </dl>
620 <!-- RETURNS -->
621 <h4>Returns</h4>
622 <dl>
623 <div>
624 <div>
625 <dt>
626 <em>
627 <!-- TYPE -->
628 <div style="display:inline">
629 (
630 <span id="typeTemplate">
631 <span>
632 <span>string</span>
633 </span>
634 </span>
635 )
636 </div>
637 </em>
638 </dt>
639 <dd>The fully-qualified URL to the resource.</dd>
640 <!-- OBJECT PROPERTIES -->
641 <!-- OBJECT METHODS -->
642 <!-- OBJECT EVENT FIELDS -->
643 <!-- FUNCTION PARAMETERS -->
644 </div>
645 </div>
646 </dl>
647 <!-- CALLBACK -->
648 <!-- MIN_VERSION -->
649 </div> <!-- /description -->
650 </div><div class="apiItem">
651 <a name="method-getViews"></a> <!-- method-anchor -->
652 <h4>getViews</h4>
653 <div class="summary"><span>array of global</span>
654 <!-- Note: intentionally longer 80 columns -->
655 <span>chrome.extension.getViews</span>(<span class="optional"> <span>object</span>
656 <var><span>fetchProperties</span></var></span>)</div>
657 <div class="description">
658 <p>Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.</p>
659 <!-- PARAMETERS -->
660 <h4>Parameters</h4>
661 <dl>
662 <div>
663 <div>
664 <dt>
665 <var>fetchProperties</var>
666 <em>
667 <!-- TYPE -->
668 <div style="display:inline">
669 (
670 <span class="optional">optional</span>
671 <span id="typeTemplate">
672 <span>
673 <span>object</span>
674 </span>
675 </span>
676 )
677 </div>
678 </em>
679 </dt>
680 <dd class="todo">
681 Undocumented.
682 </dd>
683 <!-- OBJECT PROPERTIES -->
684 <dd>
685 <dl>
686 <div>
687 <div>
688 <dt>
689 <var>type</var>
690 <em>
691 <!-- TYPE -->
692 <div style="display:inline">
693 (
694 <span class="optional">optional</span>
695 <span class="enum">enumerated</span>
696 <span id="typeTemplate">
697 <span>
698 <span>string</span>
699 <span>["tab", "infobar", "notification", "popup"]</span>
700 </span>
701 </span>
702 )
703 </div>
704 </em>
705 </dt>
706 <dd>The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'infobar', 'notification', 'pop up'.</dd>
707 <!-- OBJECT PROPERTIES -->
708 <!-- OBJECT METHODS -->
709 <!-- OBJECT EVENT FIELDS -->
710 <!-- FUNCTION PARAMETERS -->
711 </div>
712 </div><div>
713 <div>
714 <dt>
715 <var>windowId</var>
716 <em>
717 <!-- TYPE -->
718 <div style="display:inline">
719 (
720 <span class="optional">optional</span>
721 <span id="typeTemplate">
722 <span>
723 <span>integer</span>
724 </span>
725 </span>
726 )
727 </div>
728 </em>
729 </dt>
730 <dd>The window to restrict the search to. If omitted, returns all view s.</dd>
731 <!-- OBJECT PROPERTIES -->
732 <!-- OBJECT METHODS -->
733 <!-- OBJECT EVENT FIELDS -->
734 <!-- FUNCTION PARAMETERS -->
735 </div>
736 </div>
737 </dl>
738 </dd>
739 <!-- OBJECT METHODS -->
740 <!-- OBJECT EVENT FIELDS -->
741 <!-- FUNCTION PARAMETERS -->
742 </div>
743 </div>
744 </dl>
745 <!-- RETURNS -->
746 <h4>Returns</h4>
747 <dl>
748 <div>
749 <div>
750 <dt>
751 <em>
752 <!-- TYPE -->
753 <div style="display:inline">
754 (
755 <span id="typeTemplate">
756 <span>
757 <span>
758 array of <span><span>
759 <span>
760 <span>global</span>
761 </span>
762 </span></span>
763 </span>
764 </span>
765 </span>
766 )
767 </div>
768 </em>
769 </dt>
770 <dd>Array of global objects</dd>
771 <!-- OBJECT PROPERTIES -->
772 <!-- OBJECT METHODS -->
773 <!-- OBJECT EVENT FIELDS -->
774 <!-- FUNCTION PARAMETERS -->
775 </div>
776 </div>
777 </dl>
778 <!-- CALLBACK -->
779 <!-- MIN_VERSION -->
780 </div> <!-- /description -->
781 </div><div class="apiItem">
782 <a name="method-isAllowedFileSchemeAccess"></a> <!-- method-anchor -->
783 <h4>isAllowedFileSchemeAccess</h4>
784 <div class="summary">
785 <!-- Note: intentionally longer 80 columns -->
786 <span>chrome.extension.isAllowedFileSchemeAccess</span>(<span class="null"><span>function</span>
787 <var><span>callback</span></var></span>)</div>
788 <div class="description">
789 <p>Retrieves the state of the extension's access to the 'file:// ' scheme (as determined by the user-controlled 'Allow access to File URLs' check box.</p>
790 <!-- PARAMETERS -->
791 <h4>Parameters</h4>
792 <dl>
793 <div>
794 <div>
795 <dt>
796 <var>callback</var>
797 <em>
798 <!-- TYPE -->
799 <div style="display:inline">
800 (
801 <span id="typeTemplate">
802 <span>
803 <span>function</span>
804 </span>
805 </span>
806 )
807 </div>
808 </em>
809 </dt>
810 <dd class="todo">
811 Undocumented.
812 </dd>
813 <!-- OBJECT PROPERTIES -->
814 <!-- OBJECT METHODS -->
815 <!-- OBJECT EVENT FIELDS -->
816 <!-- FUNCTION PARAMETERS -->
817 </div>
818 </div>
819 </dl>
820 <!-- RETURNS -->
821 <dl>
822 </dl>
823 <!-- CALLBACK -->
824 <div>
825 <div>
826 <h4>Callback function</h4>
827 <p>
828 The <em>callback</em> parameter should specify a function
829 that looks like this:
830 </p>
831 <!-- Note: intentionally longer 80 columns -->
832 <pre>function(<span>boolean isAllowedAccess</span>) <span clas s="subdued">{...}</span>;</pre>
833 <dl>
834 <div>
835 <div>
836 <dt>
837 <var>isAllowedAccess</var>
838 <em>
839 <!-- TYPE -->
840 <div style="display:inline">
841 (
842 <span id="typeTemplate">
843 <span>
844 <span>boolean</span>
845 </span>
846 </span>
847 )
848 </div>
849 </em>
850 </dt>
851 <dd>True if the extension can access the 'file://' scheme, false other wise.</dd>
852 <!-- OBJECT PROPERTIES -->
853 <!-- OBJECT METHODS -->
854 <!-- OBJECT EVENT FIELDS -->
855 <!-- FUNCTION PARAMETERS -->
856 </div>
857 </div>
858 </dl>
859 </div>
860 </div>
861 <!-- MIN_VERSION -->
862 <p>
863 This function was added in version <b><span>12.0.706.0</span>< /b>.
864 If you require this function, the manifest key
865 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
866 can ensure that your extension won't be run in an earlier brow ser version.
867 </p>
868 </div> <!-- /description -->
869 </div><div class="apiItem">
870 <a name="method-isAllowedIncognitoAccess"></a> <!-- method-anchor -->
871 <h4>isAllowedIncognitoAccess</h4>
872 <div class="summary">
873 <!-- Note: intentionally longer 80 columns -->
874 <span>chrome.extension.isAllowedIncognitoAccess</span>(<span c lass="null"><span>function</span>
875 <var><span>callback</span></var></span>)</div>
876 <div class="description">
877 <p>Retrieves the state of the extension's access to Incognito-mo de (as determined by the user-controlled 'Allowed in Incognito' checkbox.</p>
878 <!-- PARAMETERS -->
879 <h4>Parameters</h4>
880 <dl>
881 <div>
882 <div>
883 <dt>
884 <var>callback</var>
885 <em>
886 <!-- TYPE -->
887 <div style="display:inline">
888 (
889 <span id="typeTemplate">
890 <span>
891 <span>function</span>
892 </span>
893 </span>
894 )
895 </div>
896 </em>
897 </dt>
898 <dd class="todo">
899 Undocumented.
900 </dd>
901 <!-- OBJECT PROPERTIES -->
902 <!-- OBJECT METHODS -->
903 <!-- OBJECT EVENT FIELDS -->
904 <!-- FUNCTION PARAMETERS -->
905 </div>
906 </div>
907 </dl>
908 <!-- RETURNS -->
909 <dl>
910 </dl>
911 <!-- CALLBACK -->
912 <div>
913 <div>
914 <h4>Callback function</h4>
915 <p>
916 The <em>callback</em> parameter should specify a function
917 that looks like this:
918 </p>
919 <!-- Note: intentionally longer 80 columns -->
920 <pre>function(<span>boolean isAllowedAccess</span>) <span clas s="subdued">{...}</span>;</pre>
921 <dl>
922 <div>
923 <div>
924 <dt>
925 <var>isAllowedAccess</var>
926 <em>
927 <!-- TYPE -->
928 <div style="display:inline">
929 (
930 <span id="typeTemplate">
931 <span>
932 <span>boolean</span>
933 </span>
934 </span>
935 )
936 </div>
937 </em>
938 </dt>
939 <dd>True if the extension has access to Incognito mode, false otherwis e.</dd>
940 <!-- OBJECT PROPERTIES -->
941 <!-- OBJECT METHODS -->
942 <!-- OBJECT EVENT FIELDS -->
943 <!-- FUNCTION PARAMETERS -->
944 </div>
945 </div>
946 </dl>
947 </div>
948 </div>
949 <!-- MIN_VERSION -->
950 <p>
951 This function was added in version <b><span>12.0.706.0</span>< /b>.
952 If you require this function, the manifest key
953 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
954 can ensure that your extension won't be run in an earlier brow ser version.
955 </p>
956 </div> <!-- /description -->
957 </div><div class="apiItem">
958 <a name="method-sendMessage"></a> <!-- method-anchor -->
959 <h4>sendMessage</h4>
960 <div class="summary">
961 <!-- Note: intentionally longer 80 columns -->
962 <span>chrome.extension.sendMessage</span>(<span class="optiona l"><span>string</span>
963 <var><span>extensionId</span></var></span><span class="nul l"><span>, </span><span>any</span>
964 <var><span>message</span></var></span><span class="optiona l"><span>, </span><span>function</span>
965 <var><span>responseCallback</span></var></span>)</div>
966 <div class="description">
967 <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>
968 <!-- PARAMETERS -->
969 <h4>Parameters</h4>
970 <dl>
971 <div>
972 <div>
973 <dt>
974 <var>extensionId</var>
975 <em>
976 <!-- TYPE -->
977 <div style="display:inline">
978 (
979 <span class="optional">optional</span>
980 <span id="typeTemplate">
981 <span>
982 <span>string</span>
983 </span>
984 </span>
985 )
986 </div>
987 </em>
988 </dt>
989 <dd>The extension ID of the extension you want to connect to. If omitt ed, default is your own extension.</dd>
990 <!-- OBJECT PROPERTIES -->
991 <!-- OBJECT METHODS -->
992 <!-- OBJECT EVENT FIELDS -->
993 <!-- FUNCTION PARAMETERS -->
994 </div>
995 </div><div>
996 <div>
997 <dt>
998 <var>message</var>
999 <em>
1000 <!-- TYPE -->
1001 <div style="display:inline">
1002 (
1003 <span id="typeTemplate">
1004 <span>
1005 <span>any</span>
1006 </span>
1007 </span>
1008 )
1009 </div>
1010 </em>
1011 </dt>
1012 <dd class="todo">
1013 Undocumented.
1014 </dd>
1015 <!-- OBJECT PROPERTIES -->
1016 <!-- OBJECT METHODS -->
1017 <!-- OBJECT EVENT FIELDS -->
1018 <!-- FUNCTION PARAMETERS -->
1019 </div>
1020 </div><div>
1021 <div>
1022 <dt>
1023 <var>responseCallback</var>
1024 <em>
1025 <!-- TYPE -->
1026 <div style="display:inline">
1027 (
1028 <span class="optional">optional</span>
1029 <span id="typeTemplate">
1030 <span>
1031 <span>function</span>
1032 </span>
1033 </span>
1034 )
1035 </div>
1036 </em>
1037 </dt>
1038 <dd class="todo">
1039 Undocumented.
1040 </dd>
1041 <!-- OBJECT PROPERTIES -->
1042 <!-- OBJECT METHODS -->
1043 <!-- OBJECT EVENT FIELDS -->
1044 <!-- FUNCTION PARAMETERS -->
1045 <dd>
1046 <div>
1047 <h5>Parameters</h5>
1048 <dl>
1049 <div>
1050 <div>
1051 <dt>
1052 <var>response</var>
1053 <em>
1054 <!-- TYPE -->
1055 <div style="display:inline">
1056 (
1057 <span id="typeTemplate">
1058 <span>
1059 <span>any</span>
1060 </span>
1061 </span>
1062 )
1063 </div>
1064 </em>
1065 </dt>
1066 <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>
1067 <!-- OBJECT PROPERTIES -->
1068 <!-- OBJECT METHODS -->
1069 <!-- OBJECT EVENT FIELDS -->
1070 <!-- FUNCTION PARAMETERS -->
1071 </div>
1072 </div>
1073 </dl>
1074 </div>
1075 </dd>
1076 </div>
1077 </div>
1078 </dl>
1079 <!-- RETURNS -->
1080 <dl>
1081 </dl>
1082 <!-- CALLBACK -->
1083 <div>
1084 <div>
1085 <h4>Callback function</h4>
1086 <p>
1087 If you specify the <em>callback</em> parameter, it should
1088 specify a function that looks like this:
1089 </p>
1090 <!-- Note: intentionally longer 80 columns -->
1091 <pre>function(<span>any response</span>) <span class="subdued" >{...}</span>;</pre>
1092 <dl>
1093 <div>
1094 <div>
1095 <dt>
1096 <var>response</var>
1097 <em>
1098 <!-- TYPE -->
1099 <div style="display:inline">
1100 (
1101 <span id="typeTemplate">
1102 <span>
1103 <span>any</span>
1104 </span>
1105 </span>
1106 )
1107 </div>
1108 </em>
1109 </dt>
1110 <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>
1111 <!-- OBJECT PROPERTIES -->
1112 <!-- OBJECT METHODS -->
1113 <!-- OBJECT EVENT FIELDS -->
1114 <!-- FUNCTION PARAMETERS -->
1115 </div>
1116 </div>
1117 </dl>
1118 </div>
1119 </div>
1120 <!-- MIN_VERSION -->
1121 </div> <!-- /description -->
1122 </div><div class="apiItem">
1123 <a name="method-setUpdateUrlData"></a> <!-- method-anchor -->
1124 <h4>setUpdateUrlData</h4>
1125 <div class="summary">
1126 <!-- Note: intentionally longer 80 columns -->
1127 <span>chrome.extension.setUpdateUrlData</span>(<span class="nu ll"><span>string</span>
1128 <var><span>data</span></var></span>)</div>
1129 <div class="description">
1130 <p>Sets the value of the ap CGI parameter used in the extension' s update URL. This value is ignored for extensions that are hosted in the Chrom e Extension Gallery.</p>
1131 <!-- PARAMETERS -->
1132 <h4>Parameters</h4>
1133 <dl>
1134 <div>
1135 <div>
1136 <dt>
1137 <var>data</var>
1138 <em>
1139 <!-- TYPE -->
1140 <div style="display:inline">
1141 (
1142 <span id="typeTemplate">
1143 <span>
1144 <span>string</span>
1145 </span>
1146 </span>
1147 )
1148 </div>
1149 </em>
1150 </dt>
1151 <dd class="todo">
1152 Undocumented.
1153 </dd>
1154 <!-- OBJECT PROPERTIES -->
1155 <!-- OBJECT METHODS -->
1156 <!-- OBJECT EVENT FIELDS -->
1157 <!-- FUNCTION PARAMETERS -->
1158 </div>
1159 </div>
1160 </dl>
1161 <!-- RETURNS -->
1162 <dl>
1163 </dl>
1164 <!-- CALLBACK -->
1165 <!-- MIN_VERSION -->
1166 </div> <!-- /description -->
1167 </div> <!-- /apiItem -->
1168 </div> <!-- /apiGroup -->
1169 <!-- EVENTS -->
1170 <div id="eventsTemplate" class="apiGroup">
1171 <a name="global-events"></a>
1172 <h3>Events</h3>
1173 <!-- iterates over all events -->
1174 <div class="apiItem">
1175 <a name="event-onConnect"></a>
1176 <h4>onConnect</h4>
1177 <div class="summary">
1178 <!-- Note: intentionally longer 80 columns -->
1179 <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>);
1180 </div>
1181 <div class="description">
1182 <p>Fired when a connection is made from either an extension proc ess or a content script.</p>
1183 <!-- LISTENER PARAMETERS -->
1184 <div>
1185 <h4>Listener parameters</h4>
1186 <dl>
1187 <div>
1188 <div>
1189 <dt>
1190 <var>port</var>
1191 <em>
1192 <!-- TYPE -->
1193 <div style="display:inline">
1194 (
1195 <span id="typeTemplate">
1196 <span>
1197 <a href="extension.html#type-Port">Port</a>
1198 </span>
1199 </span>
1200 )
1201 </div>
1202 </em>
1203 </dt>
1204 <dd class="todo">
1205 Undocumented.
1206 </dd>
1207 <!-- OBJECT PROPERTIES -->
1208 <!-- OBJECT METHODS -->
1209 <!-- OBJECT EVENT FIELDS -->
1210 <!-- FUNCTION PARAMETERS -->
1211 </div>
1212 </div>
1213 </dl>
1214 </div>
1215 <!-- EXTRA PARAMETERS -->
1216 <!-- LISTENER RETURN VALUE -->
1217 <dl>
1218 </dl>
1219 </div> <!-- /description -->
1220 <!-- /description -->
1221 </div><div class="apiItem">
1222 <a name="event-onConnectExternal"></a>
1223 <h4>onConnectExternal</h4>
1224 <div class="summary">
1225 <!-- Note: intentionally longer 80 columns -->
1226 <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>);
1227 </div>
1228 <div class="description">
1229 <p>Fired when a connection is made from another extension.</p>
1230 <!-- LISTENER PARAMETERS -->
1231 <div>
1232 <h4>Listener parameters</h4>
1233 <dl>
1234 <div>
1235 <div>
1236 <dt>
1237 <var>port</var>
1238 <em>
1239 <!-- TYPE -->
1240 <div style="display:inline">
1241 (
1242 <span id="typeTemplate">
1243 <span>
1244 <a href="extension.html#type-Port">Port</a>
1245 </span>
1246 </span>
1247 )
1248 </div>
1249 </em>
1250 </dt>
1251 <dd class="todo">
1252 Undocumented.
1253 </dd>
1254 <!-- OBJECT PROPERTIES -->
1255 <!-- OBJECT METHODS -->
1256 <!-- OBJECT EVENT FIELDS -->
1257 <!-- FUNCTION PARAMETERS -->
1258 </div>
1259 </div>
1260 </dl>
1261 </div>
1262 <!-- EXTRA PARAMETERS -->
1263 <!-- LISTENER RETURN VALUE -->
1264 <dl>
1265 </dl>
1266 </div> <!-- /description -->
1267 <!-- /description -->
1268 </div><div class="apiItem">
1269 <a name="event-onMessage"></a>
1270 <h4>onMessage</h4>
1271 <div class="summary">
1272 <!-- Note: intentionally longer 80 columns -->
1273 <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>);
1274 </div>
1275 <div class="description">
1276 <p>Fired when a message is sent from either an extension process or a content script.</p>
1277 <!-- LISTENER PARAMETERS -->
1278 <div>
1279 <h4>Listener parameters</h4>
1280 <dl>
1281 <div>
1282 <div>
1283 <dt>
1284 <var>details</var>
1285 <em>
1286 <!-- TYPE -->
1287 <div style="display:inline">
1288 (
1289 <span id="typeTemplate">
1290 <span>
1291 <span>object</span>
1292 </span>
1293 </span>
1294 )
1295 </div>
1296 </em>
1297 </dt>
1298 <dd class="todo">
1299 Undocumented.
1300 </dd>
1301 <!-- OBJECT PROPERTIES -->
1302 <dd>
1303 <dl>
1304 <div>
1305 <div>
1306 <dt>
1307 <var>message</var>
1308 <em>
1309 <!-- TYPE -->
1310 <div style="display:inline">
1311 (
1312 <span id="typeTemplate">
1313 <span>
1314 <span>any</span>
1315 </span>
1316 </span>
1317 )
1318 </div>
1319 </em>
1320 </dt>
1321 <dd>The message sent by the calling script.</dd>
1322 <!-- OBJECT PROPERTIES -->
1323 <!-- OBJECT METHODS -->
1324 <!-- OBJECT EVENT FIELDS -->
1325 <!-- FUNCTION PARAMETERS -->
1326 </div>
1327 </div><div>
1328 <div>
1329 <dt>
1330 <var>sender</var>
1331 <em>
1332 <!-- TYPE -->
1333 <div style="display:inline">
1334 (
1335 <span id="typeTemplate">
1336 <span>
1337 <a href="extension.html#type-MessageSender">MessageSende r</a>
1338 </span>
1339 </span>
1340 )
1341 </div>
1342 </em>
1343 </dt>
1344 <dd class="todo">
1345 Undocumented.
1346 </dd>
1347 <!-- OBJECT PROPERTIES -->
1348 <!-- OBJECT METHODS -->
1349 <!-- OBJECT EVENT FIELDS -->
1350 <!-- FUNCTION PARAMETERS -->
1351 </div>
1352 </div><div>
1353 <div>
1354 <dt>
1355 <var>sendResponse</var>
1356 <em>
1357 <!-- TYPE -->
1358 <div style="display:inline">
1359 (
1360 <span id="typeTemplate">
1361 <span>
1362 <span>function</span>
1363 </span>
1364 </span>
1365 )
1366 </div>
1367 </em>
1368 </dt>
1369 <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>
1370 <!-- OBJECT PROPERTIES -->
1371 <!-- OBJECT METHODS -->
1372 <!-- OBJECT EVENT FIELDS -->
1373 <!-- FUNCTION PARAMETERS -->
1374 </div>
1375 </div>
1376 </dl>
1377 </dd>
1378 <!-- OBJECT METHODS -->
1379 <!-- OBJECT EVENT FIELDS -->
1380 <!-- FUNCTION PARAMETERS -->
1381 </div>
1382 </div>
1383 </dl>
1384 </div>
1385 <!-- EXTRA PARAMETERS -->
1386 <!-- LISTENER RETURN VALUE -->
1387 <h4>Listener returns</h4>
1388 <dl>
1389 <div>
1390 <div>
1391 <dt>
1392 <em>
1393 <!-- TYPE -->
1394 <div style="display:inline">
1395 (
1396 <span class="optional">optional</span>
1397 <span id="typeTemplate">
1398 <span>
1399 <span>boolean</span>
1400 </span>
1401 </span>
1402 )
1403 </div>
1404 </em>
1405 </dt>
1406 <dd>Return true from the event listener if you wish to call <code>send Response</code> after the event listener returns.</dd>
1407 <!-- OBJECT PROPERTIES -->
1408 <!-- OBJECT METHODS -->
1409 <!-- OBJECT EVENT FIELDS -->
1410 <!-- FUNCTION PARAMETERS -->
1411 </div>
1412 </div>
1413 </dl>
1414 </div> <!-- /description -->
1415 <!-- /description -->
1416 </div><div class="apiItem">
1417 <a name="event-onMessageExternal"></a>
1418 <h4>onMessageExternal</h4>
1419 <div class="summary">
1420 <!-- Note: intentionally longer 80 columns -->
1421 <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>);
1422 </div>
1423 <div class="description">
1424 <p>Fired when a message is sent from another extension.</p>
1425 <!-- LISTENER PARAMETERS -->
1426 <div>
1427 <h4>Listener parameters</h4>
1428 <dl>
1429 <div>
1430 <div>
1431 <dt>
1432 <var>details</var>
1433 <em>
1434 <!-- TYPE -->
1435 <div style="display:inline">
1436 (
1437 <span id="typeTemplate">
1438 <span>
1439 <span>object</span>
1440 </span>
1441 </span>
1442 )
1443 </div>
1444 </em>
1445 </dt>
1446 <dd class="todo">
1447 Undocumented.
1448 </dd>
1449 <!-- OBJECT PROPERTIES -->
1450 <dd>
1451 <dl>
1452 <div>
1453 <div>
1454 <dt>
1455 <var>message</var>
1456 <em>
1457 <!-- TYPE -->
1458 <div style="display:inline">
1459 (
1460 <span id="typeTemplate">
1461 <span>
1462 <span>any</span>
1463 </span>
1464 </span>
1465 )
1466 </div>
1467 </em>
1468 </dt>
1469 <dd>The message sent by the calling script.</dd>
1470 <!-- OBJECT PROPERTIES -->
1471 <!-- OBJECT METHODS -->
1472 <!-- OBJECT EVENT FIELDS -->
1473 <!-- FUNCTION PARAMETERS -->
1474 </div>
1475 </div><div>
1476 <div>
1477 <dt>
1478 <var>sender</var>
1479 <em>
1480 <!-- TYPE -->
1481 <div style="display:inline">
1482 (
1483 <span id="typeTemplate">
1484 <span>
1485 <a href="extension.html#type-MessageSender">MessageSende r</a>
1486 </span>
1487 </span>
1488 )
1489 </div>
1490 </em>
1491 </dt>
1492 <dd class="todo">
1493 Undocumented.
1494 </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>sendResponse</var>
1504 <em>
1505 <!-- TYPE -->
1506 <div style="display:inline">
1507 (
1508 <span id="typeTemplate">
1509 <span>
1510 <span>function</span>
1511 </span>
1512 </span>
1513 )
1514 </div>
1515 </em>
1516 </dt>
1517 <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>
1518 <!-- OBJECT PROPERTIES -->
1519 <!-- OBJECT METHODS -->
1520 <!-- OBJECT EVENT FIELDS -->
1521 <!-- FUNCTION PARAMETERS -->
1522 </div>
1523 </div>
1524 </dl>
1525 </dd>
1526 <!-- OBJECT METHODS -->
1527 <!-- OBJECT EVENT FIELDS -->
1528 <!-- FUNCTION PARAMETERS -->
1529 </div>
1530 </div>
1531 </dl>
1532 </div>
1533 <!-- EXTRA PARAMETERS -->
1534 <!-- LISTENER RETURN VALUE -->
1535 <h4>Listener returns</h4>
1536 <dl>
1537 <div>
1538 <div>
1539 <dt>
1540 <em>
1541 <!-- TYPE -->
1542 <div style="display:inline">
1543 (
1544 <span class="optional">optional</span>
1545 <span id="typeTemplate">
1546 <span>
1547 <span>boolean</span>
1548 </span>
1549 </span>
1550 )
1551 </div>
1552 </em>
1553 </dt>
1554 <dd>Return true from the event listener if you wish to call <code>send Response</code> after the event listener returns.</dd>
1555 <!-- OBJECT PROPERTIES -->
1556 <!-- OBJECT METHODS -->
1557 <!-- OBJECT EVENT FIELDS -->
1558 <!-- FUNCTION PARAMETERS -->
1559 </div>
1560 </div>
1561 </dl>
1562 </div> <!-- /description -->
1563 <!-- /description -->
1564 </div> <!-- /apiItem -->
1565 </div> <!-- /apiGroup -->
1566 <!-- TYPES -->
1567 <div class="apiGroup">
1568 <a name="types"></a>
1569 <h3 id="types">Types</h3>
1570 <!-- iterates over all types -->
1571 <div class="apiItem">
1572 <a name="type-MessageSender"></a>
1573 <h4>MessageSender</h4>
1574 <div>
1575 <dt>
1576 <em>
1577 <!-- TYPE -->
1578 <div style="display:inline">
1579 (
1580 <span id="typeTemplate">
1581 <span>
1582 <span>object</span>
1583 </span>
1584 </span>
1585 )
1586 </div>
1587 </em>
1588 </dt>
1589 <dd>An object containing information about the script context that sen t a message or request.</dd>
1590 <!-- OBJECT PROPERTIES -->
1591 <dd>
1592 <dl>
1593 <div>
1594 <div>
1595 <dt>
1596 <var>tab</var>
1597 <em>
1598 <!-- TYPE -->
1599 <div style="display:inline">
1600 (
1601 <span class="optional">optional</span>
1602 <span id="typeTemplate">
1603 <span>
1604 <a>tabs.Tab</a>
1605 </span>
1606 </span>
1607 )
1608 </div>
1609 </em>
1610 </dt>
1611 <dd>This property will <b>only</b> be present when the connection was opened from a tab or content script.</dd>
1612 <!-- OBJECT PROPERTIES -->
1613 <!-- OBJECT METHODS -->
1614 <!-- OBJECT EVENT FIELDS -->
1615 <!-- FUNCTION PARAMETERS -->
1616 </div>
1617 </div><div>
1618 <div>
1619 <dt>
1620 <var>id</var>
1621 <em>
1622 <!-- TYPE -->
1623 <div style="display:inline">
1624 (
1625 <span id="typeTemplate">
1626 <span>
1627 <span>string</span>
1628 </span>
1629 </span>
1630 )
1631 </div>
1632 </em>
1633 </dt>
1634 <dd>The extension ID of the extension that opened the connection.</dd>
1635 <!-- OBJECT PROPERTIES -->
1636 <!-- OBJECT METHODS -->
1637 <!-- OBJECT EVENT FIELDS -->
1638 <!-- FUNCTION PARAMETERS -->
1639 </div>
1640 </div>
1641 </dl>
1642 </dd>
1643 <!-- OBJECT METHODS -->
1644 <!-- OBJECT EVENT FIELDS -->
1645 <!-- FUNCTION PARAMETERS -->
1646 </div>
1647 </div><div class="apiItem">
1648 <a name="type-Port"></a>
1649 <h4>Port</h4>
1650 <div>
1651 <dt>
1652 <em>
1653 <!-- TYPE -->
1654 <div style="display:inline">
1655 (
1656 <span id="typeTemplate">
1657 <span>
1658 <span>object</span>
1659 </span>
1660 </span>
1661 )
1662 </div>
1663 </em>
1664 </dt>
1665 <dd>An object which allows two way communication with other pages.</dd >
1666 <!-- OBJECT PROPERTIES -->
1667 <dd>
1668 <dl>
1669 <div>
1670 <div>
1671 <dt>
1672 <var>name</var>
1673 <em>
1674 <!-- TYPE -->
1675 <div style="display:inline">
1676 (
1677 <span id="typeTemplate">
1678 <span>
1679 <span>string</span>
1680 </span>
1681 </span>
1682 )
1683 </div>
1684 </em>
1685 </dt>
1686 <dd class="todo">
1687 Undocumented.
1688 </dd>
1689 <!-- OBJECT PROPERTIES -->
1690 <!-- OBJECT METHODS -->
1691 <!-- OBJECT EVENT FIELDS -->
1692 <!-- FUNCTION PARAMETERS -->
1693 </div>
1694 </div><div>
1695 <div>
1696 <dt>
1697 <var>onDisconnect</var>
1698 <em>
1699 <!-- TYPE -->
1700 <div style="display:inline">
1701 (
1702 <span id="typeTemplate">
1703 <span>
1704 <a>events.Event</a>
1705 </span>
1706 </span>
1707 )
1708 </div>
1709 </em>
1710 </dt>
1711 <dd class="todo">
1712 Undocumented.
1713 </dd>
1714 <!-- OBJECT PROPERTIES -->
1715 <!-- OBJECT METHODS -->
1716 <!-- OBJECT EVENT FIELDS -->
1717 <!-- FUNCTION PARAMETERS -->
1718 </div>
1719 </div><div>
1720 <div>
1721 <dt>
1722 <var>onMessage</var>
1723 <em>
1724 <!-- TYPE -->
1725 <div style="display:inline">
1726 (
1727 <span id="typeTemplate">
1728 <span>
1729 <a>events.Event</a>
1730 </span>
1731 </span>
1732 )
1733 </div>
1734 </em>
1735 </dt>
1736 <dd class="todo">
1737 Undocumented.
1738 </dd>
1739 <!-- OBJECT PROPERTIES -->
1740 <!-- OBJECT METHODS -->
1741 <!-- OBJECT EVENT FIELDS -->
1742 <!-- FUNCTION PARAMETERS -->
1743 </div>
1744 </div><div>
1745 <div>
1746 <dt>
1747 <var>postMessage</var>
1748 <em>
1749 <!-- TYPE -->
1750 <div style="display:inline">
1751 (
1752 <span id="typeTemplate">
1753 <span>
1754 <span>function</span>
1755 </span>
1756 </span>
1757 )
1758 </div>
1759 </em>
1760 </dt>
1761 <dd class="todo">
1762 Undocumented.
1763 </dd>
1764 <!-- OBJECT PROPERTIES -->
1765 <!-- OBJECT METHODS -->
1766 <!-- OBJECT EVENT FIELDS -->
1767 <!-- FUNCTION PARAMETERS -->
1768 </div>
1769 </div><div>
1770 <div>
1771 <dt>
1772 <var>sender</var>
1773 <em>
1774 <!-- TYPE -->
1775 <div style="display:inline">
1776 (
1777 <span class="optional">optional</span>
1778 <span id="typeTemplate">
1779 <span>
1780 <a href="extension.html#type-MessageSender">MessageSende r</a>
1781 </span>
1782 </span>
1783 )
1784 </div>
1785 </em>
1786 </dt>
1787 <dd>This property will <b>only</b> be present on ports passed to onCon nect/onConnectExternal listeners.</dd>
1788 <!-- OBJECT PROPERTIES -->
1789 <!-- OBJECT METHODS -->
1790 <!-- OBJECT EVENT FIELDS -->
1791 <!-- FUNCTION PARAMETERS -->
1792 </div>
1793 </div>
1794 </dl>
1795 </dd>
1796 <!-- OBJECT METHODS -->
1797 <!-- OBJECT EVENT FIELDS -->
1798 <!-- FUNCTION PARAMETERS -->
1799 </div>
1800 </div> <!-- /apiItem -->
1801 </div> <!-- /apiGroup -->
1802 </div> <!-- /apiPage -->
1803 </div> <!-- /gc-pagecontent -->
1804 </div> <!-- /g-section -->
1805 </div> <!-- /codesiteContent -->
1806 <div id="gc-footer" --="">
1807 <div class="text">
1808 <p>
1809 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1810 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1811 Attribution 3.0 License</a>, and code samples are licensed under the
1812 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1813 </p>
1814 <p>
1815 ©2011 Google
1816 </p>
1817 <!-- begin analytics -->
1818 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
1819 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
1820 <script type="text/javascript">
1821 // chrome doc tracking
1822 try {
1823 var engdocs = _gat._getTracker("YT-10763712-2");
1824 engdocs._trackPageview();
1825 } catch(err) {}
1826 // code.google.com site-wide tracking
1827 try {
1828 _uacct="UA-18071-1";
1829 _uanchor=1;
1830 _uff=0;
1831 urchinTracker();
1832 }
1833 catch(e) {/* urchinTracker not available. */}
1834 </script>
1835 <!-- end analytics -->
1836 </div>
1837 </div> <!-- /gc-footer -->
1838 </div> <!-- /gc-container -->
1839 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.webRequest.html ('k') | chrome/common/extensions/docs/extensions/a11y.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698