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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/runtime.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/proxy.html ('k') | chrome/common/extensions/docs/samples.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.runtime module, which is part of the Google Chrome extension APIs."><title>chrome.runtime - Go ogle 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.runtime</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.runtime</a>
196 <ol>
197 <li>
198 <a href="#global-methods">Methods</a>
199 <ol>
200 <li>
201 <a href="#method-getBackgroundPage">getBackgroundPage</a>
202 </li>
203 </ol>
204 </li>
205 <li>
206 <a href="#global-events">Events</a>
207 <ol>
208 <li>
209 <a href="#event-onInstalled">onInstalled</a>
210 </li><li>
211 <a href="#event-onSuspend">onSuspend</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 <p class="warning">
222 <!-- Standard content lead-in for APIs that are not yet available on
223 the stable channel. -->
224 <em>Warning:</em> This API is still under development. It is only
225 available for Chrome users on the
226 <span>
227 <strong>dev</strong>
228 <a href="http://www.chromium.org/getting-involved/dev-channel">ear ly
229 release channel</a>.</span>
230 <a href="TODO">Learn more</a>.
231 </p>
232 <!-- STATIC CONTENT PLACEHOLDER -->
233 <div id="static"></div>
234 <!-- API PAGE -->
235 <div class="apiPage">
236 <a name="apiReference"></a>
237 <h2>API reference: chrome.runtime</h2>
238 <!-- PROPERTIES -->
239 <!-- /apiGroup -->
240 <!-- METHODS -->
241 <div id="methodsTemplate" class="apiGroup">
242 <a name="global-methods"></a>
243 <h3>Methods</h3>
244 <!-- iterates over all functions -->
245 <div class="apiItem">
246 <a name="method-getBackgroundPage"></a> <!-- method-anchor -->
247 <h4>getBackgroundPage</h4>
248 <div class="summary">
249 <!-- Note: intentionally longer 80 columns -->
250 <span>chrome.runtime.getBackgroundPage</span>(<span class="nul l"><span>function</span>
251 <var><span>callback</span></var></span>)</div>
252 <div class="description">
253 <p>Retrieves the JavaScript 'window' object for the background p age running inside the current extension. If the background page is an event pag e, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.</p>
254 <!-- PARAMETERS -->
255 <h4>Parameters</h4>
256 <dl>
257 <div>
258 <div>
259 <dt>
260 <var>callback</var>
261 <em>
262 <!-- TYPE -->
263 <div style="display:inline">
264 (
265 <span id="typeTemplate">
266 <span>
267 <span>function</span>
268 </span>
269 </span>
270 )
271 </div>
272 </em>
273 </dt>
274 <dd class="todo">
275 Undocumented.
276 </dd>
277 <!-- OBJECT PROPERTIES -->
278 <!-- OBJECT METHODS -->
279 <!-- OBJECT EVENT FIELDS -->
280 <!-- FUNCTION PARAMETERS -->
281 </div>
282 </div>
283 </dl>
284 <!-- RETURNS -->
285 <dl>
286 </dl>
287 <!-- CALLBACK -->
288 <div>
289 <div>
290 <h4>Callback function</h4>
291 <p>
292 The <em>callback</em> parameter should specify a function
293 that looks like this:
294 </p>
295 <!-- Note: intentionally longer 80 columns -->
296 <pre>function(<span>global backgroundPage</span>) <span class= "subdued">{...}</span>;</pre>
297 <dl>
298 <div>
299 <div>
300 <dt>
301 <var>backgroundPage</var>
302 <em>
303 <!-- TYPE -->
304 <div style="display:inline">
305 (
306 <span class="optional">optional</span>
307 <span id="typeTemplate">
308 <span>
309 <span>global</span>
310 </span>
311 </span>
312 )
313 </div>
314 </em>
315 </dt>
316 <dd>The JavaScript 'window' object for the background page.</dd>
317 <!-- OBJECT PROPERTIES -->
318 <!-- OBJECT METHODS -->
319 <!-- OBJECT EVENT FIELDS -->
320 <!-- FUNCTION PARAMETERS -->
321 </div>
322 </div>
323 </dl>
324 </div>
325 </div>
326 <!-- MIN_VERSION -->
327 </div> <!-- /description -->
328 </div> <!-- /apiItem -->
329 </div> <!-- /apiGroup -->
330 <!-- EVENTS -->
331 <div id="eventsTemplate" class="apiGroup">
332 <a name="global-events"></a>
333 <h3>Events</h3>
334 <!-- iterates over all events -->
335 <div class="apiItem">
336 <a name="event-onInstalled"></a>
337 <h4>onInstalled</h4>
338 <div class="summary">
339 <!-- Note: intentionally longer 80 columns -->
340 <span class="subdued">chrome.runtime.</span><span>onInstalled</s pan><span class="subdued">.addListener</span>(function(<span></span>) <span clas s="subdued">{...}</span><span></span>);
341 </div>
342 <div class="description">
343 <p>Fired when the extension is first installed.</p>
344 <!-- LISTENER PARAMETERS -->
345 <!-- EXTRA PARAMETERS -->
346 <!-- LISTENER RETURN VALUE -->
347 <dl>
348 </dl>
349 </div> <!-- /description -->
350 <!-- /description -->
351 </div><div class="apiItem">
352 <a name="event-onSuspend"></a>
353 <h4>onSuspend</h4>
354 <div class="summary">
355 <!-- Note: intentionally longer 80 columns -->
356 <span class="subdued">chrome.runtime.</span><span>onSuspend</spa n><span class="subdued">.addListener</span>(function(<span></span>) <span class= "subdued">{...}</span><span></span>);
357 </div>
358 <div class="description">
359 <p>Sent to the event page just before it is unloaded. This gives the extension opportunity to do some clean up. Note that since the page is unlo ading, any asynchronous operations started while handling this event are not gua ranteed to complete.</p>
360 <!-- LISTENER PARAMETERS -->
361 <!-- EXTRA PARAMETERS -->
362 <!-- LISTENER RETURN VALUE -->
363 <dl>
364 </dl>
365 </div> <!-- /description -->
366 <!-- /description -->
367 </div> <!-- /apiItem -->
368 </div> <!-- /apiGroup -->
369 <!-- TYPES -->
370 <!-- /apiGroup -->
371 </div> <!-- /apiPage -->
372 </div> <!-- /gc-pagecontent -->
373 </div> <!-- /g-section -->
374 </div> <!-- /codesiteContent -->
375 <div id="gc-footer" --="">
376 <div class="text">
377 <p>
378 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
379 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
380 Attribution 3.0 License</a>, and code samples are licensed under the
381 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
382 </p>
383 <p>
384 ©2011 Google
385 </p>
386 <!-- begin analytics -->
387 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
388 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
389 <script type="text/javascript">
390 // chrome doc tracking
391 try {
392 var engdocs = _gat._getTracker("YT-10763712-2");
393 engdocs._trackPageview();
394 } catch(err) {}
395 // code.google.com site-wide tracking
396 try {
397 _uacct="UA-18071-1";
398 _uanchor=1;
399 _uff=0;
400 urchinTracker();
401 }
402 catch(e) {/* urchinTracker not available. */}
403 </script>
404 <!-- end analytics -->
405 </div>
406 </div> <!-- /gc-footer -->
407 </div> <!-- /gc-container -->
408 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/proxy.html ('k') | chrome/common/extensions/docs/samples.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698