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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/scriptBadge.html

Issue 10695070: Implement scriptBadge.requestToAct. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 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
« chrome/common/extensions/docs/extensions/scriptBadge.html ('K') | « chrome/common/extensions/docs/samples.json ('k') | chrome/common/extensions/extension.h » ('j') | chrome/common/extensions/extension.h » ('J')
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="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <meta name="description" content="Documentation for the chrome.scriptBadge mod ule, which is part of the Google Chrome extension APIs."><title>chrome.scriptBa dge - Google Chrome Extensions - Google Code</title></head>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <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>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">chrome.scriptBadge</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#apiReference">API reference: chrome.scriptBadge</a>
196 <ol>
197 <li>
198 <a href="#global-methods">Methods</a>
199 <ol>
200 <li>
201 <a href="#method-getPopup">getPopup</a>
202 </li><li>
203 <a href="#method-setPopup">setPopup</a>
204 </li>
205 </ol>
206 </li>
207 <li>
208 <a href="#global-events">Events</a>
209 <ol>
210 <li>
211 <a href="#event-onClicked">onClicked</a>
212 </li>
213 </ol>
214 </li>
215 </ol>
216 </li>
217 </ol>
218 </div>
219 <!-- /TABLE OF CONTENTS -->
220 <!-- Standard content lead-in for experimental API pages -->
221 <!-- STATIC CONTENT PLACEHOLDER -->
222 <div id="static"></div>
223 <!-- API PAGE -->
224 <div class="apiPage">
225 <a name="apiReference"></a>
226 <h2>API reference: chrome.scriptBadge</h2>
227 <!-- PROPERTIES -->
228 <!-- /apiGroup -->
229 <!-- METHODS -->
230 <div id="methodsTemplate" class="apiGroup">
231 <a name="global-methods"></a>
232 <h3>Methods</h3>
233 <!-- iterates over all functions -->
234 <div class="apiItem">
235 <a name="method-getPopup"></a> <!-- method-anchor -->
236 <h4>getPopup</h4>
237 <div class="summary">
238 <!-- Note: intentionally longer 80 columns -->
239 <span>chrome.scriptBadge.getPopup</span>(<span class="null"><s pan>object</span>
240 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
241 <var><span>callback</span></var></span>)</div>
242 <div class="description">
243 <p>Gets the html document set as the popup for this script badge .</p>
244 <!-- PARAMETERS -->
245 <h4>Parameters</h4>
246 <dl>
247 <div>
248 <div>
249 <dt>
250 <var>details</var>
251 <em>
252 <!-- TYPE -->
253 <div style="display:inline">
254 (
255 <span id="typeTemplate">
256 <span>
257 <span>object</span>
258 </span>
259 </span>
260 )
261 </div>
262 </em>
263 </dt>
264 <dd class="todo">
265 Undocumented.
266 </dd>
267 <!-- OBJECT PROPERTIES -->
268 <dd>
269 <dl>
270 <div>
271 <div>
272 <dt>
273 <var>tabId</var>
274 <em>
275 <!-- TYPE -->
276 <div style="display:inline">
277 (
278 <span id="typeTemplate">
279 <span>
280 <span>integer</span>
281 </span>
282 </span>
283 )
284 </div>
285 </em>
286 </dt>
287 <dd>Specify the tab to get the popup from.</dd>
288 <!-- OBJECT PROPERTIES -->
289 <!-- OBJECT METHODS -->
290 <!-- OBJECT EVENT FIELDS -->
291 <!-- FUNCTION PARAMETERS -->
292 </div>
293 </div>
294 </dl>
295 </dd>
296 <!-- OBJECT METHODS -->
297 <!-- OBJECT EVENT FIELDS -->
298 <!-- FUNCTION PARAMETERS -->
299 </div>
300 </div><div>
301 <div>
302 <dt>
303 <var>callback</var>
304 <em>
305 <!-- TYPE -->
306 <div style="display:inline">
307 (
308 <span id="typeTemplate">
309 <span>
310 <span>function</span>
311 </span>
312 </span>
313 )
314 </div>
315 </em>
316 </dt>
317 <dd class="todo">
318 Undocumented.
319 </dd>
320 <!-- OBJECT PROPERTIES -->
321 <!-- OBJECT METHODS -->
322 <!-- OBJECT EVENT FIELDS -->
323 <!-- FUNCTION PARAMETERS -->
324 </div>
325 </div>
326 </dl>
327 <!-- RETURNS -->
328 <dl>
329 </dl>
330 <!-- CALLBACK -->
331 <div>
332 <div>
333 <h4>Callback function</h4>
334 <p>
335 The <em>callback</em> parameter should specify a function
336 that looks like this:
337 </p>
338 <!-- Note: intentionally longer 80 columns -->
339 <pre>function(<span>string result</span>) <span class="subdued ">{...}</span>;</pre>
340 <dl>
341 <div>
342 <div>
343 <dt>
344 <var>result</var>
345 <em>
346 <!-- TYPE -->
347 <div style="display:inline">
348 (
349 <span id="typeTemplate">
350 <span>
351 <span>string</span>
352 </span>
353 </span>
354 )
355 </div>
356 </em>
357 </dt>
358 <dd class="todo">
359 Undocumented.
360 </dd>
361 <!-- OBJECT PROPERTIES -->
362 <!-- OBJECT METHODS -->
363 <!-- OBJECT EVENT FIELDS -->
364 <!-- FUNCTION PARAMETERS -->
365 </div>
366 </div>
367 </dl>
368 </div>
369 </div>
370 <!-- MIN_VERSION -->
371 </div> <!-- /description -->
372 </div><div class="apiItem">
373 <a name="method-setPopup"></a> <!-- method-anchor -->
374 <h4>setPopup</h4>
375 <div class="summary">
376 <!-- Note: intentionally longer 80 columns -->
377 <span>chrome.scriptBadge.setPopup</span>(<span class="null"><s pan>object</span>
378 <var><span>details</span></var></span>)</div>
379 <div class="description">
380 <p>Sets the html document to be opened as a popup when the user clicks on the script badge's icon.</p>
381 <!-- PARAMETERS -->
382 <h4>Parameters</h4>
383 <dl>
384 <div>
385 <div>
386 <dt>
387 <var>details</var>
388 <em>
389 <!-- TYPE -->
390 <div style="display:inline">
391 (
392 <span id="typeTemplate">
393 <span>
394 <span>object</span>
395 </span>
396 </span>
397 )
398 </div>
399 </em>
400 </dt>
401 <dd class="todo">
402 Undocumented.
403 </dd>
404 <!-- OBJECT PROPERTIES -->
405 <dd>
406 <dl>
407 <div>
408 <div>
409 <dt>
410 <var>tabId</var>
411 <em>
412 <!-- TYPE -->
413 <div style="display:inline">
414 (
415 <span id="typeTemplate">
416 <span>
417 <span>integer</span>
418 </span>
419 </span>
420 )
421 </div>
422 </em>
423 </dt>
424 <dd>The id of the tab for which you want to modify the script badge.</ dd>
425 <!-- OBJECT PROPERTIES -->
426 <!-- OBJECT METHODS -->
427 <!-- OBJECT EVENT FIELDS -->
428 <!-- FUNCTION PARAMETERS -->
429 </div>
430 </div><div>
431 <div>
432 <dt>
433 <var>popup</var>
434 <em>
435 <!-- TYPE -->
436 <div style="display:inline">
437 (
438 <span id="typeTemplate">
439 <span>
440 <span>string</span>
441 </span>
442 </span>
443 )
444 </div>
445 </em>
446 </dt>
447 <dd>The html file to show in a popup. If set to the empty string ('') , no popup is shown.</dd>
448 <!-- OBJECT PROPERTIES -->
449 <!-- OBJECT METHODS -->
450 <!-- OBJECT EVENT FIELDS -->
451 <!-- FUNCTION PARAMETERS -->
452 </div>
453 </div>
454 </dl>
455 </dd>
456 <!-- OBJECT METHODS -->
457 <!-- OBJECT EVENT FIELDS -->
458 <!-- FUNCTION PARAMETERS -->
459 </div>
460 </div>
461 </dl>
462 <!-- RETURNS -->
463 <dl>
464 </dl>
465 <!-- CALLBACK -->
466 <!-- MIN_VERSION -->
467 </div> <!-- /description -->
468 </div> <!-- /apiItem -->
469 </div> <!-- /apiGroup -->
470 <!-- EVENTS -->
471 <div id="eventsTemplate" class="apiGroup">
472 <a name="global-events"></a>
473 <h3>Events</h3>
474 <!-- iterates over all events -->
475 <div class="apiItem">
476 <a name="event-onClicked"></a>
477 <h4>onClicked</h4>
478 <div class="summary">
479 <!-- Note: intentionally longer 80 columns -->
480 <span class="subdued">chrome.scriptBadge.</span><span>onClicked< /span><span class="subdued">.addListener</span>(function(<span>tabs.Tab tab</spa n>) <span class="subdued">{...}</span><span></span>);
481 </div>
482 <div class="description">
483 <p>Fired when a script badge icon is clicked. This event will n ot fire if the script badge has a popup.</p>
484 <!-- LISTENER PARAMETERS -->
485 <div>
486 <h4>Listener parameters</h4>
487 <dl>
488 <div>
489 <div>
490 <dt>
491 <var>tab</var>
492 <em>
493 <!-- TYPE -->
494 <div style="display:inline">
495 (
496 <span id="typeTemplate">
497 <span>
498 <a>tabs.Tab</a>
499 </span>
500 </span>
501 )
502 </div>
503 </em>
504 </dt>
505 <dd class="todo">
506 Undocumented.
507 </dd>
508 <!-- OBJECT PROPERTIES -->
509 <!-- OBJECT METHODS -->
510 <!-- OBJECT EVENT FIELDS -->
511 <!-- FUNCTION PARAMETERS -->
512 </div>
513 </div>
514 </dl>
515 </div>
516 <!-- EXTRA PARAMETERS -->
517 <!-- LISTENER RETURN VALUE -->
518 <dl>
519 </dl>
520 </div> <!-- /description -->
521 <!-- /description -->
522 </div> <!-- /apiItem -->
523 </div> <!-- /apiGroup -->
524 <!-- TYPES -->
525 <!-- /apiGroup -->
526 </div> <!-- /apiPage -->
527 </div> <!-- /gc-pagecontent -->
528 </div> <!-- /g-section -->
529 </div> <!-- /codesiteContent -->
530 <div id="gc-footer" --="">
531 <div class="text">
532 <p>
533 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
534 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
535 Attribution 3.0 License</a>, and code samples are licensed under the
536 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
537 </p>
538 <p>
539 ©2011 Google
540 </p>
541 <!-- begin analytics -->
542 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
543 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
544 <script type="text/javascript">
545 // chrome doc tracking
546 try {
547 var engdocs = _gat._getTracker("YT-10763712-2");
548 engdocs._trackPageview();
549 } catch(err) {}
550 // code.google.com site-wide tracking
551 try {
552 _uacct="UA-18071-1";
553 _uanchor=1;
554 _uff=0;
555 urchinTracker();
556 }
557 catch(e) {/* urchinTracker not available. */}
558 </script>
559 <!-- end analytics -->
560 </div>
561 </div> <!-- /gc-footer -->
562 </div> <!-- /gc-container -->
563 </body></html>
OLDNEW
« chrome/common/extensions/docs/extensions/scriptBadge.html ('K') | « chrome/common/extensions/docs/samples.json ('k') | chrome/common/extensions/extension.h » ('j') | chrome/common/extensions/extension.h » ('J')

Powered by Google App Engine
This is Rietveld 408576698