Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(238)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.app.html

Issue 7187023: Adding an experimental app notification API. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: fixing clang errors Created 9 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(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>Experimental App APIs - 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_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&amp;t13n_langs=en"></script>
136 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&amp;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">Experimental App APIs</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.experimental.app</ 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-clearAllNotifications">clearAllNotifica tions</a>
284 </li><li>
285 <a href="#method-notify">notify</a>
286 </li><li>
287 <a href="#method-resetLaunchIcon">resetLaunchIcon</a>
288 </li><li>
289 <a href="#method-setLaunchIcon">setLaunchIcon</a>
290 </li>
291 </ol>
292 </li>
293 <li style="display: none; ">
294 <a>Events</a>
295 <ol>
296 <li>
297 <a href="#event-anchor">eventName</a>
298 </li>
299 </ol>
300 </li>
301 <li style="display: none; ">
302 <a href="#types">Types</a>
303 <ol>
304 <li>
305 <a href="#id-anchor">id</a>
306 </li>
307 </ol>
308 </li>
309 </ol>
310 </li>
311 </ol>
312 </div>
313 <!-- /TABLE OF CONTENTS -->
314
315 <!-- Standard content lead-in for experimental API pages -->
316 <p id="classSummary" style="display: none; ">
317 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
318 </p>
319
320 <!-- STATIC CONTENT PLACEHOLDER -->
321 <div id="static"><div id="pageData-name" class="pageData">Experimental A pp APIs</div>
322
323 <!-- BEGIN AUTHORED CONTENT -->
324 <p>The current methods allow applications to generate passive notifications.</p>
325 <!-- END AUTHORED CONTENT -->
326 </div>
327
328 <!-- API PAGE -->
329 <div class="apiPage">
330 <a name="apiReference"></a>
331 <h2>API reference: chrome.experimental.app</h2>
332
333 <!-- PROPERTIES -->
334 <div class="apiGroup" style="display: none; ">
335 <a name="properties"></a>
336 <h3 id="properties">Properties</h3>
337
338 <div>
339 <a></a>
340 <h4>getLastError</h4>
341 <div class="summary">
342 <!-- Note: intentionally longer 80 columns -->
343 <span>chrome.extension</span><span>lastError</span>
344 </div>
345 <div>
346 </div>
347 </div>
348
349 </div> <!-- /apiGroup -->
350
351 <!-- METHODS -->
352 <div id="methodsTemplate" class="apiGroup">
353 <a name="global-methods"></a>
354 <h3>Methods</h3>
355
356 <!-- iterates over all functions -->
357 <div class="apiItem">
358 <a name="method-clearAllNotifications"></a> <!-- method-anchor -->
359 <h4>clearAllNotifications</h4>
360
361 <div class="summary"><span style="display: none; ">void</span>
362 <!-- Note: intentionally longer 80 columns -->
363 <span>chrome.experimental.app.clearAllNotifications</span>(<sp an class="optional"><span style="display: none; ">, </span><span>function</span>
364 <var><span>callback</span></var></span>)</div>
365
366 <div class="description">
367 <p class="todo" style="display: none; ">Undocumented.</p>
368 <p>Clears all previously sent notifications.</p>
369
370 <!-- PARAMETERS -->
371 <h4>Parameters</h4>
372 <dl>
373 <div>
374 <div>
375 <dt>
376 <var>callback</var>
377 <em>
378
379 <!-- TYPE -->
380 <div style="display:inline">
381 (
382 <span class="optional">optional</span>
383 <span class="enum" style="display: none; ">enumerated</span>
384 <span id="typeTemplate">
385 <span style="display: none; ">
386 <a> Type</a>
387 </span>
388 <span>
389 <span style="display: none; ">
390 array of <span><span></span></span>
391 </span>
392 <span>function</span>
393 <span style="display: none; "></span>
394 </span>
395 </span>
396 )
397 </div>
398
399 </em>
400 </dt>
401 <dd class="todo" style="display: none; ">
402 Undocumented.
403 </dd>
404 <dd>A callback when the function is complete. Any errors will be repor ted in <a href="extension.html#property-lastError">chrome.extension.lastError</a >.</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>
442 </dl>
443
444 <!-- RETURNS -->
445 <h4 style="display: none; ">Returns</h4>
446 <dl>
447 <div style="display: none; ">
448 <div>
449 </div>
450 </div>
451 </dl>
452
453 <!-- CALLBACK -->
454 <div>
455 <div>
456 <h4>Callback function</h4>
457 <p style="display: none; ">
458 The callback <em>parameter</em> should specify a function
459 that looks like this:
460 </p>
461 <p>
462 If you specify the <em>callback</em> parameter, it should
463 specify a function that looks like this:
464 </p>
465
466 <!-- Note: intentionally longer 80 columns -->
467 <pre>function(<span>null</span>) <span class="subdued">{...}</ span>;</pre>
468 <dl>
469 <div style="display: none; ">
470 <div>
471 </div>
472 </div>
473 </dl>
474 </div>
475 </div>
476
477 <!-- MIN_VERSION -->
478 <p style="display: none; ">
479 This function was added in version <b><span></span></b>.
480 If you require this function, the manifest key
481 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
482 can ensure that your extension won't be run in an earlier brow ser version.
483 </p>
484 </div> <!-- /description -->
485
486 </div><div class="apiItem">
487 <a name="method-notify"></a> <!-- method-anchor -->
488 <h4>notify</h4>
489
490 <div class="summary"><span style="display: none; ">void</span>
491 <!-- Note: intentionally longer 80 columns -->
492 <span>chrome.experimental.app.notify</span>(<span class="null" ><span style="display: none; ">, </span><span>object</span>
493 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
494 <var><span>callback</span></var></span>)</div>
495
496 <div class="description">
497 <p class="todo" style="display: none; ">Undocumented.</p>
498 <p>Creates a notification from this app.</p>
499
500 <!-- PARAMETERS -->
501 <h4>Parameters</h4>
502 <dl>
503 <div>
504 <div>
505 <dt>
506 <var>details</var>
507 <em>
508
509 <!-- TYPE -->
510 <div style="display:inline">
511 (
512 <span class="optional" style="display: none; ">optional</spa n>
513 <span class="enum" style="display: none; ">enumerated</span>
514 <span id="typeTemplate">
515 <span style="display: none; ">
516 <a> Type</a>
517 </span>
518 <span>
519 <span style="display: none; ">
520 array of <span><span></span></span>
521 </span>
522 <span>object</span>
523 <span style="display: none; "></span>
524 </span>
525 </span>
526 )
527 </div>
528
529 </em>
530 </dt>
531 <dd class="todo">
532 Undocumented.
533 </dd>
534 <dd style="display: none; ">
535 Description of this parameter from the json schema.
536 </dd>
537 <dd style="display: none; ">
538 This parameter was added in version
539 <b><span></span></b>.
540 You must omit this parameter in earlier versions,
541 and you may omit it in any version. If you require this
542 parameter, the manifest key
543 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
544 can ensure that your extension won't be run in an earlier browser ve rsion.
545 </dd>
546
547 <!-- OBJECT PROPERTIES -->
548 <dd>
549 <dl>
550 <div>
551 <div>
552 <dt>
553 <var>passive</var>
554 <em>
555
556 <!-- TYPE -->
557 <div style="display:inline">
558 (
559 <span class="optional">optional</span>
560 <span class="enum" style="display: none; ">enumerated</span>
561 <span id="typeTemplate">
562 <span style="display: none; ">
563 <a> Type</a>
564 </span>
565 <span>
566 <span style="display: none; ">
567 array of <span><span></span></span>
568 </span>
569 <span>boolean</span>
570 <span style="display: none; "></span>
571 </span>
572 </span>
573 )
574 </div>
575
576 </em>
577 </dt>
578 <dd class="todo" style="display: none; ">
579 Undocumented.
580 </dd>
581 <dd>Whether the notification should be passive (true) or active (false ). The default value is true.</dd>
582 <dd style="display: none; ">
583 This parameter was added in version
584 <b><span></span></b>.
585 You must omit this parameter in earlier versions,
586 and you may omit it in any version. If you require this
587 parameter, the manifest key
588 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
589 can ensure that your extension won't be run in an earlier browser ve rsion.
590 </dd>
591
592 <!-- OBJECT PROPERTIES -->
593 <dd style="display: none; ">
594 <dl>
595 <div>
596 <div>
597 </div>
598 </div>
599 </dl>
600 </dd>
601
602 <!-- OBJECT METHODS -->
603 <dd style="display: none; ">
604 <div></div>
605 </dd>
606
607 <!-- OBJECT EVENT FIELDS -->
608 <dd style="display: none; ">
609 <div></div>
610 </dd>
611
612 <!-- FUNCTION PARAMETERS -->
613 <dd style="display: none; ">
614 <div></div>
615 </dd>
616
617 </div>
618 </div><div>
619 <div>
620 <dt>
621 <var>title</var>
622 <em>
623
624 <!-- TYPE -->
625 <div style="display:inline">
626 (
627 <span class="optional">optional</span>
628 <span class="enum" style="display: none; ">enumerated</span>
629 <span id="typeTemplate">
630 <span style="display: none; ">
631 <a> Type</a>
632 </span>
633 <span>
634 <span style="display: none; ">
635 array of <span><span></span></span>
636 </span>
637 <span>string</span>
638 <span style="display: none; "></span>
639 </span>
640 </span>
641 )
642 </div>
643
644 </em>
645 </dt>
646 <dd class="todo" style="display: none; ">
647 Undocumented.
648 </dd>
649 <dd>The title of the notification.</dd>
650 <dd style="display: none; ">
651 This parameter was added in version
652 <b><span></span></b>.
653 You must omit this parameter in earlier versions,
654 and you may omit it in any version. If you require this
655 parameter, the manifest key
656 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
657 can ensure that your extension won't be run in an earlier browser ve rsion.
658 </dd>
659
660 <!-- OBJECT PROPERTIES -->
661 <dd style="display: none; ">
662 <dl>
663 <div>
664 <div>
665 </div>
666 </div>
667 </dl>
668 </dd>
669
670 <!-- OBJECT METHODS -->
671 <dd style="display: none; ">
672 <div></div>
673 </dd>
674
675 <!-- OBJECT EVENT FIELDS -->
676 <dd style="display: none; ">
677 <div></div>
678 </dd>
679
680 <!-- FUNCTION PARAMETERS -->
681 <dd style="display: none; ">
682 <div></div>
683 </dd>
684
685 </div>
686 </div><div>
687 <div>
688 <dt>
689 <var>bodyText</var>
690 <em>
691
692 <!-- TYPE -->
693 <div style="display:inline">
694 (
695 <span class="optional">optional</span>
696 <span class="enum" style="display: none; ">enumerated</span>
697 <span id="typeTemplate">
698 <span style="display: none; ">
699 <a> Type</a>
700 </span>
701 <span>
702 <span style="display: none; ">
703 array of <span><span></span></span>
704 </span>
705 <span>string</span>
706 <span style="display: none; "></span>
707 </span>
708 </span>
709 )
710 </div>
711
712 </em>
713 </dt>
714 <dd class="todo" style="display: none; ">
715 Undocumented.
716 </dd>
717 <dd>The text content of the notification.</dd>
718 <dd style="display: none; ">
719 This parameter was added in version
720 <b><span></span></b>.
721 You must omit this parameter in earlier versions,
722 and you may omit it in any version. If you require this
723 parameter, the manifest key
724 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
725 can ensure that your extension won't be run in an earlier browser ve rsion.
726 </dd>
727
728 <!-- OBJECT PROPERTIES -->
729 <dd style="display: none; ">
730 <dl>
731 <div>
732 <div>
733 </div>
734 </div>
735 </dl>
736 </dd>
737
738 <!-- OBJECT METHODS -->
739 <dd style="display: none; ">
740 <div></div>
741 </dd>
742
743 <!-- OBJECT EVENT FIELDS -->
744 <dd style="display: none; ">
745 <div></div>
746 </dd>
747
748 <!-- FUNCTION PARAMETERS -->
749 <dd style="display: none; ">
750 <div></div>
751 </dd>
752
753 </div>
754 </div><div>
755 <div>
756 <dt>
757 <var>linkUrl</var>
758 <em>
759
760 <!-- TYPE -->
761 <div style="display:inline">
762 (
763 <span class="optional">optional</span>
764 <span class="enum" style="display: none; ">enumerated</span>
765 <span id="typeTemplate">
766 <span style="display: none; ">
767 <a> Type</a>
768 </span>
769 <span>
770 <span style="display: none; ">
771 array of <span><span></span></span>
772 </span>
773 <span>string</span>
774 <span style="display: none; "></span>
775 </span>
776 </span>
777 )
778 </div>
779
780 </em>
781 </dt>
782 <dd class="todo" style="display: none; ">
783 Undocumented.
784 </dd>
785 <dd>The URL for an optional link to show along with the notification. If you specify a linkUrl, you must also specify a value for linkText.</dd>
786 <dd style="display: none; ">
787 This parameter was added in version
788 <b><span></span></b>.
789 You must omit this parameter in earlier versions,
790 and you may omit it in any version. If you require this
791 parameter, the manifest key
792 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
793 can ensure that your extension won't be run in an earlier browser ve rsion.
794 </dd>
795
796 <!-- OBJECT PROPERTIES -->
797 <dd style="display: none; ">
798 <dl>
799 <div>
800 <div>
801 </div>
802 </div>
803 </dl>
804 </dd>
805
806 <!-- OBJECT METHODS -->
807 <dd style="display: none; ">
808 <div></div>
809 </dd>
810
811 <!-- OBJECT EVENT FIELDS -->
812 <dd style="display: none; ">
813 <div></div>
814 </dd>
815
816 <!-- FUNCTION PARAMETERS -->
817 <dd style="display: none; ">
818 <div></div>
819 </dd>
820
821 </div>
822 </div><div>
823 <div>
824 <dt>
825 <var>linkText</var>
826 <em>
827
828 <!-- TYPE -->
829 <div style="display:inline">
830 (
831 <span class="optional">optional</span>
832 <span class="enum" style="display: none; ">enumerated</span>
833 <span id="typeTemplate">
834 <span style="display: none; ">
835 <a> Type</a>
836 </span>
837 <span>
838 <span style="display: none; ">
839 array of <span><span></span></span>
840 </span>
841 <span>string</span>
842 <span style="display: none; "></span>
843 </span>
844 </span>
845 )
846 </div>
847
848 </em>
849 </dt>
850 <dd class="todo" style="display: none; ">
851 Undocumented.
852 </dd>
853 <dd>If a linkUrl is provided, this is required and will be used as the linkified text. It should be relatively short.</dd>
854 <dd style="display: none; ">
855 This parameter was added in version
856 <b><span></span></b>.
857 You must omit this parameter in earlier versions,
858 and you may omit it in any version. If you require this
859 parameter, the manifest key
860 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
861 can ensure that your extension won't be run in an earlier browser ve rsion.
862 </dd>
863
864 <!-- OBJECT PROPERTIES -->
865 <dd style="display: none; ">
866 <dl>
867 <div>
868 <div>
869 </div>
870 </div>
871 </dl>
872 </dd>
873
874 <!-- OBJECT METHODS -->
875 <dd style="display: none; ">
876 <div></div>
877 </dd>
878
879 <!-- OBJECT EVENT FIELDS -->
880 <dd style="display: none; ">
881 <div></div>
882 </dd>
883
884 <!-- FUNCTION PARAMETERS -->
885 <dd style="display: none; ">
886 <div></div>
887 </dd>
888
889 </div>
890 </div><div>
891 <div>
892 <dt>
893 <var>iconData</var>
894 <em>
895
896 <!-- TYPE -->
897 <div style="display:inline">
898 (
899 <span class="optional">optional</span>
900 <span class="enum" style="display: none; ">enumerated</span>
901 <span id="typeTemplate">
902 <span style="display: none; ">
903 <a> Type</a>
904 </span>
905 <span>
906 <span style="display: none; ">
907 array of <span><span></span></span>
908 </span>
909 <span>ImageData</span>
910 <span style="display: none; "></span>
911 </span>
912 </span>
913 )
914 </div>
915
916 </em>
917 </dt>
918 <dd class="todo" style="display: none; ">
919 Undocumented.
920 </dd>
921 <dd>Pixel data for an image to use as the icon for this notification. Must be an ImageData object (for example, from a canvas element).</dd>
922 <dd style="display: none; ">
923 This parameter was added in version
924 <b><span></span></b>.
925 You must omit this parameter in earlier versions,
926 and you may omit it in any version. If you require this
927 parameter, the manifest key
928 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
929 can ensure that your extension won't be run in an earlier browser ve rsion.
930 </dd>
931
932 <!-- OBJECT PROPERTIES -->
933 <dd>
934 <dl>
935 <div style="display: none; ">
936 <div>
937 </div>
938 </div>
939 </dl>
940 </dd>
941
942 <!-- OBJECT METHODS -->
943 <dd style="display: none; ">
944 <div></div>
945 </dd>
946
947 <!-- OBJECT EVENT FIELDS -->
948 <dd style="display: none; ">
949 <div></div>
950 </dd>
951
952 <!-- FUNCTION PARAMETERS -->
953 <dd style="display: none; ">
954 <div></div>
955 </dd>
956
957 </div>
958 </div>
959 </dl>
960 </dd>
961
962 <!-- OBJECT METHODS -->
963 <dd style="display: none; ">
964 <div></div>
965 </dd>
966
967 <!-- OBJECT EVENT FIELDS -->
968 <dd style="display: none; ">
969 <div></div>
970 </dd>
971
972 <!-- FUNCTION PARAMETERS -->
973 <dd style="display: none; ">
974 <div></div>
975 </dd>
976
977 </div>
978 </div><div>
979 <div>
980 <dt>
981 <var>callback</var>
982 <em>
983
984 <!-- TYPE -->
985 <div style="display:inline">
986 (
987 <span class="optional">optional</span>
988 <span class="enum" style="display: none; ">enumerated</span>
989 <span id="typeTemplate">
990 <span style="display: none; ">
991 <a> Type</a>
992 </span>
993 <span>
994 <span style="display: none; ">
995 array of <span><span></span></span>
996 </span>
997 <span>function</span>
998 <span style="display: none; "></span>
999 </span>
1000 </span>
1001 )
1002 </div>
1003
1004 </em>
1005 </dt>
1006 <dd class="todo" style="display: none; ">
1007 Undocumented.
1008 </dd>
1009 <dd>A callback when the function is complete. Any errors will be repor ted in <a href="extension.html#property-lastError">chrome.extension.lastError</a >.</dd>
1010 <dd style="display: none; ">
1011 This parameter was added in version
1012 <b><span></span></b>.
1013 You must omit this parameter in earlier versions,
1014 and you may omit it in any version. If you require this
1015 parameter, the manifest key
1016 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1017 can ensure that your extension won't be run in an earlier browser ve rsion.
1018 </dd>
1019
1020 <!-- OBJECT PROPERTIES -->
1021 <dd style="display: none; ">
1022 <dl>
1023 <div>
1024 <div>
1025 </div>
1026 </div>
1027 </dl>
1028 </dd>
1029
1030 <!-- OBJECT METHODS -->
1031 <dd style="display: none; ">
1032 <div></div>
1033 </dd>
1034
1035 <!-- OBJECT EVENT FIELDS -->
1036 <dd style="display: none; ">
1037 <div></div>
1038 </dd>
1039
1040 <!-- FUNCTION PARAMETERS -->
1041 <dd style="display: none; ">
1042 <div></div>
1043 </dd>
1044
1045 </div>
1046 </div>
1047 </dl>
1048
1049 <!-- RETURNS -->
1050 <h4 style="display: none; ">Returns</h4>
1051 <dl>
1052 <div style="display: none; ">
1053 <div>
1054 </div>
1055 </div>
1056 </dl>
1057
1058 <!-- CALLBACK -->
1059 <div>
1060 <div>
1061 <h4>Callback function</h4>
1062 <p style="display: none; ">
1063 The callback <em>parameter</em> should specify a function
1064 that looks like this:
1065 </p>
1066 <p>
1067 If you specify the <em>callback</em> parameter, it should
1068 specify a function that looks like this:
1069 </p>
1070
1071 <!-- Note: intentionally longer 80 columns -->
1072 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1073 <dl>
1074 <div style="display: none; ">
1075 <div>
1076 </div>
1077 </div>
1078 </dl>
1079 </div>
1080 </div>
1081
1082 <!-- MIN_VERSION -->
1083 <p style="display: none; ">
1084 This function was added in version <b><span></span></b>.
1085 If you require this function, the manifest key
1086 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1087 can ensure that your extension won't be run in an earlier brow ser version.
1088 </p>
1089 </div> <!-- /description -->
1090
1091 </div><div class="apiItem">
1092 <a name="method-resetLaunchIcon"></a> <!-- method-anchor -->
1093 <h4>resetLaunchIcon</h4>
1094
1095 <div class="summary"><span style="display: none; ">void</span>
1096 <!-- Note: intentionally longer 80 columns -->
1097 <span>chrome.experimental.app.resetLaunchIcon</span>(<span cla ss="optional"><span style="display: none; ">, </span><span>function</span>
1098 <var><span>callback</span></var></span>)</div>
1099
1100 <div class="description">
1101 <p class="todo" style="display: none; ">Undocumented.</p>
1102 <p>Resets the app's launch icon to its default value as specifie d in the manifest.json file.</p>
1103
1104 <!-- PARAMETERS -->
1105 <h4>Parameters</h4>
1106 <dl>
1107 <div>
1108 <div>
1109 <dt>
1110 <var>callback</var>
1111 <em>
1112
1113 <!-- TYPE -->
1114 <div style="display:inline">
1115 (
1116 <span class="optional">optional</span>
1117 <span class="enum" style="display: none; ">enumerated</span>
1118 <span id="typeTemplate">
1119 <span style="display: none; ">
1120 <a> Type</a>
1121 </span>
1122 <span>
1123 <span style="display: none; ">
1124 array of <span><span></span></span>
1125 </span>
1126 <span>function</span>
1127 <span style="display: none; "></span>
1128 </span>
1129 </span>
1130 )
1131 </div>
1132
1133 </em>
1134 </dt>
1135 <dd class="todo" style="display: none; ">
1136 Undocumented.
1137 </dd>
1138 <dd>A callback when the function is complete. Any errors will be repor ted in <a href="extension.html#property-lastError">chrome.extension.lastError</a >.</dd>
1139 <dd style="display: none; ">
1140 This parameter was added in version
1141 <b><span></span></b>.
1142 You must omit this parameter in earlier versions,
1143 and you may omit it in any version. If you require this
1144 parameter, the manifest key
1145 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1146 can ensure that your extension won't be run in an earlier browser ve rsion.
1147 </dd>
1148
1149 <!-- OBJECT PROPERTIES -->
1150 <dd style="display: none; ">
1151 <dl>
1152 <div>
1153 <div>
1154 </div>
1155 </div>
1156 </dl>
1157 </dd>
1158
1159 <!-- OBJECT METHODS -->
1160 <dd style="display: none; ">
1161 <div></div>
1162 </dd>
1163
1164 <!-- OBJECT EVENT FIELDS -->
1165 <dd style="display: none; ">
1166 <div></div>
1167 </dd>
1168
1169 <!-- FUNCTION PARAMETERS -->
1170 <dd style="display: none; ">
1171 <div></div>
1172 </dd>
1173
1174 </div>
1175 </div>
1176 </dl>
1177
1178 <!-- RETURNS -->
1179 <h4 style="display: none; ">Returns</h4>
1180 <dl>
1181 <div style="display: none; ">
1182 <div>
1183 </div>
1184 </div>
1185 </dl>
1186
1187 <!-- CALLBACK -->
1188 <div>
1189 <div>
1190 <h4>Callback function</h4>
1191 <p style="display: none; ">
1192 The callback <em>parameter</em> should specify a function
1193 that looks like this:
1194 </p>
1195 <p>
1196 If you specify the <em>callback</em> parameter, it should
1197 specify a function that looks like this:
1198 </p>
1199
1200 <!-- Note: intentionally longer 80 columns -->
1201 <pre>function(<span>null</span>) <span class="subdued">{...}</ span>;</pre>
1202 <dl>
1203 <div style="display: none; ">
1204 <div>
1205 </div>
1206 </div>
1207 </dl>
1208 </div>
1209 </div>
1210
1211 <!-- MIN_VERSION -->
1212 <p style="display: none; ">
1213 This function was added in version <b><span></span></b>.
1214 If you require this function, the manifest key
1215 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1216 can ensure that your extension won't be run in an earlier brow ser version.
1217 </p>
1218 </div> <!-- /description -->
1219
1220 </div><div class="apiItem">
1221 <a name="method-setLaunchIcon"></a> <!-- method-anchor -->
1222 <h4>setLaunchIcon</h4>
1223
1224 <div class="summary"><span style="display: none; ">void</span>
1225 <!-- Note: intentionally longer 80 columns -->
1226 <span>chrome.experimental.app.setLaunchIcon</span>(<span class ="optional"><span style="display: none; ">, </span><span>ImageData</span>
1227 <var><span>iconData</span></var></span><span class="option al"><span>, </span><span>function</span>
1228 <var><span>callback</span></var></span>)</div>
1229
1230 <div class="description">
1231 <p class="todo" style="display: none; ">Undocumented.</p>
1232 <p style="display: none; ">
1233 A description from the json schema def of the function goes he re.
1234 </p>
1235
1236 <!-- PARAMETERS -->
1237 <h4>Parameters</h4>
1238 <dl>
1239 <div>
1240 <div>
1241 <dt>
1242 <var>iconData</var>
1243 <em>
1244
1245 <!-- TYPE -->
1246 <div style="display:inline">
1247 (
1248 <span class="optional">optional</span>
1249 <span class="enum" style="display: none; ">enumerated</span>
1250 <span id="typeTemplate">
1251 <span style="display: none; ">
1252 <a> Type</a>
1253 </span>
1254 <span>
1255 <span style="display: none; ">
1256 array of <span><span></span></span>
1257 </span>
1258 <span>ImageData</span>
1259 <span style="display: none; "></span>
1260 </span>
1261 </span>
1262 )
1263 </div>
1264
1265 </em>
1266 </dt>
1267 <dd class="todo" style="display: none; ">
1268 Undocumented.
1269 </dd>
1270 <dd>Pixel data for an image to replace the launch icon on the New Tab Page. Must be an ImageData object (for example, from a canvas element). See http ://code.google.com/chrome/webstore/docs/images.html for more details.</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>
1283 <dl>
1284 <div style="display: none; ">
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><div>
1308 <div>
1309 <dt>
1310 <var>callback</var>
1311 <em>
1312
1313 <!-- TYPE -->
1314 <div style="display:inline">
1315 (
1316 <span class="optional">optional</span>
1317 <span class="enum" style="display: none; ">enumerated</span>
1318 <span id="typeTemplate">
1319 <span style="display: none; ">
1320 <a> Type</a>
1321 </span>
1322 <span>
1323 <span style="display: none; ">
1324 array of <span><span></span></span>
1325 </span>
1326 <span>function</span>
1327 <span style="display: none; "></span>
1328 </span>
1329 </span>
1330 )
1331 </div>
1332
1333 </em>
1334 </dt>
1335 <dd class="todo" style="display: none; ">
1336 Undocumented.
1337 </dd>
1338 <dd>A callback when the function is complete. Any errors will be repor ted in <a href="extension.html#property-lastError">chrome.extension.lastError</a >.</dd>
1339 <dd style="display: none; ">
1340 This parameter was added in version
1341 <b><span></span></b>.
1342 You must omit this parameter in earlier versions,
1343 and you may omit it in any version. If you require this
1344 parameter, the manifest key
1345 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1346 can ensure that your extension won't be run in an earlier browser ve rsion.
1347 </dd>
1348
1349 <!-- OBJECT PROPERTIES -->
1350 <dd style="display: none; ">
1351 <dl>
1352 <div>
1353 <div>
1354 </div>
1355 </div>
1356 </dl>
1357 </dd>
1358
1359 <!-- OBJECT METHODS -->
1360 <dd style="display: none; ">
1361 <div></div>
1362 </dd>
1363
1364 <!-- OBJECT EVENT FIELDS -->
1365 <dd style="display: none; ">
1366 <div></div>
1367 </dd>
1368
1369 <!-- FUNCTION PARAMETERS -->
1370 <dd style="display: none; ">
1371 <div></div>
1372 </dd>
1373
1374 </div>
1375 </div>
1376 </dl>
1377
1378 <!-- RETURNS -->
1379 <h4 style="display: none; ">Returns</h4>
1380 <dl>
1381 <div style="display: none; ">
1382 <div>
1383 </div>
1384 </div>
1385 </dl>
1386
1387 <!-- CALLBACK -->
1388 <div>
1389 <div>
1390 <h4>Callback function</h4>
1391 <p style="display: none; ">
1392 The callback <em>parameter</em> should specify a function
1393 that looks like this:
1394 </p>
1395 <p>
1396 If you specify the <em>callback</em> parameter, it should
1397 specify a function that looks like this:
1398 </p>
1399
1400 <!-- Note: intentionally longer 80 columns -->
1401 <pre>function(<span>null</span>) <span class="subdued">{...}</ span>;</pre>
1402 <dl>
1403 <div style="display: none; ">
1404 <div>
1405 </div>
1406 </div>
1407 </dl>
1408 </div>
1409 </div>
1410
1411 <!-- MIN_VERSION -->
1412 <p style="display: none; ">
1413 This function was added in version <b><span></span></b>.
1414 If you require this function, the manifest key
1415 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1416 can ensure that your extension won't be run in an earlier brow ser version.
1417 </p>
1418 </div> <!-- /description -->
1419
1420 </div> <!-- /apiItem -->
1421
1422 </div> <!-- /apiGroup -->
1423
1424 <!-- EVENTS -->
1425 <div id="eventsTemplate" class="apiGroup" style="display: none; ">
1426 <a></a>
1427 <h3>Events</h3>
1428 <!-- iterates over all events -->
1429 <div class="apiItem">
1430 <a></a>
1431 <h4>event name</h4>
1432
1433 <div class="summary">
1434 <!-- Note: intentionally longer 80 columns -->
1435 <span class="subdued">chrome.bookmarks</span><span>onEvent</span ><span class="subdued">.addListener</span>(function(<span>Type param1, Type para m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p aram2</span>));
1436 </div>
1437
1438 <div class="description">
1439 <p class="todo">Undocumented.</p>
1440 <p>
1441 A description from the json schema def of the event goes here.
1442 </p>
1443
1444 <!-- LISTENER PARAMETERS -->
1445 <div>
1446 <h4>Listener parameters</h4>
1447 <dl>
1448 <div>
1449 <div>
1450 </div>
1451 </div>
1452 </dl>
1453 </div>
1454
1455 <!-- EXTRA PARAMETERS -->
1456 <div>
1457 <h4>Extra parameters to addListener</h4>
1458 <dl>
1459 <div>
1460 <div>
1461 </div>
1462 </div>
1463 </dl>
1464 </div>
1465
1466 <!-- LISTENER RETURN VALUE -->
1467 <h4>Listener returns</h4>
1468 <dl>
1469 <div>
1470 <div>
1471 </div>
1472 </div>
1473 </dl>
1474
1475 </div> <!-- /description -->
1476 </div> <!-- /apiItem -->
1477
1478 </div> <!-- /apiGroup -->
1479
1480 <!-- TYPES -->
1481 <div class="apiGroup" style="display: none; ">
1482 <a name="types"></a>
1483 <h3 id="types">Types</h3>
1484
1485 <!-- iterates over all types -->
1486 <div class="apiItem">
1487 <a></a>
1488 <h4>type name</h4>
1489
1490 <div>
1491 </div>
1492
1493 </div> <!-- /apiItem -->
1494
1495 </div> <!-- /apiGroup -->
1496
1497 </div> <!-- /apiPage -->
1498 </div> <!-- /gc-pagecontent -->
1499 </div> <!-- /g-section -->
1500 </div> <!-- /codesiteContent -->
1501 <div id="gc-footer" --="">
1502 <div class="text">
1503 <p>
1504 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1505 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1506 Attribution 3.0 License</a>, and code samples are licensed under the
1507 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1508 </p>
1509 <p>
1510 ©2011 Google
1511 </p>
1512
1513 <!-- begin analytics -->
1514 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
1515 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
1516
1517 <script type="text/javascript">
1518 // chrome doc tracking
1519 try {
1520 var engdocs = _gat._getTracker("YT-10763712-2");
1521 engdocs._trackPageview();
1522 } catch(err) {}
1523
1524 // code.google.com site-wide tracking
1525 try {
1526 _uacct="UA-18071-1";
1527 _uanchor=1;
1528 _uff=0;
1529 urchinTracker();
1530 }
1531 catch(e) {/* urchinTracker not available. */}
1532 </script>
1533 <!-- end analytics -->
1534 </div>
1535 </div> <!-- /gc-footer -->
1536 </div> <!-- /gc-container -->
1537 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698