OLD | NEW |
(Empty) | |
| 1 <div id="devModeWarning" class="displayModeWarning"> |
| 2 You are viewing extension docs in chrome via the 'file:' scheme: are you exp
ecting to see local changes when you refresh? You'll need run chrome with --allo
w-file-access-from-files. |
| 3 </div> |
| 4 <div id="branchWarning" class="displayModeWarning"> |
| 5 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. |
| 6 It may not work with the stable release of Chrome.</span> |
| 7 <select id='branchChooser'> |
| 8 <option>Choose a different version... |
| 9 <option value="">Stable |
| 10 <option value="beta">Beta |
| 11 <option value="dev">Dev |
| 12 <option value="trunk">Trunk |
| 13 </select> |
| 14 </div> |
| 15 <div id="unofficialWarning" class="displayModeWarning"> |
| 16 <span>WARNING: This is unofficial documentation. It may not work with the |
| 17 current release of Chrome.</span> |
| 18 <button id="goToOfficialDocs">Go to the official docs</button> |
| 19 </div> |
| 20 <div id="gc-container" class="labs"> |
| 21 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> |
| 22 <!-- In particular, sub-templates that recurse, must be used by allowing |
| 23 jstemplate to make a copy of the template in this section which |
| 24 are not operated on by way of the jsskip="true" --> |
| 25 <div jsskip="true" style="display:none"> |
| 26 |
| 27 <!-- VALUE --> |
| 28 <div id="valueTemplate"> |
| 29 <dt> |
| 30 <var jsdisplay="$this.name" jscontent="$this.name">paramName</var> |
| 31 <em> |
| 32 |
| 33 <!-- TYPE --> |
| 34 <div style="display:inline"> |
| 35 ( |
| 36 <span class="optional" jsdisplay="optional">optional</span> |
| 37 <span class="enum" jsdisplay="$this.enum">enumerated</span> |
| 38 <span id="typeTemplate"> |
| 39 <code jsdisplay="hasPrimitiveValue($this)" jscontent="getP
rimitiveValue($this)">value</code> |
| 40 <span jsdisplay="!hasPrimitiveValue($this) && getTypeRef($
this)"> |
| 41 <a jsvalues=".href: getTypeRefPage($this) + '#type-' + g
etTypeRef($this)" |
| 42 jscontent="getTypeRef($this)"> Type</a> |
| 43 </span> |
| 44 <span jsdisplay="!hasPrimitiveValue($this) && !getTypeRef(
$this)"> |
| 45 <span jsdisplay="isArray($this)"> |
| 46 array of <span jsselect="items"><span transclude="type
Template"></span></span> |
| 47 </span> |
| 48 <span jsdisplay="!isArray($this)" jscontent="getTypeName
($this)">paramType</span> |
| 49 <span jsdisplay="!isArray($this) && $this.enum" jsconten
t="getEnumValues($this.enum, type);"></span> |
| 50 </span> |
| 51 </span> |
| 52 ) |
| 53 </div> |
| 54 |
| 55 </em> |
| 56 </dt> |
| 57 <dd class="todo" jsdisplay="!$this.description"> |
| 58 Undocumented. |
| 59 </dd> |
| 60 <dd jsdisplay="$this.description" |
| 61 jsvalues=".innerHTML:substituteTypeRefs($this.description)"> |
| 62 Description of this parameter from the json schema. |
| 63 </dd> |
| 64 <dd jsdisplay="$this.min_version"> |
| 65 This parameter was added in version |
| 66 <b><span jscontent="$this.min_version"></span></b>. |
| 67 You must omit this parameter in earlier versions, |
| 68 and you may omit it in any version. If you require this |
| 69 parameter, the manifest key |
| 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 71 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 72 </dd> |
| 73 |
| 74 <!-- OBJECT PROPERTIES --> |
| 75 <dd jsdisplay="shouldExpandObject($this)"> |
| 76 <dl> |
| 77 <div jsselect="getPropertyListFromObject($this)"> |
| 78 <div transclude="valueTemplate"> |
| 79 </div> |
| 80 </div> |
| 81 </dl> |
| 82 </dd> |
| 83 |
| 84 <!-- OBJECT METHODS --> |
| 85 <dd jsdisplay="$this.type === 'object' && |
| 86 filterDocumented($this.functions).length > 0" |
| 87 jsvalues="$scope:id"> |
| 88 <div transclude="methodsTemplate"></div> |
| 89 </dd> |
| 90 |
| 91 <!-- OBJECT EVENT FIELDS --> |
| 92 <dd jsdisplay="$this.type === 'object' && |
| 93 filterDocumented($this.events).length > 0" |
| 94 jsvalues="$scope:id"> |
| 95 <div transclude="eventsTemplate"></div> |
| 96 </dd> |
| 97 |
| 98 <!-- FUNCTION PARAMETERS --> |
| 99 <dd jsdisplay="isFunction($this) && $this.parameters && |
| 100 $this.name != 'callback'"> |
| 101 <div transclude="functionParametersTemplate"></div> |
| 102 </dd> |
| 103 |
| 104 </div> <!-- /VALUE --> |
| 105 |
| 106 <div id="conditionAndActionTemplate"> |
| 107 <dt> |
| 108 <a jsvalues=".href: typeModule[$this].namespace + '.html#type-' + $t
his" |
| 109 jscontent="$this">condition name</a> |
| 110 </dt> |
| 111 <dd class="todo" jsdisplay="!typeModule[$this].description"> |
| 112 Undocumented. |
| 113 </dd> |
| 114 <dd jsdisplay="getDescription($this)" |
| 115 jsvalues=".innerHTML:substituteTypeRefs(getDescription($this))"> |
| 116 Description of this parameter from the json schema. |
| 117 </dd> |
| 118 </div> |
| 119 |
| 120 <div id="functionParametersTemplate" jsdisplay="$this.parameters.length
> 0"> |
| 121 <h5>Parameters</h5> |
| 122 <dl> |
| 123 <div jsselect="$this.parameters"> |
| 124 <div transclude="valueTemplate"> |
| 125 </div> |
| 126 </div> |
| 127 </dl> |
| 128 </div> |
| 129 |
| 130 <!-- Individual subsections from the table of contents --> |
| 131 <ol> |
| 132 <li id="propertiesTocTemplate" jsdisplay="$this.properties"> |
| 133 <a href="#properties">Properties</a> |
| 134 <ol> |
| 135 <li jsselect="getPropertyListFromObject($this)"> |
| 136 <a jscontent="name" |
| 137 jsvalues=".href:'#property-' + name" |
| 138 href="#property-anchor">propertyName</a> |
| 139 </li> |
| 140 </ol> |
| 141 </li> |
| 142 <li id="methodsTocTemplate" jsdisplay="filterDocumented(functions).len
gth > 0"> |
| 143 <a jsvalues=".href:'#' + getAnchorName('global', 'methods', $type)">
Methods</a> |
| 144 <ol> |
| 145 <li jsselect="filterDocumented(functions).sort(sortByName)"> |
| 146 <a jscontent="name" |
| 147 jsvalues=".href:'#' + getAnchorName('method', name, $type)" |
| 148 href="#method-anchor">methodName</a> |
| 149 </li> |
| 150 </ol> |
| 151 </li> |
| 152 <li id="eventsTocTemplate" jsdisplay="filterDocumented(events).length
> 0"> |
| 153 <a jsvalues=".href:'#' + getAnchorName('global', 'events', $type)">E
vents</a> |
| 154 <ol> |
| 155 <li jsselect="filterDocumented(events).sort(sortByName)"> |
| 156 <a jscontent="name" |
| 157 jsvalues=".href:'#' + getAnchorName('event', name, $type)" |
| 158 href="#event-anchor">eventName</a> |
| 159 </li> |
| 160 </ol> |
| 161 </li> |
| 162 <li id="typesTocTemplate" jsdisplay="filterDocumented(types).length >
0"> |
| 163 <a href="#types">Types</a> |
| 164 <ol> |
| 165 <li jsselect="filterDocumented(types).sort(sortByName)"> |
| 166 <a jscontent="id" |
| 167 jsvalues=".href:'#type-' + id" |
| 168 href="#id-anchor">id</a> |
| 169 <ol jsvalues="$type:id"> |
| 170 <div transclude="methodsTocTemplate"></div> |
| 171 <div transclude="eventsTocTemplate"></div> |
| 172 </ol> |
| 173 </li> |
| 174 </ol> |
| 175 </li> |
| 176 </ol> |
| 177 </div> <!-- /SUBTEMPLATES --> |
| 178 |
| 179 <a id="top"></a> |
| 180 <div id="skipto"> |
| 181 <a href="#gc-pagecontent">Skip to page content</a> |
| 182 <a href="#gc-toc">Skip to main navigation</a> |
| 183 </div> |
| 184 <!-- API HEADER --> |
| 185 <table id="header" width="100%" cellspacing="0" border="0"> |
| 186 <tr> |
| 187 <td valign="middle" |
| 188 ><a href="http://code.google.com/"><img src="images/chrome_logo.gif" a
lt="Google Code" |
| 189 style="border:0; margin:0;" |
| 190 ></a></td> |
| 191 <td valign="middle" width="100%" style="padding-left:0.6em;"> |
| 192 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.
5em"> |
| 193 <div id="gsc-search-box"> |
| 194 <input type="hidden" name="cx" value="002967670403910741006:61_cvz
fqtno" /> |
| 195 <input type="hidden" name="ie" value="UTF-8" /> |
| 196 <input id="gsc-search-input" type="text" name="q" value="" size="5
5" /> |
| 197 <button class="gsc-search-button" type="submit" name="sa"> |
| 198 <img class="gsc-search-button-lens" src="images/search.png" alt=
"Search"> |
| 199 </button> |
| 200 <br> |
| 201 <span class="greytext">e.g. "page action" or "tabs"</span> |
| 202 </div> |
| 203 </form> |
| 204 |
| 205 <script type="text/javascript" src="https://www.google.com/jsapi"></sc
ript> |
| 206 <script type="text/javascript">google.load("elements", "1", {packages:
"transliteration"});</script> |
| 207 <script type="text/javascript" src="https://www.google.com/coop/cse/t1
3n?form=cse&t13n_langs=en"></script> |
| 208 <script type="text/javascript" src="https://www.google.com/coop/cse/br
and?form=cse&lang=en"></script> |
| 209 </td> |
| 210 </tr> |
| 211 </table> |
| 212 |
| 213 <div id="codesiteContent" jsvalues=".className: showSideNav() ? '' : 'hideSi
deNav'"> |
| 214 |
| 215 <a id="gc-topnav-anchor"></a> |
| 216 <div id="gc-topnav"> |
| 217 <h1>Packaged Apps</h1> |
| 218 <ul id="home" class="gc-topnav-tabs"> |
| 219 <li id="home_link"> |
| 220 <a href="app_landing.html" title="Packaged Apps home page">Home</a> |
| 221 </li> |
| 222 <li id="docs_link"> |
| 223 <a href="about_apps.html" title="Official Packaged apps documentatio
n">Docs</a> |
| 224 </li> |
| 225 <li id="samples_link"> |
| 226 <a href="app_samples.html" title="Sample apps (with source code)">Sa
mples</a> |
| 227 </li> |
| 228 <li id="group_link"> |
| 229 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte
nsions" title="Google Chrome Extensions developer forum">Group</a> |
| 230 </li> |
| 231 <li id="so_link"> |
| 232 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext
ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a> |
| 233 </li> |
| 234 </ul> |
| 235 </div> <!-- end gc-topnav --> |
| 236 |
| 237 <div class="g-section g-tpl-170"> |
| 238 <!-- SIDENAV --> |
| 239 <div class="g-unit g-first" id="gc-toc" jsdisplay="showSideNav()"> |
| 240 <ul> |
| 241 <li><h2>Getting Started</h2> |
| 242 <ul> |
| 243 <li><a href="about_apps.html">What Are Packaged Apps?</a></li> |
| 244 <li><a href="app_architecture.html">Understand the Architecture</a
></li> |
| 245 <li><a href="first_app.html">Create Your First App</a></li> |
| 246 </ul> |
| 247 </li> |
| 248 <li><h2>Developing</h2> |
| 249 <ul> |
| 250 <li><a href="develop_apps.html">Before You Start</a></li> |
| 251 <li>The Fundamentals |
| 252 <ul> |
| 253 <li><a href="app_lifecycle.html">Manage App Lifecycle</a></li> |
| 254 <li><a href="app_storage.html">Manage Data</a></li> |
| 255 <li><a href="offline_apps.html">Offline First</a></li> |
| 256 <li><a href="app_external.html">Embed Content</a></li> |
| 257 </ul> |
| 258 </li> |
| 259 <li>Security & Privacy |
| 260 <ul> |
| 261 <li><a href="app_security.html">About Security & Privacy</
a></li> |
| 262 <li><a href="app_identity.html">Identify User</a></li> |
| 263 <li><a href="app_permissions.html">Manage User Permissions</a>
</li> |
| 264 <li><a href="app_csp">Comply with CSP</a></li> |
| 265 </ul> |
| 266 </li> |
| 267 <li>Advanced Technologies |
| 268 <ul> |
| 269 <li><a href="app_network.html">Communicate across Network</a><
/li> |
| 270 <li><a href="app_hardware.html">Access Hardware Devices</a></l
i> |
| 271 <li><a href="app_intents.html">Connect Apps with Web Intents</
a></li> |
| 272 </ul> |
| 273 </li> |
| 274 <li><a href="app_frameworks.html">Recommended Frameworks</a></li> |
| 275 </ul> |
| 276 </li> |
| 277 <li><h2>Deploying</h2> |
| 278 <ul> |
| 279 <li><a href="publish_app.html">Publish</a></li> |
| 280 <li><a href="sell_app.html">Sell</a></li> |
| 281 </ul> |
| 282 </li> |
| 283 <li><h2>Reference</h2> |
| 284 <ul> |
| 285 <li><a href="manifest.html">Manifest Files</a></li> |
| 286 <li><a href="api_index.html">Chrome JavaScript APIs</a></li> |
| 287 <li><a href="experimental.html">Experimental APIs</a></li> |
| 288 <li><a href="api_other.html">Supported Libraries</a></li> |
| 289 <li><a href="app_deprecated.html">Disabled Web Features</a></li> |
| 290 </ul> |
| 291 </li> |
| 292 <li><h2><a href="app_samples.html">Samples</a></h2></li> |
| 293 </ul> |
| 294 </div> |
| 295 <script> |
| 296 initToggles(); |
| 297 </script> |
| 298 |
| 299 <div class="g-unit" id="gc-pagecontent"> |
| 300 <div id="pageTitle"> |
| 301 <h1 class="page_title" jscontent="getPageName()">chrome.apiname</h1> |
| 302 </div> |
| 303 <!-- TABLE OF CONTENTS --> |
| 304 <div id="toc" jsdisplay="showPageTOC()"> |
| 305 <h2>Contents</h2> |
| 306 <ol> |
| 307 <li jsselect="getStaticTOC()"> |
| 308 <a jscontent="name" |
| 309 jsvalues=".href:'#' + href">h2Name</a> |
| 310 <ol> |
| 311 <li jsselect="$this.children"> |
| 312 <a jscontent="name" |
| 313 jsvalues=".href:'#' + href">h3Name</a> |
| 314 </li> |
| 315 </ol> |
| 316 </li> |
| 317 <li jsselect="apiDefinition" jsvalues="$type:''"> |
| 318 <a href="#apiReference" jscontent="'API reference: ' + getModule
Name()">API reference</a> |
| 319 <ol> |
| 320 <div transclude="propertiesTocTemplate"></div> |
| 321 <div transclude="methodsTocTemplate"></div> |
| 322 <div transclude="eventsTocTemplate"></div> |
| 323 <div transclude="typesTocTemplate"></div> |
| 324 </ol> |
| 325 </li> |
| 326 </ol> |
| 327 </div> |
| 328 <!-- /TABLE OF CONTENTS --> |
| 329 |
| 330 <!-- Standard content lead-in for experimental API pages --> |
| 331 <p jsdisplay="isExperimentalAPIPage();" id="classSummary"> |
| 332 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. |
| 333 </p> |
| 334 |
| 335 <p jsdisplay="!isPermittedOnChannel('stable');" class="warning"> |
| 336 <!-- Standard content lead-in for APIs that are not yet available on |
| 337 the stable channel. --> |
| 338 <em>Warning:</em> This API is still under development. It is only |
| 339 available for Chrome users on the |
| 340 <span jsdisplay="isPermittedOnChannel('beta');"> |
| 341 <strong>dev</strong> and <strong>beta</strong> |
| 342 <a href="http://www.chromium.org/getting-involved/dev-channel">ear
ly |
| 343 release channels</a>.</span> |
| 344 <span jsdisplay="!isPermittedOnChannel('beta');"> |
| 345 <strong>dev</strong> |
| 346 <a href="http://www.chromium.org/getting-involved/dev-channel">ear
ly |
| 347 release channel</a>.</span> |
| 348 <a href="TODO">Learn more</a>. |
| 349 </p> |
| 350 |
| 351 <!-- STATIC CONTENT PLACEHOLDER --> |
| 352 <div id="static"></div> |
| 353 |
| 354 <!-- API PAGE --> |
| 355 <div class="apiPage" jsselect="apiDefinition" jsvalues="$scope:''"> |
| 356 <a name="apiReference"></a> |
| 357 <h2 jscontent="'API reference: ' + getModuleName()">API reference: chrom
e.apiname </h2> |
| 358 |
| 359 <!-- PROPERTIES --> |
| 360 <div jsdisplay="$this.properties" class="apiGroup"> |
| 361 <a name="properties"></a> |
| 362 <h3 id="properties">Properties</h3> |
| 363 |
| 364 <div jsselect="getPropertyListFromObject($this)"> |
| 365 <a jsvalues=".name:'property-' + name"></a> |
| 366 <h4 jscontent="name">getLastError</h4> |
| 367 <div class="summary"> |
| 368 <!-- Note: intentionally longer 80 columns --> |
| 369 <span jscontent="getModuleName() + '.'">chrome.extension</span><
span jscontent="$this.name">lastError</span> |
| 370 </div> |
| 371 <div transclude="valueTemplate"> |
| 372 </div> |
| 373 </div> |
| 374 |
| 375 </div> <!-- /apiGroup --> |
| 376 |
| 377 <!-- METHODS --> |
| 378 <div id="methodsTemplate" class="apiGroup" |
| 379 jsdisplay="filterDocumented($this.functions).length > 0"> |
| 380 <a jsvalues=".name:getAnchorName('global', 'methods', $scope)"></a> |
| 381 <h3 jscontent="$scope ? 'Methods of ' + $scope : 'Methods'">Methods<
/h3> |
| 382 |
| 383 <!-- iterates over all functions --> |
| 384 <div class="apiItem" jsselect="filterDocumented(functions).sort(sort
ByName)"> |
| 385 <a jsvalues=".name:getAnchorName('method', name, $scope)"></a> <!-
- method-anchor --> |
| 386 <h4 jscontent="name">method name</h4> |
| 387 |
| 388 <div class="summary"><span jsdisplay="returns" jscontent="getTypeN
ame(returns)">void</span> |
| 389 <!-- Note: intentionally longer 80 columns --> |
| 390 <span jscontent="getFullyQualifiedFunctionName($scope, $this)"
>chrome.module.methodName</span>(<span jsselect="filterDocumented(parameters)" j
svalues="class:optional ? 'optional' : ''"><span jsdisplay="$index">, </span><sp
an jscontent="getTypeName($this)"></span> |
| 391 <var><span jscontent="$this.name"></span></var></span>)</d
iv> |
| 392 |
| 393 <div class="description"> |
| 394 <p class="todo" jsdisplay="!description">Undocumented.</p> |
| 395 <p jsdisplay="description" jsvalues=".innerHTML:description"> |
| 396 A description from the json schema def of the function goes he
re. |
| 397 </p> |
| 398 |
| 399 <!-- PARAMETERS --> |
| 400 <h4 jsdisplay="$this.parameters && filterDocumented($this.parame
ters).length > 0">Parameters</h4> |
| 401 <dl> |
| 402 <div jsselect="filterDocumented(parameters)"> |
| 403 <div transclude="valueTemplate"> |
| 404 </div> |
| 405 </div> |
| 406 </dl> |
| 407 |
| 408 <!-- RETURNS --> |
| 409 <h4 jsdisplay="returns">Returns</h4> |
| 410 <dl> |
| 411 <div jsselect="returns"> |
| 412 <div transclude="valueTemplate"> |
| 413 </div> |
| 414 </div> |
| 415 </dl> |
| 416 |
| 417 <!-- CALLBACK --> |
| 418 <div jsdisplay="hasCallback(parameters)"> |
| 419 <div jsselect="getCallbackParameters(parameters)"> |
| 420 <h4>Callback function</h4> |
| 421 <p jsdisplay="!$this.optional"> |
| 422 The callback <em>parameter</em> should specify a function |
| 423 that looks like this: |
| 424 </p> |
| 425 <p jsdisplay="$this.optional"> |
| 426 If you specify the <em>callback</em> parameter, it should |
| 427 specify a function that looks like this: |
| 428 </p> |
| 429 |
| 430 <!-- Note: intentionally longer 80 columns --> |
| 431 <pre>function(<span jscontent="getSignatureString(parameters)"
>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> |
| 432 <dl> |
| 433 <div jsselect="parameters"> |
| 434 <div transclude="valueTemplate"> |
| 435 </div> |
| 436 </div> |
| 437 </dl> |
| 438 </div> |
| 439 </div> |
| 440 |
| 441 <!-- MIN_VERSION --> |
| 442 <p jsdisplay="min_version" > |
| 443 This function was added in version <b><span jscontent="$this.m
in_version"></span></b>. |
| 444 If you require this function, the manifest key |
| 445 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> |
| 446 can ensure that your extension won't be run in an earlier brow
ser version. |
| 447 </p> |
| 448 </div> <!-- /description --> |
| 449 |
| 450 </div> <!-- /apiItem --> |
| 451 |
| 452 </div> <!-- /apiGroup --> |
| 453 |
| 454 <!-- EVENTS --> |
| 455 <div id="eventsTemplate" class="apiGroup" |
| 456 jsdisplay="filterDocumented($this.events).length > 0"> |
| 457 <a jsvalues=".name:getAnchorName('global', 'events', $scope)"></a> |
| 458 <h3 jscontent="$scope ? 'Events of ' + $scope : 'Events'">Events</h3
> |
| 459 <!-- iterates over all events --> |
| 460 <div class="apiItem" jsselect="filterDocumented($this.events).sort(s
ortByName)"> |
| 461 <a jsvalues=".name:getAnchorName('event', name, $scope)"></a> |
| 462 <h4 jscontent="name">event name</h4> |
| 463 |
| 464 <div class="summary" jsdisplay="!($this.options && $this.options.s
upportsListeners === false)"> |
| 465 <!-- Note: intentionally longer 80 columns --> |
| 466 <span jscontent="(getObjectName($scope) || getModuleName()) + '.
'" class="subdued">chrome.bookmarks</span><span jscontent="name">onEvent</span><
span class="subdued">.addListener</span>(function(<span jscontent="getSignatureS
tring($this.parameters)">Type param1, Type param2</span>) <span class="subdued">
{...}</span><span jscontent="getOptionalSignatureSubstring($this.extraParameters
)">, Type opt_param1, Type opt_param2</span>); |
| 467 </div> |
| 468 |
| 469 <div class="description" jsdisplay="!($this.options && $this.optio
ns.supportsListeners === false)"> |
| 470 <p class="todo" jsdisplay="!description">Undocumented.</p> |
| 471 <p jsdisplay="description" jsvalues=".innerHTML:description"> |
| 472 A description from the json schema def of the event goes here. |
| 473 </p> |
| 474 |
| 475 <!-- LISTENER PARAMETERS --> |
| 476 <div jsdisplay="parameters && parameters.length > 0"> |
| 477 <h4>Listener parameters</h4> |
| 478 <dl> |
| 479 <div jsselect="parameters"> |
| 480 <div transclude="valueTemplate"> |
| 481 </div> |
| 482 </div> |
| 483 </dl> |
| 484 </div> |
| 485 |
| 486 <!-- EXTRA PARAMETERS --> |
| 487 <div jsdisplay="extraParameters && extraParameters.length > 0"> |
| 488 <h4>Extra parameters to addListener</h4> |
| 489 <dl> |
| 490 <div jsselect="extraParameters"> |
| 491 <div transclude="valueTemplate"> |
| 492 </div> |
| 493 </div> |
| 494 </dl> |
| 495 </div> |
| 496 |
| 497 <!-- LISTENER RETURN VALUE --> |
| 498 <h4 jsdisplay="returns">Listener returns</h4> |
| 499 <dl> |
| 500 <div jsselect="returns"> |
| 501 <div transclude="valueTemplate"> |
| 502 </div> |
| 503 </div> |
| 504 </dl> |
| 505 |
| 506 </div> <!-- /description --> |
| 507 |
| 508 <div class="summary" jsdisplay="$this.options && $this.options.sup
portsRules === true"> |
| 509 <span jscontent="(getObjectName($scope) || getModuleName()) + '.
'" class="subdued">chrome.bookmarks</span><span jscontent="name">onEvent</span><
span class="subdued">.addRules</span>(...); |
| 510 </div> |
| 511 |
| 512 <div class="description" jsdisplay="$this.options && $this.options
.supportsRules === true"> |
| 513 <p class="todo" jsdisplay="!description">Undocumented.</p> |
| 514 <p jsdisplay="description" jsvalues=".innerHTML:description"> |
| 515 A description from the json schema def of the event goes here. |
| 516 </p> |
| 517 |
| 518 <p>See <a href="declarative.html#method-addRules"><code>chrome.d
eclarative.addRules()</code></a>. |
| 519 </p> |
| 520 |
| 521 <!-- CONDITIONS --> |
| 522 <div jsdisplay="options && options.conditions && options.conditi
ons.length > 0"> |
| 523 <h4>Supported conditions</h4> |
| 524 <dl> |
| 525 <div jsselect="options.conditions"> |
| 526 <div transclude="conditionAndActionTemplate"> |
| 527 </div> |
| 528 </div> |
| 529 </dl> |
| 530 </div> <!-- /conditions --> |
| 531 |
| 532 <!-- ACTIONS --> |
| 533 <div jsdisplay="options && options.actions && options.actions.le
ngth > 0"> |
| 534 <h4>Supported actions</h4> |
| 535 <dl> |
| 536 <div jsselect="options.actions"> |
| 537 <div transclude="conditionAndActionTemplate"> |
| 538 </div> |
| 539 </div> |
| 540 </dl> |
| 541 </div> <!-- /actions --> |
| 542 </div> <!-- /description --> |
| 543 |
| 544 </div> <!-- /apiItem --> |
| 545 |
| 546 </div> <!-- /apiGroup --> |
| 547 |
| 548 <!-- TYPES --> |
| 549 <div jsdisplay="filterDocumented(types).length > 0" class="apiGroup"> |
| 550 <a name="types"></a> |
| 551 <h3 id="types">Types</h3> |
| 552 |
| 553 <!-- iterates over all types --> |
| 554 <div jsselect="filterDocumented(types).sort(sortByName)" class="apiI
tem"> |
| 555 <a jsvalues=".name:'type-' + id"></a> |
| 556 <h4 jscontent="id">type name</h4> |
| 557 |
| 558 <div transclude="valueTemplate"> |
| 559 </div> |
| 560 |
| 561 </div> <!-- /apiItem --> |
| 562 |
| 563 </div> <!-- /apiGroup --> |
| 564 |
| 565 </div> <!-- /apiPage --> |
| 566 </div> <!-- /gc-pagecontent --> |
| 567 </div> <!-- /g-section --> |
| 568 </div> <!-- /codesiteContent --> |
| 569 <div id="gc-footer" --> |
| 570 <div class="text"> |
| 571 <p> |
| 572 Except as otherwise <a |
| 573 href="http://code.google.com/policies.html#restrictions">noted</a>, |
| 574 the content of this page is licensed under the <a rel="license" |
| 575 href="http://creativecommons.org/licenses/by/3.0/">Creative Commons |
| 576 Attribution 3.0 License</a>, and code samples are licensed under the |
| 577 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. |
| 578 </p> |
| 579 <p> |
| 580 ©2011 Google |
| 581 </p> |
| 582 |
| 583 <!-- begin analytics --> |
| 584 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript">
</script> |
| 585 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc
ript> |
| 586 |
| 587 <script type="text/javascript"> |
| 588 // chrome doc tracking |
| 589 try { |
| 590 var engdocs = _gat._getTracker("YT-10763712-2"); |
| 591 engdocs._trackPageview(); |
| 592 } catch(err) {} |
| 593 |
| 594 // code.google.com site-wide tracking |
| 595 try { |
| 596 _uacct="UA-18071-1"; |
| 597 _uanchor=1; |
| 598 _uff=0; |
| 599 urchinTracker(); |
| 600 } |
| 601 catch(e) {/* urchinTracker not available. */} |
| 602 </script> |
| 603 <!-- end analytics --> |
| 604 </div> |
| 605 </div> <!-- /gc-footer --> |
| 606 </div> <!-- /gc-container --> |
OLD | NEW |