forked from Yixi/ChromeExtensionDocument
/
runtime.html
437 lines (430 loc) · 23.4 KB
/
runtime.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="stable/static/css/site.css" rel="stylesheet" type="text/css">
<link href="stable/static/css/print.css" rel="stylesheet" type="text/css" media="print">
<link href="stable/static/css/prettify.css" rel="stylesheet" type="text/css">
<link href="//www.google.com/images/icons/product/chrome-16.png" rel="icon" type="image/ico">
<link href="stable/static/css/api.css" rel="stylesheet" type="text/css">
<title>chrome.runtime - chrome插件中文开发文档(非官方)</title>
</head>
<body>
<a id="top"></a>
<div id="header">{Header content}</div>
<a id="gc-topnav-anchor"></a>
<div id="gc-topnav">
<h1>Google Chrome Extensions</h1>
<ul id="home" class="gc-topnav-tabs">
<li id="home_link">
<a href="index.html" title="Google Chrome Extensions home page"><div>Home</div></a>
</li>
<li id="docs_link">
<a href="docs.html" title="Official Google Chrome Extensions documentation"><div>Docs</div></a>
</li>
<li id="faq_link">
<a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions"><div>FAQ</div></a>
</li>
<li id="samples_link">
<a href="samples.html" title="Sample Extensions (with source code)"><div>Samples</div></a>
</li>
<li id="group_link">
<a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum"><div>Group</div></a>
</li>
<li id="so_link">
<a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><div>Questions?</div></a>
</li>
</ul>
</div>
<div id="gc-container">
<div id="gc-sidebar">
<ul
class="level1 ">
<li class="level2">
<a href="getstarted.html" class="level2 ">Getting Started</a>
</li>
<li class="level2">
<a href="overview.html" class="level2 ">Overview</a>
</li>
<li class="level2">
<a href="whats_new.html" class="level2 ">What's New?</a>
</li>
<li class="level2">
<a href="devguide.html" class="level2 ">Developer's Guide</a>
<ul
class="level2 ">
<li class="level3">
<a class="button level3">
<span class="level3">Browser UI</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="browserAction.html" class="level4 ">Browser Actions</a>
</li>
<li class="level4">
<a href="contextMenus.html" class="level4 ">Context Menus</a>
</li>
<li class="level4">
<a href="notifications.html" class="level4 ">Desktop Notifications</a>
</li>
<li class="level4">
<a href="omnibox.html" class="level4 ">Omnibox</a>
</li>
<li class="level4">
<a href="options.html" class="level4 ">Options Pages</a>
</li>
<li class="level4">
<a href="override.html" class="level4 ">Override Pages</a>
</li>
<li class="level4">
<a href="pageAction.html" class="level4 ">Page Actions</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Browser Interaction</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="bookmarks.html" class="level4 ">Bookmarks</a>
</li>
<li class="level4">
<a href="cookies.html" class="level4 ">Cookies</a>
</li>
<li class="level4">
<a href="devtools.html" class="level4 ">Developer Tools</a>
</li>
<li class="level4">
<a href="events.html" class="level4 ">Events</a>
</li>
<li class="level4">
<a href="history.html" class="level4 ">History</a>
</li>
<li class="level4">
<a href="management.html" class="level4 ">Management</a>
</li>
<li class="level4">
<a href="tabs.html" class="level4 ">Tabs</a>
</li>
<li class="level4">
<a href="windows.html" class="level4 ">Windows</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Implementation</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="a11y.html" class="level4 ">Accessibility</a>
</li>
<li class="level4">
<a href="event_pages.html" class="level4 ">Event Pages</a>
</li>
<li class="level4">
<a href="contentSecurityPolicy.html" class="level4 ">Content Security Policy</a>
</li>
<li class="level4">
<a href="content_scripts.html" class="level4 ">Content Scripts</a>
</li>
<li class="level4">
<a href="xhr.html" class="level4 ">Cross-Origin XHR</a>
</li>
<li class="level4">
<a href="i18n.html" class="level4 ">Internationalization</a>
</li>
<li class="level4">
<a href="messaging.html" class="level4 ">Message Passing</a>
</li>
<li class="level4">
<a href="permissions.html" class="level4 ">Optional Permissions</a>
</li>
<li class="level4">
<a href="npapi.html" class="level4 ">NPAPI Plugins</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Finishing</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="hosting.html" class="level4 ">Hosting</a>
</li>
<li class="level4">
<a href="external_extensions.html" class="level4 ">Other Deployment Options</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="level2">
<a href="tutorials.html" class="level2 ">Tutorials</a>
<ul
class="level2 ">
<li class="level3">
<a href="tut_migration_to_manifest_v2.html" class="level3 ">Manifest V2</a>
</li>
<li class="level3">
<a href="tut_debugging.html" class="level3 ">Debugging</a>
</li>
<li class="level3">
<a href="tut_analytics.html" class="level3 ">Google Analytics</a>
</li>
<li class="level3">
<a href="tut_oauth.html" class="level3 ">OAuth</a>
</li>
</ul>
</li>
<li class="level2">
<span class="level2">Reference</span>
<ul
class="level2 ">
<li class="level3">
<a class="button level3">
<span class="level3">Formats</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="manifest.html" class="level4 ">Manifest Files</a>
</li>
<li class="level4">
<a href="match_patterns.html" class="level4 ">Match Patterns</a>
</li>
</ul>
</li>
<li class="level3">
<a href="permission_warnings.html" class="level3 ">Permission Warnings</a>
</li>
<li class="level3">
<a href="api_index.html" class="level3 ">chrome.* APIs</a>
</li>
<li class="level3">
<a href="api_other.html" class="level3 ">Other APIs</a>
</li>
</ul>
</li>
<li class="level2">
<span class="level2">More</span>
<ul
class="level2 ">
<li class="level3">
<a href="http://code.google.com/chrome/webstore/docs/index.html" class="level3 ">Chrome Web Store</a>
</li>
<li class="level3">
<a href="http://code.google.com/chrome/apps/docs/developers_guide.html" class="level3 ">Hosted Apps</a>
</li>
<li class="level3">
<a href="themes.html" class="level3 ">Themes</a>
</li>
</ul>
</li>
</ul>
</div>
<div id="gc-pagecontent">
<h1 class="page_title">chrome.runtime</h1>
<div id="toc">
<h2>Contents</h2>
<ol>
<li>
<a href="#apiReference">API reference: chrome.runtime</a>
<ol>
<li><a href="#properties">Properties</a><ol> <li> <a href="#property-lastError">lastError</a><ol><li> <a href="#lastError-properties">Properties</a> <ol> <li> <a href="#property-lastError-message">message</a> </li> </ol> </li></ol> </li> <li> <a href="#property-id">id</a> </li></ol></li>
<li><a href="#methods">Methods</a><ol> <li><a href="#method-getBackgroundPage">getBackgroundPage</a></li> <li><a href="#method-getManifest">getManifest</a></li> <li><a href="#method-getURL">getURL</a></li></ol></li>
<li><a href="#events">Events</a><ol> <li><a href="#event-onStartup">onStartup</a></li> <li><a href="#event-onInstalled">onInstalled</a></li> <li><a href="#event-onSuspend">onSuspend</a></li> <li><a href="#event-onSuspendCanceled">onSuspendCanceled</a></li></ol></li>
<li><a href="#samples">Sample Extensions</a></li>
</ol>
</li>
</ol>
</div>
<h2 id="apiReference">API Reference: chrome.runtime</h2>
<div class="api_reference">
<h3 id="properties">Properties</h3>
<div>
<h3 id="property-lastError">lastError</h3>
<div class="summary">
<span>chrome.runtime.lastError</span>
</div>
<div>
<dt><span class="property">lastError</span> <span class="type_name"> ( <span class="optional">optional</span> <span id="typeTemplate">object</span> )</span></dt>
<dd>
This will be defined during an API method callback if there was an error
</dd> <h4 id="lastError-properties">
Properties of <a href="#property-lastError">lastError</a>
</h4>
<dd><dl> <div>
<a name="property-lastError-message"></a>
<dt>
<span class="variable">message</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Details about the error which occurred.
</dd>
</div>
</dl></dd>
</div>
</div>
<div>
<h3 id="property-id">id</h3>
<div class="summary">
<span>chrome.runtime.id</span>
</div>
<div>
<dt><span class="property">id</span> <span class="type_name"> ( <span id="typeTemplate">string</span> )</span></dt>
<dd>
The ID of the extension/app.
</dd> </div>
</div>
<h3 id="methods">Methods</h3>
<div>
<h4 id="method-getBackgroundPage">getBackgroundPage</h4>
<div class="summary lower">
<span>chrome.runtime.getBackgroundPage</span>()
</div>
<div class="description">
<p>
Retrieves the JavaScript 'window' object for the background page running inside the current extension. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.
</p> </div>
</div>
<div>
<h4 id="method-getManifest">getManifest</h4>
<div class="summary">
<span>object chrome.runtime.getManifest</span>()
</div>
<div class="description">
<p>
Returns details about the app or extension from the manifest. The object returned is a serialization of the full <a href="manifest.html">manifest file</a>.
</p> </div>
</div>
<div>
<h4 id="method-getURL">getURL</h4>
<div class="summary">
<span>string chrome.runtime.getURL</span>(<span>string <span class="variable">path</span></span>)
</div>
<div class="description">
<p>
Converts a relative path within an app/extension install directory to a fully-qualified URL.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-getURL-path"></a> <dt> <span class="variable">path</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> A path to a resource within an app/extension expressed relative to its install directory. </dd></div>
</dl>
</div>
</div>
<h3 id="events">Events</h3>
<div>
<h4 id="event-onStartup">onStartup</h4>
<div class="summary">
<span class="subdued">chrome.runtime.</span>onStartup<span class="subdued">.addListener</span>(function()<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
Fired when the browser first starts up.
</p> </div>
</div>
<div>
<h4 id="event-onInstalled">onInstalled</h4>
<div class="summary">
<span class="subdued">chrome.runtime.</span>onInstalled<span class="subdued">.addListener</span>(function(<span>object <span class="variable">details</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
Fired when the extension is first installed, and on each update to a new version.
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onInstalled-details"></a> <dt> <span class="variable">details</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-details-reason"></a> <dt> <span class="variable">reason</span> <span class="property"> ( <span id="typeTemplate">enumerated string ["install", "update"]</span> ) </span> </dt> <dd> The reason that this event is being dispatched. </dd> </div> <div> <a name="property-details-previousVersion"></a> <dt> <span class="variable">previousVersion</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">string</span> ) </span> </dt> <dd> Indicates the previous version of the extension, which has just been updated. This is present only if 'reason' is 'update'. </dd> </div> </dl> </dd></div>
</dl>
</div>
</div>
<div>
<h4 id="event-onSuspend">onSuspend</h4>
<div class="summary">
<span class="subdued">chrome.runtime.</span>onSuspend<span class="subdued">.addListener</span>(function()<span class="subdued"> {...}</span>);
</div>
<div class="description">
<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 unloading, any asynchronous operations started while handling this event are not guaranteed to complete. If more activity for the event page occurs before it gets unloaded the onSuspendCanceled event will be sent and the page won't be unloaded.
</p> </div>
</div>
<div>
<h4 id="event-onSuspendCanceled">onSuspendCanceled</h4>
<div class="summary">
<span class="subdued">chrome.runtime.</span>onSuspendCanceled<span class="subdued">.addListener</span>(function()<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
Sent after onSuspend() to indicate that the app won't be unloaded after all.
</p> </div>
</div>
</div>
<h2 id="samples">Sample Extensions that use chrome.runtime</h2>
<li><strong><a href="samples.html#e0410b3575a19930b8cf73f1e5acee0a">Context Menus Sample (with Event Page)</a></strong> –
Shows some of the features of the Context Menus API using an event page
</li>
<li><strong><a href="samples.html#d5d930bdcf3f5e1753d0de5924a89a65">Event Page Example</a></strong> –
Demonstrates usage and features of the event page
</li>
<li><strong><a href="samples.html#0837f59976e148ed9922266e1de6c29f">WebNavigation Tech Demo</a></strong> –
Demonstration of the WebNavigation extension API.
</li>
<li><strong><a href="samples.html#ecc227966949f60af19c444222a775d9">Catifier</a></strong> –
Moar cats!
</li>
<li><strong><a href="samples.html#5139d19c542e2188a42418c27c9cdd5b">Google Mail Checker</a></strong> –
Displays the number of unread messages in your Google Mail inbox. You can also click the button to open your inbox.
</li>
</div>
</div>
</body>
<script>
window.bootstrap = {
api_names: [{"name":"alarms"},{"name":"bookmarks"},{"name":"browserAction"},{"name":"browsingData"},{"name":"commands"},{"name":"contentSettings"},{"name":"contextMenus"},{"name":"cookies"},{"name":"debugger"},{"name":"declarativeWebRequest"},{"name":"devtools.inspectedWindow"},{"name":"devtools.network"},{"name":"devtools.panels"},{"name":"downloads"},{"name":"events"},{"name":"extension"},{"name":"fileBrowserHandler"},{"name":"fontSettings"},{"name":"history"},{"name":"i18n"},{"name":"idle"},{"name":"input.ime"},{"name":"management"},{"name":"omnibox"},{"name":"pageAction"},{"name":"pageCapture"},{"name":"permissions"},{"name":"privacy"},{"name":"proxy"},{"name":"runtime"},{"name":"scriptBadge"},{"name":"storage"},{"name":"tabs"},{"name":"topSites"},{"name":"tts"},{"name":"ttsEngine"},{"name":"types"},{"name":"webNavigation"},{"name":"webRequest"},{"name":"webstore"},{"last":true,"name":"windows"}].concat(
[{"name":"experimental.bluetooth"},{"name":"experimental.devtools.audits"},{"name":"experimental.devtools.console"},{"name":"experimental.discovery"},{"name":"experimental.identity"},{"name":"experimental.infobars"},{"name":"experimental.offscreenTabs"},{"name":"experimental.processes"},{"name":"experimental.record"},{"name":"experimental.speechInput"},{"name":"experimental.systemInfo.cpu"},{"name":"experimental.systemInfo.storage"},{"last":true,"name":"experimental.usb"}]),
branchInfo: {"channels":[{"path":"stable","name":"Stable"},{"path":"dev","name":"Dev"},{"path":"beta","name":"Beta"},{"path":"trunk","name":"Trunk"}],"current":"stable","showWarning":false}
};
</script>
<div id="gc-footer">
<div class="text">
<p>
Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
<a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
</p>
<p>
©2012 Google
</p>
<script src="stable/static/js/branch.js" type="text/javascript"></script>
<script src="stable/static/js/sidebar.js" type="text/javascript"></script>
<script src="stable/static/js/prettify.js" type="text/javascript"></script>
<script>
(function() {
// Auto syntax highlight all pre tags.
var preElements = document.getElementsByTagName('pre');
for (var i = 0; i < preElements.length; i++)
preElements[i].classList.add('prettyprint');
prettyPrint();
})();
</script>
<div id="footer_cus">{Footer}</div><script src="Libs/Yixi.js"></script><script src="http://s9.cnzz.com/stat.php?id=4928336&web_id=4928336" language="JavaScript"></script>
</div>
</div>
</html>