OLD | NEW |
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: | 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 | 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 | 3 across api docs and should be edited only with knowledge of the |
4 templating mechanism. | 4 templating mechanism. |
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a | 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 | 6 browser, it will be re-generated from the template, json schema and |
7 authored overview content. | 7 authored overview content. |
8 4) The <body>.innerHTML is also generated by an offline step so that this | 8 4) The <body>.innerHTML is also generated by an offline step so that this |
9 page may easily be indexed by search engines. | 9 page may easily be indexed by search engines. |
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> | 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> |
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> | 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> |
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> | 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"> | 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla
te_compiled.js"> |
15 </script> | 15 </script> |
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini
fy-sans-regexp.js"> | 16 <script type="text/javascript" src="../../../../third_party/json_minify/mini
fy-sans-regexp.js"> |
17 </script> | 17 </script> |
18 <script type="text/javascript" src="js/api_page_generator.js"></script> | 18 <script type="text/javascript" src="js/api_page_generator.js"></script> |
19 <script type="text/javascript" src="js/bootstrap.js"></script> | 19 <script type="text/javascript" src="js/bootstrap.js"></script> |
20 <script type="text/javascript" src="js/sidebar.js"></script> | 20 <script type="text/javascript" src="js/sidebar.js"></script> |
21 <meta name="description" content="Documentation for the chrome.experimental.ru
ntime module, which is part of the Google Chrome extension APIs."><title>chrome
.experimental.runtime - Google Chrome Extensions - Google Code</title></head> | 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"> | 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. | 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> | 24 </div> |
25 <div id="branchWarning" class="displayModeWarning"> | 25 <div id="branchWarning" class="displayModeWarning"> |
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. | 26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. |
27 It may not work with the stable release of Chrome.</span> | 27 It may not work with the stable release of Chrome.</span> |
28 <select id="branchChooser"> | 28 <select id="branchChooser"> |
29 <option>Choose a different version... | 29 <option>Choose a different version... |
30 </option><option value="">Stable | 30 </option><option value="">Stable |
31 </option><option value="beta">Beta | 31 </option><option value="beta">Beta |
(...skipping 146 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
178 <li><a href="themes.html">Themes</a></li> | 178 <li><a href="themes.html">Themes</a></li> |
179 </ul> | 179 </ul> |
180 </li> | 180 </li> |
181 </ul> | 181 </ul> |
182 </div> | 182 </div> |
183 <script> | 183 <script> |
184 initToggles(); | 184 initToggles(); |
185 </script> | 185 </script> |
186 <div class="g-unit" id="gc-pagecontent"> | 186 <div class="g-unit" id="gc-pagecontent"> |
187 <div id="pageTitle"> | 187 <div id="pageTitle"> |
188 <h1 class="page_title">chrome.experimental.runtime</h1> | 188 <h1 class="page_title">chrome.runtime</h1> |
189 </div> | 189 </div> |
190 <!-- TABLE OF CONTENTS --> | 190 <!-- TABLE OF CONTENTS --> |
191 <div id="toc"> | 191 <div id="toc"> |
192 <h2>Contents</h2> | 192 <h2>Contents</h2> |
193 <ol> | 193 <ol> |
194 <li> | 194 <li> |
195 <a href="#apiReference">API reference: chrome.experimental.runti
me</a> | 195 <a href="#apiReference">API reference: chrome.runtime</a> |
196 <ol> | 196 <ol> |
197 <li> | 197 <li> |
198 <a href="#global-methods">Methods</a> | 198 <a href="#global-methods">Methods</a> |
199 <ol> | 199 <ol> |
200 <li> | 200 <li> |
201 <a href="#method-getBackgroundPage">getBackgroundPage</a> | 201 <a href="#method-getBackgroundPage">getBackgroundPage</a> |
202 </li> | 202 </li> |
203 </ol> | 203 </ol> |
204 </li> | 204 </li> |
205 <li> | 205 <li> |
206 <a href="#global-events">Events</a> | 206 <a href="#global-events">Events</a> |
207 <ol> | 207 <ol> |
208 <li> | 208 <li> |
209 <a href="#event-onBackgroundPageUnloadingSoon">onBackgroundPageU
nloadingSoon</a> | 209 <a href="#event-onBackgroundPageUnloadingSoon">onBackgroundPageU
nloadingSoon</a> |
210 </li><li> | 210 </li><li> |
211 <a href="#event-onInstalled">onInstalled</a> | 211 <a href="#event-onInstalled">onInstalled</a> |
212 </li> | 212 </li> |
213 </ol> | 213 </ol> |
214 </li> | 214 </li> |
215 </ol> | 215 </ol> |
216 </li> | 216 </li> |
217 </ol> | 217 </ol> |
218 </div> | 218 </div> |
219 <!-- /TABLE OF CONTENTS --> | 219 <!-- /TABLE OF CONTENTS --> |
220 <!-- Standard content lead-in for experimental API pages --> | 220 <!-- Standard content lead-in for experimental API pages --> |
221 <p id="classSummary"> | 221 <p class="warning"> |
222 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. | 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>. |
223 </p> | 231 </p> |
224 <!-- STATIC CONTENT PLACEHOLDER --> | 232 <!-- STATIC CONTENT PLACEHOLDER --> |
225 <div id="static"></div> | 233 <div id="static"></div> |
226 <!-- API PAGE --> | 234 <!-- API PAGE --> |
227 <div class="apiPage"> | 235 <div class="apiPage"> |
228 <a name="apiReference"></a> | 236 <a name="apiReference"></a> |
229 <h2>API reference: chrome.experimental.runtime</h2> | 237 <h2>API reference: chrome.runtime</h2> |
230 <!-- PROPERTIES --> | 238 <!-- PROPERTIES --> |
231 <!-- /apiGroup --> | 239 <!-- /apiGroup --> |
232 <!-- METHODS --> | 240 <!-- METHODS --> |
233 <div id="methodsTemplate" class="apiGroup"> | 241 <div id="methodsTemplate" class="apiGroup"> |
234 <a name="global-methods"></a> | 242 <a name="global-methods"></a> |
235 <h3>Methods</h3> | 243 <h3>Methods</h3> |
236 <!-- iterates over all functions --> | 244 <!-- iterates over all functions --> |
237 <div class="apiItem"> | 245 <div class="apiItem"> |
238 <a name="method-getBackgroundPage"></a> <!-- method-anchor --> | 246 <a name="method-getBackgroundPage"></a> <!-- method-anchor --> |
239 <h4>getBackgroundPage</h4> | 247 <h4>getBackgroundPage</h4> |
240 <div class="summary"> | 248 <div class="summary"> |
241 <!-- Note: intentionally longer 80 columns --> | 249 <!-- Note: intentionally longer 80 columns --> |
242 <span>chrome.experimental.runtime.getBackgroundPage</span>(<sp
an class="null"><span>function</span> | 250 <span>chrome.runtime.getBackgroundPage</span>(<span class="nul
l"><span>function</span> |
243 <var><span>callback</span></var></span>)</div> | 251 <var><span>callback</span></var></span>)</div> |
244 <div class="description"> | 252 <div class="description"> |
245 <p>Retrieves the JavaScript 'window' object for the background p
age running inside the current extension. If the background page is transient, t
he system will ensure it is loaded before calling the callback. If there is no b
ackground page, an error is set.</p> | 253 <p>Retrieves the JavaScript 'window' object for the background p
age running inside the current extension. If the background page is transient, t
he system will ensure it is loaded before calling the callback. If there is no b
ackground page, an error is set.</p> |
246 <!-- PARAMETERS --> | 254 <!-- PARAMETERS --> |
247 <h4>Parameters</h4> | 255 <h4>Parameters</h4> |
248 <dl> | 256 <dl> |
249 <div> | 257 <div> |
250 <div> | 258 <div> |
251 <dt> | 259 <dt> |
252 <var>callback</var> | 260 <var>callback</var> |
(...skipping 69 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
322 <!-- EVENTS --> | 330 <!-- EVENTS --> |
323 <div id="eventsTemplate" class="apiGroup"> | 331 <div id="eventsTemplate" class="apiGroup"> |
324 <a name="global-events"></a> | 332 <a name="global-events"></a> |
325 <h3>Events</h3> | 333 <h3>Events</h3> |
326 <!-- iterates over all events --> | 334 <!-- iterates over all events --> |
327 <div class="apiItem"> | 335 <div class="apiItem"> |
328 <a name="event-onBackgroundPageUnloadingSoon"></a> | 336 <a name="event-onBackgroundPageUnloadingSoon"></a> |
329 <h4>onBackgroundPageUnloadingSoon</h4> | 337 <h4>onBackgroundPageUnloadingSoon</h4> |
330 <div class="summary"> | 338 <div class="summary"> |
331 <!-- Note: intentionally longer 80 columns --> | 339 <!-- Note: intentionally longer 80 columns --> |
332 <span class="subdued">chrome.experimental.runtime.</span><span>o
nBackgroundPageUnloadingSoon</span><span class="subdued">.addListener</span>(fun
ction(<span></span>) <span class="subdued">{...}</span><span></span>); | 340 <span class="subdued">chrome.runtime.</span><span>onBackgroundPa
geUnloadingSoon</span><span class="subdued">.addListener</span>(function(<span><
/span>) <span class="subdued">{...}</span><span></span>); |
333 </div> | 341 </div> |
334 <div class="description"> | 342 <div class="description"> |
335 <p>Sent to the transient background page just before it is unloa
ded. This gives the extension opportunity to do some clean up. Note that since t
he page is unloading, any asynchronous operations started while handling this ev
ent are not guaranteed to complete.</p> | 343 <p>Sent to the transient background page just before it is unloa
ded. This gives the extension opportunity to do some clean up. Note that since t
he page is unloading, any asynchronous operations started while handling this ev
ent are not guaranteed to complete.</p> |
336 <!-- LISTENER PARAMETERS --> | 344 <!-- LISTENER PARAMETERS --> |
337 <!-- EXTRA PARAMETERS --> | 345 <!-- EXTRA PARAMETERS --> |
338 <!-- LISTENER RETURN VALUE --> | 346 <!-- LISTENER RETURN VALUE --> |
339 <dl> | 347 <dl> |
340 </dl> | 348 </dl> |
341 </div> <!-- /description --> | 349 </div> <!-- /description --> |
342 <!-- /description --> | 350 <!-- /description --> |
343 </div><div class="apiItem"> | 351 </div><div class="apiItem"> |
344 <a name="event-onInstalled"></a> | 352 <a name="event-onInstalled"></a> |
345 <h4>onInstalled</h4> | 353 <h4>onInstalled</h4> |
346 <div class="summary"> | 354 <div class="summary"> |
347 <!-- Note: intentionally longer 80 columns --> | 355 <!-- Note: intentionally longer 80 columns --> |
348 <span class="subdued">chrome.experimental.runtime.</span><span>o
nInstalled</span><span class="subdued">.addListener</span>(function(<span></span
>) <span class="subdued">{...}</span><span></span>); | 356 <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>); |
349 </div> | 357 </div> |
350 <div class="description"> | 358 <div class="description"> |
351 <p>Fired when the extension is first installed.</p> | 359 <p>Fired when the extension is first installed.</p> |
352 <!-- LISTENER PARAMETERS --> | 360 <!-- LISTENER PARAMETERS --> |
353 <!-- EXTRA PARAMETERS --> | 361 <!-- EXTRA PARAMETERS --> |
354 <!-- LISTENER RETURN VALUE --> | 362 <!-- LISTENER RETURN VALUE --> |
355 <dl> | 363 <dl> |
356 </dl> | 364 </dl> |
357 </div> <!-- /description --> | 365 </div> <!-- /description --> |
358 <!-- /description --> | 366 <!-- /description --> |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
391 _uff=0; | 399 _uff=0; |
392 urchinTracker(); | 400 urchinTracker(); |
393 } | 401 } |
394 catch(e) {/* urchinTracker not available. */} | 402 catch(e) {/* urchinTracker not available. */} |
395 </script> | 403 </script> |
396 <!-- end analytics --> | 404 <!-- end analytics --> |
397 </div> | 405 </div> |
398 </div> <!-- /gc-footer --> | 406 </div> <!-- /gc-footer --> |
399 </div> <!-- /gc-container --> | 407 </div> <!-- /gc-container --> |
400 </body></html> | 408 </body></html> |
OLD | NEW |