api_index.html revision 201ade2fbba22bfb27ae029f4d23fca6ded109a0
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/jstemplate_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.* 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_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 72 </dd> 73 74 <!-- OBJECT PROPERTIES --> 75 <dd> 76 <dl> 77 <div> 78 <div> 79 </div> 80 </div> 81 </dl> 82 </dd> 83 84 <!-- FUNCTION PARAMETERS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 </div> <!-- /VALUE --> 90 91 <div id="functionParametersTemplate"> 92 <h5>Parameters</h5> 93 <dl> 94 <div> 95 <div> 96 </div> 97 </div> 98 </dl> 99 </div> 100 </div> <!-- /SUBTEMPLATES --> 101 102 <a id="top"></a> 103 <div id="skipto"> 104 <a href="#gc-pagecontent">Skip to page content</a> 105 <a href="#gc-toc">Skip to main navigation</a> 106 </div> 107 <!-- API HEADER --> 108 <table id="header" width="100%" cellspacing="0" border="0"> 109 <tbody><tr> 110 <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> 111 <td valign="middle" width="100%" style="padding-left:0.6em;"> 112 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 113 <div id="gsc-search-box"> 114 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 115 <input type="hidden" name="ie" value="UTF-8"> 116 <input type="text" name="q" value="" size="55"> 117 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 118 <br> 119 <span class="greytext">e.g. "page action" or "tabs"</span> 120 </div> 121 </form> 122 123 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 124 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 125 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 126 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 127 </td> 128 </tr> 129 </tbody></table> 130 131 <div id="codesiteContent" class=""> 132 133 <a id="gc-topnav-anchor"></a> 134 <div id="gc-topnav"> 135 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 136 <ul id="home" class="gc-topnav-tabs"> 137 <li id="home_link"> 138 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 139 </li> 140 <li id="docs_link"> 141 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 142 </li> 143 <li id="faq_link"> 144 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 145 </li> 146 <li id="samples_link"> 147 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 148 </li> 149 <li id="group_link"> 150 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 151 </li> 152 </ul> 153 </div> <!-- end gc-topnav --> 154 155 <div class="g-section g-tpl-170"> 156 <!-- SIDENAV --> 157 <div class="g-unit g-first" id="gc-toc"> 158 <ul> 159 <li><a href="getstarted.html">Getting Started</a></li> 160 <li><a href="overview.html">Overview</a></li> 161 <li><a href="whats_new.html">What's New?</a></li> 162 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 163 <ul> 164 <li>Browser UI 165 <ul> 166 <li><a href="browserAction.html">Browser Actions</a></li> 167 <li><a href="contextMenus.html">Context Menus</a></li> 168 <li><a href="notifications.html">Desktop Notifications</a></li> 169 <li><a href="omnibox.html">Omnibox</a></li> 170 <li><a href="options.html">Options Pages</a></li> 171 <li><a href="override.html">Override Pages</a></li> 172 <li><a href="pageAction.html">Page Actions</a></li> 173 </ul> 174 </li> 175 <li>Browser Interaction 176 <ul> 177 <li><a href="bookmarks.html">Bookmarks</a></li> 178 <li><a href="cookies.html">Cookies</a></li> 179 <li><a href="events.html">Events</a></li> 180 <li><a href="history.html">History</a></li> 181 <li><a href="management.html">Management</a></li> 182 <li><a href="tabs.html">Tabs</a></li> 183 <li><a href="windows.html">Windows</a></li> 184 </ul> 185 </li> 186 <li>Implementation 187 <ul> 188 <li><a href="a11y.html">Accessibility</a></li> 189 <li><a href="background_pages.html">Background Pages</a></li> 190 <li><a href="content_scripts.html">Content Scripts</a></li> 191 <li><a href="xhr.html">Cross-Origin XHR</a></li> 192 <li><a href="idle.html">Idle</a></li> 193 <li><a href="i18n.html">Internationalization</a></li> 194 <li><a href="messaging.html">Message Passing</a></li> 195 <li><a href="npapi.html">NPAPI Plugins</a></li> 196 </ul> 197 </li> 198 <li>Finishing 199 <ul> 200 <li><a href="hosting.html">Hosting</a></li> 201 <li><a href="external_extensions.html">Other Deployment Options</a></li> 202 </ul> 203 </li> 204 </ul> 205 </li> 206 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 207 <li><h2><a href="tutorials.html">Tutorials</a></h2> 208 <ul> 209 <li><a href="tut_debugging.html">Debugging</a></li> 210 <li><a href="tut_analytics.html">Google Analytics</a></li> 211 <li><a href="tut_oauth.html">OAuth</a></li> 212 </ul> 213 </li> 214 <li><h2>Reference</h2> 215 <ul> 216 <li>Formats 217 <ul> 218 <li><a href="manifest.html">Manifest Files</a></li> 219 <li><a href="match_patterns.html">Match Patterns</a></li> 220 </ul> 221 </li> 222 <li><a href="permission_warnings.html">Permission Warnings</a></li> 223 <li class="leftNavSelected">chrome.* APIs</li> 224 <li><a href="api_other.html">Other APIs</a></li> 225 </ul> 226 </li> 227 <li><h2><a href="samples.html">Samples</a></h2></li> 228 <div class="line"> </div> 229 <li><h2>More</h2> 230 <ul> 231 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 232 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 233 <li><a href="themes.html">Themes</a></li> 234 </ul> 235 </li> 236 </ul> 237 </div> 238 <script> 239 initToggles(); 240 </script> 241 242 <div class="g-unit" id="gc-pagecontent"> 243 <div id="pageTitle"> 244 <h1 class="page_title">chrome.* APIs</h1> 245 </div> 246 <!-- TABLE OF CONTENTS --> 247 <div id="toc"> 248 <h2>Contents</h2> 249 <ol> 250 <li> 251 <a href="#supported">Supported APIs</a> 252 <ol> 253 <li style="display: none; "> 254 <a>h3Name</a> 255 </li> 256 </ol> 257 </li><li> 258 <a href="#experimental">Experimental APIs</a> 259 <ol> 260 <li style="display: none; "> 261 <a>h3Name</a> 262 </li> 263 </ol> 264 </li><li> 265 <a href="#conventions">API conventions</a> 266 <ol> 267 <li style="display: none; "> 268 <a>h3Name</a> 269 </li> 270 </ol> 271 </li> 272 <li style="display: none; "> 273 <a href="#apiReference">API reference</a> 274 <ol> 275 <li> 276 <a href="#properties">Properties</a> 277 <ol> 278 <li> 279 <a href="#property-anchor">propertyName</a> 280 </li> 281 </ol> 282 </li> 283 <li> 284 <a href="#methods">Methods</a> 285 <ol> 286 <li> 287 <a href="#method-anchor">methodName</a> 288 </li> 289 </ol> 290 </li> 291 <li> 292 <a href="#events">Events</a> 293 <ol> 294 <li> 295 <a href="#event-anchor">eventName</a> 296 </li> 297 </ol> 298 </li> 299 <li> 300 <a href="#types">Types</a> 301 <ol> 302 <li> 303 <a href="#id-anchor">id</a> 304 </li> 305 </ol> 306 </li> 307 </ol> 308 </li> 309 </ol> 310 </div> 311 <!-- /TABLE OF CONTENTS --> 312 313 <!-- Standard content lead-in for experimental API pages --> 314 <p id="classSummary" style="display: none; "> 315 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 316 </p> 317 318 <!-- STATIC CONTENT PLACEHOLDER --> 319 <div id="static"><div id="pageData-name" class="pageData">chrome.* APIs</div> 320<div id="pageData-showTOC" class="pageData">true</div> 321 322<p> 323Google Chrome provides APIs such as 324<code>chrome.bookmarks</code> and <code>chrome.tab</code> 325so that extensions can interact with the browser. 326</p> 327 328<h2 id="supported">Supported APIs</h2> 329 330<p> 331Here are the supported chrome.* APIs: 332</p> 333 334<ul> 335 <li><a href="bookmarks.html" js="">bookmarks</a></li><li><a href="browserAction.html" js="">browserAction</a></li><li><a href="contextMenus.html" js="">contextMenus</a></li><li><a href="cookies.html" js="">cookies</a></li><li><a href="extension.html" js="">extension</a></li><li><a href="history.html" js="">history</a></li><li><a href="i18n.html" js="">i18n</a></li><li><a href="idle.html" js="">idle</a></li><li><a href="management.html" js="">management</a></li><li><a href="omnibox.html" js="">omnibox</a></li><li><a href="pageAction.html" js="">pageAction</a></li><li><a href="tabs.html" js="">tabs</a></li><li><a href="windows.html" js="">windows</a></li> 336</ul> 337 338<h2 id="experimental">Experimental APIs</h2> 339 340<p> 341Google Chrome also has some 342<a href="experimental.html">experimental APIs</a>, 343which give you access to 344functionality such as process information and history. 345</p> 346 347<h2 id="conventions">API conventions</h2> 348 349<p> 350Unless the doc says otherwise, 351methods in the chrome.* APIs are asynchronous: 352they return immediately, 353without waiting for the operation to finish. 354If you need to know the outcome of an operation, 355then you pass a callback function into the method. 356For more information, see the video 357<a href="http://www.youtube.com/watch?v=bmxr75CV36A&feature=PlayList&p=CA101D6A85FE9D4B&index=2">Extension API Design</a>. 358</p> 359</div> 360 361 <!-- API PAGE --> 362 <div class="apiPage" style="display: none; "> 363 <a name="apiReference"></a> 364 <h2>API reference: chrome.apiname </h2> 365 366 <!-- PROPERTIES --> 367 <div class="apiGroup"> 368 <a name="properties"></a> 369 <h3 id="properties">Properties</h3> 370 371 <div> 372 <a></a> 373 <h4>getLastError</h4> 374 <div class="summary"> 375 <!-- Note: intentionally longer 80 columns --> 376 <span>chrome.extension</span><span>lastError</span> 377 </div> 378 <div> 379 </div> 380 </div> 381 382 </div> <!-- /apiGroup --> 383 384 <!-- METHODS --> 385 <div class="apiGroup" id="methods"> 386 <a name="methods"></a> 387 <h3>Methods</h3> 388 389 <!-- iterates over all functions --> 390 <div class="apiItem"> 391 <a></a> <!-- method-anchor --> 392 <h4>method name</h4> 393 394 <div class="summary"><span>void</span> 395 <!-- Note: intentionally longer 80 columns --> 396 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 397 <var><span></span></var></span>)</div> 398 399 <div class="description"> 400 <p class="todo">Undocumented.</p> 401 <p> 402 A description from the json schema def of the function goes here. 403 </p> 404 405 <!-- PARAMETERS --> 406 <h4>Parameters</h4> 407 <dl> 408 <div> 409 <div> 410 </div> 411 </div> 412 </dl> 413 414 <!-- RETURNS --> 415 <h4>Returns</h4> 416 <dl> 417 <div> 418 <div> 419 </div> 420 </div> 421 </dl> 422 423 <!-- CALLBACK --> 424 <div> 425 <div> 426 <h4>Callback function</h4> 427 <p> 428 The callback <em>parameter</em> should specify a function 429 that looks like this: 430 </p> 431 <p> 432 If you specify the <em>callback</em> parameter, it should 433 specify a function that looks like this: 434 </p> 435 436 <!-- Note: intentionally longer 80 columns --> 437 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 438 <dl> 439 <div> 440 <div> 441 </div> 442 </div> 443 </dl> 444 </div> 445 </div> 446 447 <!-- MIN_VERSION --> 448 <p> 449 This function was added in version <b><span></span></b>. 450 If you require this function, the manifest key 451 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 452 can ensure that your extension won't be run in an earlier browser version. 453 </p> 454 </div> <!-- /description --> 455 456 </div> <!-- /apiItem --> 457 458 </div> <!-- /apiGroup --> 459 460 <!-- EVENTS --> 461 <div class="apiGroup"> 462 <a name="events"></a> 463 <h3 id="events">Events</h3> 464 465 <!-- iterates over all events --> 466 <div class="apiItem"> 467 <a></a> 468 <h4>event name</h4> 469 470 <div class="summary"> 471 <!-- Note: intentionally longer 80 columns --> 472 <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>); 473 </div> 474 475 <div class="description"> 476 <p class="todo">Undocumented.</p> 477 <p> 478 A description from the json schema def of the event goes here. 479 </p> 480 481 <!-- PARAMETERS --> 482 <h4>Parameters</h4> 483 <dl> 484 <div> 485 <div> 486 </div> 487 </div> 488 </dl> 489 490 </div> <!-- /decription --> 491 492 </div> <!-- /apiItem --> 493 494 </div> <!-- /apiGroup --> 495 496 <!-- TYPES --> 497 <div class="apiGroup"> 498 <a name="types"></a> 499 <h3 id="types">Types</h3> 500 501 <!-- iterates over all types --> 502 <div class="apiItem"> 503 <a></a> 504 <h4>type name</h4> 505 506 <div> 507 </div> 508 509 </div> <!-- /apiItem --> 510 511 </div> <!-- /apiGroup --> 512 513 </div> <!-- /apiPage --> 514 </div> <!-- /gc-pagecontent --> 515 </div> <!-- /g-section --> 516 </div> <!-- /codesiteContent --> 517 <div id="gc-footer" --=""> 518 <div class="text"> 519 <p> 520 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 521 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 522 Attribution 3.0 License</a>, and code samples are licensed under the 523 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 524 </p> 525 <p> 526 ©2010 Google 527 </p> 528 529<!-- begin analytics --> 530<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 531<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 532 533<script type="text/javascript"> 534 // chrome doc tracking 535 try { 536 var engdocs = _gat._getTracker("YT-10763712-2"); 537 engdocs._trackPageview(); 538 } catch(err) {} 539 540 // code.google.com site-wide tracking 541 try { 542 _uacct="UA-18071-1"; 543 _uanchor=1; 544 _uff=0; 545 urchinTracker(); 546 } 547 catch(e) {/* urchinTracker not available. */} 548</script> 549<!-- end analytics --> 550 </div> 551 </div> <!-- /gc-footer --> 552 </div> <!-- /gc-container --> 553</body></html> 554
