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