experimental.clipboard.html revision 513209b27ff55e2841eac0e4120199c23acce758
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="options.html">Options Pages</a></li> 170 <li><a href="override.html">Override Pages</a></li> 171 <li><a href="pageAction.html">Page Actions</a></li> 172 <li><a href="themes.html">Themes</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="tutorials.html">Tutorials</a></h2> 207 <ul> 208 <li><a href="tut_debugging.html">Debugging</a></li> 209 <li><a href="tut_analytics.html">Google Analytics</a></li> 210 <li><a href="tut_oauth.html">OAuth</a></li> 211 </ul> 212 </li> 213 <li><h2>Reference</h2> 214 <ul> 215 <li>Formats 216 <ul> 217 <li><a href="manifest.html">Manifest Files</a></li> 218 <li><a href="match_patterns.html">Match Patterns</a></li> 219 <!-- <li>Packages (.crx)</li> --> 220 </ul> 221 </li> 222 <li><a href="api_index.html">chrome.* APIs</a></li> 223 <li><a href="api_other.html">Other APIs</a></li> 224 </ul> 225 </li> 226 <li><h2><a href="samples.html">Samples</a></h2></li> 227 </ul> 228 </div> 229 <script> 230 initToggles(); 231 </script> 232 233 <div class="g-unit" id="gc-pagecontent"> 234 <div id="pageTitle"> 235 <h1 class="page_title">chrome.experimental.clipboard</h1> 236 </div> 237 <!-- TABLE OF CONTENTS --> 238 <div id="toc"> 239 <h2>Contents</h2> 240 <ol> 241 <li> 242 <a href="#H2-0">Notes</a> 243 <ol> 244 <li style="display: none; "> 245 <a>h3Name</a> 246 </li> 247 </ol> 248 </li> 249 <li> 250 <a href="#apiReference">API reference: chrome.experimental.clipboard</a> 251 <ol> 252 <li style="display: none; "> 253 <a href="#properties">Properties</a> 254 <ol> 255 <li> 256 <a href="#property-anchor">propertyName</a> 257 </li> 258 </ol> 259 </li> 260 <li> 261 <a href="#methods">Methods</a> 262 <ol> 263 <li> 264 <a href="#method-executeCopy">executeCopy</a> 265 </li><li> 266 <a href="#method-executeCut">executeCut</a> 267 </li><li> 268 <a href="#method-executePaste">executePaste</a> 269 </li> 270 </ol> 271 </li> 272 <li style="display: none; "> 273 <a href="#events">Events</a> 274 <ol> 275 <li> 276 <a href="#event-anchor">eventName</a> 277 </li> 278 </ol> 279 </li> 280 <li style="display: none; "> 281 <a href="#types">Types</a> 282 <ol> 283 <li> 284 <a href="#id-anchor">id</a> 285 </li> 286 </ol> 287 </li> 288 </ol> 289 </li> 290 </ol> 291 </div> 292 <!-- /TABLE OF CONTENTS --> 293 294 <!-- Standard content lead-in for experimental API pages --> 295 <p id="classSummary"> 296 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 297 </p> 298 299 <!-- STATIC CONTENT PLACEHOLDER --> 300 <div id="static"><!-- BEGIN AUTHORED CONTENT --> 301 302 303<a name="H2-0"></a><h2>Notes</h2> 304 305<p> 306For all functions exposed by this API, the argument to the callback indicates 307whether or not the event was successfully dispatched, not whether the event was 308successfully processed and handled. Most callers won't care, since a failure 309generally indicates the tab is going away. 310</p> 311 312<!-- END AUTHORED CONTENT --> 313</div> 314 315 <!-- API PAGE --> 316 <div class="apiPage"> 317 <a name="apiReference"></a> 318 <h2>API reference: chrome.experimental.clipboard</h2> 319 320 <!-- PROPERTIES --> 321 <div class="apiGroup" style="display: none; "> 322 <a name="properties"></a> 323 <h3 id="properties">Properties</h3> 324 325 <div> 326 <a></a> 327 <h4>getLastError</h4> 328 <div class="summary"> 329 <!-- Note: intentionally longer 80 columns --> 330 <span>chrome.extension</span><span>lastError</span> 331 </div> 332 <div> 333 </div> 334 </div> 335 336 </div> <!-- /apiGroup --> 337 338 <!-- METHODS --> 339 <div class="apiGroup" id="methods"> 340 <a name="methods"></a> 341 <h3>Methods</h3> 342 343 <!-- iterates over all functions --> 344 <div class="apiItem"> 345 <a name="method-executeCopy"></a> <!-- method-anchor --> 346 <h4>executeCopy</h4> 347 348 <div class="summary"><span style="display: none; ">void</span> 349 <!-- Note: intentionally longer 80 columns --> 350 <span>chrome.experimental.clipboard.executeCopy</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 351 <var><span>tabId</span></var></span><span class="optional"><span>, </span><span>function</span> 352 <var><span>callback</span></var></span>)</div> 353 354 <div class="description"> 355 <p class="todo" style="display: none; ">Undocumented.</p> 356 <p>Triggers a copy operation in the specified tab.</p> 357 358 <!-- PARAMETERS --> 359 <h4>Parameters</h4> 360 <dl> 361 <div> 362 <div> 363 <dt> 364 <var>tabId</var> 365 <em> 366 367 <!-- TYPE --> 368 <div style="display:inline"> 369 ( 370 <span class="optional" style="display: none; ">optional</span> 371 <span class="enum" style="display: none; ">enumerated</span> 372 <span id="typeTemplate"> 373 <span style="display: none; "> 374 <a> Type</a> 375 </span> 376 <span> 377 <span style="display: none; "> 378 array of <span><span></span></span> 379 </span> 380 <span>integer</span> 381 <span style="display: none; "></span> 382 </span> 383 </span> 384 ) 385 </div> 386 387 </em> 388 </dt> 389 <dd class="todo"> 390 Undocumented. 391 </dd> 392 <dd style="display: none; "> 393 Description of this parameter from the json schema. 394 </dd> 395 <dd style="display: none; "> 396 This parameter was added in version 397 <b><span></span></b>. 398 You must omit this parameter in earlier versions, 399 and you may omit it in any version. If you require this 400 parameter, the manifest key 401 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 402 can ensure that your extension won't be run in an earlier browser version. 403 </dd> 404 405 <!-- OBJECT PROPERTIES --> 406 <dd style="display: none; "> 407 <dl> 408 <div> 409 <div> 410 </div> 411 </div> 412 </dl> 413 </dd> 414 415 <!-- FUNCTION PARAMETERS --> 416 <dd style="display: none; "> 417 <div></div> 418 </dd> 419 420 </div> 421 </div><div> 422 <div> 423 <dt> 424 <var>callback</var> 425 <em> 426 427 <!-- TYPE --> 428 <div style="display:inline"> 429 ( 430 <span class="optional">optional</span> 431 <span class="enum" style="display: none; ">enumerated</span> 432 <span id="typeTemplate"> 433 <span style="display: none; "> 434 <a> Type</a> 435 </span> 436 <span> 437 <span style="display: none; "> 438 array of <span><span></span></span> 439 </span> 440 <span>function</span> 441 <span style="display: none; "></span> 442 </span> 443 </span> 444 ) 445 </div> 446 447 </em> 448 </dt> 449 <dd class="todo"> 450 Undocumented. 451 </dd> 452 <dd style="display: none; "> 453 Description of this parameter from the json schema. 454 </dd> 455 <dd style="display: none; "> 456 This parameter was added in version 457 <b><span></span></b>. 458 You must omit this parameter in earlier versions, 459 and you may omit it in any version. If you require this 460 parameter, the manifest key 461 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 462 can ensure that your extension won't be run in an earlier browser version. 463 </dd> 464 465 <!-- OBJECT PROPERTIES --> 466 <dd style="display: none; "> 467 <dl> 468 <div> 469 <div> 470 </div> 471 </div> 472 </dl> 473 </dd> 474 475 <!-- FUNCTION PARAMETERS --> 476 <dd style="display: none; "> 477 <div></div> 478 </dd> 479 480 </div> 481 </div> 482 </dl> 483 484 <!-- RETURNS --> 485 <h4 style="display: none; ">Returns</h4> 486 <dl> 487 <div style="display: none; "> 488 <div> 489 </div> 490 </div> 491 </dl> 492 493 <!-- CALLBACK --> 494 <div> 495 <div> 496 <h4>Callback function</h4> 497 <p style="display: none; "> 498 The callback <em>parameter</em> should specify a function 499 that looks like this: 500 </p> 501 <p> 502 If you specify the <em>callback</em> parameter, it should 503 specify a function that looks like this: 504 </p> 505 506 <!-- Note: intentionally longer 80 columns --> 507 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 508 <dl> 509 <div style="display: none; "> 510 <div> 511 </div> 512 </div> 513 </dl> 514 </div> 515 </div> 516 517 <!-- MIN_VERSION --> 518 <p style="display: none; "> 519 This function was added in version <b><span></span></b>. 520 If you require this function, the manifest key 521 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 522 can ensure that your extension won't be run in an earlier browser version. 523 </p> 524 </div> <!-- /description --> 525 526 </div><div class="apiItem"> 527 <a name="method-executeCut"></a> <!-- method-anchor --> 528 <h4>executeCut</h4> 529 530 <div class="summary"><span style="display: none; ">void</span> 531 <!-- Note: intentionally longer 80 columns --> 532 <span>chrome.experimental.clipboard.executeCut</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 533 <var><span>tabId</span></var></span><span class="optional"><span>, </span><span>function</span> 534 <var><span>callback</span></var></span>)</div> 535 536 <div class="description"> 537 <p class="todo" style="display: none; ">Undocumented.</p> 538 <p>Triggers a cut operation in the specified tab.</p> 539 540 <!-- PARAMETERS --> 541 <h4>Parameters</h4> 542 <dl> 543 <div> 544 <div> 545 <dt> 546 <var>tabId</var> 547 <em> 548 549 <!-- TYPE --> 550 <div style="display:inline"> 551 ( 552 <span class="optional" style="display: none; ">optional</span> 553 <span class="enum" style="display: none; ">enumerated</span> 554 <span id="typeTemplate"> 555 <span style="display: none; "> 556 <a> Type</a> 557 </span> 558 <span> 559 <span style="display: none; "> 560 array of <span><span></span></span> 561 </span> 562 <span>integer</span> 563 <span style="display: none; "></span> 564 </span> 565 </span> 566 ) 567 </div> 568 569 </em> 570 </dt> 571 <dd class="todo"> 572 Undocumented. 573 </dd> 574 <dd style="display: none; "> 575 Description of this parameter from the json schema. 576 </dd> 577 <dd style="display: none; "> 578 This parameter was added in version 579 <b><span></span></b>. 580 You must omit this parameter in earlier versions, 581 and you may omit it in any version. If you require this 582 parameter, the manifest key 583 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 584 can ensure that your extension won't be run in an earlier browser version. 585 </dd> 586 587 <!-- OBJECT PROPERTIES --> 588 <dd style="display: none; "> 589 <dl> 590 <div> 591 <div> 592 </div> 593 </div> 594 </dl> 595 </dd> 596 597 <!-- FUNCTION PARAMETERS --> 598 <dd style="display: none; "> 599 <div></div> 600 </dd> 601 602 </div> 603 </div><div> 604 <div> 605 <dt> 606 <var>callback</var> 607 <em> 608 609 <!-- TYPE --> 610 <div style="display:inline"> 611 ( 612 <span class="optional">optional</span> 613 <span class="enum" style="display: none; ">enumerated</span> 614 <span id="typeTemplate"> 615 <span style="display: none; "> 616 <a> Type</a> 617 </span> 618 <span> 619 <span style="display: none; "> 620 array of <span><span></span></span> 621 </span> 622 <span>function</span> 623 <span style="display: none; "></span> 624 </span> 625 </span> 626 ) 627 </div> 628 629 </em> 630 </dt> 631 <dd class="todo"> 632 Undocumented. 633 </dd> 634 <dd style="display: none; "> 635 Description of this parameter from the json schema. 636 </dd> 637 <dd style="display: none; "> 638 This parameter was added in version 639 <b><span></span></b>. 640 You must omit this parameter in earlier versions, 641 and you may omit it in any version. If you require this 642 parameter, the manifest key 643 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 644 can ensure that your extension won't be run in an earlier browser version. 645 </dd> 646 647 <!-- OBJECT PROPERTIES --> 648 <dd style="display: none; "> 649 <dl> 650 <div> 651 <div> 652 </div> 653 </div> 654 </dl> 655 </dd> 656 657 <!-- FUNCTION PARAMETERS --> 658 <dd style="display: none; "> 659 <div></div> 660 </dd> 661 662 </div> 663 </div> 664 </dl> 665 666 <!-- RETURNS --> 667 <h4 style="display: none; ">Returns</h4> 668 <dl> 669 <div style="display: none; "> 670 <div> 671 </div> 672 </div> 673 </dl> 674 675 <!-- CALLBACK --> 676 <div> 677 <div> 678 <h4>Callback function</h4> 679 <p style="display: none; "> 680 The callback <em>parameter</em> should specify a function 681 that looks like this: 682 </p> 683 <p> 684 If you specify the <em>callback</em> parameter, it should 685 specify a function that looks like this: 686 </p> 687 688 <!-- Note: intentionally longer 80 columns --> 689 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 690 <dl> 691 <div style="display: none; "> 692 <div> 693 </div> 694 </div> 695 </dl> 696 </div> 697 </div> 698 699 <!-- MIN_VERSION --> 700 <p style="display: none; "> 701 This function was added in version <b><span></span></b>. 702 If you require this function, the manifest key 703 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 704 can ensure that your extension won't be run in an earlier browser version. 705 </p> 706 </div> <!-- /description --> 707 708 </div><div class="apiItem"> 709 <a name="method-executePaste"></a> <!-- method-anchor --> 710 <h4>executePaste</h4> 711 712 <div class="summary"><span style="display: none; ">void</span> 713 <!-- Note: intentionally longer 80 columns --> 714 <span>chrome.experimental.clipboard.executePaste</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 715 <var><span>tabId</span></var></span><span class="optional"><span>, </span><span>function</span> 716 <var><span>callback</span></var></span>)</div> 717 718 <div class="description"> 719 <p class="todo" style="display: none; ">Undocumented.</p> 720 <p>Triggers a paste operation in the specified tab.</p> 721 722 <!-- PARAMETERS --> 723 <h4>Parameters</h4> 724 <dl> 725 <div> 726 <div> 727 <dt> 728 <var>tabId</var> 729 <em> 730 731 <!-- TYPE --> 732 <div style="display:inline"> 733 ( 734 <span class="optional" style="display: none; ">optional</span> 735 <span class="enum" style="display: none; ">enumerated</span> 736 <span id="typeTemplate"> 737 <span style="display: none; "> 738 <a> Type</a> 739 </span> 740 <span> 741 <span style="display: none; "> 742 array of <span><span></span></span> 743 </span> 744 <span>integer</span> 745 <span style="display: none; "></span> 746 </span> 747 </span> 748 ) 749 </div> 750 751 </em> 752 </dt> 753 <dd class="todo"> 754 Undocumented. 755 </dd> 756 <dd style="display: none; "> 757 Description of this parameter from the json schema. 758 </dd> 759 <dd style="display: none; "> 760 This parameter was added in version 761 <b><span></span></b>. 762 You must omit this parameter in earlier versions, 763 and you may omit it in any version. If you require this 764 parameter, the manifest key 765 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 766 can ensure that your extension won't be run in an earlier browser version. 767 </dd> 768 769 <!-- OBJECT PROPERTIES --> 770 <dd style="display: none; "> 771 <dl> 772 <div> 773 <div> 774 </div> 775 </div> 776 </dl> 777 </dd> 778 779 <!-- FUNCTION PARAMETERS --> 780 <dd style="display: none; "> 781 <div></div> 782 </dd> 783 784 </div> 785 </div><div> 786 <div> 787 <dt> 788 <var>callback</var> 789 <em> 790 791 <!-- TYPE --> 792 <div style="display:inline"> 793 ( 794 <span class="optional">optional</span> 795 <span class="enum" style="display: none; ">enumerated</span> 796 <span id="typeTemplate"> 797 <span style="display: none; "> 798 <a> Type</a> 799 </span> 800 <span> 801 <span style="display: none; "> 802 array of <span><span></span></span> 803 </span> 804 <span>function</span> 805 <span style="display: none; "></span> 806 </span> 807 </span> 808 ) 809 </div> 810 811 </em> 812 </dt> 813 <dd class="todo"> 814 Undocumented. 815 </dd> 816 <dd style="display: none; "> 817 Description of this parameter from the json schema. 818 </dd> 819 <dd style="display: none; "> 820 This parameter was added in version 821 <b><span></span></b>. 822 You must omit this parameter in earlier versions, 823 and you may omit it in any version. If you require this 824 parameter, the manifest key 825 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 826 can ensure that your extension won't be run in an earlier browser version. 827 </dd> 828 829 <!-- OBJECT PROPERTIES --> 830 <dd style="display: none; "> 831 <dl> 832 <div> 833 <div> 834 </div> 835 </div> 836 </dl> 837 </dd> 838 839 <!-- FUNCTION PARAMETERS --> 840 <dd style="display: none; "> 841 <div></div> 842 </dd> 843 844 </div> 845 </div> 846 </dl> 847 848 <!-- RETURNS --> 849 <h4 style="display: none; ">Returns</h4> 850 <dl> 851 <div style="display: none; "> 852 <div> 853 </div> 854 </div> 855 </dl> 856 857 <!-- CALLBACK --> 858 <div> 859 <div> 860 <h4>Callback function</h4> 861 <p style="display: none; "> 862 The callback <em>parameter</em> should specify a function 863 that looks like this: 864 </p> 865 <p> 866 If you specify the <em>callback</em> parameter, it should 867 specify a function that looks like this: 868 </p> 869 870 <!-- Note: intentionally longer 80 columns --> 871 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 872 <dl> 873 <div style="display: none; "> 874 <div> 875 </div> 876 </div> 877 </dl> 878 </div> 879 </div> 880 881 <!-- MIN_VERSION --> 882 <p style="display: none; "> 883 This function was added in version <b><span></span></b>. 884 If you require this function, the manifest key 885 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 886 can ensure that your extension won't be run in an earlier browser version. 887 </p> 888 </div> <!-- /description --> 889 890 </div> <!-- /apiItem --> 891 892 </div> <!-- /apiGroup --> 893 894 <!-- EVENTS --> 895 <div class="apiGroup" style="display: none; "> 896 <a name="events"></a> 897 <h3 id="events">Events</h3> 898 899 <!-- iterates over all events --> 900 <div class="apiItem"> 901 <a></a> 902 <h4>event name</h4> 903 904 <div class="summary"> 905 <!-- Note: intentionally longer 80 columns --> 906 <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>); 907 </div> 908 909 <div class="description"> 910 <p class="todo">Undocumented.</p> 911 <p> 912 A description from the json schema def of the event goes here. 913 </p> 914 915 <!-- PARAMETERS --> 916 <h4>Parameters</h4> 917 <dl> 918 <div> 919 <div> 920 </div> 921 </div> 922 </dl> 923 924 </div> <!-- /decription --> 925 926 </div> <!-- /apiItem --> 927 928 </div> <!-- /apiGroup --> 929 930 <!-- TYPES --> 931 <div class="apiGroup" style="display: none; "> 932 <a name="types"></a> 933 <h3 id="types">Types</h3> 934 935 <!-- iterates over all types --> 936 <div class="apiItem"> 937 <a></a> 938 <h4>type name</h4> 939 940 <div> 941 </div> 942 943 </div> <!-- /apiItem --> 944 945 </div> <!-- /apiGroup --> 946 947 </div> <!-- /apiPage --> 948 </div> <!-- /gc-pagecontent --> 949 </div> <!-- /g-section --> 950 </div> <!-- /codesiteContent --> 951 <div id="gc-footer" --=""> 952 <div class="text"> 953 <p> 954 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 955 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 956 Attribution 3.0 License</a>, and code samples are licensed under the 957 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 958 </p> 959 <p> 960 ©2010 Google 961 </p> 962 963<!-- begin analytics --> 964<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 965<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 966 967<script type="text/javascript"> 968 // chrome doc tracking 969 try { 970 var engdocs = _gat._getTracker("YT-10763712-2"); 971 engdocs._trackPageview(); 972 } catch(err) {} 973 974 // code.google.com site-wide tracking 975 try { 976 _uacct="UA-18071-1"; 977 _uanchor=1; 978 _uff=0; 979 urchinTracker(); 980 } 981 catch(e) {/* urchinTracker not available. */} 982</script> 983<!-- end analytics --> 984 </div> 985 </div> <!-- /gc-footer --> 986 </div> <!-- /gc-container --> 987</body></html> 988
