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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 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/js/api_page_generator.js ('k') | chrome/common/extensions/docs/manifest.html » ('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="../../../../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.management modu le, which is part of the Google Chrome extension APIs."><title>Management - Goo gle 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 class="leftNavSelected">Management</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">Management</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#manifest">Manifest</a>
196 <ol>
197 </ol>
198 </li>
199 <li>
200 <a href="#apiReference">API reference: chrome.management</a>
201 <ol>
202 <li>
203 <a href="#global-methods">Methods</a>
204 <ol>
205 <li>
206 <a href="#method-get">get</a>
207 </li><li>
208 <a href="#method-getAll">getAll</a>
209 </li><li>
210 <a href="#method-getPermissionWarningsById">getPermissionWarning sById</a>
211 </li><li>
212 <a href="#method-getPermissionWarningsByManifest">getPermissionW arningsByManifest</a>
213 </li><li>
214 <a href="#method-launchApp">launchApp</a>
215 </li><li>
216 <a href="#method-setEnabled">setEnabled</a>
217 </li><li>
218 <a href="#method-uninstall">uninstall</a>
219 </li>
220 </ol>
221 </li>
222 <li>
223 <a href="#global-events">Events</a>
224 <ol>
225 <li>
226 <a href="#event-onDisabled">onDisabled</a>
227 </li><li>
228 <a href="#event-onEnabled">onEnabled</a>
229 </li><li>
230 <a href="#event-onInstalled">onInstalled</a>
231 </li><li>
232 <a href="#event-onUninstalled">onUninstalled</a>
233 </li>
234 </ol>
235 </li>
236 <li>
237 <a href="#types">Types</a>
238 <ol>
239 <li>
240 <a href="#type-IconInfo">IconInfo</a>
241 <ol>
242 </ol>
243 </li><li>
244 <a href="#type-ExtensionInfo">ExtensionInfo</a>
245 <ol>
246 </ol>
247 </li>
248 </ol>
249 </li>
250 </ol>
251 </li>
252 </ol>
253 </div>
254 <!-- /TABLE OF CONTENTS -->
255 <!-- Standard content lead-in for experimental API pages -->
256 <!-- STATIC CONTENT PLACEHOLDER -->
257 <div id="static"><div id="pageData-name" class="pageData">Management</di v>
258 <!-- BEGIN AUTHORED CONTENT -->
259 <p id="classSummary">
260 The <code>chrome.management</code> module provides ways to manage the list of ex tensions/apps that are installed and running. It is particularly useful for exte nsions that <a href="override.html">override</a> the built-in New Tab page.
261 </p>
262 <h2 id="manifest">Manifest</h2>
263 <p>You must declare the "management" permission
264 in the <a href="manifest.html">extension manifest</a>
265 to use the management API.
266 For example:</p>
267 <pre>{
268 "name": "My extension",
269 ...
270 <b>"permissions": [
271 "management"
272 ]</b>,
273 ...
274 }</pre>
275 <p>
276 The one method that doesn't require the "management" permission is
277 <a href="#method-getPermissionWarningsByManifest"><code>getPermissionWarningsByM anifest</code></a>
278 </p>
279 <!-- END AUTHORED CONTENT -->
280 </div>
281 <!-- API PAGE -->
282 <div class="apiPage">
283 <a name="apiReference"></a>
284 <h2>API reference: chrome.management</h2>
285 <!-- PROPERTIES -->
286 <!-- /apiGroup -->
287 <!-- METHODS -->
288 <div id="methodsTemplate" class="apiGroup">
289 <a name="global-methods"></a>
290 <h3>Methods</h3>
291 <!-- iterates over all functions -->
292 <div class="apiItem">
293 <a name="method-get"></a> <!-- method-anchor -->
294 <h4>get</h4>
295 <div class="summary">
296 <!-- Note: intentionally longer 80 columns -->
297 <span>chrome.management.get</span>(<span class="null"><span>st ring</span>
298 <var><span>id</span></var></span><span class="optional"><s pan>, </span><span>function</span>
299 <var><span>callback</span></var></span>)</div>
300 <div class="description">
301 <p>Returns information about the installed extension or app that has the given ID.</p>
302 <!-- PARAMETERS -->
303 <h4>Parameters</h4>
304 <dl>
305 <div>
306 <div>
307 <dt>
308 <var>id</var>
309 <em>
310 <!-- TYPE -->
311 <div style="display:inline">
312 (
313 <span id="typeTemplate">
314 <span>
315 <span>string</span>
316 </span>
317 </span>
318 )
319 </div>
320 </em>
321 </dt>
322 <dd>The ID from an item of <a href="management.html#type-ExtensionInfo ">ExtensionInfo</a>.</dd>
323 <!-- OBJECT PROPERTIES -->
324 <!-- OBJECT METHODS -->
325 <!-- OBJECT EVENT FIELDS -->
326 <!-- FUNCTION PARAMETERS -->
327 </div>
328 </div><div>
329 <div>
330 <dt>
331 <var>callback</var>
332 <em>
333 <!-- TYPE -->
334 <div style="display:inline">
335 (
336 <span class="optional">optional</span>
337 <span id="typeTemplate">
338 <span>
339 <span>function</span>
340 </span>
341 </span>
342 )
343 </div>
344 </em>
345 </dt>
346 <dd class="todo">
347 Undocumented.
348 </dd>
349 <!-- OBJECT PROPERTIES -->
350 <!-- OBJECT METHODS -->
351 <!-- OBJECT EVENT FIELDS -->
352 <!-- FUNCTION PARAMETERS -->
353 </div>
354 </div>
355 </dl>
356 <!-- RETURNS -->
357 <dl>
358 </dl>
359 <!-- CALLBACK -->
360 <div>
361 <div>
362 <h4>Callback function</h4>
363 <p>
364 If you specify the <em>callback</em> parameter, it should
365 specify a function that looks like this:
366 </p>
367 <!-- Note: intentionally longer 80 columns -->
368 <pre>function(<span>ExtensionInfo result</span>) <span class=" subdued">{...}</span>;</pre>
369 <dl>
370 <div>
371 <div>
372 <dt>
373 <var>result</var>
374 <em>
375 <!-- TYPE -->
376 <div style="display:inline">
377 (
378 <span id="typeTemplate">
379 <span>
380 <a href="management.html#type-ExtensionInfo">ExtensionIn fo</a>
381 </span>
382 </span>
383 )
384 </div>
385 </em>
386 </dt>
387 <dd class="todo">
388 Undocumented.
389 </dd>
390 <!-- OBJECT PROPERTIES -->
391 <!-- OBJECT METHODS -->
392 <!-- OBJECT EVENT FIELDS -->
393 <!-- FUNCTION PARAMETERS -->
394 </div>
395 </div>
396 </dl>
397 </div>
398 </div>
399 <!-- MIN_VERSION -->
400 </div> <!-- /description -->
401 </div><div class="apiItem">
402 <a name="method-getAll"></a> <!-- method-anchor -->
403 <h4>getAll</h4>
404 <div class="summary">
405 <!-- Note: intentionally longer 80 columns -->
406 <span>chrome.management.getAll</span>(<span class="optional">< span>function</span>
407 <var><span>callback</span></var></span>)</div>
408 <div class="description">
409 <p>Returns a list of information about installed extensions and apps.</p>
410 <!-- PARAMETERS -->
411 <h4>Parameters</h4>
412 <dl>
413 <div>
414 <div>
415 <dt>
416 <var>callback</var>
417 <em>
418 <!-- TYPE -->
419 <div style="display:inline">
420 (
421 <span class="optional">optional</span>
422 <span id="typeTemplate">
423 <span>
424 <span>function</span>
425 </span>
426 </span>
427 )
428 </div>
429 </em>
430 </dt>
431 <dd class="todo">
432 Undocumented.
433 </dd>
434 <!-- OBJECT PROPERTIES -->
435 <!-- OBJECT METHODS -->
436 <!-- OBJECT EVENT FIELDS -->
437 <!-- FUNCTION PARAMETERS -->
438 </div>
439 </div>
440 </dl>
441 <!-- RETURNS -->
442 <dl>
443 </dl>
444 <!-- CALLBACK -->
445 <div>
446 <div>
447 <h4>Callback function</h4>
448 <p>
449 If you specify the <em>callback</em> parameter, it should
450 specify a function that looks like this:
451 </p>
452 <!-- Note: intentionally longer 80 columns -->
453 <pre>function(<span>array of ExtensionInfo result</span>) <spa n class="subdued">{...}</span>;</pre>
454 <dl>
455 <div>
456 <div>
457 <dt>
458 <var>result</var>
459 <em>
460 <!-- TYPE -->
461 <div style="display:inline">
462 (
463 <span id="typeTemplate">
464 <span>
465 <span>
466 array of <span><span>
467 <span>
468 <a href="management.html#type-ExtensionInfo">ExtensionIn fo</a>
469 </span>
470 </span></span>
471 </span>
472 </span>
473 </span>
474 )
475 </div>
476 </em>
477 </dt>
478 <dd class="todo">
479 Undocumented.
480 </dd>
481 <!-- OBJECT PROPERTIES -->
482 <!-- OBJECT METHODS -->
483 <!-- OBJECT EVENT FIELDS -->
484 <!-- FUNCTION PARAMETERS -->
485 </div>
486 </div>
487 </dl>
488 </div>
489 </div>
490 <!-- MIN_VERSION -->
491 </div> <!-- /description -->
492 </div><div class="apiItem">
493 <a name="method-getPermissionWarningsById"></a> <!-- method-anchor -->
494 <h4>getPermissionWarningsById</h4>
495 <div class="summary">
496 <!-- Note: intentionally longer 80 columns -->
497 <span>chrome.management.getPermissionWarningsById</span>(<span class="null"><span>string</span>
498 <var><span>id</span></var></span><span class="optional"><s pan>, </span><span>function</span>
499 <var><span>callback</span></var></span>)</div>
500 <div class="description">
501 <p>Returns a list of <a href="permission_warnings.html">permissi on warnings</a> for the given extension id.</p>
502 <!-- PARAMETERS -->
503 <h4>Parameters</h4>
504 <dl>
505 <div>
506 <div>
507 <dt>
508 <var>id</var>
509 <em>
510 <!-- TYPE -->
511 <div style="display:inline">
512 (
513 <span id="typeTemplate">
514 <span>
515 <span>string</span>
516 </span>
517 </span>
518 )
519 </div>
520 </em>
521 </dt>
522 <dd>The ID of an already installed extension.</dd>
523 <!-- OBJECT PROPERTIES -->
524 <!-- OBJECT METHODS -->
525 <!-- OBJECT EVENT FIELDS -->
526 <!-- FUNCTION PARAMETERS -->
527 </div>
528 </div><div>
529 <div>
530 <dt>
531 <var>callback</var>
532 <em>
533 <!-- TYPE -->
534 <div style="display:inline">
535 (
536 <span class="optional">optional</span>
537 <span id="typeTemplate">
538 <span>
539 <span>function</span>
540 </span>
541 </span>
542 )
543 </div>
544 </em>
545 </dt>
546 <dd class="todo">
547 Undocumented.
548 </dd>
549 <!-- OBJECT PROPERTIES -->
550 <!-- OBJECT METHODS -->
551 <!-- OBJECT EVENT FIELDS -->
552 <!-- FUNCTION PARAMETERS -->
553 </div>
554 </div>
555 </dl>
556 <!-- RETURNS -->
557 <dl>
558 </dl>
559 <!-- CALLBACK -->
560 <div>
561 <div>
562 <h4>Callback function</h4>
563 <p>
564 If you specify the <em>callback</em> parameter, it should
565 specify a function that looks like this:
566 </p>
567 <!-- Note: intentionally longer 80 columns -->
568 <pre>function(<span>array of string permissionWarnings</span>) <span class="subdued">{...}</span>;</pre>
569 <dl>
570 <div>
571 <div>
572 <dt>
573 <var>permissionWarnings</var>
574 <em>
575 <!-- TYPE -->
576 <div style="display:inline">
577 (
578 <span id="typeTemplate">
579 <span>
580 <span>
581 array of <span><span>
582 <span>
583 <span>string</span>
584 </span>
585 </span></span>
586 </span>
587 </span>
588 </span>
589 )
590 </div>
591 </em>
592 </dt>
593 <dd class="todo">
594 Undocumented.
595 </dd>
596 <!-- OBJECT PROPERTIES -->
597 <!-- OBJECT METHODS -->
598 <!-- OBJECT EVENT FIELDS -->
599 <!-- FUNCTION PARAMETERS -->
600 </div>
601 </div>
602 </dl>
603 </div>
604 </div>
605 <!-- MIN_VERSION -->
606 </div> <!-- /description -->
607 </div><div class="apiItem">
608 <a name="method-getPermissionWarningsByManifest"></a> <!-- method- anchor -->
609 <h4>getPermissionWarningsByManifest</h4>
610 <div class="summary">
611 <!-- Note: intentionally longer 80 columns -->
612 <span>chrome.management.getPermissionWarningsByManifest</span> (<span class="null"><span>string</span>
613 <var><span>manifestStr</span></var></span><span class="opt ional"><span>, </span><span>function</span>
614 <var><span>callback</span></var></span>)</div>
615 <div class="description">
616 <p>Returns a list of <a href="permission_warnings.html">permissi on warnings</a> for the given extension manifest string. Note: This function can be used without requesting the 'management' permission in the manifest.</p>
617 <!-- PARAMETERS -->
618 <h4>Parameters</h4>
619 <dl>
620 <div>
621 <div>
622 <dt>
623 <var>manifestStr</var>
624 <em>
625 <!-- TYPE -->
626 <div style="display:inline">
627 (
628 <span id="typeTemplate">
629 <span>
630 <span>string</span>
631 </span>
632 </span>
633 )
634 </div>
635 </em>
636 </dt>
637 <dd>Extension manifest JSON string.</dd>
638 <!-- OBJECT PROPERTIES -->
639 <!-- OBJECT METHODS -->
640 <!-- OBJECT EVENT FIELDS -->
641 <!-- FUNCTION PARAMETERS -->
642 </div>
643 </div><div>
644 <div>
645 <dt>
646 <var>callback</var>
647 <em>
648 <!-- TYPE -->
649 <div style="display:inline">
650 (
651 <span class="optional">optional</span>
652 <span id="typeTemplate">
653 <span>
654 <span>function</span>
655 </span>
656 </span>
657 )
658 </div>
659 </em>
660 </dt>
661 <dd class="todo">
662 Undocumented.
663 </dd>
664 <!-- OBJECT PROPERTIES -->
665 <!-- OBJECT METHODS -->
666 <!-- OBJECT EVENT FIELDS -->
667 <!-- FUNCTION PARAMETERS -->
668 </div>
669 </div>
670 </dl>
671 <!-- RETURNS -->
672 <dl>
673 </dl>
674 <!-- CALLBACK -->
675 <div>
676 <div>
677 <h4>Callback function</h4>
678 <p>
679 If you specify the <em>callback</em> parameter, it should
680 specify a function that looks like this:
681 </p>
682 <!-- Note: intentionally longer 80 columns -->
683 <pre>function(<span>array of string permissionWarnings</span>) <span class="subdued">{...}</span>;</pre>
684 <dl>
685 <div>
686 <div>
687 <dt>
688 <var>permissionWarnings</var>
689 <em>
690 <!-- TYPE -->
691 <div style="display:inline">
692 (
693 <span id="typeTemplate">
694 <span>
695 <span>
696 array of <span><span>
697 <span>
698 <span>string</span>
699 </span>
700 </span></span>
701 </span>
702 </span>
703 </span>
704 )
705 </div>
706 </em>
707 </dt>
708 <dd class="todo">
709 Undocumented.
710 </dd>
711 <!-- OBJECT PROPERTIES -->
712 <!-- OBJECT METHODS -->
713 <!-- OBJECT EVENT FIELDS -->
714 <!-- FUNCTION PARAMETERS -->
715 </div>
716 </div>
717 </dl>
718 </div>
719 </div>
720 <!-- MIN_VERSION -->
721 </div> <!-- /description -->
722 </div><div class="apiItem">
723 <a name="method-launchApp"></a> <!-- method-anchor -->
724 <h4>launchApp</h4>
725 <div class="summary">
726 <!-- Note: intentionally longer 80 columns -->
727 <span>chrome.management.launchApp</span>(<span class="null"><s pan>string</span>
728 <var><span>id</span></var></span><span class="optional"><s pan>, </span><span>function</span>
729 <var><span>callback</span></var></span>)</div>
730 <div class="description">
731 <p>Launches an application.</p>
732 <!-- PARAMETERS -->
733 <h4>Parameters</h4>
734 <dl>
735 <div>
736 <div>
737 <dt>
738 <var>id</var>
739 <em>
740 <!-- TYPE -->
741 <div style="display:inline">
742 (
743 <span id="typeTemplate">
744 <span>
745 <span>string</span>
746 </span>
747 </span>
748 )
749 </div>
750 </em>
751 </dt>
752 <dd>The extension id of the application.</dd>
753 <!-- OBJECT PROPERTIES -->
754 <!-- OBJECT METHODS -->
755 <!-- OBJECT EVENT FIELDS -->
756 <!-- FUNCTION PARAMETERS -->
757 </div>
758 </div><div>
759 <div>
760 <dt>
761 <var>callback</var>
762 <em>
763 <!-- TYPE -->
764 <div style="display:inline">
765 (
766 <span class="optional">optional</span>
767 <span id="typeTemplate">
768 <span>
769 <span>function</span>
770 </span>
771 </span>
772 )
773 </div>
774 </em>
775 </dt>
776 <dd class="todo">
777 Undocumented.
778 </dd>
779 <!-- OBJECT PROPERTIES -->
780 <!-- OBJECT METHODS -->
781 <!-- OBJECT EVENT FIELDS -->
782 <!-- FUNCTION PARAMETERS -->
783 </div>
784 </div>
785 </dl>
786 <!-- RETURNS -->
787 <dl>
788 </dl>
789 <!-- CALLBACK -->
790 <div>
791 <div>
792 <h4>Callback function</h4>
793 <p>
794 If you specify the <em>callback</em> parameter, it should
795 specify a function that looks like this:
796 </p>
797 <!-- Note: intentionally longer 80 columns -->
798 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
799 <dl>
800 </dl>
801 </div>
802 </div>
803 <!-- MIN_VERSION -->
804 </div> <!-- /description -->
805 </div><div class="apiItem">
806 <a name="method-setEnabled"></a> <!-- method-anchor -->
807 <h4>setEnabled</h4>
808 <div class="summary">
809 <!-- Note: intentionally longer 80 columns -->
810 <span>chrome.management.setEnabled</span>(<span class="null">< span>string</span>
811 <var><span>id</span></var></span><span class="null"><span> , </span><span>boolean</span>
812 <var><span>enabled</span></var></span><span class="optiona l"><span>, </span><span>function</span>
813 <var><span>callback</span></var></span>)</div>
814 <div class="description">
815 <p>Enables or disables an app or extension.</p>
816 <!-- PARAMETERS -->
817 <h4>Parameters</h4>
818 <dl>
819 <div>
820 <div>
821 <dt>
822 <var>id</var>
823 <em>
824 <!-- TYPE -->
825 <div style="display:inline">
826 (
827 <span id="typeTemplate">
828 <span>
829 <span>string</span>
830 </span>
831 </span>
832 )
833 </div>
834 </em>
835 </dt>
836 <dd>This should be the id from an item of <a href="management.html#typ e-ExtensionInfo">ExtensionInfo</a>.</dd>
837 <!-- OBJECT PROPERTIES -->
838 <!-- OBJECT METHODS -->
839 <!-- OBJECT EVENT FIELDS -->
840 <!-- FUNCTION PARAMETERS -->
841 </div>
842 </div><div>
843 <div>
844 <dt>
845 <var>enabled</var>
846 <em>
847 <!-- TYPE -->
848 <div style="display:inline">
849 (
850 <span id="typeTemplate">
851 <span>
852 <span>boolean</span>
853 </span>
854 </span>
855 )
856 </div>
857 </em>
858 </dt>
859 <dd>Whether this item should be enabled or disabled.</dd>
860 <!-- OBJECT PROPERTIES -->
861 <!-- OBJECT METHODS -->
862 <!-- OBJECT EVENT FIELDS -->
863 <!-- FUNCTION PARAMETERS -->
864 </div>
865 </div><div>
866 <div>
867 <dt>
868 <var>callback</var>
869 <em>
870 <!-- TYPE -->
871 <div style="display:inline">
872 (
873 <span class="optional">optional</span>
874 <span id="typeTemplate">
875 <span>
876 <span>function</span>
877 </span>
878 </span>
879 )
880 </div>
881 </em>
882 </dt>
883 <dd class="todo">
884 Undocumented.
885 </dd>
886 <!-- OBJECT PROPERTIES -->
887 <!-- OBJECT METHODS -->
888 <!-- OBJECT EVENT FIELDS -->
889 <!-- FUNCTION PARAMETERS -->
890 </div>
891 </div>
892 </dl>
893 <!-- RETURNS -->
894 <dl>
895 </dl>
896 <!-- CALLBACK -->
897 <div>
898 <div>
899 <h4>Callback function</h4>
900 <p>
901 If you specify the <em>callback</em> parameter, it should
902 specify a function that looks like this:
903 </p>
904 <!-- Note: intentionally longer 80 columns -->
905 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
906 <dl>
907 </dl>
908 </div>
909 </div>
910 <!-- MIN_VERSION -->
911 </div> <!-- /description -->
912 </div><div class="apiItem">
913 <a name="method-uninstall"></a> <!-- method-anchor -->
914 <h4>uninstall</h4>
915 <div class="summary">
916 <!-- Note: intentionally longer 80 columns -->
917 <span>chrome.management.uninstall</span>(<span class="null"><s pan>string</span>
918 <var><span>id</span></var></span><span class="optional"><s pan>, </span><span>object</span>
919 <var><span>options</span></var></span><span class="optiona l"><span>, </span><span>function</span>
920 <var><span>callback</span></var></span>)</div>
921 <div class="description">
922 <p>Uninstalls a currently installed app or extension.</p>
923 <!-- PARAMETERS -->
924 <h4>Parameters</h4>
925 <dl>
926 <div>
927 <div>
928 <dt>
929 <var>id</var>
930 <em>
931 <!-- TYPE -->
932 <div style="display:inline">
933 (
934 <span id="typeTemplate">
935 <span>
936 <span>string</span>
937 </span>
938 </span>
939 )
940 </div>
941 </em>
942 </dt>
943 <dd>This should be the id from an item of <a href="management.html#typ e-ExtensionInfo">ExtensionInfo</a>.</dd>
944 <!-- OBJECT PROPERTIES -->
945 <!-- OBJECT METHODS -->
946 <!-- OBJECT EVENT FIELDS -->
947 <!-- FUNCTION PARAMETERS -->
948 </div>
949 </div><div>
950 <div>
951 <dt>
952 <var>options</var>
953 <em>
954 <!-- TYPE -->
955 <div style="display:inline">
956 (
957 <span class="optional">optional</span>
958 <span id="typeTemplate">
959 <span>
960 <span>object</span>
961 </span>
962 </span>
963 )
964 </div>
965 </em>
966 </dt>
967 <dd class="todo">
968 Undocumented.
969 </dd>
970 <!-- OBJECT PROPERTIES -->
971 <dd>
972 <dl>
973 <div>
974 <div>
975 <dt>
976 <var>showConfirmDialog</var>
977 <em>
978 <!-- TYPE -->
979 <div style="display:inline">
980 (
981 <span class="optional">optional</span>
982 <span id="typeTemplate">
983 <span>
984 <span>boolean</span>
985 </span>
986 </span>
987 )
988 </div>
989 </em>
990 </dt>
991 <dd>Whether or not a confirm-uninstall dialog should prompt the user. Defaults to false.</dd>
992 <!-- OBJECT PROPERTIES -->
993 <!-- OBJECT METHODS -->
994 <!-- OBJECT EVENT FIELDS -->
995 <!-- FUNCTION PARAMETERS -->
996 </div>
997 </div>
998 </dl>
999 </dd>
1000 <!-- OBJECT METHODS -->
1001 <!-- OBJECT EVENT FIELDS -->
1002 <!-- FUNCTION PARAMETERS -->
1003 </div>
1004 </div><div>
1005 <div>
1006 <dt>
1007 <var>callback</var>
1008 <em>
1009 <!-- TYPE -->
1010 <div style="display:inline">
1011 (
1012 <span class="optional">optional</span>
1013 <span id="typeTemplate">
1014 <span>
1015 <span>function</span>
1016 </span>
1017 </span>
1018 )
1019 </div>
1020 </em>
1021 </dt>
1022 <dd class="todo">
1023 Undocumented.
1024 </dd>
1025 <!-- OBJECT PROPERTIES -->
1026 <!-- OBJECT METHODS -->
1027 <!-- OBJECT EVENT FIELDS -->
1028 <!-- FUNCTION PARAMETERS -->
1029 </div>
1030 </div>
1031 </dl>
1032 <!-- RETURNS -->
1033 <dl>
1034 </dl>
1035 <!-- CALLBACK -->
1036 <div>
1037 <div>
1038 <h4>Callback function</h4>
1039 <p>
1040 If you specify the <em>callback</em> parameter, it should
1041 specify a function that looks like this:
1042 </p>
1043 <!-- Note: intentionally longer 80 columns -->
1044 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1045 <dl>
1046 </dl>
1047 </div>
1048 </div>
1049 <!-- MIN_VERSION -->
1050 </div> <!-- /description -->
1051 </div> <!-- /apiItem -->
1052 </div> <!-- /apiGroup -->
1053 <!-- EVENTS -->
1054 <div id="eventsTemplate" class="apiGroup">
1055 <a name="global-events"></a>
1056 <h3>Events</h3>
1057 <!-- iterates over all events -->
1058 <div class="apiItem">
1059 <a name="event-onDisabled"></a>
1060 <h4>onDisabled</h4>
1061 <div class="summary">
1062 <!-- Note: intentionally longer 80 columns -->
1063 <span class="subdued">chrome.management.</span><span>onDisabled< /span><span class="subdued">.addListener</span>(function(<span>ExtensionInfo inf o</span>) <span class="subdued">{...}</span><span></span>);
1064 </div>
1065 <div class="description">
1066 <p>Fired when an app or extension has been disabled</p>
1067 <!-- LISTENER PARAMETERS -->
1068 <div>
1069 <h4>Listener parameters</h4>
1070 <dl>
1071 <div>
1072 <div>
1073 <dt>
1074 <var>info</var>
1075 <em>
1076 <!-- TYPE -->
1077 <div style="display:inline">
1078 (
1079 <span id="typeTemplate">
1080 <span>
1081 <a href="management.html#type-ExtensionInfo">ExtensionIn fo</a>
1082 </span>
1083 </span>
1084 )
1085 </div>
1086 </em>
1087 </dt>
1088 <dd class="todo">
1089 Undocumented.
1090 </dd>
1091 <!-- OBJECT PROPERTIES -->
1092 <!-- OBJECT METHODS -->
1093 <!-- OBJECT EVENT FIELDS -->
1094 <!-- FUNCTION PARAMETERS -->
1095 </div>
1096 </div>
1097 </dl>
1098 </div>
1099 <!-- EXTRA PARAMETERS -->
1100 <!-- LISTENER RETURN VALUE -->
1101 <dl>
1102 </dl>
1103 </div> <!-- /description -->
1104 <!-- /description -->
1105 </div><div class="apiItem">
1106 <a name="event-onEnabled"></a>
1107 <h4>onEnabled</h4>
1108 <div class="summary">
1109 <!-- Note: intentionally longer 80 columns -->
1110 <span class="subdued">chrome.management.</span><span>onEnabled</ span><span class="subdued">.addListener</span>(function(<span>ExtensionInfo info </span>) <span class="subdued">{...}</span><span></span>);
1111 </div>
1112 <div class="description">
1113 <p>Fired when an app or extension has been enabled.</p>
1114 <!-- LISTENER PARAMETERS -->
1115 <div>
1116 <h4>Listener parameters</h4>
1117 <dl>
1118 <div>
1119 <div>
1120 <dt>
1121 <var>info</var>
1122 <em>
1123 <!-- TYPE -->
1124 <div style="display:inline">
1125 (
1126 <span id="typeTemplate">
1127 <span>
1128 <a href="management.html#type-ExtensionInfo">ExtensionIn fo</a>
1129 </span>
1130 </span>
1131 )
1132 </div>
1133 </em>
1134 </dt>
1135 <dd class="todo">
1136 Undocumented.
1137 </dd>
1138 <!-- OBJECT PROPERTIES -->
1139 <!-- OBJECT METHODS -->
1140 <!-- OBJECT EVENT FIELDS -->
1141 <!-- FUNCTION PARAMETERS -->
1142 </div>
1143 </div>
1144 </dl>
1145 </div>
1146 <!-- EXTRA PARAMETERS -->
1147 <!-- LISTENER RETURN VALUE -->
1148 <dl>
1149 </dl>
1150 </div> <!-- /description -->
1151 <!-- /description -->
1152 </div><div class="apiItem">
1153 <a name="event-onInstalled"></a>
1154 <h4>onInstalled</h4>
1155 <div class="summary">
1156 <!-- Note: intentionally longer 80 columns -->
1157 <span class="subdued">chrome.management.</span><span>onInstalled </span><span class="subdued">.addListener</span>(function(<span>ExtensionInfo in fo</span>) <span class="subdued">{...}</span><span></span>);
1158 </div>
1159 <div class="description">
1160 <p>Fired when an app or extension has been installed.</p>
1161 <!-- LISTENER PARAMETERS -->
1162 <div>
1163 <h4>Listener parameters</h4>
1164 <dl>
1165 <div>
1166 <div>
1167 <dt>
1168 <var>info</var>
1169 <em>
1170 <!-- TYPE -->
1171 <div style="display:inline">
1172 (
1173 <span id="typeTemplate">
1174 <span>
1175 <a href="management.html#type-ExtensionInfo">ExtensionIn fo</a>
1176 </span>
1177 </span>
1178 )
1179 </div>
1180 </em>
1181 </dt>
1182 <dd class="todo">
1183 Undocumented.
1184 </dd>
1185 <!-- OBJECT PROPERTIES -->
1186 <!-- OBJECT METHODS -->
1187 <!-- OBJECT EVENT FIELDS -->
1188 <!-- FUNCTION PARAMETERS -->
1189 </div>
1190 </div>
1191 </dl>
1192 </div>
1193 <!-- EXTRA PARAMETERS -->
1194 <!-- LISTENER RETURN VALUE -->
1195 <dl>
1196 </dl>
1197 </div> <!-- /description -->
1198 <!-- /description -->
1199 </div><div class="apiItem">
1200 <a name="event-onUninstalled"></a>
1201 <h4>onUninstalled</h4>
1202 <div class="summary">
1203 <!-- Note: intentionally longer 80 columns -->
1204 <span class="subdued">chrome.management.</span><span>onUninstall ed</span><span class="subdued">.addListener</span>(function(<span>string id</spa n>) <span class="subdued">{...}</span><span></span>);
1205 </div>
1206 <div class="description">
1207 <p>Fired when an app or extension has been uninstalled.</p>
1208 <!-- LISTENER PARAMETERS -->
1209 <div>
1210 <h4>Listener parameters</h4>
1211 <dl>
1212 <div>
1213 <div>
1214 <dt>
1215 <var>id</var>
1216 <em>
1217 <!-- TYPE -->
1218 <div style="display:inline">
1219 (
1220 <span id="typeTemplate">
1221 <span>
1222 <span>string</span>
1223 </span>
1224 </span>
1225 )
1226 </div>
1227 </em>
1228 </dt>
1229 <dd>The id of the extension or app that was uninstalled.</dd>
1230 <!-- OBJECT PROPERTIES -->
1231 <!-- OBJECT METHODS -->
1232 <!-- OBJECT EVENT FIELDS -->
1233 <!-- FUNCTION PARAMETERS -->
1234 </div>
1235 </div>
1236 </dl>
1237 </div>
1238 <!-- EXTRA PARAMETERS -->
1239 <!-- LISTENER RETURN VALUE -->
1240 <dl>
1241 </dl>
1242 </div> <!-- /description -->
1243 <!-- /description -->
1244 </div> <!-- /apiItem -->
1245 </div> <!-- /apiGroup -->
1246 <!-- TYPES -->
1247 <div class="apiGroup">
1248 <a name="types"></a>
1249 <h3 id="types">Types</h3>
1250 <!-- iterates over all types -->
1251 <div class="apiItem">
1252 <a name="type-IconInfo"></a>
1253 <h4>IconInfo</h4>
1254 <div>
1255 <dt>
1256 <em>
1257 <!-- TYPE -->
1258 <div style="display:inline">
1259 (
1260 <span id="typeTemplate">
1261 <span>
1262 <span>object</span>
1263 </span>
1264 </span>
1265 )
1266 </div>
1267 </em>
1268 </dt>
1269 <dd>Information about an icon belonging to an extension or app.</dd>
1270 <!-- OBJECT PROPERTIES -->
1271 <dd>
1272 <dl>
1273 <div>
1274 <div>
1275 <dt>
1276 <var>size</var>
1277 <em>
1278 <!-- TYPE -->
1279 <div style="display:inline">
1280 (
1281 <span id="typeTemplate">
1282 <span>
1283 <span>integer</span>
1284 </span>
1285 </span>
1286 )
1287 </div>
1288 </em>
1289 </dt>
1290 <dd>A number representing the width and height of the icon. Likely val ues include (but are not limited to) 128, 48, 24, and 16.</dd>
1291 <!-- OBJECT PROPERTIES -->
1292 <!-- OBJECT METHODS -->
1293 <!-- OBJECT EVENT FIELDS -->
1294 <!-- FUNCTION PARAMETERS -->
1295 </div>
1296 </div><div>
1297 <div>
1298 <dt>
1299 <var>url</var>
1300 <em>
1301 <!-- TYPE -->
1302 <div style="display:inline">
1303 (
1304 <span id="typeTemplate">
1305 <span>
1306 <span>string</span>
1307 </span>
1308 </span>
1309 )
1310 </div>
1311 </em>
1312 </dt>
1313 <dd>The URL for this icon image. To display a grayscale version of the icon (to indicate that an extension is disabled, for example), append <code>?gr ayscale=true</code> to the URL.</dd>
1314 <!-- OBJECT PROPERTIES -->
1315 <!-- OBJECT METHODS -->
1316 <!-- OBJECT EVENT FIELDS -->
1317 <!-- FUNCTION PARAMETERS -->
1318 </div>
1319 </div>
1320 </dl>
1321 </dd>
1322 <!-- OBJECT METHODS -->
1323 <!-- OBJECT EVENT FIELDS -->
1324 <!-- FUNCTION PARAMETERS -->
1325 </div>
1326 </div><div class="apiItem">
1327 <a name="type-ExtensionInfo"></a>
1328 <h4>ExtensionInfo</h4>
1329 <div>
1330 <dt>
1331 <em>
1332 <!-- TYPE -->
1333 <div style="display:inline">
1334 (
1335 <span id="typeTemplate">
1336 <span>
1337 <span>object</span>
1338 </span>
1339 </span>
1340 )
1341 </div>
1342 </em>
1343 </dt>
1344 <dd>Information about an installed extension or app.</dd>
1345 <!-- OBJECT PROPERTIES -->
1346 <dd>
1347 <dl>
1348 <div>
1349 <div>
1350 <dt>
1351 <var>id</var>
1352 <em>
1353 <!-- TYPE -->
1354 <div style="display:inline">
1355 (
1356 <span id="typeTemplate">
1357 <span>
1358 <span>string</span>
1359 </span>
1360 </span>
1361 )
1362 </div>
1363 </em>
1364 </dt>
1365 <dd>The extension's unique identifier.</dd>
1366 <!-- OBJECT PROPERTIES -->
1367 <!-- OBJECT METHODS -->
1368 <!-- OBJECT EVENT FIELDS -->
1369 <!-- FUNCTION PARAMETERS -->
1370 </div>
1371 </div><div>
1372 <div>
1373 <dt>
1374 <var>name</var>
1375 <em>
1376 <!-- TYPE -->
1377 <div style="display:inline">
1378 (
1379 <span id="typeTemplate">
1380 <span>
1381 <span>string</span>
1382 </span>
1383 </span>
1384 )
1385 </div>
1386 </em>
1387 </dt>
1388 <dd>The name of this extension or app.</dd>
1389 <!-- OBJECT PROPERTIES -->
1390 <!-- OBJECT METHODS -->
1391 <!-- OBJECT EVENT FIELDS -->
1392 <!-- FUNCTION PARAMETERS -->
1393 </div>
1394 </div><div>
1395 <div>
1396 <dt>
1397 <var>description</var>
1398 <em>
1399 <!-- TYPE -->
1400 <div style="display:inline">
1401 (
1402 <span id="typeTemplate">
1403 <span>
1404 <span>string</span>
1405 </span>
1406 </span>
1407 )
1408 </div>
1409 </em>
1410 </dt>
1411 <dd>The description of this extension or app.</dd>
1412 <!-- OBJECT PROPERTIES -->
1413 <!-- OBJECT METHODS -->
1414 <!-- OBJECT EVENT FIELDS -->
1415 <!-- FUNCTION PARAMETERS -->
1416 </div>
1417 </div><div>
1418 <div>
1419 <dt>
1420 <var>version</var>
1421 <em>
1422 <!-- TYPE -->
1423 <div style="display:inline">
1424 (
1425 <span id="typeTemplate">
1426 <span>
1427 <span>string</span>
1428 </span>
1429 </span>
1430 )
1431 </div>
1432 </em>
1433 </dt>
1434 <dd>The <a href="manifest.html#version">version</a> of this extension or app.</dd>
1435 <!-- OBJECT PROPERTIES -->
1436 <!-- OBJECT METHODS -->
1437 <!-- OBJECT EVENT FIELDS -->
1438 <!-- FUNCTION PARAMETERS -->
1439 </div>
1440 </div><div>
1441 <div>
1442 <dt>
1443 <var>mayDisable</var>
1444 <em>
1445 <!-- TYPE -->
1446 <div style="display:inline">
1447 (
1448 <span id="typeTemplate">
1449 <span>
1450 <span>boolean</span>
1451 </span>
1452 </span>
1453 )
1454 </div>
1455 </em>
1456 </dt>
1457 <dd>Whether this extension can be disabled or uninstalled by the user. </dd>
1458 <!-- OBJECT PROPERTIES -->
1459 <!-- OBJECT METHODS -->
1460 <!-- OBJECT EVENT FIELDS -->
1461 <!-- FUNCTION PARAMETERS -->
1462 </div>
1463 </div><div>
1464 <div>
1465 <dt>
1466 <var>enabled</var>
1467 <em>
1468 <!-- TYPE -->
1469 <div style="display:inline">
1470 (
1471 <span id="typeTemplate">
1472 <span>
1473 <span>boolean</span>
1474 </span>
1475 </span>
1476 )
1477 </div>
1478 </em>
1479 </dt>
1480 <dd>Whether it is currently enabled or disabled.</dd>
1481 <!-- OBJECT PROPERTIES -->
1482 <!-- OBJECT METHODS -->
1483 <!-- OBJECT EVENT FIELDS -->
1484 <!-- FUNCTION PARAMETERS -->
1485 </div>
1486 </div><div>
1487 <div>
1488 <dt>
1489 <var>disabledReason</var>
1490 <em>
1491 <!-- TYPE -->
1492 <div style="display:inline">
1493 (
1494 <span class="optional">optional</span>
1495 <span class="enum">enumerated</span>
1496 <span id="typeTemplate">
1497 <span>
1498 <span>string</span>
1499 <span>["unknown", "permissions_increase"]</span>
1500 </span>
1501 </span>
1502 )
1503 </div>
1504 </em>
1505 </dt>
1506 <dd>A reason the item is disabled.</dd>
1507 <!-- OBJECT PROPERTIES -->
1508 <!-- OBJECT METHODS -->
1509 <!-- OBJECT EVENT FIELDS -->
1510 <!-- FUNCTION PARAMETERS -->
1511 </div>
1512 </div><div>
1513 <div>
1514 <dt>
1515 <var>isApp</var>
1516 <em>
1517 <!-- TYPE -->
1518 <div style="display:inline">
1519 (
1520 <span id="typeTemplate">
1521 <span>
1522 <span>boolean</span>
1523 </span>
1524 </span>
1525 )
1526 </div>
1527 </em>
1528 </dt>
1529 <dd>True if this is an app.</dd>
1530 <!-- OBJECT PROPERTIES -->
1531 <!-- OBJECT METHODS -->
1532 <!-- OBJECT EVENT FIELDS -->
1533 <!-- FUNCTION PARAMETERS -->
1534 </div>
1535 </div><div>
1536 <div>
1537 <dt>
1538 <var>appLaunchUrl</var>
1539 <em>
1540 <!-- TYPE -->
1541 <div style="display:inline">
1542 (
1543 <span class="optional">optional</span>
1544 <span id="typeTemplate">
1545 <span>
1546 <span>string</span>
1547 </span>
1548 </span>
1549 )
1550 </div>
1551 </em>
1552 </dt>
1553 <dd>The launch url (only present for apps).</dd>
1554 <!-- OBJECT PROPERTIES -->
1555 <!-- OBJECT METHODS -->
1556 <!-- OBJECT EVENT FIELDS -->
1557 <!-- FUNCTION PARAMETERS -->
1558 </div>
1559 </div><div>
1560 <div>
1561 <dt>
1562 <var>homepageUrl</var>
1563 <em>
1564 <!-- TYPE -->
1565 <div style="display:inline">
1566 (
1567 <span class="optional">optional</span>
1568 <span id="typeTemplate">
1569 <span>
1570 <span>string</span>
1571 </span>
1572 </span>
1573 )
1574 </div>
1575 </em>
1576 </dt>
1577 <dd>The URL of the homepage of this extension or app.</dd>
1578 <!-- OBJECT PROPERTIES -->
1579 <!-- OBJECT METHODS -->
1580 <!-- OBJECT EVENT FIELDS -->
1581 <!-- FUNCTION PARAMETERS -->
1582 </div>
1583 </div><div>
1584 <div>
1585 <dt>
1586 <var>updateUrl</var>
1587 <em>
1588 <!-- TYPE -->
1589 <div style="display:inline">
1590 (
1591 <span class="optional">optional</span>
1592 <span id="typeTemplate">
1593 <span>
1594 <span>string</span>
1595 </span>
1596 </span>
1597 )
1598 </div>
1599 </em>
1600 </dt>
1601 <dd>The update URL of this extension or app.</dd>
1602 <!-- OBJECT PROPERTIES -->
1603 <!-- OBJECT METHODS -->
1604 <!-- OBJECT EVENT FIELDS -->
1605 <!-- FUNCTION PARAMETERS -->
1606 </div>
1607 </div><div>
1608 <div>
1609 <dt>
1610 <var>offlineEnabled</var>
1611 <em>
1612 <!-- TYPE -->
1613 <div style="display:inline">
1614 (
1615 <span id="typeTemplate">
1616 <span>
1617 <span>boolean</span>
1618 </span>
1619 </span>
1620 )
1621 </div>
1622 </em>
1623 </dt>
1624 <dd>Whether the extension or app declares that it supports offline.</d d>
1625 <!-- OBJECT PROPERTIES -->
1626 <!-- OBJECT METHODS -->
1627 <!-- OBJECT EVENT FIELDS -->
1628 <!-- FUNCTION PARAMETERS -->
1629 </div>
1630 </div><div>
1631 <div>
1632 <dt>
1633 <var>optionsUrl</var>
1634 <em>
1635 <!-- TYPE -->
1636 <div style="display:inline">
1637 (
1638 <span id="typeTemplate">
1639 <span>
1640 <span>string</span>
1641 </span>
1642 </span>
1643 )
1644 </div>
1645 </em>
1646 </dt>
1647 <dd>The url for the item's options page, if it has one.</dd>
1648 <!-- OBJECT PROPERTIES -->
1649 <!-- OBJECT METHODS -->
1650 <!-- OBJECT EVENT FIELDS -->
1651 <!-- FUNCTION PARAMETERS -->
1652 </div>
1653 </div><div>
1654 <div>
1655 <dt>
1656 <var>icons</var>
1657 <em>
1658 <!-- TYPE -->
1659 <div style="display:inline">
1660 (
1661 <span class="optional">optional</span>
1662 <span id="typeTemplate">
1663 <span>
1664 <span>
1665 array of <span><span>
1666 <span>
1667 <a href="management.html#type-IconInfo">IconInfo</a>
1668 </span>
1669 </span></span>
1670 </span>
1671 </span>
1672 </span>
1673 )
1674 </div>
1675 </em>
1676 </dt>
1677 <dd>A list of icon information. Note that this just reflects what was declared in the manifest, and the actual image at that url may be larger or smal ler than what was declared, so you might consider using explicit width and heigh t attributes on img tags referencing these images. See the <a href="manifest.htm l#icons">manifest documentation on icons</a> for more details.</dd>
1678 <!-- OBJECT PROPERTIES -->
1679 <!-- OBJECT METHODS -->
1680 <!-- OBJECT EVENT FIELDS -->
1681 <!-- FUNCTION PARAMETERS -->
1682 </div>
1683 </div><div>
1684 <div>
1685 <dt>
1686 <var>permissions</var>
1687 <em>
1688 <!-- TYPE -->
1689 <div style="display:inline">
1690 (
1691 <span id="typeTemplate">
1692 <span>
1693 <span>
1694 array of <span><span>
1695 <span>
1696 <span>string</span>
1697 </span>
1698 </span></span>
1699 </span>
1700 </span>
1701 </span>
1702 )
1703 </div>
1704 </em>
1705 </dt>
1706 <dd>Returns a list of API based permissions.</dd>
1707 <!-- OBJECT PROPERTIES -->
1708 <!-- OBJECT METHODS -->
1709 <!-- OBJECT EVENT FIELDS -->
1710 <!-- FUNCTION PARAMETERS -->
1711 </div>
1712 </div><div>
1713 <div>
1714 <dt>
1715 <var>hostPermissions</var>
1716 <em>
1717 <!-- TYPE -->
1718 <div style="display:inline">
1719 (
1720 <span id="typeTemplate">
1721 <span>
1722 <span>
1723 array of <span><span>
1724 <span>
1725 <span>string</span>
1726 </span>
1727 </span></span>
1728 </span>
1729 </span>
1730 </span>
1731 )
1732 </div>
1733 </em>
1734 </dt>
1735 <dd>Returns a list of host based permissions.</dd>
1736 <!-- OBJECT PROPERTIES -->
1737 <!-- OBJECT METHODS -->
1738 <!-- OBJECT EVENT FIELDS -->
1739 <!-- FUNCTION PARAMETERS -->
1740 </div>
1741 </div>
1742 </dl>
1743 </dd>
1744 <!-- OBJECT METHODS -->
1745 <!-- OBJECT EVENT FIELDS -->
1746 <!-- FUNCTION PARAMETERS -->
1747 </div>
1748 </div> <!-- /apiItem -->
1749 </div> <!-- /apiGroup -->
1750 </div> <!-- /apiPage -->
1751 </div> <!-- /gc-pagecontent -->
1752 </div> <!-- /g-section -->
1753 </div> <!-- /codesiteContent -->
1754 <div id="gc-footer" --="">
1755 <div class="text">
1756 <p>
1757 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1758 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1759 Attribution 3.0 License</a>, and code samples are licensed under the
1760 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1761 </p>
1762 <p>
1763 ©2011 Google
1764 </p>
1765 <!-- begin analytics -->
1766 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
1767 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
1768 <script type="text/javascript">
1769 // chrome doc tracking
1770 try {
1771 var engdocs = _gat._getTracker("YT-10763712-2");
1772 engdocs._trackPageview();
1773 } catch(err) {}
1774 // code.google.com site-wide tracking
1775 try {
1776 _uacct="UA-18071-1";
1777 _uanchor=1;
1778 _uff=0;
1779 urchinTracker();
1780 }
1781 catch(e) {/* urchinTracker not available. */}
1782 </script>
1783 <!-- end analytics -->
1784 </div>
1785 </div> <!-- /gc-footer -->
1786 </div> <!-- /gc-container -->
1787 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/js/api_page_generator.js ('k') | chrome/common/extensions/docs/manifest.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698