experimental.clipboard.html revision 3f50c38dc070f4bb515c1b64450dae14f316474e
1<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 2 1) The <head> information in this page is significant, should be uniform 3 across api docs and should be edited only with knowledge of the 4 templating mechanism. 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 6 browser, it will be re-generated from the template, json schema and 7 authored overview content. 8 4) The <body>.innerHTML is also generated by an offline step so that this 9 page may easily be indexed by search engines. 10--><html xmlns="http://www.w3.org/1999/xhtml"><head> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 14 <script type="text/javascript" src="/third_party/jstemplate/jstemplate_compiled.js"> 15 </script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script> 19 <title>chrome.experimental.clipboard - 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 <!-- FUNCTION PARAMETERS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 </div> <!-- /VALUE --> 90 91 <div id="functionParametersTemplate"> 92 <h5>Parameters</h5> 93 <dl> 94 <div> 95 <div> 96 </div> 97 </div> 98 </dl> 99 </div> 100 </div> <!-- /SUBTEMPLATES --> 101 102 <a id="top"></a> 103 <div id="skipto"> 104 <a href="#gc-pagecontent">Skip to page content</a> 105 <a href="#gc-toc">Skip to main navigation</a> 106 </div> 107 <!-- API HEADER --> 108 <table id="header" width="100%" cellspacing="0" border="0"> 109 <tbody><tr> 110 <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> 111 <td valign="middle" width="100%" style="padding-left:0.6em;"> 112 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 113 <div id="gsc-search-box"> 114 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 115 <input type="hidden" name="ie" value="UTF-8"> 116 <input type="text" name="q" value="" size="55"> 117 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 118 <br> 119 <span class="greytext">e.g. "page action" or "tabs"</span> 120 </div> 121 </form> 122 123 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 124 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 125 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 126 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 127 </td> 128 </tr> 129 </tbody></table> 130 131 <div id="codesiteContent" class=""> 132 133 <a id="gc-topnav-anchor"></a> 134 <div id="gc-topnav"> 135 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 136 <ul id="home" class="gc-topnav-tabs"> 137 <li id="home_link"> 138 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 139 </li> 140 <li id="docs_link"> 141 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 142 </li> 143 <li id="faq_link"> 144 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 145 </li> 146 <li id="samples_link"> 147 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 148 </li> 149 <li id="group_link"> 150 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 151 </li> 152 </ul> 153 </div> <!-- end gc-topnav --> 154 155 <div class="g-section g-tpl-170"> 156 <!-- SIDENAV --> 157 <div class="g-unit g-first" id="gc-toc"> 158 <ul> 159 <li><a href="getstarted.html">Getting Started</a></li> 160 <li><a href="overview.html">Overview</a></li> 161 <li><a href="whats_new.html">What's New?</a></li> 162 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 163 <ul> 164 <li>Browser UI 165 <ul> 166 <li><a href="browserAction.html">Browser Actions</a></li> 167 <li><a href="contextMenus.html">Context Menus</a></li> 168 <li><a href="notifications.html">Desktop Notifications</a></li> 169 <li><a href="omnibox.html">Omnibox</a></li> 170 <li><a href="options.html">Options Pages</a></li> 171 <li><a href="override.html">Override Pages</a></li> 172 <li><a href="pageAction.html">Page Actions</a></li> 173 </ul> 174 </li> 175 <li>Browser Interaction 176 <ul> 177 <li><a href="bookmarks.html">Bookmarks</a></li> 178 <li><a href="cookies.html">Cookies</a></li> 179 <li><a href="events.html">Events</a></li> 180 <li><a href="history.html">History</a></li> 181 <li><a href="management.html">Management</a></li> 182 <li><a href="tabs.html">Tabs</a></li> 183 <li><a href="windows.html">Windows</a></li> 184 </ul> 185 </li> 186 <li>Implementation 187 <ul> 188 <li><a href="a11y.html">Accessibility</a></li> 189 <li><a href="background_pages.html">Background Pages</a></li> 190 <li><a href="content_scripts.html">Content Scripts</a></li> 191 <li><a href="xhr.html">Cross-Origin XHR</a></li> 192 <li><a href="idle.html">Idle</a></li> 193 <li><a href="i18n.html">Internationalization</a></li> 194 <li><a href="messaging.html">Message Passing</a></li> 195 <li><a href="npapi.html">NPAPI Plugins</a></li> 196 </ul> 197 </li> 198 <li>Finishing 199 <ul> 200 <li><a href="hosting.html">Hosting</a></li> 201 <li><a href="external_extensions.html">Other Deployment Options</a></li> 202 </ul> 203 </li> 204 </ul> 205 </li> 206 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 207 <li><h2><a href="tutorials.html">Tutorials</a></h2> 208 <ul> 209 <li><a href="tut_debugging.html">Debugging</a></li> 210 <li><a href="tut_analytics.html">Google Analytics</a></li> 211 <li><a href="tut_oauth.html">OAuth</a></li> 212 </ul> 213 </li> 214 <li><h2>Reference</h2> 215 <ul> 216 <li>Formats 217 <ul> 218 <li><a href="manifest.html">Manifest Files</a></li> 219 <li><a href="match_patterns.html">Match Patterns</a></li> 220 </ul> 221 </li> 222 <li><a href="permission_warnings.html">Permission Warnings</a></li> 223 <li><a href="api_index.html">chrome.* APIs</a></li> 224 <li><a href="api_other.html">Other APIs</a></li> 225 </ul> 226 </li> 227 <li><h2><a href="samples.html">Samples</a></h2></li> 228 <div class="line"> </div> 229 <li><h2>More</h2> 230 <ul> 231 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 232 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 233 <li><a href="themes.html">Themes</a></li> 234 </ul> 235 </li> 236 </ul> 237 </div> 238 <script> 239 initToggles(); 240 </script> 241 242 <div class="g-unit" id="gc-pagecontent"> 243 <div id="pageTitle"> 244 <h1 class="page_title">chrome.experimental.clipboard</h1> 245 </div> 246 <!-- TABLE OF CONTENTS --> 247 <div id="toc"> 248 <h2>Contents</h2> 249 <ol> 250 <li> 251 <a href="#H2-0">Notes</a> 252 <ol> 253 <li style="display: none; "> 254 <a>h3Name</a> 255 </li> 256 </ol> 257 </li> 258 <li> 259 <a href="#apiReference">API reference: chrome.experimental.clipboard</a> 260 <ol> 261 <li style="display: none; "> 262 <a href="#properties">Properties</a> 263 <ol> 264 <li> 265 <a href="#property-anchor">propertyName</a> 266 </li> 267 </ol> 268 </li> 269 <li> 270 <a href="#methods">Methods</a> 271 <ol> 272 <li> 273 <a href="#method-executeCopy">executeCopy</a> 274 </li><li> 275 <a href="#method-executeCut">executeCut</a> 276 </li><li> 277 <a href="#method-executePaste">executePaste</a> 278 </li> 279 </ol> 280 </li> 281 <li style="display: none; "> 282 <a href="#events">Events</a> 283 <ol> 284 <li> 285 <a href="#event-anchor">eventName</a> 286 </li> 287 </ol> 288 </li> 289 <li style="display: none; "> 290 <a href="#types">Types</a> 291 <ol> 292 <li> 293 <a href="#id-anchor">id</a> 294 </li> 295 </ol> 296 </li> 297 </ol> 298 </li> 299 </ol> 300 </div> 301 <!-- /TABLE OF CONTENTS --> 302 303 <!-- Standard content lead-in for experimental API pages --> 304 <p id="classSummary"> 305 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 306 </p> 307 308 <!-- STATIC CONTENT PLACEHOLDER --> 309 <div id="static"><!-- BEGIN AUTHORED CONTENT --> 310 311 312<a name="H2-0"></a><h2>Notes</h2> 313 314<p> 315For all functions exposed by this API, the argument to the callback indicates 316whether or not the event was successfully dispatched, not whether the event was 317successfully processed and handled. Most callers won't care, since a failure 318generally indicates the tab is going away. 319</p> 320 321<!-- END AUTHORED CONTENT --> 322</div> 323 324 <!-- API PAGE --> 325 <div class="apiPage"> 326 <a name="apiReference"></a> 327 <h2>API reference: chrome.experimental.clipboard</h2> 328 329 <!-- PROPERTIES --> 330 <div class="apiGroup" style="display: none; "> 331 <a name="properties"></a> 332 <h3 id="properties">Properties</h3> 333 334 <div> 335 <a></a> 336 <h4>getLastError</h4> 337 <div class="summary"> 338 <!-- Note: intentionally longer 80 columns --> 339 <span>chrome.extension</span><span>lastError</span> 340 </div> 341 <div> 342 </div> 343 </div> 344 345 </div> <!-- /apiGroup --> 346 347 <!-- METHODS --> 348 <div class="apiGroup" id="methods"> 349 <a name="methods"></a> 350 <h3>Methods</h3> 351 352 <!-- iterates over all functions --> 353 <div class="apiItem"> 354 <a name="method-executeCopy"></a> <!-- method-anchor --> 355 <h4>executeCopy</h4> 356 357 <div class="summary"><span style="display: none; ">void</span> 358 <!-- Note: intentionally longer 80 columns --> 359 <span>chrome.experimental.clipboard.executeCopy</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 360 <var><span>tabId</span></var></span><span class="optional"><span>, </span><span>function</span> 361 <var><span>callback</span></var></span>)</div> 362 363 <div class="description"> 364 <p class="todo" style="display: none; ">Undocumented.</p> 365 <p>Triggers a copy operation in the specified tab.</p> 366 367 <!-- PARAMETERS --> 368 <h4>Parameters</h4> 369 <dl> 370 <div> 371 <div> 372 <dt> 373 <var>tabId</var> 374 <em> 375 376 <!-- TYPE --> 377 <div style="display:inline"> 378 ( 379 <span class="optional" style="display: none; ">optional</span> 380 <span class="enum" style="display: none; ">enumerated</span> 381 <span id="typeTemplate"> 382 <span style="display: none; "> 383 <a> Type</a> 384 </span> 385 <span> 386 <span style="display: none; "> 387 array of <span><span></span></span> 388 </span> 389 <span>integer</span> 390 <span style="display: none; "></span> 391 </span> 392 </span> 393 ) 394 </div> 395 396 </em> 397 </dt> 398 <dd class="todo"> 399 Undocumented. 400 </dd> 401 <dd style="display: none; "> 402 Description of this parameter from the json schema. 403 </dd> 404 <dd style="display: none; "> 405 This parameter was added in version 406 <b><span></span></b>. 407 You must omit this parameter in earlier versions, 408 and you may omit it in any version. If you require this 409 parameter, the manifest key 410 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 411 can ensure that your extension won't be run in an earlier browser version. 412 </dd> 413 414 <!-- OBJECT PROPERTIES --> 415 <dd style="display: none; "> 416 <dl> 417 <div> 418 <div> 419 </div> 420 </div> 421 </dl> 422 </dd> 423 424 <!-- FUNCTION PARAMETERS --> 425 <dd style="display: none; "> 426 <div></div> 427 </dd> 428 429 </div> 430 </div><div> 431 <div> 432 <dt> 433 <var>callback</var> 434 <em> 435 436 <!-- TYPE --> 437 <div style="display:inline"> 438 ( 439 <span class="optional">optional</span> 440 <span class="enum" style="display: none; ">enumerated</span> 441 <span id="typeTemplate"> 442 <span style="display: none; "> 443 <a> Type</a> 444 </span> 445 <span> 446 <span style="display: none; "> 447 array of <span><span></span></span> 448 </span> 449 <span>function</span> 450 <span style="display: none; "></span> 451 </span> 452 </span> 453 ) 454 </div> 455 456 </em> 457 </dt> 458 <dd class="todo"> 459 Undocumented. 460 </dd> 461 <dd style="display: none; "> 462 Description of this parameter from the json schema. 463 </dd> 464 <dd style="display: none; "> 465 This parameter was added in version 466 <b><span></span></b>. 467 You must omit this parameter in earlier versions, 468 and you may omit it in any version. If you require this 469 parameter, the manifest key 470 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 471 can ensure that your extension won't be run in an earlier browser version. 472 </dd> 473 474 <!-- OBJECT PROPERTIES --> 475 <dd style="display: none; "> 476 <dl> 477 <div> 478 <div> 479 </div> 480 </div> 481 </dl> 482 </dd> 483 484 <!-- FUNCTION PARAMETERS --> 485 <dd style="display: none; "> 486 <div></div> 487 </dd> 488 489 </div> 490 </div> 491 </dl> 492 493 <!-- RETURNS --> 494 <h4 style="display: none; ">Returns</h4> 495 <dl> 496 <div style="display: none; "> 497 <div> 498 </div> 499 </div> 500 </dl> 501 502 <!-- CALLBACK --> 503 <div> 504 <div> 505 <h4>Callback function</h4> 506 <p style="display: none; "> 507 The callback <em>parameter</em> should specify a function 508 that looks like this: 509 </p> 510 <p> 511 If you specify the <em>callback</em> parameter, it should 512 specify a function that looks like this: 513 </p> 514 515 <!-- Note: intentionally longer 80 columns --> 516 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 517 <dl> 518 <div style="display: none; "> 519 <div> 520 </div> 521 </div> 522 </dl> 523 </div> 524 </div> 525 526 <!-- MIN_VERSION --> 527 <p style="display: none; "> 528 This function was added in version <b><span></span></b>. 529 If you require this function, the manifest key 530 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 531 can ensure that your extension won't be run in an earlier browser version. 532 </p> 533 </div> <!-- /description --> 534 535 </div><div class="apiItem"> 536 <a name="method-executeCut"></a> <!-- method-anchor --> 537 <h4>executeCut</h4> 538 539 <div class="summary"><span style="display: none; ">void</span> 540 <!-- Note: intentionally longer 80 columns --> 541 <span>chrome.experimental.clipboard.executeCut</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 542 <var><span>tabId</span></var></span><span class="optional"><span>, </span><span>function</span> 543 <var><span>callback</span></var></span>)</div> 544 545 <div class="description"> 546 <p class="todo" style="display: none; ">Undocumented.</p> 547 <p>Triggers a cut operation in the specified tab.</p> 548 549 <!-- PARAMETERS --> 550 <h4>Parameters</h4> 551 <dl> 552 <div> 553 <div> 554 <dt> 555 <var>tabId</var> 556 <em> 557 558 <!-- TYPE --> 559 <div style="display:inline"> 560 ( 561 <span class="optional" style="display: none; ">optional</span> 562 <span class="enum" style="display: none; ">enumerated</span> 563 <span id="typeTemplate"> 564 <span style="display: none; "> 565 <a> Type</a> 566 </span> 567 <span> 568 <span style="display: none; "> 569 array of <span><span></span></span> 570 </span> 571 <span>integer</span> 572 <span style="display: none; "></span> 573 </span> 574 </span> 575 ) 576 </div> 577 578 </em> 579 </dt> 580 <dd class="todo"> 581 Undocumented. 582 </dd> 583 <dd style="display: none; "> 584 Description of this parameter from the json schema. 585 </dd> 586 <dd style="display: none; "> 587 This parameter was added in version 588 <b><span></span></b>. 589 You must omit this parameter in earlier versions, 590 and you may omit it in any version. If you require this 591 parameter, the manifest key 592 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 593 can ensure that your extension won't be run in an earlier browser version. 594 </dd> 595 596 <!-- OBJECT PROPERTIES --> 597 <dd style="display: none; "> 598 <dl> 599 <div> 600 <div> 601 </div> 602 </div> 603 </dl> 604 </dd> 605 606 <!-- FUNCTION PARAMETERS --> 607 <dd style="display: none; "> 608 <div></div> 609 </dd> 610 611 </div> 612 </div><div> 613 <div> 614 <dt> 615 <var>callback</var> 616 <em> 617 618 <!-- TYPE --> 619 <div style="display:inline"> 620 ( 621 <span class="optional">optional</span> 622 <span class="enum" style="display: none; ">enumerated</span> 623 <span id="typeTemplate"> 624 <span style="display: none; "> 625 <a> Type</a> 626 </span> 627 <span> 628 <span style="display: none; "> 629 array of <span><span></span></span> 630 </span> 631 <span>function</span> 632 <span style="display: none; "></span> 633 </span> 634 </span> 635 ) 636 </div> 637 638 </em> 639 </dt> 640 <dd class="todo"> 641 Undocumented. 642 </dd> 643 <dd style="display: none; "> 644 Description of this parameter from the json schema. 645 </dd> 646 <dd style="display: none; "> 647 This parameter was added in version 648 <b><span></span></b>. 649 You must omit this parameter in earlier versions, 650 and you may omit it in any version. If you require this 651 parameter, the manifest key 652 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 653 can ensure that your extension won't be run in an earlier browser version. 654 </dd> 655 656 <!-- OBJECT PROPERTIES --> 657 <dd style="display: none; "> 658 <dl> 659 <div> 660 <div> 661 </div> 662 </div> 663 </dl> 664 </dd> 665 666 <!-- FUNCTION PARAMETERS --> 667 <dd style="display: none; "> 668 <div></div> 669 </dd> 670 671 </div> 672 </div> 673 </dl> 674 675 <!-- RETURNS --> 676 <h4 style="display: none; ">Returns</h4> 677 <dl> 678 <div style="display: none; "> 679 <div> 680 </div> 681 </div> 682 </dl> 683 684 <!-- CALLBACK --> 685 <div> 686 <div> 687 <h4>Callback function</h4> 688 <p style="display: none; "> 689 The callback <em>parameter</em> should specify a function 690 that looks like this: 691 </p> 692 <p> 693 If you specify the <em>callback</em> parameter, it should 694 specify a function that looks like this: 695 </p> 696 697 <!-- Note: intentionally longer 80 columns --> 698 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 699 <dl> 700 <div style="display: none; "> 701 <div> 702 </div> 703 </div> 704 </dl> 705 </div> 706 </div> 707 708 <!-- MIN_VERSION --> 709 <p style="display: none; "> 710 This function was added in version <b><span></span></b>. 711 If you require this function, the manifest key 712 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 713 can ensure that your extension won't be run in an earlier browser version. 714 </p> 715 </div> <!-- /description --> 716 717 </div><div class="apiItem"> 718 <a name="method-executePaste"></a> <!-- method-anchor --> 719 <h4>executePaste</h4> 720 721 <div class="summary"><span style="display: none; ">void</span> 722 <!-- Note: intentionally longer 80 columns --> 723 <span>chrome.experimental.clipboard.executePaste</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 724 <var><span>tabId</span></var></span><span class="optional"><span>, </span><span>function</span> 725 <var><span>callback</span></var></span>)</div> 726 727 <div class="description"> 728 <p class="todo" style="display: none; ">Undocumented.</p> 729 <p>Triggers a paste operation in the specified tab.</p> 730 731 <!-- PARAMETERS --> 732 <h4>Parameters</h4> 733 <dl> 734 <div> 735 <div> 736 <dt> 737 <var>tabId</var> 738 <em> 739 740 <!-- TYPE --> 741 <div style="display:inline"> 742 ( 743 <span class="optional" style="display: none; ">optional</span> 744 <span class="enum" style="display: none; ">enumerated</span> 745 <span id="typeTemplate"> 746 <span style="display: none; "> 747 <a> Type</a> 748 </span> 749 <span> 750 <span style="display: none; "> 751 array of <span><span></span></span> 752 </span> 753 <span>integer</span> 754 <span style="display: none; "></span> 755 </span> 756 </span> 757 ) 758 </div> 759 760 </em> 761 </dt> 762 <dd class="todo"> 763 Undocumented. 764 </dd> 765 <dd style="display: none; "> 766 Description of this parameter from the json schema. 767 </dd> 768 <dd style="display: none; "> 769 This parameter was added in version 770 <b><span></span></b>. 771 You must omit this parameter in earlier versions, 772 and you may omit it in any version. If you require this 773 parameter, the manifest key 774 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 775 can ensure that your extension won't be run in an earlier browser version. 776 </dd> 777 778 <!-- OBJECT PROPERTIES --> 779 <dd style="display: none; "> 780 <dl> 781 <div> 782 <div> 783 </div> 784 </div> 785 </dl> 786 </dd> 787 788 <!-- FUNCTION PARAMETERS --> 789 <dd style="display: none; "> 790 <div></div> 791 </dd> 792 793 </div> 794 </div><div> 795 <div> 796 <dt> 797 <var>callback</var> 798 <em> 799 800 <!-- TYPE --> 801 <div style="display:inline"> 802 ( 803 <span class="optional">optional</span> 804 <span class="enum" style="display: none; ">enumerated</span> 805 <span id="typeTemplate"> 806 <span style="display: none; "> 807 <a> Type</a> 808 </span> 809 <span> 810 <span style="display: none; "> 811 array of <span><span></span></span> 812 </span> 813 <span>function</span> 814 <span style="display: none; "></span> 815 </span> 816 </span> 817 ) 818 </div> 819 820 </em> 821 </dt> 822 <dd class="todo"> 823 Undocumented. 824 </dd> 825 <dd style="display: none; "> 826 Description of this parameter from the json schema. 827 </dd> 828 <dd style="display: none; "> 829 This parameter was added in version 830 <b><span></span></b>. 831 You must omit this parameter in earlier versions, 832 and you may omit it in any version. If you require this 833 parameter, the manifest key 834 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 835 can ensure that your extension won't be run in an earlier browser version. 836 </dd> 837 838 <!-- OBJECT PROPERTIES --> 839 <dd style="display: none; "> 840 <dl> 841 <div> 842 <div> 843 </div> 844 </div> 845 </dl> 846 </dd> 847 848 <!-- FUNCTION PARAMETERS --> 849 <dd style="display: none; "> 850 <div></div> 851 </dd> 852 853 </div> 854 </div> 855 </dl> 856 857 <!-- RETURNS --> 858 <h4 style="display: none; ">Returns</h4> 859 <dl> 860 <div style="display: none; "> 861 <div> 862 </div> 863 </div> 864 </dl> 865 866 <!-- CALLBACK --> 867 <div> 868 <div> 869 <h4>Callback function</h4> 870 <p style="display: none; "> 871 The callback <em>parameter</em> should specify a function 872 that looks like this: 873 </p> 874 <p> 875 If you specify the <em>callback</em> parameter, it should 876 specify a function that looks like this: 877 </p> 878 879 <!-- Note: intentionally longer 80 columns --> 880 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 881 <dl> 882 <div style="display: none; "> 883 <div> 884 </div> 885 </div> 886 </dl> 887 </div> 888 </div> 889 890 <!-- MIN_VERSION --> 891 <p style="display: none; "> 892 This function was added in version <b><span></span></b>. 893 If you require this function, the manifest key 894 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 895 can ensure that your extension won't be run in an earlier browser version. 896 </p> 897 </div> <!-- /description --> 898 899 </div> <!-- /apiItem --> 900 901 </div> <!-- /apiGroup --> 902 903 <!-- EVENTS --> 904 <div class="apiGroup" style="display: none; "> 905 <a name="events"></a> 906 <h3 id="events">Events</h3> 907 908 <!-- iterates over all events --> 909 <div class="apiItem"> 910 <a></a> 911 <h4>event name</h4> 912 913 <div class="summary"> 914 <!-- Note: intentionally longer 80 columns --> 915 <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>); 916 </div> 917 918 <div class="description"> 919 <p class="todo">Undocumented.</p> 920 <p> 921 A description from the json schema def of the event goes here. 922 </p> 923 924 <!-- PARAMETERS --> 925 <h4>Parameters</h4> 926 <dl> 927 <div> 928 <div> 929 </div> 930 </div> 931 </dl> 932 933 </div> <!-- /decription --> 934 935 </div> <!-- /apiItem --> 936 937 </div> <!-- /apiGroup --> 938 939 <!-- TYPES --> 940 <div class="apiGroup" style="display: none; "> 941 <a name="types"></a> 942 <h3 id="types">Types</h3> 943 944 <!-- iterates over all types --> 945 <div class="apiItem"> 946 <a></a> 947 <h4>type name</h4> 948 949 <div> 950 </div> 951 952 </div> <!-- /apiItem --> 953 954 </div> <!-- /apiGroup --> 955 956 </div> <!-- /apiPage --> 957 </div> <!-- /gc-pagecontent --> 958 </div> <!-- /g-section --> 959 </div> <!-- /codesiteContent --> 960 <div id="gc-footer" --=""> 961 <div class="text"> 962 <p> 963 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 964 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 965 Attribution 3.0 License</a>, and code samples are licensed under the 966 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 967 </p> 968 <p> 969 ©2011 Google 970 </p> 971 972<!-- begin analytics --> 973<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 974<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 975 976<script type="text/javascript"> 977 // chrome doc tracking 978 try { 979 var engdocs = _gat._getTracker("YT-10763712-2"); 980 engdocs._trackPageview(); 981 } catch(err) {} 982 983 // code.google.com site-wide tracking 984 try { 985 _uacct="UA-18071-1"; 986 _uanchor=1; 987 _uff=0; 988 urchinTracker(); 989 } 990 catch(e) {/* urchinTracker not available. */} 991</script> 992<!-- end analytics --> 993 </div> 994 </div> <!-- /gc-footer --> 995 </div> <!-- /gc-container --> 996</body></html> 997
