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