chrome/common/extensions/docs/webNavigation.html - Issue 10642015: Basic setup for generating app docs

Unified 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: 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 side-by-side diff with in-line comments

Index: chrome/common/extensions/docs/webNavigation.html

diff --git a/chrome/common/extensions/docs/webNavigation.html b/chrome/common/extensions/docs/webNavigation.html

deleted file mode 100644

index 12573bf430233bca791b45983082b471f27cff01..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/webNavigation.html

+++ /dev/null

@@ -1,2038 +0,0 @@

-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

- 1) The <head> information in this page is significant, should be uniform

- across api docs and should be edited only with knowledge of the

- templating mechanism.

- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

- browser, it will be re-generated from the template, json schema and

- authored overview content.

- 4) The <body>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

---><html xmlns="http://www.w3.org/1999/xhtml"><head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <meta name="description" content="Documentation for the chrome.webNavigation module, which is part of the Google Chrome extension APIs."><title>WebNavigation API - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <div id="gc-container" class="labs">

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

-

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="https://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">WebNavigation API</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#H2-0">Manifest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-1">Examples</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-2">Event order</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-3">Relation to webRequest events</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-4">A note about timestamps</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-5">Transition types and qualifiers</a>

- <ol>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.webNavigation</a>

- <ol>

- <li>

- <a href="#global-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-getAllFrames">getAllFrames</a>

- </li><li>

- <a href="#method-getFrame">getFrame</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-events">Events</a>

- <ol>

- <li>

- <a href="#event-onBeforeNavigate">onBeforeNavigate</a>

- </li><li>

- <a href="#event-onCommitted">onCommitted</a>

- </li><li>

- <a href="#event-onCompleted">onCompleted</a>

- </li><li>

- <a href="#event-onCreatedNavigationTarget">onCreatedNavigationTarget</a>

- </li><li>

- <a href="#event-onDOMContentLoaded">onDOMContentLoaded</a>

- </li><li>

- <a href="#event-onErrorOccurred">onErrorOccurred</a>

- </li><li>

- <a href="#event-onReferenceFragmentUpdated">onReferenceFragmentUpdated</a>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">WebNavigation API</div>

-

-<p id="classSummary">

-Use the <code>chrome.webNavigation</code> module to receive

-notifications about the status of navigations requests in-flight.

-</p>

-<a name="H2-0"></a><h2>Manifest</h2>

-<p>

-All <code>chrome.webNavigation</code> methods and events require you to declare

-the "webNavigation" permission in the <a href="manifest.html">extension

-manifest</a>.

-For example:

-</p>

-<pre>{

- "name": "My extension",

- ...

- <b>"permissions": [

- "webNavigation"

- ]</b>,

- ...

-}</pre>

-<a name="H2-1"></a><h2>Examples</h2>

-<p>

-You can find simple examples of using the tabs module in the

-<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/webNavigation/">examples/api/webNavigation</a>

-directory.

-For other examples and for help in viewing the source code, see

-<a href="samples.html">Samples</a>.

-</p>

-<a name="H2-2"></a><h2>Event order</h2>

-<p>

-For a navigation that is successfully completed, events are fired in the

-following order:

-</p><pre>onBeforeNavigate -> onCommitted -> onDOMContentLoaded -> onCompleted

-</pre>

-<p></p>

-<p>

-Any error that occurs during the process results in an

-<code>onErrorOccurred</code> event. For a specific navigation, there are no

-further events fired after <code>onErrorOccurred</code>.

-</p>

-<p>

-If a navigating frame contains subframes, its <code>onCommitted</code> is fired

-before any of its children's <code>onBeforeNavigate</code>; while

-<code>onCompleted</code> is fired after all of its children's

-<code>onCompleted</code>.

-</p>

-<p>

-If the reference fragment of a frame is changed, a

-<code>onReferenceFragmentUpdated</code> event is fired. This event can fire any

-time after <code>onDOMContentLoaded</code>, even after

-<code>onCompleted</code>.

-</p>

-<a name="H2-3"></a><h2>Relation to webRequest events</h2>

-<p>

-There is no defined ordering between events of the <a href="webRequest.html">webRequest API</a> and the events of the

-webNavigation API. It is possible that webRequest events are still received for

-frames that already started a new navigation, or that a navigation only

-proceeds after the network resources are already fully loaded.

-</p>

-<p>

-In general, the webNavigation events are closely related to the navigation

-state that is displayed in the UI, while the webRequest events correspond to

-the state of the network stack which is generally opaque to the user.

-</p>

-<a name="H2-4"></a><h2>A note about timestamps</h2>

-<p>

-It's important to note that some technical oddities in the OS's handling

-of distinct Chrome processes can cause the clock to be skewed between the

-browser itself and extension processes. That means that WebNavigation's events'

-<code>timeStamp</code> property is only guaranteed to be <i>internally</i>

-consistent. Comparing one event to another event will give you the correct

-offset between them, but comparing them to the current time inside the

-extension (via <code>(new Date()).getTime()</code>, for instance) might give

-unexpected results.

-</p>

-<a name="H2-5"></a><h2>Transition types and qualifiers</h2>

-<p>

-The webNavigation API's <code>onCommitted</code> event has a

-<code>transitionType</code> and a <code>transitionQualifiers</code> property.

-The <em>transition type</em> is the same as used in the <a href="history.html#transition_types">history API</a> describing how the browser

-navigated to this particular URL. In addition, several <em>transition

-qualifiers</em> can be returned that further define the navigation.

-</p>

-<p>

-The following transition qualifiers exist:

-</p>

