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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: fix 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
« chrome/common/extensions/docs/js/api_page_generator.js ('K') | « chrome/common/extensions/docs/types.html ('k') | chrome/common/extensions/docs/webRequest.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.webNavigation m odule, which is part of the Google Chrome extension APIs."><title>WebNavigation API - Google Chrome Extensions - Google Code</title></head>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">WebNavigation API</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#H2-0">Manifest</a>
196 <ol>
197 </ol>
198 </li><li>
199 <a href="#H2-1">Examples</a>
200 <ol>
201 </ol>
202 </li><li>
203 <a href="#H2-2">Event order</a>
204 <ol>
205 </ol>
206 </li><li>
207 <a href="#H2-3">Relation to webRequest events</a>
208 <ol>
209 </ol>
210 </li><li>
211 <a href="#H2-4">A note about timestamps</a>
212 <ol>
213 </ol>
214 </li><li>
215 <a href="#H2-5">Transition types and qualifiers</a>
216 <ol>
217 </ol>
218 </li>
219 <li>
220 <a href="#apiReference">API reference: chrome.webNavigation</a>
221 <ol>
222 <li>
223 <a href="#global-methods">Methods</a>
224 <ol>
225 <li>
226 <a href="#method-getAllFrames">getAllFrames</a>
227 </li><li>
228 <a href="#method-getFrame">getFrame</a>
229 </li>
230 </ol>
231 </li>
232 <li>
233 <a href="#global-events">Events</a>
234 <ol>
235 <li>
236 <a href="#event-onBeforeNavigate">onBeforeNavigate</a>
237 </li><li>
238 <a href="#event-onCommitted">onCommitted</a>
239 </li><li>
240 <a href="#event-onCompleted">onCompleted</a>
241 </li><li>
242 <a href="#event-onCreatedNavigationTarget">onCreatedNavigationTa rget</a>
243 </li><li>
244 <a href="#event-onDOMContentLoaded">onDOMContentLoaded</a>
245 </li><li>
246 <a href="#event-onErrorOccurred">onErrorOccurred</a>
247 </li><li>
248 <a href="#event-onReferenceFragmentUpdated">onReferenceFragmentU pdated</a>
249 </li>
250 </ol>
251 </li>
252 </ol>
253 </li>
254 </ol>
255 </div>
256 <!-- /TABLE OF CONTENTS -->
257 <!-- Standard content lead-in for experimental API pages -->
258 <!-- STATIC CONTENT PLACEHOLDER -->
259 <div id="static"><div id="pageData-name" class="pageData">WebNavigation API</div>
260 <!-- BEGIN AUTHORED CONTENT -->
261 <p id="classSummary">
262 Use the <code>chrome.webNavigation</code> module to receive
263 notifications about the status of navigations requests in-flight.
264 </p>
265 <a name="H2-0"></a><h2>Manifest</h2>
266 <p>
267 All <code>chrome.webNavigation</code> methods and events require you to declare
268 the "webNavigation" permission in the <a href="manifest.html">extension
269 manifest</a>.
270 For example:
271 </p>
272 <pre>{
273 "name": "My extension",
274 ...
275 <b>"permissions": [
276 "webNavigation"
277 ]</b>,
278 ...
279 }</pre>
280 <a name="H2-1"></a><h2>Examples</h2>
281 <p>
282 You can find simple examples of using the tabs module in the
283 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/webNavigation/">examples/api/webNavigation</a>
284 directory.
285 For other examples and for help in viewing the source code, see
286 <a href="samples.html">Samples</a>.
287 </p>
288 <a name="H2-2"></a><h2>Event order</h2>
289 <p>
290 For a navigation that is successfully completed, events are fired in the
291 following order:
292 </p><pre>onBeforeNavigate -&gt; onCommitted -&gt; onDOMContentLoaded -&gt; onCom pleted
293 </pre>
294 <p></p>
295 <p>
296 Any error that occurs during the process results in an
297 <code>onErrorOccurred</code> event. For a specific navigation, there are no
298 further events fired after <code>onErrorOccurred</code>.
299 </p>
300 <p>
301 If a navigating frame contains subframes, its <code>onCommitted</code> is fired
302 before any of its children's <code>onBeforeNavigate</code>; while
303 <code>onCompleted</code> is fired after all of its children's
304 <code>onCompleted</code>.
305 </p>
306 <p>
307 If the reference fragment of a frame is changed, a
308 <code>onReferenceFragmentUpdated</code> event is fired. This event can fire any
309 time after <code>onDOMContentLoaded</code>, even after
310 <code>onCompleted</code>.
311 </p>
312 <a name="H2-3"></a><h2>Relation to webRequest events</h2>
313 <p>
314 There is no defined ordering between events of the <a href="webRequest.html">web Request API</a> and the events of the
315 webNavigation API. It is possible that webRequest events are still received for
316 frames that already started a new navigation, or that a navigation only
317 proceeds after the network resources are already fully loaded.
318 </p>
319 <p>
320 In general, the webNavigation events are closely related to the navigation
321 state that is displayed in the UI, while the webRequest events correspond to
322 the state of the network stack which is generally opaque to the user.
323 </p>
324 <a name="H2-4"></a><h2>A note about timestamps</h2>
325 <p>
326 It's important to note that some technical oddities in the OS's handling
327 of distinct Chrome processes can cause the clock to be skewed between the
328 browser itself and extension processes. That means that WebNavigation's events'
329 <code>timeStamp</code> property is only guaranteed to be <i>internally</i>
330 consistent. Comparing one event to another event will give you the correct
331 offset between them, but comparing them to the current time inside the
332 extension (via <code>(new Date()).getTime()</code>, for instance) might give
333 unexpected results.
334 </p>
335 <a name="H2-5"></a><h2>Transition types and qualifiers</h2>
336 <p>
337 The webNavigation API's <code>onCommitted</code> event has a
338 <code>transitionType</code> and a <code>transitionQualifiers</code> property.
339 The <em>transition type</em> is the same as used in the <a href="history.html#tr ansition_types">history API</a> describing how the browser
340 navigated to this particular URL. In addition, several <em>transition
341 qualifiers</em> can be returned that further define the navigation.
342 </p>
343 <p>
344 The following transition qualifiers exist:
345 </p>
346 <table>
347 <tbody><tr>
348 <th> Transition qualifier </th> <th> Description </th>
349 </tr>
350 <tr>
351 <td>"client_redirect"</td>
352 <td>
353 One or more redirects caused by JavaScript or meta refresh tags on the page
354 happened during the navigation.
355 </td>
356 </tr>
357 <tr>
358 <td>"server_redirect"</td>
359 <td>
360 One or more redirects caused by HTTP headers sent from the server happened
361 during the navigation.
362 </td>
363 </tr>
364 <tr>
365 <td>"forward_back"</td>
366 <td>
367 The user used the Forward or Back button to initiate the navigation.
368 </td>
369 </tr>
370 <tr>
371 <td>"from_address_bar"</td>
372 <td>
373 The user initiated the navigation from the address bar (aka Omnibox).
374 </td>
375 </tr>
376 </tbody></table>
377 <!-- END AUTHORED CONTENT -->
378 </div>
379 <!-- API PAGE -->
380 <div class="apiPage">
381 <a name="apiReference"></a>
382 <h2>API reference: chrome.webNavigation</h2>
383 <!-- PROPERTIES -->
384 <!-- /apiGroup -->
385 <!-- METHODS -->
386 <div id="methodsTemplate" class="apiGroup">
387 <a name="global-methods"></a>
388 <h3>Methods</h3>
389 <!-- iterates over all functions -->
390 <div class="apiItem">
391 <a name="method-getAllFrames"></a> <!-- method-anchor -->
392 <h4>getAllFrames</h4>
393 <div class="summary">
394 <!-- Note: intentionally longer 80 columns -->
395 <span>chrome.webNavigation.getAllFrames</span>(<span class="nu ll"><span>object</span>
396 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
397 <var><span>callback</span></var></span>)</div>
398 <div class="description">
399 <p>Retrieves information about all frames of a given tab.</p>
400 <!-- PARAMETERS -->
401 <h4>Parameters</h4>
402 <dl>
403 <div>
404 <div>
405 <dt>
406 <var>details</var>
407 <em>
408 <!-- TYPE -->
409 <div style="display:inline">
410 (
411 <span id="typeTemplate">
412 <span>
413 <span>object</span>
414 </span>
415 </span>
416 )
417 </div>
418 </em>
419 </dt>
420 <dd>Information about the tab to retrieve all frames from.</dd>
421 <!-- OBJECT PROPERTIES -->
422 <dd>
423 <dl>
424 <div>
425 <div>
426 <dt>
427 <var>tabId</var>
428 <em>
429 <!-- TYPE -->
430 <div style="display:inline">
431 (
432 <span id="typeTemplate">
433 <span>
434 <span>integer</span>
435 </span>
436 </span>
437 )
438 </div>
439 </em>
440 </dt>
441 <dd>The ID of the tab.</dd>
442 <!-- OBJECT PROPERTIES -->
443 <!-- OBJECT METHODS -->
444 <!-- OBJECT EVENT FIELDS -->
445 <!-- FUNCTION PARAMETERS -->
446 </div>
447 </div>
448 </dl>
449 </dd>
450 <!-- OBJECT METHODS -->
451 <!-- OBJECT EVENT FIELDS -->
452 <!-- FUNCTION PARAMETERS -->
453 </div>
454 </div><div>
455 <div>
456 <dt>
457 <var>callback</var>
458 <em>
459 <!-- TYPE -->
460 <div style="display:inline">
461 (
462 <span id="typeTemplate">
463 <span>
464 <span>function</span>
465 </span>
466 </span>
467 )
468 </div>
469 </em>
470 </dt>
471 <dd class="todo">
472 Undocumented.
473 </dd>
474 <!-- OBJECT PROPERTIES -->
475 <!-- OBJECT METHODS -->
476 <!-- OBJECT EVENT FIELDS -->
477 <!-- FUNCTION PARAMETERS -->
478 </div>
479 </div>
480 </dl>
481 <!-- RETURNS -->
482 <dl>
483 </dl>
484 <!-- CALLBACK -->
485 <div>
486 <div>
487 <h4>Callback function</h4>
488 <p>
489 The <em>callback</em> parameter should specify a function
490 that looks like this:
491 </p>
492 <!-- Note: intentionally longer 80 columns -->
493 <pre>function(<span>array of object details</span>) <span clas s="subdued">{...}</span>;</pre>
494 <dl>
495 <div>
496 <div>
497 <dt>
498 <var>details</var>
499 <em>
500 <!-- TYPE -->
501 <div style="display:inline">
502 (
503 <span class="optional">optional</span>
504 <span id="typeTemplate">
505 <span>
506 <span>
507 array of <span><span>
508 <span>
509 <span>object</span>
510 </span>
511 </span></span>
512 </span>
513 </span>
514 </span>
515 )
516 </div>
517 </em>
518 </dt>
519 <dd>A list of frames in the given tab, null if the specified tab ID is invalid.</dd>
520 <!-- OBJECT PROPERTIES -->
521 <dd>
522 <dl>
523 <div>
524 <div>
525 <dt>
526 <var>errorOccurred</var>
527 <em>
528 <!-- TYPE -->
529 <div style="display:inline">
530 (
531 <span id="typeTemplate">
532 <span>
533 <span>boolean</span>
534 </span>
535 </span>
536 )
537 </div>
538 </em>
539 </dt>
540 <dd>True if the last navigation in this frame was interrupted by an er ror, i.e. the onErrorOccurred event fired.</dd>
541 <!-- OBJECT PROPERTIES -->
542 <!-- OBJECT METHODS -->
543 <!-- OBJECT EVENT FIELDS -->
544 <!-- FUNCTION PARAMETERS -->
545 </div>
546 </div><div>
547 <div>
548 <dt>
549 <var>frameId</var>
550 <em>
551 <!-- TYPE -->
552 <div style="display:inline">
553 (
554 <span id="typeTemplate">
555 <span>
556 <span>integer</span>
557 </span>
558 </span>
559 )
560 </div>
561 </em>
562 </dt>
563 <dd>The ID of the frame. 0 indicates that this is the main frame; a po sitive value indicates the ID of a subframe.</dd>
564 <!-- OBJECT PROPERTIES -->
565 <!-- OBJECT METHODS -->
566 <!-- OBJECT EVENT FIELDS -->
567 <!-- FUNCTION PARAMETERS -->
568 </div>
569 </div><div>
570 <div>
571 <dt>
572 <var>url</var>
573 <em>
574 <!-- TYPE -->
575 <div style="display:inline">
576 (
577 <span id="typeTemplate">
578 <span>
579 <span>string</span>
580 </span>
581 </span>
582 )
583 </div>
584 </em>
585 </dt>
586 <dd>The URL currently associated with this frame, if the frame identif ied by the frameId existed at one point in the given tab. The fact that an URL i s associated with a given frameId does not imply that the corresponding frame st ill exists.</dd>
587 <!-- OBJECT PROPERTIES -->
588 <!-- OBJECT METHODS -->
589 <!-- OBJECT EVENT FIELDS -->
590 <!-- FUNCTION PARAMETERS -->
591 </div>
592 </div>
593 </dl>
594 </dd>
595 <!-- OBJECT METHODS -->
596 <!-- OBJECT EVENT FIELDS -->
597 <!-- FUNCTION PARAMETERS -->
598 </div>
599 </div>
600 </dl>
601 </div>
602 </div>
603 <!-- MIN_VERSION -->
604 </div> <!-- /description -->
605 </div><div class="apiItem">
606 <a name="method-getFrame"></a> <!-- method-anchor -->
607 <h4>getFrame</h4>
608 <div class="summary">
609 <!-- Note: intentionally longer 80 columns -->
610 <span>chrome.webNavigation.getFrame</span>(<span class="null"> <span>object</span>
611 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
612 <var><span>callback</span></var></span>)</div>
613 <div class="description">
614 <p>Retrieves information about the given frame. A frame refers t o an &lt;iframe&gt; or a &lt;frame&gt; of a web page and is identified by a tab ID and a frame ID.</p>
615 <!-- PARAMETERS -->
616 <h4>Parameters</h4>
617 <dl>
618 <div>
619 <div>
620 <dt>
621 <var>details</var>
622 <em>
623 <!-- TYPE -->
624 <div style="display:inline">
625 (
626 <span id="typeTemplate">
627 <span>
628 <span>object</span>
629 </span>
630 </span>
631 )
632 </div>
633 </em>
634 </dt>
635 <dd>Information about the frame to retrieve information about.</dd>
636 <!-- OBJECT PROPERTIES -->
637 <dd>
638 <dl>
639 <div>
640 <div>
641 <dt>
642 <var>tabId</var>
643 <em>
644 <!-- TYPE -->
645 <div style="display:inline">
646 (
647 <span id="typeTemplate">
648 <span>
649 <span>integer</span>
650 </span>
651 </span>
652 )
653 </div>
654 </em>
655 </dt>
656 <dd>The ID of the tab in which the frame is.</dd>
657 <!-- OBJECT PROPERTIES -->
658 <!-- OBJECT METHODS -->
659 <!-- OBJECT EVENT FIELDS -->
660 <!-- FUNCTION PARAMETERS -->
661 </div>
662 </div><div>
663 <div>
664 <dt>
665 <var>frameId</var>
666 <em>
667 <!-- TYPE -->
668 <div style="display:inline">
669 (
670 <span id="typeTemplate">
671 <span>
672 <span>integer</span>
673 </span>
674 </span>
675 )
676 </div>
677 </em>
678 </dt>
679 <dd>The ID of the frame in the given tab.</dd>
680 <!-- OBJECT PROPERTIES -->
681 <!-- OBJECT METHODS -->
682 <!-- OBJECT EVENT FIELDS -->
683 <!-- FUNCTION PARAMETERS -->
684 </div>
685 </div>
686 </dl>
687 </dd>
688 <!-- OBJECT METHODS -->
689 <!-- OBJECT EVENT FIELDS -->
690 <!-- FUNCTION PARAMETERS -->
691 </div>
692 </div><div>
693 <div>
694 <dt>
695 <var>callback</var>
696 <em>
697 <!-- TYPE -->
698 <div style="display:inline">
699 (
700 <span id="typeTemplate">
701 <span>
702 <span>function</span>
703 </span>
704 </span>
705 )
706 </div>
707 </em>
708 </dt>
709 <dd class="todo">
710 Undocumented.
711 </dd>
712 <!-- OBJECT PROPERTIES -->
713 <!-- OBJECT METHODS -->
714 <!-- OBJECT EVENT FIELDS -->
715 <!-- FUNCTION PARAMETERS -->
716 </div>
717 </div>
718 </dl>
719 <!-- RETURNS -->
720 <dl>
721 </dl>
722 <!-- CALLBACK -->
723 <div>
724 <div>
725 <h4>Callback function</h4>
726 <p>
727 The <em>callback</em> parameter should specify a function
728 that looks like this:
729 </p>
730 <!-- Note: intentionally longer 80 columns -->
731 <pre>function(<span>object details</span>) <span class="subdue d">{...}</span>;</pre>
732 <dl>
733 <div>
734 <div>
735 <dt>
736 <var>details</var>
737 <em>
738 <!-- TYPE -->
739 <div style="display:inline">
740 (
741 <span class="optional">optional</span>
742 <span id="typeTemplate">
743 <span>
744 <span>object</span>
745 </span>
746 </span>
747 )
748 </div>
749 </em>
750 </dt>
751 <dd>Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.</dd>
752 <!-- OBJECT PROPERTIES -->
753 <dd>
754 <dl>
755 <div>
756 <div>
757 <dt>
758 <var>errorOccurred</var>
759 <em>
760 <!-- TYPE -->
761 <div style="display:inline">
762 (
763 <span id="typeTemplate">
764 <span>
765 <span>boolean</span>
766 </span>
767 </span>
768 )
769 </div>
770 </em>
771 </dt>
772 <dd>True if the last navigation in this frame was interrupted by an er ror, i.e. the onErrorOccurred event fired.</dd>
773 <!-- OBJECT PROPERTIES -->
774 <!-- OBJECT METHODS -->
775 <!-- OBJECT EVENT FIELDS -->
776 <!-- FUNCTION PARAMETERS -->
777 </div>
778 </div><div>
779 <div>
780 <dt>
781 <var>url</var>
782 <em>
783 <!-- TYPE -->
784 <div style="display:inline">
785 (
786 <span id="typeTemplate">
787 <span>
788 <span>string</span>
789 </span>
790 </span>
791 )
792 </div>
793 </em>
794 </dt>
795 <dd>The URL currently associated with this frame, if the frame identif ied by the frameId existed at one point in the given tab. The fact that an URL i s associated with a given frameId does not imply that the corresponding frame st ill exists.</dd>
796 <!-- OBJECT PROPERTIES -->
797 <!-- OBJECT METHODS -->
798 <!-- OBJECT EVENT FIELDS -->
799 <!-- FUNCTION PARAMETERS -->
800 </div>
801 </div>
802 </dl>
803 </dd>
804 <!-- OBJECT METHODS -->
805 <!-- OBJECT EVENT FIELDS -->
806 <!-- FUNCTION PARAMETERS -->
807 </div>
808 </div>
809 </dl>
810 </div>
811 </div>
812 <!-- MIN_VERSION -->
813 </div> <!-- /description -->
814 </div> <!-- /apiItem -->
815 </div> <!-- /apiGroup -->
816 <!-- EVENTS -->
817 <div id="eventsTemplate" class="apiGroup">
818 <a name="global-events"></a>
819 <h3>Events</h3>
820 <!-- iterates over all events -->
821 <div class="apiItem">
822 <a name="event-onBeforeNavigate"></a>
823 <h4>onBeforeNavigate</h4>
824 <div class="summary">
825 <!-- Note: intentionally longer 80 columns -->
826 <span class="subdued">chrome.webNavigation.</span><span>onBefore Navigate</span><span class="subdued">.addListener</span>(function(<span>object d etails</span>) <span class="subdued">{...}</span><span></span>);
827 </div>
828 <div class="description">
829 <p>Fired when a navigation is about to occur.</p>
830 <!-- LISTENER PARAMETERS -->
831 <div>
832 <h4>Listener parameters</h4>
833 <dl>
834 <div>
835 <div>
836 <dt>
837 <var>details</var>
838 <em>
839 <!-- TYPE -->
840 <div style="display:inline">
841 (
842 <span id="typeTemplate">
843 <span>
844 <span>object</span>
845 </span>
846 </span>
847 )
848 </div>
849 </em>
850 </dt>
851 <dd class="todo">
852 Undocumented.
853 </dd>
854 <!-- OBJECT PROPERTIES -->
855 <dd>
856 <dl>
857 <div>
858 <div>
859 <dt>
860 <var>tabId</var>
861 <em>
862 <!-- TYPE -->
863 <div style="display:inline">
864 (
865 <span id="typeTemplate">
866 <span>
867 <span>integer</span>
868 </span>
869 </span>
870 )
871 </div>
872 </em>
873 </dt>
874 <dd>The ID of the tab in which the navigation is about to occur.</dd>
875 <!-- OBJECT PROPERTIES -->
876 <!-- OBJECT METHODS -->
877 <!-- OBJECT EVENT FIELDS -->
878 <!-- FUNCTION PARAMETERS -->
879 </div>
880 </div><div>
881 <div>
882 <dt>
883 <var>url</var>
884 <em>
885 <!-- TYPE -->
886 <div style="display:inline">
887 (
888 <span id="typeTemplate">
889 <span>
890 <span>string</span>
891 </span>
892 </span>
893 )
894 </div>
895 </em>
896 </dt>
897 <dd class="todo">
898 Undocumented.
899 </dd>
900 <!-- OBJECT PROPERTIES -->
901 <!-- OBJECT METHODS -->
902 <!-- OBJECT EVENT FIELDS -->
903 <!-- FUNCTION PARAMETERS -->
904 </div>
905 </div><div>
906 <div>
907 <dt>
908 <var>frameId</var>
909 <em>
910 <!-- TYPE -->
911 <div style="display:inline">
912 (
913 <span id="typeTemplate">
914 <span>
915 <span>integer</span>
916 </span>
917 </span>
918 )
919 </div>
920 </em>
921 </dt>
922 <dd>0 indicates the navigation happens in the tab content window; a po sitive value indicates navigation in a subframe. Frame IDs are unique within a t ab.</dd>
923 <!-- OBJECT PROPERTIES -->
924 <!-- OBJECT METHODS -->
925 <!-- OBJECT EVENT FIELDS -->
926 <!-- FUNCTION PARAMETERS -->
927 </div>
928 </div><div>
929 <div>
930 <dt>
931 <var>timeStamp</var>
932 <em>
933 <!-- TYPE -->
934 <div style="display:inline">
935 (
936 <span id="typeTemplate">
937 <span>
938 <span>number</span>
939 </span>
940 </span>
941 )
942 </div>
943 </em>
944 </dt>
945 <dd>The time when the browser was about to start the navigation, in mi lliseconds since the epoch.</dd>
946 <!-- OBJECT PROPERTIES -->
947 <!-- OBJECT METHODS -->
948 <!-- OBJECT EVENT FIELDS -->
949 <!-- FUNCTION PARAMETERS -->
950 </div>
951 </div>
952 </dl>
953 </dd>
954 <!-- OBJECT METHODS -->
955 <!-- OBJECT EVENT FIELDS -->
956 <!-- FUNCTION PARAMETERS -->
957 </div>
958 </div>
959 </dl>
960 </div>
961 <!-- EXTRA PARAMETERS -->
962 <!-- LISTENER RETURN VALUE -->
963 <dl>
964 </dl>
965 </div> <!-- /description -->
966 <!-- /description -->
967 </div><div class="apiItem">
968 <a name="event-onCommitted"></a>
969 <h4>onCommitted</h4>
970 <div class="summary">
971 <!-- Note: intentionally longer 80 columns -->
972 <span class="subdued">chrome.webNavigation.</span><span>onCommit ted</span><span class="subdued">.addListener</span>(function(<span>object detail s</span>) <span class="subdued">{...}</span><span></span>);
973 </div>
974 <div class="description">
975 <p>Fired when a navigation is committed. The document (and the r esources it refers to, such as images and subframes) might still be downloading, but at least part of the document has been received from the server and the bro wser has decided to switch to the new document.</p>
976 <!-- LISTENER PARAMETERS -->
977 <div>
978 <h4>Listener parameters</h4>
979 <dl>
980 <div>
981 <div>
982 <dt>
983 <var>details</var>
984 <em>
985 <!-- TYPE -->
986 <div style="display:inline">
987 (
988 <span id="typeTemplate">
989 <span>
990 <span>object</span>
991 </span>
992 </span>
993 )
994 </div>
995 </em>
996 </dt>
997 <dd class="todo">
998 Undocumented.
999 </dd>
1000 <!-- OBJECT PROPERTIES -->
1001 <dd>
1002 <dl>
1003 <div>
1004 <div>
1005 <dt>
1006 <var>tabId</var>
1007 <em>
1008 <!-- TYPE -->
1009 <div style="display:inline">
1010 (
1011 <span id="typeTemplate">
1012 <span>
1013 <span>integer</span>
1014 </span>
1015 </span>
1016 )
1017 </div>
1018 </em>
1019 </dt>
1020 <dd>The ID of the tab in which the navigation occurs.</dd>
1021 <!-- OBJECT PROPERTIES -->
1022 <!-- OBJECT METHODS -->
1023 <!-- OBJECT EVENT FIELDS -->
1024 <!-- FUNCTION PARAMETERS -->
1025 </div>
1026 </div><div>
1027 <div>
1028 <dt>
1029 <var>url</var>
1030 <em>
1031 <!-- TYPE -->
1032 <div style="display:inline">
1033 (
1034 <span id="typeTemplate">
1035 <span>
1036 <span>string</span>
1037 </span>
1038 </span>
1039 )
1040 </div>
1041 </em>
1042 </dt>
1043 <dd class="todo">
1044 Undocumented.
1045 </dd>
1046 <!-- OBJECT PROPERTIES -->
1047 <!-- OBJECT METHODS -->
1048 <!-- OBJECT EVENT FIELDS -->
1049 <!-- FUNCTION PARAMETERS -->
1050 </div>
1051 </div><div>
1052 <div>
1053 <dt>
1054 <var>frameId</var>
1055 <em>
1056 <!-- TYPE -->
1057 <div style="display:inline">
1058 (
1059 <span id="typeTemplate">
1060 <span>
1061 <span>integer</span>
1062 </span>
1063 </span>
1064 )
1065 </div>
1066 </em>
1067 </dt>
1068 <dd>0 indicates the navigation happens in the tab content window; a po sitive value indicates navigation in a subframe. Frame IDs are unique within a t ab.</dd>
1069 <!-- OBJECT PROPERTIES -->
1070 <!-- OBJECT METHODS -->
1071 <!-- OBJECT EVENT FIELDS -->
1072 <!-- FUNCTION PARAMETERS -->
1073 </div>
1074 </div><div>
1075 <div>
1076 <dt>
1077 <var>transitionType</var>
1078 <em>
1079 <!-- TYPE -->
1080 <div style="display:inline">
1081 (
1082 <span class="enum">enumerated</span>
1083 <span id="typeTemplate">
1084 <span>
1085 <span>string</span>
1086 <span>["link", "typed", "auto_bookmark", "auto_subframe" , "manual_subframe", "generated", "start_page", "form_submit", "reload", "keywor d", "keyword_generated"]</span>
1087 </span>
1088 </span>
1089 )
1090 </div>
1091 </em>
1092 </dt>
1093 <dd>Cause of the navigation. The same transition types as defined in t he history API are used.</dd>
1094 <!-- OBJECT PROPERTIES -->
1095 <!-- OBJECT METHODS -->
1096 <!-- OBJECT EVENT FIELDS -->
1097 <!-- FUNCTION PARAMETERS -->
1098 </div>
1099 </div><div>
1100 <div>
1101 <dt>
1102 <var>transitionQualifiers</var>
1103 <em>
1104 <!-- TYPE -->
1105 <div style="display:inline">
1106 (
1107 <span id="typeTemplate">
1108 <span>
1109 <span>
1110 array of <span><span>
1111 <span>
1112 <span>string</span>
1113 <span>["client_redirect", "server_redirect", "forward_ba ck", "from_address_bar"]</span>
1114 </span>
1115 </span></span>
1116 </span>
1117 </span>
1118 </span>
1119 )
1120 </div>
1121 </em>
1122 </dt>
1123 <dd>A list of transition qualifiers.</dd>
1124 <!-- OBJECT PROPERTIES -->
1125 <!-- OBJECT METHODS -->
1126 <!-- OBJECT EVENT FIELDS -->
1127 <!-- FUNCTION PARAMETERS -->
1128 </div>
1129 </div><div>
1130 <div>
1131 <dt>
1132 <var>timeStamp</var>
1133 <em>
1134 <!-- TYPE -->
1135 <div style="display:inline">
1136 (
1137 <span id="typeTemplate">
1138 <span>
1139 <span>number</span>
1140 </span>
1141 </span>
1142 )
1143 </div>
1144 </em>
1145 </dt>
1146 <dd>The time when the navigation was committed, in milliseconds since the epoch.</dd>
1147 <!-- OBJECT PROPERTIES -->
1148 <!-- OBJECT METHODS -->
1149 <!-- OBJECT EVENT FIELDS -->
1150 <!-- FUNCTION PARAMETERS -->
1151 </div>
1152 </div>
1153 </dl>
1154 </dd>
1155 <!-- OBJECT METHODS -->
1156 <!-- OBJECT EVENT FIELDS -->
1157 <!-- FUNCTION PARAMETERS -->
1158 </div>
1159 </div>
1160 </dl>
1161 </div>
1162 <!-- EXTRA PARAMETERS -->
1163 <!-- LISTENER RETURN VALUE -->
1164 <dl>
1165 </dl>
1166 </div> <!-- /description -->
1167 <!-- /description -->
1168 </div><div class="apiItem">
1169 <a name="event-onCompleted"></a>
1170 <h4>onCompleted</h4>
1171 <div class="summary">
1172 <!-- Note: intentionally longer 80 columns -->
1173 <span class="subdued">chrome.webNavigation.</span><span>onComple ted</span><span class="subdued">.addListener</span>(function(<span>object detail s</span>) <span class="subdued">{...}</span><span></span>);
1174 </div>
1175 <div class="description">
1176 <p>Fired when a document, including the resources it refers to, is completely loaded and initialized.</p>
1177 <!-- LISTENER PARAMETERS -->
1178 <div>
1179 <h4>Listener parameters</h4>
1180 <dl>
1181 <div>
1182 <div>
1183 <dt>
1184 <var>details</var>
1185 <em>
1186 <!-- TYPE -->
1187 <div style="display:inline">
1188 (
1189 <span id="typeTemplate">
1190 <span>
1191 <span>object</span>
1192 </span>
1193 </span>
1194 )
1195 </div>
1196 </em>
1197 </dt>
1198 <dd class="todo">
1199 Undocumented.
1200 </dd>
1201 <!-- OBJECT PROPERTIES -->
1202 <dd>
1203 <dl>
1204 <div>
1205 <div>
1206 <dt>
1207 <var>tabId</var>
1208 <em>
1209 <!-- TYPE -->
1210 <div style="display:inline">
1211 (
1212 <span id="typeTemplate">
1213 <span>
1214 <span>integer</span>
1215 </span>
1216 </span>
1217 )
1218 </div>
1219 </em>
1220 </dt>
1221 <dd>The ID of the tab in which the navigation occurs.</dd>
1222 <!-- OBJECT PROPERTIES -->
1223 <!-- OBJECT METHODS -->
1224 <!-- OBJECT EVENT FIELDS -->
1225 <!-- FUNCTION PARAMETERS -->
1226 </div>
1227 </div><div>
1228 <div>
1229 <dt>
1230 <var>url</var>
1231 <em>
1232 <!-- TYPE -->
1233 <div style="display:inline">
1234 (
1235 <span id="typeTemplate">
1236 <span>
1237 <span>string</span>
1238 </span>
1239 </span>
1240 )
1241 </div>
1242 </em>
1243 </dt>
1244 <dd class="todo">
1245 Undocumented.
1246 </dd>
1247 <!-- OBJECT PROPERTIES -->
1248 <!-- OBJECT METHODS -->
1249 <!-- OBJECT EVENT FIELDS -->
1250 <!-- FUNCTION PARAMETERS -->
1251 </div>
1252 </div><div>
1253 <div>
1254 <dt>
1255 <var>frameId</var>
1256 <em>
1257 <!-- TYPE -->
1258 <div style="display:inline">
1259 (
1260 <span id="typeTemplate">
1261 <span>
1262 <span>integer</span>
1263 </span>
1264 </span>
1265 )
1266 </div>
1267 </em>
1268 </dt>
1269 <dd>0 indicates the navigation happens in the tab content window; a po sitive value indicates navigation in a subframe. Frame IDs are unique within a t ab.</dd>
1270 <!-- OBJECT PROPERTIES -->
1271 <!-- OBJECT METHODS -->
1272 <!-- OBJECT EVENT FIELDS -->
1273 <!-- FUNCTION PARAMETERS -->
1274 </div>
1275 </div><div>
1276 <div>
1277 <dt>
1278 <var>timeStamp</var>
1279 <em>
1280 <!-- TYPE -->
1281 <div style="display:inline">
1282 (
1283 <span id="typeTemplate">
1284 <span>
1285 <span>number</span>
1286 </span>
1287 </span>
1288 )
1289 </div>
1290 </em>
1291 </dt>
1292 <dd>The time when the document finished loading, in milliseconds since the epoch.</dd>
1293 <!-- OBJECT PROPERTIES -->
1294 <!-- OBJECT METHODS -->
1295 <!-- OBJECT EVENT FIELDS -->
1296 <!-- FUNCTION PARAMETERS -->
1297 </div>
1298 </div>
1299 </dl>
1300 </dd>
1301 <!-- OBJECT METHODS -->
1302 <!-- OBJECT EVENT FIELDS -->
1303 <!-- FUNCTION PARAMETERS -->
1304 </div>
1305 </div>
1306 </dl>
1307 </div>
1308 <!-- EXTRA PARAMETERS -->
1309 <!-- LISTENER RETURN VALUE -->
1310 <dl>
1311 </dl>
1312 </div> <!-- /description -->
1313 <!-- /description -->
1314 </div><div class="apiItem">
1315 <a name="event-onCreatedNavigationTarget"></a>
1316 <h4>onCreatedNavigationTarget</h4>
1317 <div class="summary">
1318 <!-- Note: intentionally longer 80 columns -->
1319 <span class="subdued">chrome.webNavigation.</span><span>onCreate dNavigationTarget</span><span class="subdued">.addListener</span>(function(<span >object details</span>) <span class="subdued">{...}</span><span></span>);
1320 </div>
1321 <div class="description">
1322 <p>Fired when a new window, or a new tab in an existing window, is created to host a navigation.</p>
1323 <!-- LISTENER PARAMETERS -->
1324 <div>
1325 <h4>Listener parameters</h4>
1326 <dl>
1327 <div>
1328 <div>
1329 <dt>
1330 <var>details</var>
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 class="todo">
1345 Undocumented.
1346 </dd>
1347 <!-- OBJECT PROPERTIES -->
1348 <dd>
1349 <dl>
1350 <div>
1351 <div>
1352 <dt>
1353 <var>sourceTabId</var>
1354 <em>
1355 <!-- TYPE -->
1356 <div style="display:inline">
1357 (
1358 <span id="typeTemplate">
1359 <span>
1360 <span>integer</span>
1361 </span>
1362 </span>
1363 )
1364 </div>
1365 </em>
1366 </dt>
1367 <dd>The ID of the tab in which the navigation is triggered.</dd>
1368 <!-- OBJECT PROPERTIES -->
1369 <!-- OBJECT METHODS -->
1370 <!-- OBJECT EVENT FIELDS -->
1371 <!-- FUNCTION PARAMETERS -->
1372 </div>
1373 </div><div>
1374 <div>
1375 <dt>
1376 <var>sourceFrameId</var>
1377 <em>
1378 <!-- TYPE -->
1379 <div style="display:inline">
1380 (
1381 <span id="typeTemplate">
1382 <span>
1383 <span>integer</span>
1384 </span>
1385 </span>
1386 )
1387 </div>
1388 </em>
1389 </dt>
1390 <dd>The ID of the frame with sourceTabId in which the navigation is tr iggered. 0 indicates the main frame.</dd>
1391 <!-- OBJECT PROPERTIES -->
1392 <!-- OBJECT METHODS -->
1393 <!-- OBJECT EVENT FIELDS -->
1394 <!-- FUNCTION PARAMETERS -->
1395 </div>
1396 </div><div>
1397 <div>
1398 <dt>
1399 <var>url</var>
1400 <em>
1401 <!-- TYPE -->
1402 <div style="display:inline">
1403 (
1404 <span id="typeTemplate">
1405 <span>
1406 <span>string</span>
1407 </span>
1408 </span>
1409 )
1410 </div>
1411 </em>
1412 </dt>
1413 <dd>The URL to be opened in the new window.</dd>
1414 <!-- OBJECT PROPERTIES -->
1415 <!-- OBJECT METHODS -->
1416 <!-- OBJECT EVENT FIELDS -->
1417 <!-- FUNCTION PARAMETERS -->
1418 </div>
1419 </div><div>
1420 <div>
1421 <dt>
1422 <var>tabId</var>
1423 <em>
1424 <!-- TYPE -->
1425 <div style="display:inline">
1426 (
1427 <span id="typeTemplate">
1428 <span>
1429 <span>integer</span>
1430 </span>
1431 </span>
1432 )
1433 </div>
1434 </em>
1435 </dt>
1436 <dd>The ID of the tab in which the url is opened</dd>
1437 <!-- OBJECT PROPERTIES -->
1438 <!-- OBJECT METHODS -->
1439 <!-- OBJECT EVENT FIELDS -->
1440 <!-- FUNCTION PARAMETERS -->
1441 </div>
1442 </div><div>
1443 <div>
1444 <dt>
1445 <var>timeStamp</var>
1446 <em>
1447 <!-- TYPE -->
1448 <div style="display:inline">
1449 (
1450 <span id="typeTemplate">
1451 <span>
1452 <span>number</span>
1453 </span>
1454 </span>
1455 )
1456 </div>
1457 </em>
1458 </dt>
1459 <dd>The time when the browser was about to create a new view, in milli seconds since the epoch.</dd>
1460 <!-- OBJECT PROPERTIES -->
1461 <!-- OBJECT METHODS -->
1462 <!-- OBJECT EVENT FIELDS -->
1463 <!-- FUNCTION PARAMETERS -->
1464 </div>
1465 </div>
1466 </dl>
1467 </dd>
1468 <!-- OBJECT METHODS -->
1469 <!-- OBJECT EVENT FIELDS -->
1470 <!-- FUNCTION PARAMETERS -->
1471 </div>
1472 </div>
1473 </dl>
1474 </div>
1475 <!-- EXTRA PARAMETERS -->
1476 <!-- LISTENER RETURN VALUE -->
1477 <dl>
1478 </dl>
1479 </div> <!-- /description -->
1480 <!-- /description -->
1481 </div><div class="apiItem">
1482 <a name="event-onDOMContentLoaded"></a>
1483 <h4>onDOMContentLoaded</h4>
1484 <div class="summary">
1485 <!-- Note: intentionally longer 80 columns -->
1486 <span class="subdued">chrome.webNavigation.</span><span>onDOMCon tentLoaded</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);
1487 </div>
1488 <div class="description">
1489 <p>Fired when the page's DOM is fully constructed, but the refer enced resources may not finish loading.</p>
1490 <!-- LISTENER PARAMETERS -->
1491 <div>
1492 <h4>Listener parameters</h4>
1493 <dl>
1494 <div>
1495 <div>
1496 <dt>
1497 <var>details</var>
1498 <em>
1499 <!-- TYPE -->
1500 <div style="display:inline">
1501 (
1502 <span id="typeTemplate">
1503 <span>
1504 <span>object</span>
1505 </span>
1506 </span>
1507 )
1508 </div>
1509 </em>
1510 </dt>
1511 <dd class="todo">
1512 Undocumented.
1513 </dd>
1514 <!-- OBJECT PROPERTIES -->
1515 <dd>
1516 <dl>
1517 <div>
1518 <div>
1519 <dt>
1520 <var>tabId</var>
1521 <em>
1522 <!-- TYPE -->
1523 <div style="display:inline">
1524 (
1525 <span id="typeTemplate">
1526 <span>
1527 <span>integer</span>
1528 </span>
1529 </span>
1530 )
1531 </div>
1532 </em>
1533 </dt>
1534 <dd>The ID of the tab in which the navigation occurs.</dd>
1535 <!-- OBJECT PROPERTIES -->
1536 <!-- OBJECT METHODS -->
1537 <!-- OBJECT EVENT FIELDS -->
1538 <!-- FUNCTION PARAMETERS -->
1539 </div>
1540 </div><div>
1541 <div>
1542 <dt>
1543 <var>url</var>
1544 <em>
1545 <!-- TYPE -->
1546 <div style="display:inline">
1547 (
1548 <span id="typeTemplate">
1549 <span>
1550 <span>string</span>
1551 </span>
1552 </span>
1553 )
1554 </div>
1555 </em>
1556 </dt>
1557 <dd class="todo">
1558 Undocumented.
1559 </dd>
1560 <!-- OBJECT PROPERTIES -->
1561 <!-- OBJECT METHODS -->
1562 <!-- OBJECT EVENT FIELDS -->
1563 <!-- FUNCTION PARAMETERS -->
1564 </div>
1565 </div><div>
1566 <div>
1567 <dt>
1568 <var>frameId</var>
1569 <em>
1570 <!-- TYPE -->
1571 <div style="display:inline">
1572 (
1573 <span id="typeTemplate">
1574 <span>
1575 <span>integer</span>
1576 </span>
1577 </span>
1578 )
1579 </div>
1580 </em>
1581 </dt>
1582 <dd>0 indicates the navigation happens in the tab content window; a po sitive value indicates navigation in a subframe. Frame IDs are unique within a t ab.</dd>
1583 <!-- OBJECT PROPERTIES -->
1584 <!-- OBJECT METHODS -->
1585 <!-- OBJECT EVENT FIELDS -->
1586 <!-- FUNCTION PARAMETERS -->
1587 </div>
1588 </div><div>
1589 <div>
1590 <dt>
1591 <var>timeStamp</var>
1592 <em>
1593 <!-- TYPE -->
1594 <div style="display:inline">
1595 (
1596 <span id="typeTemplate">
1597 <span>
1598 <span>number</span>
1599 </span>
1600 </span>
1601 )
1602 </div>
1603 </em>
1604 </dt>
1605 <dd>The time when the page's DOM was fully constructed, in millisecond s since the epoch.</dd>
1606 <!-- OBJECT PROPERTIES -->
1607 <!-- OBJECT METHODS -->
1608 <!-- OBJECT EVENT FIELDS -->
1609 <!-- FUNCTION PARAMETERS -->
1610 </div>
1611 </div>
1612 </dl>
1613 </dd>
1614 <!-- OBJECT METHODS -->
1615 <!-- OBJECT EVENT FIELDS -->
1616 <!-- FUNCTION PARAMETERS -->
1617 </div>
1618 </div>
1619 </dl>
1620 </div>
1621 <!-- EXTRA PARAMETERS -->
1622 <!-- LISTENER RETURN VALUE -->
1623 <dl>
1624 </dl>
1625 </div> <!-- /description -->
1626 <!-- /description -->
1627 </div><div class="apiItem">
1628 <a name="event-onErrorOccurred"></a>
1629 <h4>onErrorOccurred</h4>
1630 <div class="summary">
1631 <!-- Note: intentionally longer 80 columns -->
1632 <span class="subdued">chrome.webNavigation.</span><span>onErrorO ccurred</span><span class="subdued">.addListener</span>(function(<span>object de tails</span>) <span class="subdued">{...}</span><span></span>);
1633 </div>
1634 <div class="description">
1635 <p>Fired when an error occurs and the navigation is aborted. Thi s can happen if either a network error occurred, or the user aborted the navigat ion.</p>
1636 <!-- LISTENER PARAMETERS -->
1637 <div>
1638 <h4>Listener parameters</h4>
1639 <dl>
1640 <div>
1641 <div>
1642 <dt>
1643 <var>details</var>
1644 <em>
1645 <!-- TYPE -->
1646 <div style="display:inline">
1647 (
1648 <span id="typeTemplate">
1649 <span>
1650 <span>object</span>
1651 </span>
1652 </span>
1653 )
1654 </div>
1655 </em>
1656 </dt>
1657 <dd class="todo">
1658 Undocumented.
1659 </dd>
1660 <!-- OBJECT PROPERTIES -->
1661 <dd>
1662 <dl>
1663 <div>
1664 <div>
1665 <dt>
1666 <var>tabId</var>
1667 <em>
1668 <!-- TYPE -->
1669 <div style="display:inline">
1670 (
1671 <span id="typeTemplate">
1672 <span>
1673 <span>integer</span>
1674 </span>
1675 </span>
1676 )
1677 </div>
1678 </em>
1679 </dt>
1680 <dd>The ID of the tab in which the navigation occurs.</dd>
1681 <!-- OBJECT PROPERTIES -->
1682 <!-- OBJECT METHODS -->
1683 <!-- OBJECT EVENT FIELDS -->
1684 <!-- FUNCTION PARAMETERS -->
1685 </div>
1686 </div><div>
1687 <div>
1688 <dt>
1689 <var>url</var>
1690 <em>
1691 <!-- TYPE -->
1692 <div style="display:inline">
1693 (
1694 <span id="typeTemplate">
1695 <span>
1696 <span>string</span>
1697 </span>
1698 </span>
1699 )
1700 </div>
1701 </em>
1702 </dt>
1703 <dd class="todo">
1704 Undocumented.
1705 </dd>
1706 <!-- OBJECT PROPERTIES -->
1707 <!-- OBJECT METHODS -->
1708 <!-- OBJECT EVENT FIELDS -->
1709 <!-- FUNCTION PARAMETERS -->
1710 </div>
1711 </div><div>
1712 <div>
1713 <dt>
1714 <var>frameId</var>
1715 <em>
1716 <!-- TYPE -->
1717 <div style="display:inline">
1718 (
1719 <span id="typeTemplate">
1720 <span>
1721 <span>integer</span>
1722 </span>
1723 </span>
1724 )
1725 </div>
1726 </em>
1727 </dt>
1728 <dd>0 indicates the navigation happens in the tab content window; a po sitive value indicates navigation in a subframe. Frame IDs are unique within a t ab.</dd>
1729 <!-- OBJECT PROPERTIES -->
1730 <!-- OBJECT METHODS -->
1731 <!-- OBJECT EVENT FIELDS -->
1732 <!-- FUNCTION PARAMETERS -->
1733 </div>
1734 </div><div>
1735 <div>
1736 <dt>
1737 <var>error</var>
1738 <em>
1739 <!-- TYPE -->
1740 <div style="display:inline">
1741 (
1742 <span id="typeTemplate">
1743 <span>
1744 <span>string</span>
1745 </span>
1746 </span>
1747 )
1748 </div>
1749 </em>
1750 </dt>
1751 <dd>The error description.</dd>
1752 <!-- OBJECT PROPERTIES -->
1753 <!-- OBJECT METHODS -->
1754 <!-- OBJECT EVENT FIELDS -->
1755 <!-- FUNCTION PARAMETERS -->
1756 </div>
1757 </div><div>
1758 <div>
1759 <dt>
1760 <var>timeStamp</var>
1761 <em>
1762 <!-- TYPE -->
1763 <div style="display:inline">
1764 (
1765 <span id="typeTemplate">
1766 <span>
1767 <span>number</span>
1768 </span>
1769 </span>
1770 )
1771 </div>
1772 </em>
1773 </dt>
1774 <dd>The time when the error occurred, in milliseconds since the epoch. </dd>
1775 <!-- OBJECT PROPERTIES -->
1776 <!-- OBJECT METHODS -->
1777 <!-- OBJECT EVENT FIELDS -->
1778 <!-- FUNCTION PARAMETERS -->
1779 </div>
1780 </div>
1781 </dl>
1782 </dd>
1783 <!-- OBJECT METHODS -->
1784 <!-- OBJECT EVENT FIELDS -->
1785 <!-- FUNCTION PARAMETERS -->
1786 </div>
1787 </div>
1788 </dl>
1789 </div>
1790 <!-- EXTRA PARAMETERS -->
1791 <!-- LISTENER RETURN VALUE -->
1792 <dl>
1793 </dl>
1794 </div> <!-- /description -->
1795 <!-- /description -->
1796 </div><div class="apiItem">
1797 <a name="event-onReferenceFragmentUpdated"></a>
1798 <h4>onReferenceFragmentUpdated</h4>
1799 <div class="summary">
1800 <!-- Note: intentionally longer 80 columns -->
1801 <span class="subdued">chrome.webNavigation.</span><span>onRefere nceFragmentUpdated</span><span class="subdued">.addListener</span>(function(<spa n>object details</span>) <span class="subdued">{...}</span><span></span>);
1802 </div>
1803 <div class="description">
1804 <p>Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.</p>
1805 <!-- LISTENER PARAMETERS -->
1806 <div>
1807 <h4>Listener parameters</h4>
1808 <dl>
1809 <div>
1810 <div>
1811 <dt>
1812 <var>details</var>
1813 <em>
1814 <!-- TYPE -->
1815 <div style="display:inline">
1816 (
1817 <span id="typeTemplate">
1818 <span>
1819 <span>object</span>
1820 </span>
1821 </span>
1822 )
1823 </div>
1824 </em>
1825 </dt>
1826 <dd class="todo">
1827 Undocumented.
1828 </dd>
1829 <!-- OBJECT PROPERTIES -->
1830 <dd>
1831 <dl>
1832 <div>
1833 <div>
1834 <dt>
1835 <var>tabId</var>
1836 <em>
1837 <!-- TYPE -->
1838 <div style="display:inline">
1839 (
1840 <span id="typeTemplate">
1841 <span>
1842 <span>integer</span>
1843 </span>
1844 </span>
1845 )
1846 </div>
1847 </em>
1848 </dt>
1849 <dd>The ID of the tab in which the navigation occurs.</dd>
1850 <!-- OBJECT PROPERTIES -->
1851 <!-- OBJECT METHODS -->
1852 <!-- OBJECT EVENT FIELDS -->
1853 <!-- FUNCTION PARAMETERS -->
1854 </div>
1855 </div><div>
1856 <div>
1857 <dt>
1858 <var>url</var>
1859 <em>
1860 <!-- TYPE -->
1861 <div style="display:inline">
1862 (
1863 <span id="typeTemplate">
1864 <span>
1865 <span>string</span>
1866 </span>
1867 </span>
1868 )
1869 </div>
1870 </em>
1871 </dt>
1872 <dd class="todo">
1873 Undocumented.
1874 </dd>
1875 <!-- OBJECT PROPERTIES -->
1876 <!-- OBJECT METHODS -->
1877 <!-- OBJECT EVENT FIELDS -->
1878 <!-- FUNCTION PARAMETERS -->
1879 </div>
1880 </div><div>
1881 <div>
1882 <dt>
1883 <var>frameId</var>
1884 <em>
1885 <!-- TYPE -->
1886 <div style="display:inline">
1887 (
1888 <span id="typeTemplate">
1889 <span>
1890 <span>integer</span>
1891 </span>
1892 </span>
1893 )
1894 </div>
1895 </em>
1896 </dt>
1897 <dd>0 indicates the navigation happens in the tab content window; a po sitive value indicates navigation in a subframe. Frame IDs are unique within a t ab.</dd>
1898 <!-- OBJECT PROPERTIES -->
1899 <!-- OBJECT METHODS -->
1900 <!-- OBJECT EVENT FIELDS -->
1901 <!-- FUNCTION PARAMETERS -->
1902 </div>
1903 </div><div>
1904 <div>
1905 <dt>
1906 <var>transitionType</var>
1907 <em>
1908 <!-- TYPE -->
1909 <div style="display:inline">
1910 (
1911 <span class="enum">enumerated</span>
1912 <span id="typeTemplate">
1913 <span>
1914 <span>string</span>
1915 <span>["link", "typed", "auto_bookmark", "auto_subframe" , "manual_subframe", "generated", "start_page", "form_submit", "reload", "keywor d", "keyword_generated"]</span>
1916 </span>
1917 </span>
1918 )
1919 </div>
1920 </em>
1921 </dt>
1922 <dd>Cause of the navigation. The same transition types as defined in t he history API are used.</dd>
1923 <!-- OBJECT PROPERTIES -->
1924 <!-- OBJECT METHODS -->
1925 <!-- OBJECT EVENT FIELDS -->
1926 <!-- FUNCTION PARAMETERS -->
1927 </div>
1928 </div><div>
1929 <div>
1930 <dt>
1931 <var>transitionQualifiers</var>
1932 <em>
1933 <!-- TYPE -->
1934 <div style="display:inline">
1935 (
1936 <span id="typeTemplate">
1937 <span>
1938 <span>
1939 array of <span><span>
1940 <span>
1941 <span>string</span>
1942 <span>["client_redirect", "server_redirect", "forward_ba ck", "from_address_bar"]</span>
1943 </span>
1944 </span></span>
1945 </span>
1946 </span>
1947 </span>
1948 )
1949 </div>
1950 </em>
1951 </dt>
1952 <dd>A list of transition qualifiers.</dd>
1953 <!-- OBJECT PROPERTIES -->
1954 <!-- OBJECT METHODS -->
1955 <!-- OBJECT EVENT FIELDS -->
1956 <!-- FUNCTION PARAMETERS -->
1957 </div>
1958 </div><div>
1959 <div>
1960 <dt>
1961 <var>timeStamp</var>
1962 <em>
1963 <!-- TYPE -->
1964 <div style="display:inline">
1965 (
1966 <span id="typeTemplate">
1967 <span>
1968 <span>number</span>
1969 </span>
1970 </span>
1971 )
1972 </div>
1973 </em>
1974 </dt>
1975 <dd>The time when the navigation was committed, in milliseconds since the epoch.</dd>
1976 <!-- OBJECT PROPERTIES -->
1977 <!-- OBJECT METHODS -->
1978 <!-- OBJECT EVENT FIELDS -->
1979 <!-- FUNCTION PARAMETERS -->
1980 </div>
1981 </div>
1982 </dl>
1983 </dd>
1984 <!-- OBJECT METHODS -->
1985 <!-- OBJECT EVENT FIELDS -->
1986 <!-- FUNCTION PARAMETERS -->
1987 </div>
1988 </div>
1989 </dl>
1990 </div>
1991 <!-- EXTRA PARAMETERS -->
1992 <!-- LISTENER RETURN VALUE -->
1993 <dl>
1994 </dl>
1995 </div> <!-- /description -->
1996 <!-- /description -->
1997 </div> <!-- /apiItem -->
1998 </div> <!-- /apiGroup -->
1999 <!-- TYPES -->
2000 <!-- /apiGroup -->
2001 </div> <!-- /apiPage -->
2002 </div> <!-- /gc-pagecontent -->
2003 </div> <!-- /g-section -->
2004 </div> <!-- /codesiteContent -->
2005 <div id="gc-footer" --="">
2006 <div class="text">
2007 <p>
2008 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
2009 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
2010 Attribution 3.0 License</a>, and code samples are licensed under the
2011 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
2012 </p>
2013 <p>
2014 ©2011 Google
2015 </p>
2016 <!-- begin analytics -->
2017 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
2018 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
2019 <script type="text/javascript">
2020 // chrome doc tracking
2021 try {
2022 var engdocs = _gat._getTracker("YT-10763712-2");
2023 engdocs._trackPageview();
2024 } catch(err) {}
2025 // code.google.com site-wide tracking
2026 try {
2027 _uacct="UA-18071-1";
2028 _uanchor=1;
2029 _uff=0;
2030 urchinTracker();
2031 }
2032 catch(e) {/* urchinTracker not available. */}
2033 </script>
2034 <!-- end analytics -->
2035 </div>
2036 </div> <!-- /gc-footer -->
2037 </div> <!-- /gc-container -->
2038 </body></html>
OLDNEW
« chrome/common/extensions/docs/js/api_page_generator.js ('K') | « chrome/common/extensions/docs/types.html ('k') | chrome/common/extensions/docs/webRequest.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698