Home | History | Annotate | Download | only in docs
      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>Autoupdating - 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><a href="api_index.html">chrome.* APIs</a></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">Autoupdating</h1>
    255       </div>
    256         <!-- TABLE OF CONTENTS -->
    257         <div id="toc">
    258           <h2>Contents</h2>
    259           <ol>
    260             <li>
    261               <a href="#H2-0">Overview</a>
    262               <ol>
    263                 <li style="display: none; ">
    264                   <a>h3Name</a>
    265                 </li>
    266               </ol>
    267             </li><li>
    268               <a href="#H2-1">Update URL</a>
    269               <ol>
    270                 <li style="display: none; ">
    271                   <a>h3Name</a>
    272                 </li>
    273               </ol>
    274             </li><li>
    275               <a href="#H2-2">Update manifest</a>
    276               <ol>
    277                 <li style="display: none; ">
    278                   <a>h3Name</a>
    279                 </li>
    280               </ol>
    281             </li><li>
    282               <a href="#H2-3">Testing</a>
    283               <ol>
    284                 <li style="display: none; ">
    285                   <a>h3Name</a>
    286                 </li>
    287               </ol>
    288             </li><li>
    289               <a href="#H2-4">Advanced usage: request parameters</a>
    290               <ol>
    291                 <li>
    292                   <a href="#H3-5">Future work</a>
    293                 </li>
    294               </ol>
    295             </li><li>
    296               <a href="#H2-6">Advanced usage: minimum browser version</a>
    297               <ol>
    298                 <li style="display: none; ">
    299                   <a>h3Name</a>
    300                 </li>
    301               </ol>
    302             </li>
    303               <li style="display: none; ">
    304                 <a href="#apiReference">API reference</a>
    305                 <ol>
    306                   <li>
    307                     <a href="#properties">Properties</a>
    308                     <ol>
    309                       <li>
    310                         <a href="#property-anchor">propertyName</a>
    311                       </li>
    312                     </ol>
    313                   </li>
    314                   <li>
    315                     <a>Methods</a>
    316                     <ol>
    317                       <li>
    318                         <a href="#method-anchor">methodName</a>
    319                       </li>
    320                     </ol>
    321                   </li>
    322                   <li>
    323                     <a>Events</a>
    324                     <ol>
    325                       <li>
    326                         <a href="#event-anchor">eventName</a>
    327                       </li>
    328                     </ol>
    329                   </li>
    330                   <li>
    331                     <a href="#types">Types</a>
    332                     <ol>
    333                       <li>
    334                         <a href="#id-anchor">id</a>
    335                       </li>
    336                     </ol>
    337                   </li>
    338                 </ol>
    339               </li>
    340           </ol>
    341         </div>
    342         <!-- /TABLE OF CONTENTS -->
    343 
    344         <!-- Standard content lead-in for experimental API pages -->
    345         <p id="classSummary" style="display: none; ">
    346           For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.
    347         </p>
    348 
    349         <!-- STATIC CONTENT PLACEHOLDER -->
    350         <div id="static"><div id="pageData-name" class="pageData">Autoupdating</div>
    351 <div id="pageData-showTOC" class="pageData">true</div>
    352 
    353 <p>We want extensions to be autoupdated for some of the same reasons as Google Chrome itself: to incorporate bug and security fixes, add new features or performance enhancements, and improve user interfaces.</p>
    354 
    355 <p>If you publish your extension using the <a href="https://chrome.google.com/webstore/developer/dashboard">Chrome Developer Dashboard</a>, you can <em>ignore this page</em>. You can use the dashboard to release updated versions of your extension to users, as well as to the Extensions Gallery or Chrome Web Store.</p>
    356 
    357 <p>If you want to host your extension somewhere other than the gallery or store, keep reading.
    358 You should also read <a href="hosting.html">Hosting</a> and
    359 <a href="packaging.html">Packaging</a>.</p>
    360 
    361 
    362 <a name="H2-0"></a><h2>Overview</h2>
    363 <ul><li>An extension manifest may contain an "update_url" for doing update checks.</li>
    364 <li>The content returned by an update check is an "update manifest" XML document listing the latest version of an extension (or set of extensions, more on that later).</li></ul>
    365 
    366 <p>Every few hours, the browser will check if any installed extensions have an autoupdate URL. For each one, it will make a request to that URL looking for an update manifest XML file. If the update manifest mentions a version of an extension that is more recent than what's installed, it will download and install the new version. Similar to manual updates, the new crx must be signed with the same private key as the currently installed version.</p>
    367 
    368 
    369 <a name="H2-1"></a><h2>Update URL</h2>
    370 <p>For those who are hosting their own extensions, you need to add the "update_url" key to your <a href="manifest.html">manifest.json</a> file like this:</p>
    371 
    372 <pre>{
    373   "name": "My extension",
    374   ...
    375   <b>"update_url": "http://myhost.com/mytestextension/updates.xml"</b>,
    376   ...
    377 }
    378 </pre>
    379 
    380 <a name="H2-2"></a><h2>Update manifest</h2>
    381 <p>The "update manifest" returned by the server&nbsp;should be an XML document that looks like this (parts you'll want to modify highlighted):</p>
    382 
    383 <pre>&lt;?xml version='1.0' encoding='UTF-8'?&gt;
    384 &lt;gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'&gt;
    385   &lt;app appid='<b>aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</b>'&gt;
    386    &nbsp;&lt;updatecheck&nbsp;codebase='<b>http://myhost.com/mytestextension/mte_v2.crx</b>'&nbsp;version='<b>2.0</b>' /&gt;
    387   &lt;/app&gt;
    388 &lt;/gupdate&gt;
    389 </pre>
    390 
    391 <p>(This XML format is borrowed from that used by Omaha, Google's update infrastructure. See <a href="http://code.google.com/p/omaha/">http://code.google.com/p/omaha/</a> for more details.)</p>
    392 
    393 <p><b>appid</b><br>
    394 The 'appid' property is the extension id, generated based on a hash of the extension's public key as described in <a href="packaging.html">Packaging</a>. You can find out the id of your extension by going to <b>chrome://extensions</b>.</p>
    395 
    396 <p><b>codebase</b><br>
    397 The 'codebase' property is a URL to the crx file.</p>
    398 
    399 <p><b>version</b><br>
    400 This is used by the client to determine whether it should download the crx file at 'codebase'. It should match the version parameter in the crx file's manifest.json file.</p>
    401 <p>The update manifest XML file may contain information about multiple extensions by including multiple <code>&lt;app&gt;</code> tags.</p>
    402 
    403 
    404 <a name="H2-3"></a><h2>Testing</h2>
    405 <p>The default update check frequency is several hours,
    406 but you can force an update using the Extensions page's
    407 <b>Update extensions now</b> button.
    408 </p>
    409 
    410 <p>
    411 Another option is to use the --extensions-update-frequency command-line flag to set a more frequent interval in seconds. For instance, to make checks run every 45 seconds, you would run Google Chrome like this:</p>
    412 <pre>chrome.exe <b>--extensions-update-frequency=45</b></pre>
    413 
    414 <p>Note that this affects checks for all installed extensions, so consider the bandwidth and server load implications of this. You may want to temporarily uninstall all but the one extension you are testing with, and should not run with this option turned on during normal browser usage.</p>
    415 
    416 
    417 <a name="H2-4"></a><h2>Advanced usage: request parameters</h2>
    418 <p>The basic autoupdate mechanism is designed to make the server-side work as easy as just dropping a static XML file onto any plain webserver such as apache, and updating that XML file as you release new versions of your extension(s).</p>
    419 <p>More advanced developers may wish to take advantage of the fact that we add on parameters to the request for the update manifest to indicate the extension id and version. Then they can use the same update_url for all of their extensions pointing to a URL running dynamic server side code instead of a static XML file.</p>
    420 <p>The format of the request parameters is:</p>
    421 <p><code>&nbsp;&nbsp;?x=&lt;extension_data&gt;</code></p>
    422 <p>where <code>&lt;extension_data&gt;</code> is an URL-encoded string of the format:</p>
    423 <p><code>&nbsp;&nbsp;id=&lt;id&gt;&amp;v=&lt;version&gt;</code></p>
    424 
    425 <p>So for example, say we have two extensions installed</p>
    426 <p>&nbsp;&nbsp;Extension 1 with id "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" and version "1.1"<br>
    427 &nbsp;&nbsp;Extension 2 with id "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" and version "0.4"</p>
    428 
    429 <p>and that both point at the same update_url: <code>http://test.com/extension_updates.php</code></p>
    430 
    431 <p>The two requests made would be:</p>
    432 <code>http://test.com/extension_updates.php?x=id%3Daaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa%26v%3D1.1</code>
    433 <br>
    434 <code>http://test.com/extension_updates.php?x=id%3Dbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb%26v%3D0.4</code>
    435 
    436 <p><b>Note</b>: in releases before 3.0.196.x there was a bug in how request parameters were put together (<a href="http://crbug.com/17469" rel="nofollow">http://crbug.com/17469</a>).</p>
    437 
    438 <a name="H3-5"></a><h3>Future work</h3>
    439 <p>While not implemented yet, we will eventually list multiple extensions in a single request for each unique update_url. For the above example, the request would end up being:</p>
    440 <p><code>http://test.com/extension_updates.php?x=id%3Daaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa%26v%3D1.1&x=id%3Dbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb%26v%3D0.4</code></p>
    441 
    442 <p>If the number of installed extensions using the same update_url is large enough that a GET request URL would be too long (probably greater than 1024 characters or so), the update check will instead issue a POST with the request parameters in the POST body.</p>
    443 
    444 
    445 <a name="H2-6"></a><h2>Advanced usage: minimum browser version</h2>
    446 <p>As we add more APIs to the extensions system, it's possible you will want to release an updated version of an extension that will only work with newer versions of the browser. While Google Chrome itself is autoupdated, it can take a few days before the majority of the user base has updated to any given new release. To ensure that a given extension update will apply only to Google Chrome versions at or higher than a specific version, you would add the prodversionmin parameter to the <code>&lt;app&gt;</code> tag in your update manifest. For example:</p>
    447 
    448 <pre>&lt;?xml version='1.0' encoding='UTF-8'?&gt;
    449 &lt;gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'&gt;
    450 &nbsp;&nbsp;&lt;app appid='aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'&gt;
    451 &nbsp;&nbsp; &nbsp;&lt;updatecheck&nbsp;codebase='http://myhost.com/mytestextension/mte_v2.crx'&nbsp;version='2.0' <b>prodversionmin='3.0.193.0'</b>/&gt;
    452 &nbsp;&nbsp;&lt;/app&gt;
    453 &lt;/gupdate&gt;
    454 </pre>
    455 
    456 <p>This would ensure that users of this extension would autoupdate to version 2 only if they are running Google Chrome 3.0.193.0 or greater.</p>
    457 
    458 </div>
    459 
    460         <!-- API PAGE -->
    461         <div class="apiPage" style="display: none; ">
    462         <a name="apiReference"></a>
    463         <h2>API reference: chrome.apiname </h2>
    464 
    465           <!-- PROPERTIES -->
    466           <div class="apiGroup">
    467             <a name="properties"></a>
    468             <h3 id="properties">Properties</h3>
    469 
    470             <div>
    471               <a></a>
    472               <h4>getLastError</h4>
    473               <div class="summary">
    474                 <!-- Note: intentionally longer 80 columns -->
    475                 <span>chrome.extension</span><span>lastError</span>
    476               </div>
    477               <div>
    478               </div>
    479             </div>
    480 
    481           </div> <!-- /apiGroup -->
    482 
    483           <!-- METHODS -->
    484           <div id="methodsTemplate" class="apiGroup">
    485             <a></a>
    486             <h3>Methods</h3>
    487 
    488             <!-- iterates over all functions -->
    489             <div class="apiItem">
    490               <a></a> <!-- method-anchor -->
    491               <h4>method name</h4>
    492 
    493               <div class="summary"><span>void</span>
    494                   <!-- Note: intentionally longer 80 columns -->
    495                   <span>chrome.module.methodName</span>(<span><span>, </span><span></span>
    496                       <var><span></span></var></span>)</div>
    497 
    498               <div class="description">
    499                 <p class="todo">Undocumented.</p>
    500                 <p>
    501                   A description from the json schema def of the function goes here.
    502                 </p>
    503 
    504                 <!-- PARAMETERS -->
    505                 <h4>Parameters</h4>
    506                 <dl>
    507                   <div>
    508                     <div>
    509                     </div>
    510                   </div>
    511                 </dl>
    512 
    513                 <!-- RETURNS -->
    514                 <h4>Returns</h4>
    515                 <dl>
    516                   <div>
    517                     <div>
    518                     </div>
    519                   </div>
    520                 </dl>
    521 
    522                 <!-- CALLBACK -->
    523                 <div>
    524                   <div>
    525                   <h4>Callback function</h4>
    526                   <p>
    527                     The callback <em>parameter</em> should specify a function
    528                     that looks like this:
    529                   </p>
    530                   <p>
    531                     If you specify the <em>callback</em> parameter, it should
    532                     specify a function that looks like this:
    533                   </p>
    534 
    535                   <!-- Note: intentionally longer 80 columns -->
    536                   <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre>
    537                   <dl>
    538                     <div>
    539                       <div>
    540                       </div>
    541                     </div>
    542                   </dl>
    543                   </div>
    544                 </div>
    545 
    546                 <!-- MIN_VERSION -->
    547                 <p>
    548                   This function was added in version <b><span></span></b>.
    549                   If you require this function, the manifest key
    550                   <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
    551                   can ensure that your extension won't be run in an earlier browser version.
    552                 </p>
    553               </div> <!-- /description -->
    554 
    555             </div>  <!-- /apiItem -->
    556 
    557           </div>  <!-- /apiGroup -->
    558 
    559           <!-- EVENTS -->
    560           <div id="eventsTemplate" class="apiGroup">
    561             <a></a>
    562             <h3>Events</h3>
    563             <!-- iterates over all events -->
    564             <div class="apiItem">
    565               <a></a>
    566               <h4>event name</h4>
    567 
    568               <div class="summary">
    569                 <!-- Note: intentionally longer 80 columns -->
    570                 <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>);
    571               </div>
    572 
    573               <div class="description">
    574                 <p class="todo">Undocumented.</p>
    575                 <p>
    576                   A description from the json schema def of the event goes here.
    577                 </p>
    578 
    579                 <!-- PARAMETERS -->
    580                 <div>
    581                   <h4>Parameters</h4>
    582                   <dl>
    583                     <div>
    584                       <div>
    585                       </div>
    586                     </div>
    587                   </dl>
    588                 </div>
    589               </div> <!-- /decription -->
    590 
    591             </div> <!-- /apiItem -->
    592 
    593           </div> <!-- /apiGroup -->
    594 
    595           <!-- TYPES -->
    596           <div class="apiGroup">
    597             <a name="types"></a>
    598             <h3 id="types">Types</h3>
    599 
    600             <!-- iterates over all types -->
    601             <div class="apiItem">
    602               <a></a>
    603               <h4>type name</h4>
    604 
    605               <div>
    606               </div>
    607 
    608             </div> <!-- /apiItem -->
    609 
    610           </div> <!-- /apiGroup -->
    611 
    612         </div> <!-- /apiPage -->
    613       </div> <!-- /gc-pagecontent -->
    614     </div> <!-- /g-section -->
    615   </div> <!-- /codesiteContent -->
    616     <div id="gc-footer" --="">
    617       <div class="text">
    618   <p>
    619   Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
    620   the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
    621   Attribution 3.0 License</a>, and code samples are licensed under the
    622   <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
    623   </p>
    624   <p>
    625   2011 Google
    626   </p>
    627 
    628 <!-- begin analytics -->
    629 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
    630 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>
    631 
    632 <script type="text/javascript">
    633   // chrome doc tracking
    634   try {
    635     var engdocs = _gat._getTracker("YT-10763712-2");
    636     engdocs._trackPageview();
    637   } catch(err) {}
    638 
    639   // code.google.com site-wide tracking
    640   try {
    641     _uacct="UA-18071-1";
    642     _uanchor=1;
    643     _uff=0;
    644     urchinTracker();
    645   }
    646   catch(e) {/* urchinTracker not available. */}
    647 </script>
    648 <!-- end analytics -->
    649       </div>
    650     </div> <!-- /gc-footer -->
    651   </div> <!-- /gc-container -->
    652 </body></html>
    653