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>Idle - 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 class="leftNavSelected">Idle</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">Idle</h1>
    255       </div>
    256         <!-- TABLE OF CONTENTS -->
    257         <div id="toc">
    258           <h2>Contents</h2>
    259           <ol>
    260             <li>
    261               <a href="#manifest">Manifest</a>
    262               <ol>
    263                 <li style="display: none; ">
    264                   <a>h3Name</a>
    265                 </li>
    266               </ol>
    267             </li>
    268               <li>
    269                 <a href="#apiReference">API reference: chrome.idle</a>
    270                 <ol>
    271                   <li style="display: none; ">
    272                     <a href="#properties">Properties</a>
    273                     <ol>
    274                       <li>
    275                         <a href="#property-anchor">propertyName</a>
    276                       </li>
    277                     </ol>
    278                   </li>
    279                   <li>
    280                     <a href="#global-methods">Methods</a>
    281                     <ol>
    282                       <li>
    283                         <a href="#method-queryState">queryState</a>
    284                       </li>
    285                     </ol>
    286                   </li>
    287                   <li>
    288                     <a href="#global-events">Events</a>
    289                     <ol>
    290                       <li>
    291                         <a href="#event-onStateChanged">onStateChanged</a>
    292                       </li>
    293                     </ol>
    294                   </li>
    295                   <li style="display: none; ">
    296                     <a href="#types">Types</a>
    297                     <ol>
    298                       <li>
    299                         <a href="#id-anchor">id</a>
    300                       </li>
    301                     </ol>
    302                   </li>
    303                 </ol>
    304               </li>
    305           </ol>
    306         </div>
    307         <!-- /TABLE OF CONTENTS -->
    308 
    309         <!-- Standard content lead-in for experimental API pages -->
    310         <p id="classSummary" style="display: none; ">
    311           For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.
    312         </p>
    313 
    314         <!-- STATIC CONTENT PLACEHOLDER -->
    315         <div id="static"><div id="pageData-name" class="pageData">Idle</div>
    316 
    317 <!-- BEGIN AUTHORED CONTENT -->
    318 <h2 id="manifest">Manifest</h2>
    319 <p>You must declare the "idle" permission in your extension's manifest to use the idle API.
    320 For example:
    321 </p>
    322 
    323 <pre>{
    324   "name": "My extension",
    325   ...
    326   <b>"permissions": [
    327     "idle"
    328   ]</b>,
    329   ...
    330 }</pre>
    331 
    332 <!-- END AUTHORED CONTENT -->
    333 </div>
    334 
    335         <!-- API PAGE -->
    336         <div class="apiPage">
    337         <a name="apiReference"></a>
    338         <h2>API reference: chrome.idle</h2>
    339 
    340           <!-- PROPERTIES -->
    341           <div class="apiGroup" style="display: none; ">
    342             <a name="properties"></a>
    343             <h3 id="properties">Properties</h3>
    344 
    345             <div>
    346               <a></a>
    347               <h4>getLastError</h4>
    348               <div class="summary">
    349                 <!-- Note: intentionally longer 80 columns -->
    350                 <span>chrome.extension</span><span>lastError</span>
    351               </div>
    352               <div>
    353               </div>
    354             </div>
    355 
    356           </div> <!-- /apiGroup -->
    357 
    358           <!-- METHODS -->
    359           <div id="methodsTemplate" class="apiGroup">
    360             <a name="global-methods"></a>
    361             <h3>Methods</h3>
    362 
    363             <!-- iterates over all functions -->
    364             <div class="apiItem">
    365               <a name="method-queryState"></a> <!-- method-anchor -->
    366               <h4>queryState</h4>
    367 
    368               <div class="summary"><span style="display: none; ">void</span>
    369                   <!-- Note: intentionally longer 80 columns -->
    370                   <span>chrome.idle.queryState</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
    371                       <var><span>thresholdSeconds</span></var></span><span class="null"><span>, </span><span>function</span>
    372                       <var><span>callback</span></var></span>)</div>
    373 
    374               <div class="description">
    375                 <p class="todo" style="display: none; ">Undocumented.</p>
    376                 <p>Returns the current state of the browser.</p>
    377 
    378                 <!-- PARAMETERS -->
    379                 <h4>Parameters</h4>
    380                 <dl>
    381                   <div>
    382                     <div>
    383           <dt>
    384             <var>thresholdSeconds</var>
    385               <em>
    386 
    387                 <!-- TYPE -->
    388                 <div style="display:inline">
    389                   (
    390                     <span class="optional" style="display: none; ">optional</span>
    391                     <span class="enum" style="display: none; ">enumerated</span>
    392                     <span id="typeTemplate">
    393                       <span style="display: none; ">
    394                         <a> Type</a>
    395                       </span>
    396                       <span>
    397                         <span style="display: none; ">
    398                           array of <span><span></span></span>
    399                         </span>
    400                         <span>integer</span>
    401                         <span style="display: none; "></span>
    402                       </span>
    403                     </span>
    404                   )
    405                 </div>
    406 
    407               </em>
    408           </dt>
    409           <dd class="todo" style="display: none; ">
    410             Undocumented.
    411           </dd>
    412           <dd>Threshold, in seconds, used to determine when a machine is in the idle state.</dd>
    413           <dd style="display: none; ">
    414             This parameter was added in version
    415             <b><span></span></b>.
    416             You must omit this parameter in earlier versions,
    417             and you may omit it in any version.  If you require this
    418             parameter, the manifest key
    419             <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
    420             can ensure that your extension won't be run in an earlier browser version.
    421           </dd>
    422 
    423           <!-- OBJECT PROPERTIES -->
    424           <dd style="display: none; ">
    425             <dl>
    426               <div>
    427                 <div>
    428                 </div>
    429               </div>
    430             </dl>
    431           </dd>
    432 
    433           <!-- OBJECT METHODS -->
    434           <dd style="display: none; ">
    435             <div></div>
    436           </dd>
    437 
    438           <!-- OBJECT EVENT FIELDS -->
    439           <dd style="display: none; ">
    440             <div></div>
    441           </dd>
    442 
    443           <!-- FUNCTION PARAMETERS -->
    444           <dd style="display: none; ">
    445             <div></div>
    446           </dd>
    447 
    448         </div>
    449                   </div><div>
    450                     <div>
    451           <dt>
    452             <var>callback</var>
    453               <em>
    454 
    455                 <!-- TYPE -->
    456                 <div style="display:inline">
    457                   (
    458                     <span class="optional" style="display: none; ">optional</span>
    459                     <span class="enum" style="display: none; ">enumerated</span>
    460                     <span id="typeTemplate">
    461                       <span style="display: none; ">
    462                         <a> Type</a>
    463                       </span>
    464                       <span>
    465                         <span style="display: none; ">
    466                           array of <span><span></span></span>
    467                         </span>
    468                         <span>function</span>
    469                         <span style="display: none; "></span>
    470                       </span>
    471                     </span>
    472                   )
    473                 </div>
    474 
    475               </em>
    476           </dt>
    477           <dd class="todo">
    478             Undocumented.
    479           </dd>
    480           <dd style="display: none; ">
    481             Description of this parameter from the json schema.
    482           </dd>
    483           <dd style="display: none; ">
    484             This parameter was added in version
    485             <b><span></span></b>.
    486             You must omit this parameter in earlier versions,
    487             and you may omit it in any version.  If you require this
    488             parameter, the manifest key
    489             <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
    490             can ensure that your extension won't be run in an earlier browser version.
    491           </dd>
    492 
    493           <!-- OBJECT PROPERTIES -->
    494           <dd style="display: none; ">
    495             <dl>
    496               <div>
    497                 <div>
    498                 </div>
    499               </div>
    500             </dl>
    501           </dd>
    502 
    503           <!-- OBJECT METHODS -->
    504           <dd style="display: none; ">
    505             <div></div>
    506           </dd>
    507 
    508           <!-- OBJECT EVENT FIELDS -->
    509           <dd style="display: none; ">
    510             <div></div>
    511           </dd>
    512 
    513           <!-- FUNCTION PARAMETERS -->
    514           <dd style="display: none; ">
    515             <div></div>
    516           </dd>
    517 
    518         </div>
    519                   </div>
    520                 </dl>
    521 
    522                 <!-- RETURNS -->
    523                 <h4 style="display: none; ">Returns</h4>
    524                 <dl>
    525                   <div style="display: none; ">
    526                     <div>
    527                     </div>
    528                   </div>
    529                 </dl>
    530 
    531                 <!-- CALLBACK -->
    532                 <div>
    533                   <div>
    534                   <h4>Callback function</h4>
    535                   <p>
    536                     The callback <em>parameter</em> should specify a function
    537                     that looks like this:
    538                   </p>
    539                   <p style="display: none; ">
    540                     If you specify the <em>callback</em> parameter, it should
    541                     specify a function that looks like this:
    542                   </p>
    543 
    544                   <!-- Note: intentionally longer 80 columns -->
    545                   <pre>function(<span>string newState</span>) <span class="subdued">{...}</span>;</pre>
    546                   <dl>
    547                     <div>
    548                       <div>
    549           <dt>
    550             <var>newState</var>
    551               <em>
    552 
    553                 <!-- TYPE -->
    554                 <div style="display:inline">
    555                   (
    556                     <span class="optional" style="display: none; ">optional</span>
    557                     <span class="enum">enumerated</span>
    558                     <span id="typeTemplate">
    559                       <span style="display: none; ">
    560                         <a> Type</a>
    561                       </span>
    562                       <span>
    563                         <span style="display: none; ">
    564                           array of <span><span></span></span>
    565                         </span>
    566                         <span>string</span>
    567                         <span>["active", "idle", "locked"]</span>
    568                       </span>
    569                     </span>
    570                   )
    571                 </div>
    572 
    573               </em>
    574           </dt>
    575           <dd class="todo">
    576             Undocumented.
    577           </dd>
    578           <dd style="display: none; ">
    579             Description of this parameter from the json schema.
    580           </dd>
    581           <dd style="display: none; ">
    582             This parameter was added in version
    583             <b><span></span></b>.
    584             You must omit this parameter in earlier versions,
    585             and you may omit it in any version.  If you require this
    586             parameter, the manifest key
    587             <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
    588             can ensure that your extension won't be run in an earlier browser version.
    589           </dd>
    590 
    591           <!-- OBJECT PROPERTIES -->
    592           <dd style="display: none; ">
    593             <dl>
    594               <div>
    595                 <div>
    596                 </div>
    597               </div>
    598             </dl>
    599           </dd>
    600 
    601           <!-- OBJECT METHODS -->
    602           <dd style="display: none; ">
    603             <div></div>
    604           </dd>
    605 
    606           <!-- OBJECT EVENT FIELDS -->
    607           <dd style="display: none; ">
    608             <div></div>
    609           </dd>
    610 
    611           <!-- FUNCTION PARAMETERS -->
    612           <dd style="display: none; ">
    613             <div></div>
    614           </dd>
    615 
    616         </div>
    617                     </div>
    618                   </dl>
    619                   </div>
    620                 </div>
    621 
    622                 <!-- MIN_VERSION -->
    623                 <p style="display: none; ">
    624                   This function was added in version <b><span></span></b>.
    625                   If you require this function, the manifest key
    626                   <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
    627                   can ensure that your extension won't be run in an earlier browser version.
    628                 </p>
    629               </div> <!-- /description -->
    630 
    631             </div>  <!-- /apiItem -->
    632 
    633           </div>  <!-- /apiGroup -->
    634 
    635           <!-- EVENTS -->
    636           <div id="eventsTemplate" class="apiGroup">
    637             <a name="global-events"></a>
    638             <h3>Events</h3>
    639             <!-- iterates over all events -->
    640             <div class="apiItem">
    641               <a name="event-onStateChanged"></a>
    642               <h4>onStateChanged</h4>
    643 
    644               <div class="summary">
    645                 <!-- Note: intentionally longer 80 columns -->
    646                 <span class="subdued">chrome.idle.</span><span>onStateChanged</span><span class="subdued">.addListener</span>(function(<span>string newState</span>) <span class="subdued">{...}</span>);
    647               </div>
    648 
    649               <div class="description">
    650                 <p class="todo" style="display: none; ">Undocumented.</p>
    651                 <p>Fired when the browser changes to an active state.  Currently only reports the transition from idle to active.</p>
    652 
    653                 <!-- PARAMETERS -->
    654                 <div>
    655                   <h4>Parameters</h4>
    656                   <dl>
    657                     <div>
    658                       <div>
    659           <dt>
    660             <var>newState</var>
    661               <em>
    662 
    663                 <!-- TYPE -->
    664                 <div style="display:inline">
    665                   (
    666                     <span class="optional" style="display: none; ">optional</span>
    667                     <span class="enum">enumerated</span>
    668                     <span id="typeTemplate">
    669                       <span style="display: none; ">
    670                         <a> Type</a>
    671                       </span>
    672                       <span>
    673                         <span style="display: none; ">
    674                           array of <span><span></span></span>
    675                         </span>
    676                         <span>string</span>
    677                         <span>["active"]</span>
    678                       </span>
    679                     </span>
    680                   )
    681                 </div>
    682 
    683               </em>
    684           </dt>
    685           <dd class="todo">
    686             Undocumented.
    687           </dd>
    688           <dd style="display: none; ">
    689             Description of this parameter from the json schema.
    690           </dd>
    691           <dd style="display: none; ">
    692             This parameter was added in version
    693             <b><span></span></b>.
    694             You must omit this parameter in earlier versions,
    695             and you may omit it in any version.  If you require this
    696             parameter, the manifest key
    697             <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
    698             can ensure that your extension won't be run in an earlier browser version.
    699           </dd>
    700 
    701           <!-- OBJECT PROPERTIES -->
    702           <dd style="display: none; ">
    703             <dl>
    704               <div>
    705                 <div>
    706                 </div>
    707               </div>
    708             </dl>
    709           </dd>
    710 
    711           <!-- OBJECT METHODS -->
    712           <dd style="display: none; ">
    713             <div></div>
    714           </dd>
    715 
    716           <!-- OBJECT EVENT FIELDS -->
    717           <dd style="display: none; ">
    718             <div></div>
    719           </dd>
    720 
    721           <!-- FUNCTION PARAMETERS -->
    722           <dd style="display: none; ">
    723             <div></div>
    724           </dd>
    725 
    726         </div>
    727                     </div>
    728                   </dl>
    729                 </div>
    730               </div> <!-- /decription -->
    731 
    732             </div> <!-- /apiItem -->
    733 
    734           </div> <!-- /apiGroup -->
    735 
    736           <!-- TYPES -->
    737           <div class="apiGroup" style="display: none; ">
    738             <a name="types"></a>
    739             <h3 id="types">Types</h3>
    740 
    741             <!-- iterates over all types -->
    742             <div class="apiItem">
    743               <a></a>
    744               <h4>type name</h4>
    745 
    746               <div>
    747               </div>
    748 
    749             </div> <!-- /apiItem -->
    750 
    751           </div> <!-- /apiGroup -->
    752 
    753         </div> <!-- /apiPage -->
    754       </div> <!-- /gc-pagecontent -->
    755     </div> <!-- /g-section -->
    756   </div> <!-- /codesiteContent -->
    757     <div id="gc-footer" --="">
    758       <div class="text">
    759   <p>
    760   Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
    761   the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
    762   Attribution 3.0 License</a>, and code samples are licensed under the
    763   <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
    764   </p>
    765   <p>
    766   2011 Google
    767   </p>
    768 
    769 <!-- begin analytics -->
    770 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
    771 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>
    772 
    773 <script type="text/javascript">
    774   // chrome doc tracking
    775   try {
    776     var engdocs = _gat._getTracker("YT-10763712-2");
    777     engdocs._trackPageview();
    778   } catch(err) {}
    779 
    780   // code.google.com site-wide tracking
    781   try {
    782     _uacct="UA-18071-1";
    783     _uanchor=1;
    784     _uff=0;
    785     urchinTracker();
    786   }
    787   catch(e) {/* urchinTracker not available. */}
    788 </script>
    789 <!-- end analytics -->
    790       </div>
    791     </div> <!-- /gc-footer -->
    792   </div> <!-- /gc-container -->
    793 </body></html>
    794