OLD | NEW |
(Empty) | |
| 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/jstempla
te_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.permissions - Google Chrome Extensions - Google Code</title></he
ad> |
| 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_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> |
| 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/c
ode_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_cvz
fqtno"> |
| 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="Se
arch"> |
| 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"></scr
ipt> |
| 134 <script type="text/javascript">google.load("elements", "1", {packages:
"transliteration"});</script> |
| 135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13
n?form=cse&t13n_langs=en"></script> |
| 136 <script type="text/javascript" src="http://www.google.com/coop/cse/bra
nd?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/">Lab
s</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 documen
tation">Docs</a> |
| 152 </li> |
| 153 <li id="faq_link"> |
| 154 <a href="faq.html" title="Answers to frequently asked questions abou
t 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-exte
nsions" 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 Option
s</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.htm
l">Chrome Web Store</a></li> |
| 242 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu
ide.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.permissions</h1> |
| 255 </div> |
| 256 <!-- TABLE OF CONTENTS --> |
| 257 <div id="toc"> |
| 258 <h2>Contents</h2> |
| 259 <ol> |
| 260 <li style="display: none; "> |
| 261 <a>h2Name</a> |
| 262 <ol> |
| 263 <li> |
| 264 <a>h3Name</a> |
| 265 </li> |
| 266 </ol> |
| 267 </li> |
| 268 <li> |
| 269 <a href="#apiReference">API reference: chrome.permissions</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-contains">contains</a> |
| 284 </li><li> |
| 285 <a href="#method-getAll">getAll</a> |
| 286 </li><li> |
| 287 <a href="#method-remove">remove</a> |
| 288 </li><li> |
| 289 <a href="#method-request">request</a> |
| 290 </li> |
| 291 </ol> |
| 292 </li> |
| 293 <li> |
| 294 <a href="#global-events">Events</a> |
| 295 <ol> |
| 296 <li> |
| 297 <a href="#event-onAdded">onAdded</a> |
| 298 </li><li> |
| 299 <a href="#event-onRemoved">onRemoved</a> |
| 300 </li> |
| 301 </ol> |
| 302 </li> |
| 303 <li> |
| 304 <a href="#types">Types</a> |
| 305 <ol> |
| 306 <li> |
| 307 <a href="#type-Permissions">Permissions</a> |
| 308 </li> |
| 309 </ol> |
| 310 </li> |
| 311 </ol> |
| 312 </li> |
| 313 </ol> |
| 314 </div> |
| 315 <!-- /TABLE OF CONTENTS --> |
| 316 |
| 317 <!-- Standard content lead-in for experimental API pages --> |
| 318 <p id="classSummary" style="display: none; "> |
| 319 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. |
| 320 </p> |
| 321 |
| 322 <!-- STATIC CONTENT PLACEHOLDER --> |
| 323 <div id="static"></div> |
| 324 |
| 325 <!-- API PAGE --> |
| 326 <div class="apiPage"> |
| 327 <a name="apiReference"></a> |
| 328 <h2>API reference: chrome.permissions</h2> |
| 329 |
| 330 <!-- PROPERTIES --> |
| 331 <div class="apiGroup" style="display: none; "> |
| 332 <a name="properties"></a> |
| 333 <h3 id="properties">Properties</h3> |
| 334 |
| 335 <div> |
| 336 <a></a> |
| 337 <h4>getLastError</h4> |
| 338 <div class="summary"> |
| 339 <!-- Note: intentionally longer 80 columns --> |
| 340 <span>chrome.extension</span><span>lastError</span> |
| 341 </div> |
| 342 <div> |
| 343 </div> |
| 344 </div> |
| 345 |
| 346 </div> <!-- /apiGroup --> |
| 347 |
| 348 <!-- METHODS --> |
| 349 <div id="methodsTemplate" class="apiGroup"> |
| 350 <a name="global-methods"></a> |
| 351 <h3>Methods</h3> |
| 352 |
| 353 <!-- iterates over all functions --> |
| 354 <div class="apiItem"> |
| 355 <a name="method-contains"></a> <!-- method-anchor --> |
| 356 <h4>contains</h4> |
| 357 |
| 358 <div class="summary"><span style="display: none; ">void</span> |
| 359 <!-- Note: intentionally longer 80 columns --> |
| 360 <span>chrome.permissions.contains</span>(<span class="null"><s
pan style="display: none; ">, </span><span>Permissions</span> |
| 361 <var><span>permissions</span></var></span><span class="nul
l"><span>, </span><span>function</span> |
| 362 <var><span>callback</span></var></span>)</div> |
| 363 |
| 364 <div class="description"> |
| 365 <p class="todo" style="display: none; ">Undocumented.</p> |
| 366 <p>Checks if the extension has the specified permissions.</p> |
| 367 |
| 368 <!-- PARAMETERS --> |
| 369 <h4>Parameters</h4> |
| 370 <dl> |
| 371 <div> |
| 372 <div> |
| 373 <dt> |
| 374 <var>permissions</var> |
| 375 <em> |
| 376 |
| 377 <!-- TYPE --> |
| 378 <div style="display:inline"> |
| 379 ( |
| 380 <span class="optional" style="display: none; ">optional</spa
n> |
| 381 <span class="enum" style="display: none; ">enumerated</span> |
| 382 <span id="typeTemplate"> |
| 383 <span> |
| 384 <a href="permissions.html#type-Permissions">Permissions<
/a> |
| 385 </span> |
| 386 <span style="display: none; "> |
| 387 <span> |
| 388 array of <span><span></span></span> |
| 389 </span> |
| 390 <span>paramType</span> |
| 391 <span></span> |
| 392 </span> |
| 393 </span> |
| 394 ) |
| 395 </div> |
| 396 |
| 397 </em> |
| 398 </dt> |
| 399 <dd class="todo"> |
| 400 Undocumented. |
| 401 </dd> |
| 402 <dd style="display: none; "> |
| 403 Description of this parameter from the json schema. |
| 404 </dd> |
| 405 <dd style="display: none; "> |
| 406 This parameter was added in version |
| 407 <b><span></span></b>. |
| 408 You must omit this parameter in earlier versions, |
| 409 and you may omit it in any version. If you require this |
| 410 parameter, the manifest key |
| 411 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 412 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 413 </dd> |
| 414 |
| 415 <!-- OBJECT PROPERTIES --> |
| 416 <dd style="display: none; "> |
| 417 <dl> |
| 418 <div> |
| 419 <div> |
| 420 </div> |
| 421 </div> |
| 422 </dl> |
| 423 </dd> |
| 424 |
| 425 <!-- OBJECT METHODS --> |
| 426 <dd style="display: none; "> |
| 427 <div></div> |
| 428 </dd> |
| 429 |
| 430 <!-- OBJECT EVENT FIELDS --> |
| 431 <dd style="display: none; "> |
| 432 <div></div> |
| 433 </dd> |
| 434 |
| 435 <!-- FUNCTION PARAMETERS --> |
| 436 <dd style="display: none; "> |
| 437 <div></div> |
| 438 </dd> |
| 439 |
| 440 </div> |
| 441 </div><div> |
| 442 <div> |
| 443 <dt> |
| 444 <var>callback</var> |
| 445 <em> |
| 446 |
| 447 <!-- TYPE --> |
| 448 <div style="display:inline"> |
| 449 ( |
| 450 <span class="optional" style="display: none; ">optional</spa
n> |
| 451 <span class="enum" style="display: none; ">enumerated</span> |
| 452 <span id="typeTemplate"> |
| 453 <span style="display: none; "> |
| 454 <a> Type</a> |
| 455 </span> |
| 456 <span> |
| 457 <span style="display: none; "> |
| 458 array of <span><span></span></span> |
| 459 </span> |
| 460 <span>function</span> |
| 461 <span style="display: none; "></span> |
| 462 </span> |
| 463 </span> |
| 464 ) |
| 465 </div> |
| 466 |
| 467 </em> |
| 468 </dt> |
| 469 <dd class="todo"> |
| 470 Undocumented. |
| 471 </dd> |
| 472 <dd style="display: none; "> |
| 473 Description of this parameter from the json schema. |
| 474 </dd> |
| 475 <dd style="display: none; "> |
| 476 This parameter was added in version |
| 477 <b><span></span></b>. |
| 478 You must omit this parameter in earlier versions, |
| 479 and you may omit it in any version. If you require this |
| 480 parameter, the manifest key |
| 481 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 482 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 483 </dd> |
| 484 |
| 485 <!-- OBJECT PROPERTIES --> |
| 486 <dd style="display: none; "> |
| 487 <dl> |
| 488 <div> |
| 489 <div> |
| 490 </div> |
| 491 </div> |
| 492 </dl> |
| 493 </dd> |
| 494 |
| 495 <!-- OBJECT METHODS --> |
| 496 <dd style="display: none; "> |
| 497 <div></div> |
| 498 </dd> |
| 499 |
| 500 <!-- OBJECT EVENT FIELDS --> |
| 501 <dd style="display: none; "> |
| 502 <div></div> |
| 503 </dd> |
| 504 |
| 505 <!-- FUNCTION PARAMETERS --> |
| 506 <dd style="display: none; "> |
| 507 <div></div> |
| 508 </dd> |
| 509 |
| 510 </div> |
| 511 </div> |
| 512 </dl> |
| 513 |
| 514 <!-- RETURNS --> |
| 515 <h4 style="display: none; ">Returns</h4> |
| 516 <dl> |
| 517 <div style="display: none; "> |
| 518 <div> |
| 519 </div> |
| 520 </div> |
| 521 </dl> |
| 522 |
| 523 <!-- CALLBACK --> |
| 524 <div> |
| 525 <div> |
| 526 <h4>Callback function</h4> |
| 527 <p> |
| 528 The callback <em>parameter</em> should specify a function |
| 529 that looks like this: |
| 530 </p> |
| 531 <p style="display: none; "> |
| 532 If you specify the <em>callback</em> parameter, it should |
| 533 specify a function that looks like this: |
| 534 </p> |
| 535 |
| 536 <!-- Note: intentionally longer 80 columns --> |
| 537 <pre>function(<span>boolean result</span>) <span class="subdue
d">{...}</span>;</pre> |
| 538 <dl> |
| 539 <div> |
| 540 <div> |
| 541 <dt> |
| 542 <var>result</var> |
| 543 <em> |
| 544 |
| 545 <!-- TYPE --> |
| 546 <div style="display:inline"> |
| 547 ( |
| 548 <span class="optional" style="display: none; ">optional</spa
n> |
| 549 <span class="enum" style="display: none; ">enumerated</span> |
| 550 <span id="typeTemplate"> |
| 551 <span style="display: none; "> |
| 552 <a> Type</a> |
| 553 </span> |
| 554 <span> |
| 555 <span style="display: none; "> |
| 556 array of <span><span></span></span> |
| 557 </span> |
| 558 <span>boolean</span> |
| 559 <span style="display: none; "></span> |
| 560 </span> |
| 561 </span> |
| 562 ) |
| 563 </div> |
| 564 |
| 565 </em> |
| 566 </dt> |
| 567 <dd class="todo" style="display: none; "> |
| 568 Undocumented. |
| 569 </dd> |
| 570 <dd>True if the extension has the specified permissions.</dd> |
| 571 <dd style="display: none; "> |
| 572 This parameter was added in version |
| 573 <b><span></span></b>. |
| 574 You must omit this parameter in earlier versions, |
| 575 and you may omit it in any version. If you require this |
| 576 parameter, the manifest key |
| 577 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 578 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 579 </dd> |
| 580 |
| 581 <!-- OBJECT PROPERTIES --> |
| 582 <dd style="display: none; "> |
| 583 <dl> |
| 584 <div> |
| 585 <div> |
| 586 </div> |
| 587 </div> |
| 588 </dl> |
| 589 </dd> |
| 590 |
| 591 <!-- OBJECT METHODS --> |
| 592 <dd style="display: none; "> |
| 593 <div></div> |
| 594 </dd> |
| 595 |
| 596 <!-- OBJECT EVENT FIELDS --> |
| 597 <dd style="display: none; "> |
| 598 <div></div> |
| 599 </dd> |
| 600 |
| 601 <!-- FUNCTION PARAMETERS --> |
| 602 <dd style="display: none; "> |
| 603 <div></div> |
| 604 </dd> |
| 605 |
| 606 </div> |
| 607 </div> |
| 608 </dl> |
| 609 </div> |
| 610 </div> |
| 611 |
| 612 <!-- MIN_VERSION --> |
| 613 <p style="display: none; "> |
| 614 This function was added in version <b><span></span></b>. |
| 615 If you require this function, the manifest key |
| 616 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> |
| 617 can ensure that your extension won't be run in an earlier brow
ser version. |
| 618 </p> |
| 619 </div> <!-- /description --> |
| 620 |
| 621 </div><div class="apiItem"> |
| 622 <a name="method-getAll"></a> <!-- method-anchor --> |
| 623 <h4>getAll</h4> |
| 624 |
| 625 <div class="summary"><span style="display: none; ">void</span> |
| 626 <!-- Note: intentionally longer 80 columns --> |
| 627 <span>chrome.permissions.getAll</span>(<span class="null"><spa
n style="display: none; ">, </span><span>function</span> |
| 628 <var><span>callback</span></var></span>)</div> |
| 629 |
| 630 <div class="description"> |
| 631 <p class="todo" style="display: none; ">Undocumented.</p> |
| 632 <p>Gets the extension's current set of permissions.</p> |
| 633 |
| 634 <!-- PARAMETERS --> |
| 635 <h4>Parameters</h4> |
| 636 <dl> |
| 637 <div> |
| 638 <div> |
| 639 <dt> |
| 640 <var>callback</var> |
| 641 <em> |
| 642 |
| 643 <!-- TYPE --> |
| 644 <div style="display:inline"> |
| 645 ( |
| 646 <span class="optional" style="display: none; ">optional</spa
n> |
| 647 <span class="enum" style="display: none; ">enumerated</span> |
| 648 <span id="typeTemplate"> |
| 649 <span style="display: none; "> |
| 650 <a> Type</a> |
| 651 </span> |
| 652 <span> |
| 653 <span style="display: none; "> |
| 654 array of <span><span></span></span> |
| 655 </span> |
| 656 <span>function</span> |
| 657 <span style="display: none; "></span> |
| 658 </span> |
| 659 </span> |
| 660 ) |
| 661 </div> |
| 662 |
| 663 </em> |
| 664 </dt> |
| 665 <dd class="todo"> |
| 666 Undocumented. |
| 667 </dd> |
| 668 <dd style="display: none; "> |
| 669 Description of this parameter from the json schema. |
| 670 </dd> |
| 671 <dd style="display: none; "> |
| 672 This parameter was added in version |
| 673 <b><span></span></b>. |
| 674 You must omit this parameter in earlier versions, |
| 675 and you may omit it in any version. If you require this |
| 676 parameter, the manifest key |
| 677 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 678 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 679 </dd> |
| 680 |
| 681 <!-- OBJECT PROPERTIES --> |
| 682 <dd style="display: none; "> |
| 683 <dl> |
| 684 <div> |
| 685 <div> |
| 686 </div> |
| 687 </div> |
| 688 </dl> |
| 689 </dd> |
| 690 |
| 691 <!-- OBJECT METHODS --> |
| 692 <dd style="display: none; "> |
| 693 <div></div> |
| 694 </dd> |
| 695 |
| 696 <!-- OBJECT EVENT FIELDS --> |
| 697 <dd style="display: none; "> |
| 698 <div></div> |
| 699 </dd> |
| 700 |
| 701 <!-- FUNCTION PARAMETERS --> |
| 702 <dd style="display: none; "> |
| 703 <div></div> |
| 704 </dd> |
| 705 |
| 706 </div> |
| 707 </div> |
| 708 </dl> |
| 709 |
| 710 <!-- RETURNS --> |
| 711 <h4 style="display: none; ">Returns</h4> |
| 712 <dl> |
| 713 <div style="display: none; "> |
| 714 <div> |
| 715 </div> |
| 716 </div> |
| 717 </dl> |
| 718 |
| 719 <!-- CALLBACK --> |
| 720 <div> |
| 721 <div> |
| 722 <h4>Callback function</h4> |
| 723 <p> |
| 724 The callback <em>parameter</em> should specify a function |
| 725 that looks like this: |
| 726 </p> |
| 727 <p style="display: none; "> |
| 728 If you specify the <em>callback</em> parameter, it should |
| 729 specify a function that looks like this: |
| 730 </p> |
| 731 |
| 732 <!-- Note: intentionally longer 80 columns --> |
| 733 <pre>function(<span>Permissions permissions</span>) <span clas
s="subdued">{...}</span>;</pre> |
| 734 <dl> |
| 735 <div> |
| 736 <div> |
| 737 <dt> |
| 738 <var>permissions</var> |
| 739 <em> |
| 740 |
| 741 <!-- TYPE --> |
| 742 <div style="display:inline"> |
| 743 ( |
| 744 <span class="optional" style="display: none; ">optional</spa
n> |
| 745 <span class="enum" style="display: none; ">enumerated</span> |
| 746 <span id="typeTemplate"> |
| 747 <span> |
| 748 <a href="permissions.html#type-Permissions">Permissions<
/a> |
| 749 </span> |
| 750 <span style="display: none; "> |
| 751 <span> |
| 752 array of <span><span></span></span> |
| 753 </span> |
| 754 <span>paramType</span> |
| 755 <span></span> |
| 756 </span> |
| 757 </span> |
| 758 ) |
| 759 </div> |
| 760 |
| 761 </em> |
| 762 </dt> |
| 763 <dd class="todo" style="display: none; "> |
| 764 Undocumented. |
| 765 </dd> |
| 766 <dd>The extension's active permissions.</dd> |
| 767 <dd style="display: none; "> |
| 768 This parameter was added in version |
| 769 <b><span></span></b>. |
| 770 You must omit this parameter in earlier versions, |
| 771 and you may omit it in any version. If you require this |
| 772 parameter, the manifest key |
| 773 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 774 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 775 </dd> |
| 776 |
| 777 <!-- OBJECT PROPERTIES --> |
| 778 <dd style="display: none; "> |
| 779 <dl> |
| 780 <div> |
| 781 <div> |
| 782 </div> |
| 783 </div> |
| 784 </dl> |
| 785 </dd> |
| 786 |
| 787 <!-- OBJECT METHODS --> |
| 788 <dd style="display: none; "> |
| 789 <div></div> |
| 790 </dd> |
| 791 |
| 792 <!-- OBJECT EVENT FIELDS --> |
| 793 <dd style="display: none; "> |
| 794 <div></div> |
| 795 </dd> |
| 796 |
| 797 <!-- FUNCTION PARAMETERS --> |
| 798 <dd style="display: none; "> |
| 799 <div></div> |
| 800 </dd> |
| 801 |
| 802 </div> |
| 803 </div> |
| 804 </dl> |
| 805 </div> |
| 806 </div> |
| 807 |
| 808 <!-- MIN_VERSION --> |
| 809 <p style="display: none; "> |
| 810 This function was added in version <b><span></span></b>. |
| 811 If you require this function, the manifest key |
| 812 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> |
| 813 can ensure that your extension won't be run in an earlier brow
ser version. |
| 814 </p> |
| 815 </div> <!-- /description --> |
| 816 |
| 817 </div><div class="apiItem"> |
| 818 <a name="method-remove"></a> <!-- method-anchor --> |
| 819 <h4>remove</h4> |
| 820 |
| 821 <div class="summary"><span style="display: none; ">void</span> |
| 822 <!-- Note: intentionally longer 80 columns --> |
| 823 <span>chrome.permissions.remove</span>(<span class="null"><spa
n style="display: none; ">, </span><span>object</span> |
| 824 <var><span>removeInfo</span></var></span><span class="opti
onal"><span>, </span><span>function</span> |
| 825 <var><span>callback</span></var></span>)</div> |
| 826 |
| 827 <div class="description"> |
| 828 <p class="todo" style="display: none; ">Undocumented.</p> |
| 829 <p>Removes access to the specified permissions.</p> |
| 830 |
| 831 <!-- PARAMETERS --> |
| 832 <h4>Parameters</h4> |
| 833 <dl> |
| 834 <div> |
| 835 <div> |
| 836 <dt> |
| 837 <var>removeInfo</var> |
| 838 <em> |
| 839 |
| 840 <!-- TYPE --> |
| 841 <div style="display:inline"> |
| 842 ( |
| 843 <span class="optional" style="display: none; ">optional</spa
n> |
| 844 <span class="enum" style="display: none; ">enumerated</span> |
| 845 <span id="typeTemplate"> |
| 846 <span style="display: none; "> |
| 847 <a> Type</a> |
| 848 </span> |
| 849 <span> |
| 850 <span style="display: none; "> |
| 851 array of <span><span></span></span> |
| 852 </span> |
| 853 <span>object</span> |
| 854 <span style="display: none; "></span> |
| 855 </span> |
| 856 </span> |
| 857 ) |
| 858 </div> |
| 859 |
| 860 </em> |
| 861 </dt> |
| 862 <dd class="todo"> |
| 863 Undocumented. |
| 864 </dd> |
| 865 <dd style="display: none; "> |
| 866 Description of this parameter from the json schema. |
| 867 </dd> |
| 868 <dd style="display: none; "> |
| 869 This parameter was added in version |
| 870 <b><span></span></b>. |
| 871 You must omit this parameter in earlier versions, |
| 872 and you may omit it in any version. If you require this |
| 873 parameter, the manifest key |
| 874 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 875 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 876 </dd> |
| 877 |
| 878 <!-- OBJECT PROPERTIES --> |
| 879 <dd> |
| 880 <dl> |
| 881 <div> |
| 882 <div> |
| 883 <dt> |
| 884 <var>apis</var> |
| 885 <em> |
| 886 |
| 887 <!-- TYPE --> |
| 888 <div style="display:inline"> |
| 889 ( |
| 890 <span class="optional">optional</span> |
| 891 <span class="enum" style="display: none; ">enumerated</span> |
| 892 <span id="typeTemplate"> |
| 893 <span style="display: none; "> |
| 894 <a> Type</a> |
| 895 </span> |
| 896 <span> |
| 897 <span> |
| 898 array of <span><span> |
| 899 <span style="display: none; "> |
| 900 <a> Type</a> |
| 901 </span> |
| 902 <span> |
| 903 <span style="display: none; "> |
| 904 array of <span><span></span></span> |
| 905 </span> |
| 906 <span>string</span> |
| 907 <span style="display: none; "></span> |
| 908 </span> |
| 909 </span></span> |
| 910 </span> |
| 911 <span style="display: none; ">paramType</span> |
| 912 <span style="display: none; "></span> |
| 913 </span> |
| 914 </span> |
| 915 ) |
| 916 </div> |
| 917 |
| 918 </em> |
| 919 </dt> |
| 920 <dd class="todo"> |
| 921 Undocumented. |
| 922 </dd> |
| 923 <dd style="display: none; "> |
| 924 Description of this parameter from the json schema. |
| 925 </dd> |
| 926 <dd style="display: none; "> |
| 927 This parameter was added in version |
| 928 <b><span></span></b>. |
| 929 You must omit this parameter in earlier versions, |
| 930 and you may omit it in any version. If you require this |
| 931 parameter, the manifest key |
| 932 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 933 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 934 </dd> |
| 935 |
| 936 <!-- OBJECT PROPERTIES --> |
| 937 <dd style="display: none; "> |
| 938 <dl> |
| 939 <div> |
| 940 <div> |
| 941 </div> |
| 942 </div> |
| 943 </dl> |
| 944 </dd> |
| 945 |
| 946 <!-- OBJECT METHODS --> |
| 947 <dd style="display: none; "> |
| 948 <div></div> |
| 949 </dd> |
| 950 |
| 951 <!-- OBJECT EVENT FIELDS --> |
| 952 <dd style="display: none; "> |
| 953 <div></div> |
| 954 </dd> |
| 955 |
| 956 <!-- FUNCTION PARAMETERS --> |
| 957 <dd style="display: none; "> |
| 958 <div></div> |
| 959 </dd> |
| 960 |
| 961 </div> |
| 962 </div> |
| 963 </dl> |
| 964 </dd> |
| 965 |
| 966 <!-- OBJECT METHODS --> |
| 967 <dd style="display: none; "> |
| 968 <div></div> |
| 969 </dd> |
| 970 |
| 971 <!-- OBJECT EVENT FIELDS --> |
| 972 <dd style="display: none; "> |
| 973 <div></div> |
| 974 </dd> |
| 975 |
| 976 <!-- FUNCTION PARAMETERS --> |
| 977 <dd style="display: none; "> |
| 978 <div></div> |
| 979 </dd> |
| 980 |
| 981 </div> |
| 982 </div><div> |
| 983 <div> |
| 984 <dt> |
| 985 <var>callback</var> |
| 986 <em> |
| 987 |
| 988 <!-- TYPE --> |
| 989 <div style="display:inline"> |
| 990 ( |
| 991 <span class="optional">optional</span> |
| 992 <span class="enum" style="display: none; ">enumerated</span> |
| 993 <span id="typeTemplate"> |
| 994 <span style="display: none; "> |
| 995 <a> Type</a> |
| 996 </span> |
| 997 <span> |
| 998 <span style="display: none; "> |
| 999 array of <span><span></span></span> |
| 1000 </span> |
| 1001 <span>function</span> |
| 1002 <span style="display: none; "></span> |
| 1003 </span> |
| 1004 </span> |
| 1005 ) |
| 1006 </div> |
| 1007 |
| 1008 </em> |
| 1009 </dt> |
| 1010 <dd class="todo"> |
| 1011 Undocumented. |
| 1012 </dd> |
| 1013 <dd style="display: none; "> |
| 1014 Description of this parameter from the json schema. |
| 1015 </dd> |
| 1016 <dd style="display: none; "> |
| 1017 This parameter was added in version |
| 1018 <b><span></span></b>. |
| 1019 You must omit this parameter in earlier versions, |
| 1020 and you may omit it in any version. If you require this |
| 1021 parameter, the manifest key |
| 1022 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1023 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1024 </dd> |
| 1025 |
| 1026 <!-- OBJECT PROPERTIES --> |
| 1027 <dd style="display: none; "> |
| 1028 <dl> |
| 1029 <div> |
| 1030 <div> |
| 1031 </div> |
| 1032 </div> |
| 1033 </dl> |
| 1034 </dd> |
| 1035 |
| 1036 <!-- OBJECT METHODS --> |
| 1037 <dd style="display: none; "> |
| 1038 <div></div> |
| 1039 </dd> |
| 1040 |
| 1041 <!-- OBJECT EVENT FIELDS --> |
| 1042 <dd style="display: none; "> |
| 1043 <div></div> |
| 1044 </dd> |
| 1045 |
| 1046 <!-- FUNCTION PARAMETERS --> |
| 1047 <dd style="display: none; "> |
| 1048 <div></div> |
| 1049 </dd> |
| 1050 |
| 1051 </div> |
| 1052 </div> |
| 1053 </dl> |
| 1054 |
| 1055 <!-- RETURNS --> |
| 1056 <h4 style="display: none; ">Returns</h4> |
| 1057 <dl> |
| 1058 <div style="display: none; "> |
| 1059 <div> |
| 1060 </div> |
| 1061 </div> |
| 1062 </dl> |
| 1063 |
| 1064 <!-- CALLBACK --> |
| 1065 <div> |
| 1066 <div> |
| 1067 <h4>Callback function</h4> |
| 1068 <p style="display: none; "> |
| 1069 The callback <em>parameter</em> should specify a function |
| 1070 that looks like this: |
| 1071 </p> |
| 1072 <p> |
| 1073 If you specify the <em>callback</em> parameter, it should |
| 1074 specify a function that looks like this: |
| 1075 </p> |
| 1076 |
| 1077 <!-- Note: intentionally longer 80 columns --> |
| 1078 <pre>function(<span>boolean removed</span>) <span class="subdu
ed">{...}</span>;</pre> |
| 1079 <dl> |
| 1080 <div> |
| 1081 <div> |
| 1082 <dt> |
| 1083 <var>removed</var> |
| 1084 <em> |
| 1085 |
| 1086 <!-- TYPE --> |
| 1087 <div style="display:inline"> |
| 1088 ( |
| 1089 <span class="optional" style="display: none; ">optional</spa
n> |
| 1090 <span class="enum" style="display: none; ">enumerated</span> |
| 1091 <span id="typeTemplate"> |
| 1092 <span style="display: none; "> |
| 1093 <a> Type</a> |
| 1094 </span> |
| 1095 <span> |
| 1096 <span style="display: none; "> |
| 1097 array of <span><span></span></span> |
| 1098 </span> |
| 1099 <span>boolean</span> |
| 1100 <span style="display: none; "></span> |
| 1101 </span> |
| 1102 </span> |
| 1103 ) |
| 1104 </div> |
| 1105 |
| 1106 </em> |
| 1107 </dt> |
| 1108 <dd class="todo" style="display: none; "> |
| 1109 Undocumented. |
| 1110 </dd> |
| 1111 <dd>True if the permissions were removed.</dd> |
| 1112 <dd style="display: none; "> |
| 1113 This parameter was added in version |
| 1114 <b><span></span></b>. |
| 1115 You must omit this parameter in earlier versions, |
| 1116 and you may omit it in any version. If you require this |
| 1117 parameter, the manifest key |
| 1118 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1119 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1120 </dd> |
| 1121 |
| 1122 <!-- OBJECT PROPERTIES --> |
| 1123 <dd style="display: none; "> |
| 1124 <dl> |
| 1125 <div> |
| 1126 <div> |
| 1127 </div> |
| 1128 </div> |
| 1129 </dl> |
| 1130 </dd> |
| 1131 |
| 1132 <!-- OBJECT METHODS --> |
| 1133 <dd style="display: none; "> |
| 1134 <div></div> |
| 1135 </dd> |
| 1136 |
| 1137 <!-- OBJECT EVENT FIELDS --> |
| 1138 <dd style="display: none; "> |
| 1139 <div></div> |
| 1140 </dd> |
| 1141 |
| 1142 <!-- FUNCTION PARAMETERS --> |
| 1143 <dd style="display: none; "> |
| 1144 <div></div> |
| 1145 </dd> |
| 1146 |
| 1147 </div> |
| 1148 </div> |
| 1149 </dl> |
| 1150 </div> |
| 1151 </div> |
| 1152 |
| 1153 <!-- MIN_VERSION --> |
| 1154 <p style="display: none; "> |
| 1155 This function was added in version <b><span></span></b>. |
| 1156 If you require this function, the manifest key |
| 1157 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> |
| 1158 can ensure that your extension won't be run in an earlier brow
ser version. |
| 1159 </p> |
| 1160 </div> <!-- /description --> |
| 1161 |
| 1162 </div><div class="apiItem"> |
| 1163 <a name="method-request"></a> <!-- method-anchor --> |
| 1164 <h4>request</h4> |
| 1165 |
| 1166 <div class="summary"><span style="display: none; ">void</span> |
| 1167 <!-- Note: intentionally longer 80 columns --> |
| 1168 <span>chrome.permissions.request</span>(<span class="null"><sp
an style="display: none; ">, </span><span>object</span> |
| 1169 <var><span>requestInfo</span></var></span><span class="opt
ional"><span>, </span><span>function</span> |
| 1170 <var><span>callback</span></var></span>)</div> |
| 1171 |
| 1172 <div class="description"> |
| 1173 <p class="todo" style="display: none; ">Undocumented.</p> |
| 1174 <p>Requests access to the specified permissions.</p> |
| 1175 |
| 1176 <!-- PARAMETERS --> |
| 1177 <h4>Parameters</h4> |
| 1178 <dl> |
| 1179 <div> |
| 1180 <div> |
| 1181 <dt> |
| 1182 <var>requestInfo</var> |
| 1183 <em> |
| 1184 |
| 1185 <!-- TYPE --> |
| 1186 <div style="display:inline"> |
| 1187 ( |
| 1188 <span class="optional" style="display: none; ">optional</spa
n> |
| 1189 <span class="enum" style="display: none; ">enumerated</span> |
| 1190 <span id="typeTemplate"> |
| 1191 <span style="display: none; "> |
| 1192 <a> Type</a> |
| 1193 </span> |
| 1194 <span> |
| 1195 <span style="display: none; "> |
| 1196 array of <span><span></span></span> |
| 1197 </span> |
| 1198 <span>object</span> |
| 1199 <span style="display: none; "></span> |
| 1200 </span> |
| 1201 </span> |
| 1202 ) |
| 1203 </div> |
| 1204 |
| 1205 </em> |
| 1206 </dt> |
| 1207 <dd class="todo"> |
| 1208 Undocumented. |
| 1209 </dd> |
| 1210 <dd style="display: none; "> |
| 1211 Description of this parameter from the json schema. |
| 1212 </dd> |
| 1213 <dd style="display: none; "> |
| 1214 This parameter was added in version |
| 1215 <b><span></span></b>. |
| 1216 You must omit this parameter in earlier versions, |
| 1217 and you may omit it in any version. If you require this |
| 1218 parameter, the manifest key |
| 1219 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1220 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1221 </dd> |
| 1222 |
| 1223 <!-- OBJECT PROPERTIES --> |
| 1224 <dd> |
| 1225 <dl> |
| 1226 <div> |
| 1227 <div> |
| 1228 <dt> |
| 1229 <var>apis</var> |
| 1230 <em> |
| 1231 |
| 1232 <!-- TYPE --> |
| 1233 <div style="display:inline"> |
| 1234 ( |
| 1235 <span class="optional">optional</span> |
| 1236 <span class="enum" style="display: none; ">enumerated</span> |
| 1237 <span id="typeTemplate"> |
| 1238 <span style="display: none; "> |
| 1239 <a> Type</a> |
| 1240 </span> |
| 1241 <span> |
| 1242 <span> |
| 1243 array of <span><span> |
| 1244 <span style="display: none; "> |
| 1245 <a> Type</a> |
| 1246 </span> |
| 1247 <span> |
| 1248 <span style="display: none; "> |
| 1249 array of <span><span></span></span> |
| 1250 </span> |
| 1251 <span>string</span> |
| 1252 <span style="display: none; "></span> |
| 1253 </span> |
| 1254 </span></span> |
| 1255 </span> |
| 1256 <span style="display: none; ">paramType</span> |
| 1257 <span style="display: none; "></span> |
| 1258 </span> |
| 1259 </span> |
| 1260 ) |
| 1261 </div> |
| 1262 |
| 1263 </em> |
| 1264 </dt> |
| 1265 <dd class="todo"> |
| 1266 Undocumented. |
| 1267 </dd> |
| 1268 <dd style="display: none; "> |
| 1269 Description of this parameter from the json schema. |
| 1270 </dd> |
| 1271 <dd style="display: none; "> |
| 1272 This parameter was added in version |
| 1273 <b><span></span></b>. |
| 1274 You must omit this parameter in earlier versions, |
| 1275 and you may omit it in any version. If you require this |
| 1276 parameter, the manifest key |
| 1277 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1278 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1279 </dd> |
| 1280 |
| 1281 <!-- OBJECT PROPERTIES --> |
| 1282 <dd style="display: none; "> |
| 1283 <dl> |
| 1284 <div> |
| 1285 <div> |
| 1286 </div> |
| 1287 </div> |
| 1288 </dl> |
| 1289 </dd> |
| 1290 |
| 1291 <!-- OBJECT METHODS --> |
| 1292 <dd style="display: none; "> |
| 1293 <div></div> |
| 1294 </dd> |
| 1295 |
| 1296 <!-- OBJECT EVENT FIELDS --> |
| 1297 <dd style="display: none; "> |
| 1298 <div></div> |
| 1299 </dd> |
| 1300 |
| 1301 <!-- FUNCTION PARAMETERS --> |
| 1302 <dd style="display: none; "> |
| 1303 <div></div> |
| 1304 </dd> |
| 1305 |
| 1306 </div> |
| 1307 </div> |
| 1308 </dl> |
| 1309 </dd> |
| 1310 |
| 1311 <!-- OBJECT METHODS --> |
| 1312 <dd style="display: none; "> |
| 1313 <div></div> |
| 1314 </dd> |
| 1315 |
| 1316 <!-- OBJECT EVENT FIELDS --> |
| 1317 <dd style="display: none; "> |
| 1318 <div></div> |
| 1319 </dd> |
| 1320 |
| 1321 <!-- FUNCTION PARAMETERS --> |
| 1322 <dd style="display: none; "> |
| 1323 <div></div> |
| 1324 </dd> |
| 1325 |
| 1326 </div> |
| 1327 </div><div> |
| 1328 <div> |
| 1329 <dt> |
| 1330 <var>callback</var> |
| 1331 <em> |
| 1332 |
| 1333 <!-- TYPE --> |
| 1334 <div style="display:inline"> |
| 1335 ( |
| 1336 <span class="optional">optional</span> |
| 1337 <span class="enum" style="display: none; ">enumerated</span> |
| 1338 <span id="typeTemplate"> |
| 1339 <span style="display: none; "> |
| 1340 <a> Type</a> |
| 1341 </span> |
| 1342 <span> |
| 1343 <span style="display: none; "> |
| 1344 array of <span><span></span></span> |
| 1345 </span> |
| 1346 <span>function</span> |
| 1347 <span style="display: none; "></span> |
| 1348 </span> |
| 1349 </span> |
| 1350 ) |
| 1351 </div> |
| 1352 |
| 1353 </em> |
| 1354 </dt> |
| 1355 <dd class="todo"> |
| 1356 Undocumented. |
| 1357 </dd> |
| 1358 <dd style="display: none; "> |
| 1359 Description of this parameter from the json schema. |
| 1360 </dd> |
| 1361 <dd style="display: none; "> |
| 1362 This parameter was added in version |
| 1363 <b><span></span></b>. |
| 1364 You must omit this parameter in earlier versions, |
| 1365 and you may omit it in any version. If you require this |
| 1366 parameter, the manifest key |
| 1367 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1368 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1369 </dd> |
| 1370 |
| 1371 <!-- OBJECT PROPERTIES --> |
| 1372 <dd style="display: none; "> |
| 1373 <dl> |
| 1374 <div> |
| 1375 <div> |
| 1376 </div> |
| 1377 </div> |
| 1378 </dl> |
| 1379 </dd> |
| 1380 |
| 1381 <!-- OBJECT METHODS --> |
| 1382 <dd style="display: none; "> |
| 1383 <div></div> |
| 1384 </dd> |
| 1385 |
| 1386 <!-- OBJECT EVENT FIELDS --> |
| 1387 <dd style="display: none; "> |
| 1388 <div></div> |
| 1389 </dd> |
| 1390 |
| 1391 <!-- FUNCTION PARAMETERS --> |
| 1392 <dd style="display: none; "> |
| 1393 <div></div> |
| 1394 </dd> |
| 1395 |
| 1396 </div> |
| 1397 </div> |
| 1398 </dl> |
| 1399 |
| 1400 <!-- RETURNS --> |
| 1401 <h4 style="display: none; ">Returns</h4> |
| 1402 <dl> |
| 1403 <div style="display: none; "> |
| 1404 <div> |
| 1405 </div> |
| 1406 </div> |
| 1407 </dl> |
| 1408 |
| 1409 <!-- CALLBACK --> |
| 1410 <div> |
| 1411 <div> |
| 1412 <h4>Callback function</h4> |
| 1413 <p style="display: none; "> |
| 1414 The callback <em>parameter</em> should specify a function |
| 1415 that looks like this: |
| 1416 </p> |
| 1417 <p> |
| 1418 If you specify the <em>callback</em> parameter, it should |
| 1419 specify a function that looks like this: |
| 1420 </p> |
| 1421 |
| 1422 <!-- Note: intentionally longer 80 columns --> |
| 1423 <pre>function(<span>boolean granted</span>) <span class="subdu
ed">{...}</span>;</pre> |
| 1424 <dl> |
| 1425 <div> |
| 1426 <div> |
| 1427 <dt> |
| 1428 <var>granted</var> |
| 1429 <em> |
| 1430 |
| 1431 <!-- TYPE --> |
| 1432 <div style="display:inline"> |
| 1433 ( |
| 1434 <span class="optional" style="display: none; ">optional</spa
n> |
| 1435 <span class="enum" style="display: none; ">enumerated</span> |
| 1436 <span id="typeTemplate"> |
| 1437 <span style="display: none; "> |
| 1438 <a> Type</a> |
| 1439 </span> |
| 1440 <span> |
| 1441 <span style="display: none; "> |
| 1442 array of <span><span></span></span> |
| 1443 </span> |
| 1444 <span>boolean</span> |
| 1445 <span style="display: none; "></span> |
| 1446 </span> |
| 1447 </span> |
| 1448 ) |
| 1449 </div> |
| 1450 |
| 1451 </em> |
| 1452 </dt> |
| 1453 <dd class="todo" style="display: none; "> |
| 1454 Undocumented. |
| 1455 </dd> |
| 1456 <dd>True if the user granted the specified permissions.</dd> |
| 1457 <dd style="display: none; "> |
| 1458 This parameter was added in version |
| 1459 <b><span></span></b>. |
| 1460 You must omit this parameter in earlier versions, |
| 1461 and you may omit it in any version. If you require this |
| 1462 parameter, the manifest key |
| 1463 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1464 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1465 </dd> |
| 1466 |
| 1467 <!-- OBJECT PROPERTIES --> |
| 1468 <dd style="display: none; "> |
| 1469 <dl> |
| 1470 <div> |
| 1471 <div> |
| 1472 </div> |
| 1473 </div> |
| 1474 </dl> |
| 1475 </dd> |
| 1476 |
| 1477 <!-- OBJECT METHODS --> |
| 1478 <dd style="display: none; "> |
| 1479 <div></div> |
| 1480 </dd> |
| 1481 |
| 1482 <!-- OBJECT EVENT FIELDS --> |
| 1483 <dd style="display: none; "> |
| 1484 <div></div> |
| 1485 </dd> |
| 1486 |
| 1487 <!-- FUNCTION PARAMETERS --> |
| 1488 <dd style="display: none; "> |
| 1489 <div></div> |
| 1490 </dd> |
| 1491 |
| 1492 </div> |
| 1493 </div> |
| 1494 </dl> |
| 1495 </div> |
| 1496 </div> |
| 1497 |
| 1498 <!-- MIN_VERSION --> |
| 1499 <p style="display: none; "> |
| 1500 This function was added in version <b><span></span></b>. |
| 1501 If you require this function, the manifest key |
| 1502 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> |
| 1503 can ensure that your extension won't be run in an earlier brow
ser version. |
| 1504 </p> |
| 1505 </div> <!-- /description --> |
| 1506 |
| 1507 </div> <!-- /apiItem --> |
| 1508 |
| 1509 </div> <!-- /apiGroup --> |
| 1510 |
| 1511 <!-- EVENTS --> |
| 1512 <div id="eventsTemplate" class="apiGroup"> |
| 1513 <a name="global-events"></a> |
| 1514 <h3>Events</h3> |
| 1515 <!-- iterates over all events --> |
| 1516 <div class="apiItem"> |
| 1517 <a name="event-onAdded"></a> |
| 1518 <h4>onAdded</h4> |
| 1519 |
| 1520 <div class="summary"> |
| 1521 <!-- Note: intentionally longer 80 columns --> |
| 1522 <span class="subdued">chrome.permissions.</span><span>onAdded</s
pan><span class="subdued">.addListener</span>(function(<span>Permissions permiss
ions</span>) <span class="subdued">{...}</span><span></span>)); |
| 1523 </div> |
| 1524 |
| 1525 <div class="description"> |
| 1526 <p class="todo" style="display: none; ">Undocumented.</p> |
| 1527 <p>Fired when the extension acquires new permissions.</p> |
| 1528 |
| 1529 <!-- LISTENER PARAMETERS --> |
| 1530 <div> |
| 1531 <h4>Listener parameters</h4> |
| 1532 <dl> |
| 1533 <div> |
| 1534 <div> |
| 1535 <dt> |
| 1536 <var>permissions</var> |
| 1537 <em> |
| 1538 |
| 1539 <!-- TYPE --> |
| 1540 <div style="display:inline"> |
| 1541 ( |
| 1542 <span class="optional" style="display: none; ">optional</spa
n> |
| 1543 <span class="enum" style="display: none; ">enumerated</span> |
| 1544 <span id="typeTemplate"> |
| 1545 <span> |
| 1546 <a href="permissions.html#type-Permissions">Permissions<
/a> |
| 1547 </span> |
| 1548 <span style="display: none; "> |
| 1549 <span> |
| 1550 array of <span><span></span></span> |
| 1551 </span> |
| 1552 <span>paramType</span> |
| 1553 <span></span> |
| 1554 </span> |
| 1555 </span> |
| 1556 ) |
| 1557 </div> |
| 1558 |
| 1559 </em> |
| 1560 </dt> |
| 1561 <dd class="todo" style="display: none; "> |
| 1562 Undocumented. |
| 1563 </dd> |
| 1564 <dd>The newly acquired permissions.</dd> |
| 1565 <dd style="display: none; "> |
| 1566 This parameter was added in version |
| 1567 <b><span></span></b>. |
| 1568 You must omit this parameter in earlier versions, |
| 1569 and you may omit it in any version. If you require this |
| 1570 parameter, the manifest key |
| 1571 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1572 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1573 </dd> |
| 1574 |
| 1575 <!-- OBJECT PROPERTIES --> |
| 1576 <dd style="display: none; "> |
| 1577 <dl> |
| 1578 <div> |
| 1579 <div> |
| 1580 </div> |
| 1581 </div> |
| 1582 </dl> |
| 1583 </dd> |
| 1584 |
| 1585 <!-- OBJECT METHODS --> |
| 1586 <dd style="display: none; "> |
| 1587 <div></div> |
| 1588 </dd> |
| 1589 |
| 1590 <!-- OBJECT EVENT FIELDS --> |
| 1591 <dd style="display: none; "> |
| 1592 <div></div> |
| 1593 </dd> |
| 1594 |
| 1595 <!-- FUNCTION PARAMETERS --> |
| 1596 <dd style="display: none; "> |
| 1597 <div></div> |
| 1598 </dd> |
| 1599 |
| 1600 </div> |
| 1601 </div> |
| 1602 </dl> |
| 1603 </div> |
| 1604 |
| 1605 <!-- EXTRA PARAMETERS --> |
| 1606 <div style="display: none; "> |
| 1607 <h4>Extra parameters to addListener</h4> |
| 1608 <dl> |
| 1609 <div> |
| 1610 <div> |
| 1611 </div> |
| 1612 </div> |
| 1613 </dl> |
| 1614 </div> |
| 1615 |
| 1616 <!-- LISTENER RETURN VALUE --> |
| 1617 <h4 style="display: none; ">Listener returns</h4> |
| 1618 <dl> |
| 1619 <div style="display: none; "> |
| 1620 <div> |
| 1621 </div> |
| 1622 </div> |
| 1623 </dl> |
| 1624 |
| 1625 </div> <!-- /description --> |
| 1626 </div><div class="apiItem"> |
| 1627 <a name="event-onRemoved"></a> |
| 1628 <h4>onRemoved</h4> |
| 1629 |
| 1630 <div class="summary"> |
| 1631 <!-- Note: intentionally longer 80 columns --> |
| 1632 <span class="subdued">chrome.permissions.</span><span>onRemoved<
/span><span class="subdued">.addListener</span>(function(<span>Permissions permi
ssions</span>) <span class="subdued">{...}</span><span></span>)); |
| 1633 </div> |
| 1634 |
| 1635 <div class="description"> |
| 1636 <p class="todo" style="display: none; ">Undocumented.</p> |
| 1637 <p>Fired when access to permissions has been removed from the ex
tension.</p> |
| 1638 |
| 1639 <!-- LISTENER PARAMETERS --> |
| 1640 <div> |
| 1641 <h4>Listener parameters</h4> |
| 1642 <dl> |
| 1643 <div> |
| 1644 <div> |
| 1645 <dt> |
| 1646 <var>permissions</var> |
| 1647 <em> |
| 1648 |
| 1649 <!-- TYPE --> |
| 1650 <div style="display:inline"> |
| 1651 ( |
| 1652 <span class="optional" style="display: none; ">optional</spa
n> |
| 1653 <span class="enum" style="display: none; ">enumerated</span> |
| 1654 <span id="typeTemplate"> |
| 1655 <span> |
| 1656 <a href="permissions.html#type-Permissions">Permissions<
/a> |
| 1657 </span> |
| 1658 <span style="display: none; "> |
| 1659 <span> |
| 1660 array of <span><span></span></span> |
| 1661 </span> |
| 1662 <span>paramType</span> |
| 1663 <span></span> |
| 1664 </span> |
| 1665 </span> |
| 1666 ) |
| 1667 </div> |
| 1668 |
| 1669 </em> |
| 1670 </dt> |
| 1671 <dd class="todo" style="display: none; "> |
| 1672 Undocumented. |
| 1673 </dd> |
| 1674 <dd>The permissions that have been removed.</dd> |
| 1675 <dd style="display: none; "> |
| 1676 This parameter was added in version |
| 1677 <b><span></span></b>. |
| 1678 You must omit this parameter in earlier versions, |
| 1679 and you may omit it in any version. If you require this |
| 1680 parameter, the manifest key |
| 1681 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1682 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1683 </dd> |
| 1684 |
| 1685 <!-- OBJECT PROPERTIES --> |
| 1686 <dd style="display: none; "> |
| 1687 <dl> |
| 1688 <div> |
| 1689 <div> |
| 1690 </div> |
| 1691 </div> |
| 1692 </dl> |
| 1693 </dd> |
| 1694 |
| 1695 <!-- OBJECT METHODS --> |
| 1696 <dd style="display: none; "> |
| 1697 <div></div> |
| 1698 </dd> |
| 1699 |
| 1700 <!-- OBJECT EVENT FIELDS --> |
| 1701 <dd style="display: none; "> |
| 1702 <div></div> |
| 1703 </dd> |
| 1704 |
| 1705 <!-- FUNCTION PARAMETERS --> |
| 1706 <dd style="display: none; "> |
| 1707 <div></div> |
| 1708 </dd> |
| 1709 |
| 1710 </div> |
| 1711 </div> |
| 1712 </dl> |
| 1713 </div> |
| 1714 |
| 1715 <!-- EXTRA PARAMETERS --> |
| 1716 <div style="display: none; "> |
| 1717 <h4>Extra parameters to addListener</h4> |
| 1718 <dl> |
| 1719 <div> |
| 1720 <div> |
| 1721 </div> |
| 1722 </div> |
| 1723 </dl> |
| 1724 </div> |
| 1725 |
| 1726 <!-- LISTENER RETURN VALUE --> |
| 1727 <h4 style="display: none; ">Listener returns</h4> |
| 1728 <dl> |
| 1729 <div style="display: none; "> |
| 1730 <div> |
| 1731 </div> |
| 1732 </div> |
| 1733 </dl> |
| 1734 |
| 1735 </div> <!-- /description --> |
| 1736 </div> <!-- /apiItem --> |
| 1737 |
| 1738 </div> <!-- /apiGroup --> |
| 1739 |
| 1740 <!-- TYPES --> |
| 1741 <div class="apiGroup"> |
| 1742 <a name="types"></a> |
| 1743 <h3 id="types">Types</h3> |
| 1744 |
| 1745 <!-- iterates over all types --> |
| 1746 <div class="apiItem"> |
| 1747 <a name="type-Permissions"></a> |
| 1748 <h4>Permissions</h4> |
| 1749 |
| 1750 <div> |
| 1751 <dt> |
| 1752 <var style="display: none; ">paramName</var> |
| 1753 <em> |
| 1754 |
| 1755 <!-- TYPE --> |
| 1756 <div style="display:inline"> |
| 1757 ( |
| 1758 <span class="optional" style="display: none; ">optional</spa
n> |
| 1759 <span class="enum" style="display: none; ">enumerated</span> |
| 1760 <span id="typeTemplate"> |
| 1761 <span style="display: none; "> |
| 1762 <a> Type</a> |
| 1763 </span> |
| 1764 <span> |
| 1765 <span style="display: none; "> |
| 1766 array of <span><span></span></span> |
| 1767 </span> |
| 1768 <span>object</span> |
| 1769 <span style="display: none; "></span> |
| 1770 </span> |
| 1771 </span> |
| 1772 ) |
| 1773 </div> |
| 1774 |
| 1775 </em> |
| 1776 </dt> |
| 1777 <dd class="todo"> |
| 1778 Undocumented. |
| 1779 </dd> |
| 1780 <dd style="display: none; "> |
| 1781 Description of this parameter from the json schema. |
| 1782 </dd> |
| 1783 <dd style="display: none; "> |
| 1784 This parameter was added in version |
| 1785 <b><span></span></b>. |
| 1786 You must omit this parameter in earlier versions, |
| 1787 and you may omit it in any version. If you require this |
| 1788 parameter, the manifest key |
| 1789 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1790 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1791 </dd> |
| 1792 |
| 1793 <!-- OBJECT PROPERTIES --> |
| 1794 <dd> |
| 1795 <dl> |
| 1796 <div> |
| 1797 <div> |
| 1798 <dt> |
| 1799 <var>apis</var> |
| 1800 <em> |
| 1801 |
| 1802 <!-- TYPE --> |
| 1803 <div style="display:inline"> |
| 1804 ( |
| 1805 <span class="optional">optional</span> |
| 1806 <span class="enum" style="display: none; ">enumerated</span> |
| 1807 <span id="typeTemplate"> |
| 1808 <span style="display: none; "> |
| 1809 <a> Type</a> |
| 1810 </span> |
| 1811 <span> |
| 1812 <span> |
| 1813 array of <span><span> |
| 1814 <span style="display: none; "> |
| 1815 <a> Type</a> |
| 1816 </span> |
| 1817 <span> |
| 1818 <span style="display: none; "> |
| 1819 array of <span><span></span></span> |
| 1820 </span> |
| 1821 <span>string</span> |
| 1822 <span style="display: none; "></span> |
| 1823 </span> |
| 1824 </span></span> |
| 1825 </span> |
| 1826 <span style="display: none; ">paramType</span> |
| 1827 <span style="display: none; "></span> |
| 1828 </span> |
| 1829 </span> |
| 1830 ) |
| 1831 </div> |
| 1832 |
| 1833 </em> |
| 1834 </dt> |
| 1835 <dd class="todo" style="display: none; "> |
| 1836 Undocumented. |
| 1837 </dd> |
| 1838 <dd>List of API permissions</dd> |
| 1839 <dd style="display: none; "> |
| 1840 This parameter was added in version |
| 1841 <b><span></span></b>. |
| 1842 You must omit this parameter in earlier versions, |
| 1843 and you may omit it in any version. If you require this |
| 1844 parameter, the manifest key |
| 1845 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1846 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1847 </dd> |
| 1848 |
| 1849 <!-- OBJECT PROPERTIES --> |
| 1850 <dd style="display: none; "> |
| 1851 <dl> |
| 1852 <div> |
| 1853 <div> |
| 1854 </div> |
| 1855 </div> |
| 1856 </dl> |
| 1857 </dd> |
| 1858 |
| 1859 <!-- OBJECT METHODS --> |
| 1860 <dd style="display: none; "> |
| 1861 <div></div> |
| 1862 </dd> |
| 1863 |
| 1864 <!-- OBJECT EVENT FIELDS --> |
| 1865 <dd style="display: none; "> |
| 1866 <div></div> |
| 1867 </dd> |
| 1868 |
| 1869 <!-- FUNCTION PARAMETERS --> |
| 1870 <dd style="display: none; "> |
| 1871 <div></div> |
| 1872 </dd> |
| 1873 |
| 1874 </div> |
| 1875 </div> |
| 1876 </dl> |
| 1877 </dd> |
| 1878 |
| 1879 <!-- OBJECT METHODS --> |
| 1880 <dd style="display: none; "> |
| 1881 <div></div> |
| 1882 </dd> |
| 1883 |
| 1884 <!-- OBJECT EVENT FIELDS --> |
| 1885 <dd style="display: none; "> |
| 1886 <div></div> |
| 1887 </dd> |
| 1888 |
| 1889 <!-- FUNCTION PARAMETERS --> |
| 1890 <dd style="display: none; "> |
| 1891 <div></div> |
| 1892 </dd> |
| 1893 |
| 1894 </div> |
| 1895 |
| 1896 </div> <!-- /apiItem --> |
| 1897 |
| 1898 </div> <!-- /apiGroup --> |
| 1899 |
| 1900 </div> <!-- /apiPage --> |
| 1901 </div> <!-- /gc-pagecontent --> |
| 1902 </div> <!-- /g-section --> |
| 1903 </div> <!-- /codesiteContent --> |
| 1904 <div id="gc-footer" --=""> |
| 1905 <div class="text"> |
| 1906 <p> |
| 1907 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, |
| 1908 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons |
| 1909 Attribution 3.0 License</a>, and code samples are licensed under the |
| 1910 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. |
| 1911 </p> |
| 1912 <p> |
| 1913 ©2011 Google |
| 1914 </p> |
| 1915 |
| 1916 <!-- begin analytics --> |
| 1917 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"><
/script> |
| 1918 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr
ipt> |
| 1919 |
| 1920 <script type="text/javascript"> |
| 1921 // chrome doc tracking |
| 1922 try { |
| 1923 var engdocs = _gat._getTracker("YT-10763712-2"); |
| 1924 engdocs._trackPageview(); |
| 1925 } catch(err) {} |
| 1926 |
| 1927 // code.google.com site-wide tracking |
| 1928 try { |
| 1929 _uacct="UA-18071-1"; |
| 1930 _uanchor=1; |
| 1931 _uff=0; |
| 1932 urchinTracker(); |
| 1933 } |
| 1934 catch(e) {/* urchinTracker not available. */} |
| 1935 </script> |
| 1936 <!-- end analytics --> |
| 1937 </div> |
| 1938 </div> <!-- /gc-footer --> |
| 1939 </div> <!-- /gc-container --> |
| 1940 </body></html> |
OLD | NEW |