-<table>

-<tbody><tr>

- <th> Transition qualifier </th> <th> Description </th>

-</tr>

-<tr>

- <td>"client_redirect"</td>

- <td>

- One or more redirects caused by JavaScript or meta refresh tags on the page

- happened during the navigation.

- </td>

-</tr>

-<tr>

- <td>"server_redirect"</td>

- <td>

- One or more redirects caused by HTTP headers sent from the server happened

- during the navigation.

- </td>

-</tr>

-<tr>

- <td>"forward_back"</td>

- <td>

- The user used the Forward or Back button to initiate the navigation.

- </td>

-</tr>

-<tr>

- <td>"from_address_bar"</td>

- <td>

- The user initiated the navigation from the address bar (aka Omnibox).

- </td>

-</tr>

-</tbody></table>

-

-</div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.webNavigation</h2>

-

-

-

- <div id="methodsTemplate" class="apiGroup">

- <a name="global-methods"></a>

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a name="method-getAllFrames"></a>

- <h4>getAllFrames</h4>

- <div class="summary">

-

- <span>chrome.webNavigation.getAllFrames</span>(<span class="null"><span>object</span>

- <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Retrieves information about all frames of a given tab.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Information about the tab to retrieve all frames from.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>array of object details</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>object</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A list of frames in the given tab, null if the specified tab ID is invalid.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>errorOccurred</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the frame. 0 indicates that this is the main frame; a positive value indicates the ID of a subframe.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The URL currently associated with this frame, if the frame identified by the frameId existed at one point in the given tab. The fact that an URL is associated with a given frameId does not imply that the corresponding frame still exists.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-getFrame"></a>

- <h4>getFrame</h4>

- <div class="summary">

-

- <span>chrome.webNavigation.getFrame</span>(<span class="null"><span>object</span>

- <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Retrieves information about the given frame. A frame refers to an <iframe> or a <frame> of a web page and is identified by a tab ID and a frame ID.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Information about the frame to retrieve information about.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the frame is.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the frame in the given tab.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>object details</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>errorOccurred</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div>

- </div>

-

- <div id="eventsTemplate" class="apiGroup">

- <a name="global-events"></a>

- <h3>Events</h3>

-

- <div class="apiItem">

- <a name="event-onBeforeNavigate"></a>

- <h4>onBeforeNavigate</h4>

- <div class="summary">

-

- <span class="subdued">chrome.webNavigation.</span><span>onBeforeNavigate</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when a navigation is about to occur.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the navigation is about to occur.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>timeStamp</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The time when the browser was about to start the navigation, in milliseconds since the epoch.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onCommitted"></a>

- <h4>onCommitted</h4>

- <div class="summary">

-

- <span class="subdued">chrome.webNavigation.</span><span>onCommitted</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when a navigation is committed. The document (and the resources 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 browser has decided to switch to the new document.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the navigation occurs.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>transitionType</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Cause of the navigation. The same transition types as defined in the history API are used.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>transitionQualifiers</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>string</span>

- <span>["client_redirect", "server_redirect", "forward_back", "from_address_bar"]</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A list of transition qualifiers.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>timeStamp</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The time when the navigation was committed, in milliseconds since the epoch.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onCompleted"></a>

- <h4>onCompleted</h4>

- <div class="summary">

-

- <span class="subdued">chrome.webNavigation.</span><span>onCompleted</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when a document, including the resources it refers to, is completely loaded and initialized.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the navigation occurs.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>timeStamp</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The time when the document finished loading, in milliseconds since the epoch.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onCreatedNavigationTarget"></a>

- <h4>onCreatedNavigationTarget</h4>

- <div class="summary">

-

- <span class="subdued">chrome.webNavigation.</span><span>onCreatedNavigationTarget</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when a new window, or a new tab in an existing window, is created to host a navigation.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>sourceTabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the navigation is triggered.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>sourceFrameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the frame with sourceTabId in which the navigation is triggered. 0 indicates the main frame.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The URL to be opened in the new window.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the url is opened</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>timeStamp</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The time when the browser was about to create a new view, in milliseconds since the epoch.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onDOMContentLoaded"></a>

- <h4>onDOMContentLoaded</h4>

- <div class="summary">

-

- <span class="subdued">chrome.webNavigation.</span><span>onDOMContentLoaded</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the navigation occurs.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>timeStamp</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The time when the page's DOM was fully constructed, in milliseconds since the epoch.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onErrorOccurred"></a>

- <h4>onErrorOccurred</h4>

- <div class="summary">

-

- <span class="subdued">chrome.webNavigation.</span><span>onErrorOccurred</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the navigation occurs.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>error</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The error description.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>timeStamp</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The time when the error occurred, in milliseconds since the epoch.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onReferenceFragmentUpdated"></a>

- <h4>onReferenceFragmentUpdated</h4>

- <div class="summary">

-

- <span class="subdued">chrome.webNavigation.</span><span>onReferenceFragmentUpdated</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>tabId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab in which the navigation occurs.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>transitionType</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Cause of the navigation. The same transition types as defined in the history API are used.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>transitionQualifiers</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>string</span>

- <span>["client_redirect", "server_redirect", "forward_back", "from_address_bar"]</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A list of transition qualifiers.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>timeStamp</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The time when the navigation was committed, in milliseconds since the epoch.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

-

-

- </div>

- </div>

- </div>

- </div>

- <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>

- </p>

-

-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>

« no previous file with comments | « chrome/common/extensions/docs/types.html ('k') | chrome/common/extensions/docs/webRequest.html » ('j') | no next file with comments »