OLD | NEW |
| (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="js/api_page_generator.js"></script> | |
17 <script type="text/javascript" src="js/bootstrap.js"></script> | |
18 <script type="text/javascript" src="js/sidebar.js"></script> | |
19 <title>chrome.devtools.* APIs - Google Chrome Extensions - Google Code</title>
</head> | |
20 <body> <div id="gc-container" class="labs"> | |
21 <div id="devModeWarning"> | |
22 You are viewing extension docs in chrome via the 'file:' scheme: are you
expecting to see local changes when you refresh? You'll need run chrome with --
allow-file-access-from-files. | |
23 </div> | |
24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> | |
25 <!-- In particular, sub-templates that recurse, must be used by allowing | |
26 jstemplate to make a copy of the template in this section which | |
27 are not operated on by way of the jsskip="true" --> | |
28 <div style="display:none"> | |
29 | |
30 <!-- VALUE --> | |
31 <div id="valueTemplate"> | |
32 <dt> | |
33 <var>paramName</var> | |
34 <em> | |
35 | |
36 <!-- TYPE --> | |
37 <div style="display:inline"> | |
38 ( | |
39 <span class="optional">optional</span> | |
40 <span class="enum">enumerated</span> | |
41 <span id="typeTemplate"> | |
42 <span> | |
43 <a> Type</a> | |
44 </span> | |
45 <span> | |
46 <span> | |
47 array of <span><span></span></span> | |
48 </span> | |
49 <span>paramType</span> | |
50 <span></span> | |
51 </span> | |
52 </span> | |
53 ) | |
54 </div> | |
55 | |
56 </em> | |
57 </dt> | |
58 <dd class="todo"> | |
59 Undocumented. | |
60 </dd> | |
61 <dd> | |
62 Description of this parameter from the json schema. | |
63 </dd> | |
64 <dd> | |
65 This parameter was added in version | |
66 <b><span></span></b>. | |
67 You must omit this parameter in earlier versions, | |
68 and you may omit it in any version. If you require this | |
69 parameter, the manifest key | |
70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> | |
71 can ensure that your extension won't be run in an earlier browser ve
rsion. | |
72 </dd> | |
73 | |
74 <!-- OBJECT PROPERTIES --> | |
75 <dd> | |
76 <dl> | |
77 <div> | |
78 <div> | |
79 </div> | |
80 </div> | |
81 </dl> | |
82 </dd> | |
83 | |
84 <!-- OBJECT METHODS --> | |
85 <dd> | |
86 <div></div> | |
87 </dd> | |
88 | |
89 <!-- OBJECT EVENT FIELDS --> | |
90 <dd> | |
91 <div></div> | |
92 </dd> | |
93 | |
94 <!-- FUNCTION PARAMETERS --> | |
95 <dd> | |
96 <div></div> | |
97 </dd> | |
98 | |
99 </div> <!-- /VALUE --> | |
100 | |
101 <div id="functionParametersTemplate"> | |
102 <h5>Parameters</h5> | |
103 <dl> | |
104 <div> | |
105 <div> | |
106 </div> | |
107 </div> | |
108 </dl> | |
109 </div> | |
110 | |
111 <!-- Individual subsections from the table of contents --> | |
112 <ol> | |
113 <li id="propertiesTocTemplate"> | |
114 <a href="#properties">Properties</a> | |
115 <ol> | |
116 <li> | |
117 <a href="#property-anchor">propertyName</a> | |
118 </li> | |
119 </ol> | |
120 </li> | |
121 <li id="methodsTocTemplate"> | |
122 <a>Methods</a> | |
123 <ol> | |
124 <li> | |
125 <a href="#method-anchor">methodName</a> | |
126 </li> | |
127 </ol> | |
128 </li> | |
129 <li id="eventsTocTemplate"> | |
130 <a>Events</a> | |
131 <ol> | |
132 <li> | |
133 <a href="#event-anchor">eventName</a> | |
134 </li> | |
135 </ol> | |
136 </li> | |
137 <li id="typesTocTemplate"> | |
138 <a href="#types">Types</a> | |
139 <ol> | |
140 <li> | |
141 <a href="#id-anchor">id</a> | |
142 <ol> | |
143 <div></div> | |
144 <div></div> | |
145 </ol> | |
146 </li> | |
147 </ol> | |
148 </li> | |
149 </ol> | |
150 </div> <!-- /SUBTEMPLATES --> | |
151 | |
152 <a id="top"></a> | |
153 <div id="skipto"> | |
154 <a href="#gc-pagecontent">Skip to page content</a> | |
155 <a href="#gc-toc">Skip to main navigation</a> | |
156 </div> | |
157 <!-- API HEADER --> | |
158 <table id="header" width="100%" cellspacing="0" border="0"> | |
159 <tbody><tr> | |
160 <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> | |
161 <td valign="middle" width="100%" style="padding-left:0.6em;"> | |
162 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.
5em"> | |
163 <div id="gsc-search-box"> | |
164 <input type="hidden" name="cx" value="002967670403910741006:61_cvz
fqtno"> | |
165 <input type="hidden" name="ie" value="UTF-8"> | |
166 <input type="text" name="q" value="" size="55"> | |
167 <input class="gsc-search-button" type="submit" name="sa" value="Se
arch"> | |
168 <br> | |
169 <span class="greytext">e.g. "page action" or "tabs"</span> | |
170 </div> | |
171 </form> | |
172 | |
173 <script type="text/javascript" src="https://www.google.com/jsapi"></sc
ript> | |
174 <script type="text/javascript">google.load("elements", "1", {packages:
"transliteration"});</script> | |
175 <script type="text/javascript" src="https://www.google.com/coop/cse/t1
3n?form=cse&t13n_langs=en"></script> | |
176 <script type="text/javascript" src="https://www.google.com/coop/cse/br
and?form=cse&lang=en"></script> | |
177 </td> | |
178 </tr> | |
179 </tbody></table> | |
180 | |
181 <div id="codesiteContent" class=""> | |
182 | |
183 <a id="gc-topnav-anchor"></a> | |
184 <div id="gc-topnav"> | |
185 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab
s</a>)</h1> | |
186 <ul id="home" class="gc-topnav-tabs"> | |
187 <li id="home_link"> | |
188 <a href="index.html" title="Google Chrome Extensions home page">Home
</a> | |
189 </li> | |
190 <li id="docs_link"> | |
191 <a href="docs.html" title="Official Google Chrome Extensions documen
tation">Docs</a> | |
192 </li> | |
193 <li id="faq_link"> | |
194 <a href="faq.html" title="Answers to frequently asked questions abou
t Google Chrome Extensions">FAQ</a> | |
195 </li> | |
196 <li id="samples_link"> | |
197 <a href="samples.html" title="Sample extensions (with source code)">
Samples</a> | |
198 </li> | |
199 <li id="group_link"> | |
200 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte
nsions" title="Google Chrome Extensions developer forum">Group</a> | |
201 </li> | |
202 <li id="so_link"> | |
203 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext
ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a> | |
204 </li> | |
205 </ul> | |
206 </div> <!-- end gc-topnav --> | |
207 | |
208 <div class="g-section g-tpl-170"> | |
209 <!-- SIDENAV --> | |
210 <div class="g-unit g-first" id="gc-toc"> | |
211 <ul> | |
212 <li><a href="getstarted.html">Getting Started</a></li> | |
213 <li><a href="overview.html">Overview</a></li> | |
214 <li><a href="whats_new.html">What's New?</a></li> | |
215 <li><h2><a href="devguide.html">Developer's Guide</a></h2> | |
216 <ul> | |
217 <li>Browser UI | |
218 <ul> | |
219 <li><a href="browserAction.html">Browser Actions</a></li> | |
220 <li><a href="contextMenus.html">Context Menus</a></li> | |
221 <li><a href="notifications.html">Desktop Notifications</a></li
> | |
222 <li><a href="omnibox.html">Omnibox</a></li> | |
223 <li><a href="options.html">Options Pages</a></li> | |
224 <li><a href="override.html">Override Pages</a></li> | |
225 <li><a href="pageAction.html">Page Actions</a></li> | |
226 </ul> | |
227 </li> | |
228 <li>Browser Interaction | |
229 <ul> | |
230 <li><a href="bookmarks.html">Bookmarks</a></li> | |
231 <li><a href="cookies.html">Cookies</a></li> | |
232 <li class="leftNavSelected">Developer Tools</li> | |
233 <li><a href="events.html">Events</a></li> | |
234 <li><a href="history.html">History</a></li> | |
235 <li><a href="management.html">Management</a></li> | |
236 <li><a href="tabs.html">Tabs</a></li> | |
237 <li><a href="windows.html">Windows</a></li> | |
238 </ul> | |
239 </li> | |
240 <li>Implementation | |
241 <ul> | |
242 <li><a href="a11y.html">Accessibility</a></li> | |
243 <li><a href="background_pages.html">Background Pages</a></li> | |
244 <li><a href="content_scripts.html">Content Scripts</a></li> | |
245 <li><a href="xhr.html">Cross-Origin XHR</a></li> | |
246 <li><a href="i18n.html">Internationalization</a></li> | |
247 <li><a href="messaging.html">Message Passing</a></li> | |
248 <li><a href="permissions.html">Optional Permissions</a></li> | |
249 <li><a href="npapi.html">NPAPI Plugins</a></li> | |
250 </ul> | |
251 </li> | |
252 <li>Finishing | |
253 <ul> | |
254 <li><a href="hosting.html">Hosting</a></li> | |
255 <li><a href="external_extensions.html">Other Deployment Option
s</a></li> | |
256 </ul> | |
257 </li> | |
258 </ul> | |
259 </li> | |
260 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> | |
261 <li><h2><a href="tutorials.html">Tutorials</a></h2> | |
262 <ul> | |
263 <li><a href="tut_debugging.html">Debugging</a></li> | |
264 <li><a href="tut_analytics.html">Google Analytics</a></li> | |
265 <li><a href="tut_oauth.html">OAuth</a></li> | |
266 </ul> | |
267 </li> | |
268 <li><h2>Reference</h2> | |
269 <ul> | |
270 <li>Formats | |
271 <ul> | |
272 <li><a href="manifest.html">Manifest Files</a></li> | |
273 <li><a href="match_patterns.html">Match Patterns</a></li> | |
274 </ul> | |
275 </li> | |
276 <li><a href="permission_warnings.html">Permission Warnings</a></li
> | |
277 <li><a href="api_index.html">chrome.* APIs</a></li> | |
278 <li><a href="api_other.html">Other APIs</a></li> | |
279 </ul> | |
280 </li> | |
281 <li><h2><a href="samples.html">Samples</a></h2></li> | |
282 <div class="line"> </div> | |
283 <li><h2>More</h2> | |
284 <ul> | |
285 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm
l">Chrome Web Store</a></li> | |
286 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu
ide.html">Hosted Apps</a></li> | |
287 <li><a href="themes.html">Themes</a></li> | |
288 </ul> | |
289 </li> | |
290 </ul> | |
291 </div> | |
292 <script> | |
293 initToggles(); | |
294 </script> | |
295 | |
296 <div class="g-unit" id="gc-pagecontent"> | |
297 <div id="pageTitle"> | |
298 <h1 class="page_title">chrome.devtools.* APIs</h1> | |
299 </div> | |
300 <!-- TABLE OF CONTENTS --> | |
301 <div id="toc" style="display: none; "> | |
302 <h2>Contents</h2> | |
303 <ol> | |
304 <li> | |
305 <a>h2Name</a> | |
306 <ol> | |
307 <li> | |
308 <a>h3Name</a> | |
309 </li> | |
310 </ol> | |
311 </li> | |
312 <li> | |
313 <a href="#apiReference">API reference</a> | |
314 <ol> | |
315 <div></div> | |
316 <div></div> | |
317 <div></div> | |
318 <div></div> | |
319 </ol> | |
320 </li> | |
321 </ol> | |
322 </div> | |
323 <!-- /TABLE OF CONTENTS --> | |
324 | |
325 <!-- Standard content lead-in for experimental API pages --> | |
326 <p id="classSummary" style="display: none; "> | |
327 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. | |
328 </p> | |
329 | |
330 <!-- STATIC CONTENT PLACEHOLDER --> | |
331 <div id="static"><div id="pageData-name" class="pageData">chrome.devtool
s.* APIs</div> | |
332 | |
333 <p> | |
334 The following API modules provide support for extending | |
335 Chrome Developer Tools: | |
336 </p> | |
337 | |
338 <a name="api-list"></a> | |
339 <ul> | |
340 <li> | |
341 <a href="devtools.inspectedWindow.html">devtools.inspectedWindow</a></li><li> | |
342 <a href="devtools.network.html">devtools.network</a></li><li> | |
343 <a href="devtools.panels.html">devtools.panels</a></li> | |
344 </ul> | |
345 | |
346 <h2 id="using">How to use DevTools APIs</h2> | |
347 | |
348 <ol> | |
349 <li> | |
350 Specify the "devtools_page" field in your extension's manifest: | |
351 <pre>{ | |
352 "name": ... | |
353 "version": "1.0", | |
354 "minimum_chrome_version": "10.0", | |
355 <b>"devtools_page": "devtools.html"</b>, | |
356 ... | |
357 } | |
358 </pre> | |
359 </li> | |
360 <li> | |
361 An instance of the devtools_page specified in your extension's manifest | |
362 will be created for every Developer Tools window opened. The page may add | |
363 other extension pages as panels and sidebars to the Developer Tools window | |
364 using <a href="devtools.panels.html">devtools.panels</a> | |
365 API. | |
366 </li> | |
367 <li> | |
368 The chrome.devtools.* API modules are available only to the | |
369 pages loaded within the Developer Tools window. Content scripts and other | |
370 extension pages do not have these APIs. Thus, the APIs are available only | |
371 through the lifetime of the Developer Tools window. | |
372 </li> | |
373 <li>The APIs available to extension pages within the Developer Tools | |
374 window include all <a href="#api-list">devtools modules | |
375 listed above</a> and <a href="extension.html">chrome.extension</a> API. | |
376 Other extension APIs are not available to the Developer Tools pages, but | |
377 you may invoke them by sending a request to the background page of your | |
378 extension, similarly to how it's done in the | |
379 <a href="overview.html#contentScripts">content scripts</a>. | |
380 </li><li> | |
381 There are also some Developer Tools APIs that are still experimental. | |
382 Please refer to <a href="experimental.html">chrome.experimental.* APIs</a> | |
383 for the list of experimental APIs and guidelines on how to use them. | |
384 </li> | |
385 <li> | |
386 <a href="http://groups.google.com/group/google-chrome-developer-tools/topics
">Give us feedback!</a> | |
387 Your comments and suggestions help us improve the APIs. | |
388 </li> | |
389 </ol> | |
390 | |
391 <h2 id="other">More information</h2> | |
392 | |
393 <p> | |
394 For information on the standard APIs that extensions can use, see | |
395 <a href="api_index.html">chrome.* APIs</a> and | |
396 <a href="api_other.html">Other APIs</a>. | |
397 </p> | |
398 | |
399 <h2 id="examples">Examples</h2> | |
400 | |
401 <p> | |
402 You can find examples that use Developer Tools APIs in | |
403 <a href="samples.html#devtools">Samples</a>. | |
404 </p> | |
405 </div> | |
406 | |
407 <!-- API PAGE --> | |
408 <div class="apiPage" style="display: none; "> | |
409 <a name="apiReference"></a> | |
410 <h2>API reference: chrome.apiname </h2> | |
411 | |
412 <!-- PROPERTIES --> | |
413 <div class="apiGroup"> | |
414 <a name="properties"></a> | |
415 <h3 id="properties">Properties</h3> | |
416 | |
417 <div> | |
418 <a></a> | |
419 <h4>getLastError</h4> | |
420 <div class="summary"> | |
421 <!-- Note: intentionally longer 80 columns --> | |
422 <span>chrome.extension</span><span>lastError</span> | |
423 </div> | |
424 <div> | |
425 </div> | |
426 </div> | |
427 | |
428 </div> <!-- /apiGroup --> | |
429 | |
430 <!-- METHODS --> | |
431 <div id="methodsTemplate" class="apiGroup"> | |
432 <a></a> | |
433 <h3>Methods</h3> | |
434 | |
435 <!-- iterates over all functions --> | |
436 <div class="apiItem"> | |
437 <a></a> <!-- method-anchor --> | |
438 <h4>method name</h4> | |
439 | |
440 <div class="summary"><span>void</span> | |
441 <!-- Note: intentionally longer 80 columns --> | |
442 <span>chrome.module.methodName</span>(<span><span>, </span><sp
an></span> | |
443 <var><span></span></var></span>)</div> | |
444 | |
445 <div class="description"> | |
446 <p class="todo">Undocumented.</p> | |
447 <p> | |
448 A description from the json schema def of the function goes he
re. | |
449 </p> | |
450 | |
451 <!-- PARAMETERS --> | |
452 <h4>Parameters</h4> | |
453 <dl> | |
454 <div> | |
455 <div> | |
456 </div> | |
457 </div> | |
458 </dl> | |
459 | |
460 <!-- RETURNS --> | |
461 <h4>Returns</h4> | |
462 <dl> | |
463 <div> | |
464 <div> | |
465 </div> | |
466 </div> | |
467 </dl> | |
468 | |
469 <!-- CALLBACK --> | |
470 <div> | |
471 <div> | |
472 <h4>Callback function</h4> | |
473 <p> | |
474 The callback <em>parameter</em> should specify a function | |
475 that looks like this: | |
476 </p> | |
477 <p> | |
478 If you specify the <em>callback</em> parameter, it should | |
479 specify a function that looks like this: | |
480 </p> | |
481 | |
482 <!-- Note: intentionally longer 80 columns --> | |
483 <pre>function(<span>Type param1, Type param2</span>) <span cla
ss="subdued">{...}</span>;</pre> | |
484 <dl> | |
485 <div> | |
486 <div> | |
487 </div> | |
488 </div> | |
489 </dl> | |
490 </div> | |
491 </div> | |
492 | |
493 <!-- MIN_VERSION --> | |
494 <p> | |
495 This function was added in version <b><span></span></b>. | |
496 If you require this function, the manifest key | |
497 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> | |
498 can ensure that your extension won't be run in an earlier brow
ser version. | |
499 </p> | |
500 </div> <!-- /description --> | |
501 | |
502 </div> <!-- /apiItem --> | |
503 | |
504 </div> <!-- /apiGroup --> | |
505 | |
506 <!-- EVENTS --> | |
507 <div id="eventsTemplate" class="apiGroup"> | |
508 <a></a> | |
509 <h3>Events</h3> | |
510 <!-- iterates over all events --> | |
511 <div class="apiItem"> | |
512 <a></a> | |
513 <h4>event name</h4> | |
514 | |
515 <div class="summary"> | |
516 <!-- Note: intentionally longer 80 columns --> | |
517 <span class="subdued">chrome.bookmarks</span><span>onEvent</span
><span class="subdued">.addListener</span>(function(<span>Type param1, Type para
m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p
aram2</span>); | |
518 </div> | |
519 | |
520 <div class="description"> | |
521 <p class="todo">Undocumented.</p> | |
522 <p> | |
523 A description from the json schema def of the event goes here. | |
524 </p> | |
525 | |
526 <!-- LISTENER PARAMETERS --> | |
527 <div> | |
528 <h4>Listener parameters</h4> | |
529 <dl> | |
530 <div> | |
531 <div> | |
532 </div> | |
533 </div> | |
534 </dl> | |
535 </div> | |
536 | |
537 <!-- EXTRA PARAMETERS --> | |
538 <div> | |
539 <h4>Extra parameters to addListener</h4> | |
540 <dl> | |
541 <div> | |
542 <div> | |
543 </div> | |
544 </div> | |
545 </dl> | |
546 </div> | |
547 | |
548 <!-- LISTENER RETURN VALUE --> | |
549 <h4>Listener returns</h4> | |
550 <dl> | |
551 <div> | |
552 <div> | |
553 </div> | |
554 </div> | |
555 </dl> | |
556 | |
557 </div> <!-- /description --> | |
558 </div> <!-- /apiItem --> | |
559 | |
560 </div> <!-- /apiGroup --> | |
561 | |
562 <!-- TYPES --> | |
563 <div class="apiGroup"> | |
564 <a name="types"></a> | |
565 <h3 id="types">Types</h3> | |
566 | |
567 <!-- iterates over all types --> | |
568 <div class="apiItem"> | |
569 <a></a> | |
570 <h4>type name</h4> | |
571 | |
572 <div> | |
573 </div> | |
574 | |
575 </div> <!-- /apiItem --> | |
576 | |
577 </div> <!-- /apiGroup --> | |
578 | |
579 </div> <!-- /apiPage --> | |
580 </div> <!-- /gc-pagecontent --> | |
581 </div> <!-- /g-section --> | |
582 </div> <!-- /codesiteContent --> | |
583 <div id="gc-footer" --=""> | |
584 <div class="text"> | |
585 <p> | |
586 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, | |
587 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons | |
588 Attribution 3.0 License</a>, and code samples are licensed under the | |
589 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. | |
590 </p> | |
591 <p> | |
592 ©2011 Google | |
593 </p> | |
594 | |
595 <!-- begin analytics --> | |
596 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript">
</script> | |
597 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc
ript> | |
598 | |
599 <script type="text/javascript"> | |
600 // chrome doc tracking | |
601 try { | |
602 var engdocs = _gat._getTracker("YT-10763712-2"); | |
603 engdocs._trackPageview(); | |
604 } catch(err) {} | |
605 | |
606 // code.google.com site-wide tracking | |
607 try { | |
608 _uacct="UA-18071-1"; | |
609 _uanchor=1; | |
610 _uff=0; | |
611 urchinTracker(); | |
612 } | |
613 catch(e) {/* urchinTracker not available. */} | |
614 </script> | |
615 <!-- end analytics --> | |
616 </div> | |
617 </div> <!-- /gc-footer --> | |
618 </div> <!-- /gc-container --> | |
619 </body></html> | |
OLD | NEW |