Index: chrome/common/extensions/docs/history.html |
diff --git a/chrome/common/extensions/docs/experimental.history.html b/chrome/common/extensions/docs/history.html |
similarity index 94% |
rename from chrome/common/extensions/docs/experimental.history.html |
rename to chrome/common/extensions/docs/history.html |
index 85a2397a4f9fe60b294e78eb0d8d6379694d0f45..be98deb831b55fcffd805f5b8949466d13af3dbc 100644 |
--- a/chrome/common/extensions/docs/experimental.history.html |
+++ b/chrome/common/extensions/docs/history.html |
@@ -15,7 +15,7 @@ |
</script> |
<script type="text/javascript" src="js/api_page_generator.js"></script> |
<script type="text/javascript" src="js/bootstrap.js"></script> |
- <title>chrome.experimental.history - Google Chrome Extensions - Google Code</title></head><body> <div id="gc-container" class="labs"> |
+ <title>chrome.history - Google Chrome Extensions - Google Code</title></head><body> <div id="gc-container" class="labs"> |
<div id="devModeWarning"> |
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> |
@@ -145,6 +145,7 @@ |
<ul> |
<li><a href="bookmarks.html">Bookmarks</a></li> |
<li><a href="events.html">Events</a></li> |
+ <li class="leftNavSelected">History</li> |
<li><a href="tabs.html">Tabs</a></li> |
<li><a href="windows.html">Windows</a></li> |
</ul> |
@@ -194,7 +195,7 @@ |
<div class="g-unit" id="gc-pagecontent"> |
<div id="pageTitle"> |
- <h1 class="page_title">chrome.experimental.history</h1> |
+ <h1 class="page_title">chrome.history</h1> |
</div> |
<!-- TABLE OF CONTENTS --> |
<div id="toc"> |
@@ -216,7 +217,7 @@ |
</ol> |
</li> |
<li> |
- <a href="#apiReference">API reference: chrome.experimental.history</a> |
+ <a href="#apiReference">API reference: chrome.history</a> |
<ol> |
<li style="display: none; "> |
<a href="#properties">Properties</a> |
@@ -273,8 +274,13 @@ |
<!-- STATIC CONTENT PLACEHOLDER --> |
<div id="static"><!-- BEGIN AUTHORED CONTENT --> |
<p id="classSummary"> |
-For information on how to use experimental APIs, |
-see the <a href="experimental.html">chrome.experimental.* APIs</a> page. |
+Use the <code>chrome.history</code> module to interact with the |
+browser's record of visited pages. You can add, remove, and query |
+for URLs in the browser's history. |
+ |
+To override the history page with your own version, see |
+<a href="override.html">Override Pages</a>. |
+ |
</p> |
<h2 id="transition_types">Transition types</h2> |
@@ -285,55 +291,42 @@ how the browser navigated to a particular URL |
on a particular visit. |
For example, if a user visits a page |
by clicking a link on another page, |
-the transition type is LINK. |
-To be precise, |
-the type is |
-<a href="#LINK"><code>chrome.experimental.history.transitionType.LINK</code></a>, |
-which has an integer value of 0. |
-</p> |
- |
-<p class="note"> |
-<b>Note:</b> |
-The spelling of |
-<code>transitionType</code> changed in |
-<a href="http://src.chromium.org/viewvc/chrome?view=rev&revision=38850">revision 38850</a>. |
-Previously, it was <code>transistionType</code>. |
+the transition type is "link". |
</p> |
<p> |
-The following table describes each transition type defined by |
-<code>chrome.experimental.history.transitionType</code>. |
+The following table describes each transition type. |
</p> |
<table> |
<tbody><tr> |
- <th> Transition type </th> <th> Value </th> <th> Description </th> |
+ <th> Transition type </th> <th> Description </th> |
</tr> |
-<tr id="LINK"> |
- <td>LINK</td> <td>0</td> |
+<tr id="tt_link"> |
+ <td>"link"</td> |
<td> |
The user got to this page by clicking a link on another page. |
</td> |
</tr> |
-<tr id="TYPED"> |
- <td>TYPED</td> <td>1</td> |
+<tr id="tt_typed"> |
+ <td>"typed"</td> |
<td> |
The user got this page by typing the URL in the address bar. |
Also used for other explicit navigation actions. |
- See also <a href="#GENERATED">GENERATED</a>, |
+ See also <a href="#tt_generated">generated</a>, |
which is used for cases where the user selected a choice |
that didn't look at all like a URL. |
</td> |
</tr> |
-<tr id="AUTO_BOOKMARK"> |
- <td>AUTO_BOOKMARK</td><td>2</td> |
+<tr id="tt_auto_bookmark"> |
+ <td>"auto_bookmark"</td> |
<td> |
The user got to this page through a suggestion in the UI — |
for example, through a menu item. |
</td> |
</tr> |
-<tr id="AUTO_SUBFRAME"> |
- <td>AUTO_SUBFRAME</td><td>3</td> |
+<tr id="tt_auto_subframe"> |
+ <td>"auto_subframe"</td> |
<td> |
Subframe navigation. |
This is any content that is automatically |
@@ -343,11 +336,11 @@ The following table describes each transition type defined by |
those ad URLs have this transition type. |
The user may not even realize the content in these pages |
is a separate frame, and so may not care about the URL |
- (see also <a href="#MANUAL_SUBFRAME">MANUAL_SUBFRAME</a>). |
+ (see also <a href="#tt_manual_subframe">manual_subframe</a>). |
</td> |
</tr> |
-<tr id="MANUAL_SUBFRAME"> |
- <td>MANUAL_SUBFRAME</td><td>4</td> |
+<tr id="tt_manual_subframe"> |
+ <td>"manual_subframe"</td> |
<td> |
For subframe navigations that are explicitly requested by the user |
and generate new navigation entries in the back/forward list. |
@@ -357,26 +350,26 @@ The following table describes each transition type defined by |
the requested frame was loaded. |
</td> |
</tr> |
-<tr id="GENERATED"> |
- <td>GENERATED</td><td>5</td> |
+<tr id="tt_generated"> |
+ <td>"generated"</td> |
<td> |
The user got to this page by typing in the address bar |
and selecting an entry that did not look like a URL. |
For example, a match might have the URL of a Google search result page, |
but it might appear to the user as "Search Google for ...". |
- These are not quite the same as <a href="#TYPED">TYPED</a> navigations |
+ These are not quite the same as <a href="#tt_typed">typed</a> navigations |
because the user didn't type or see the destination URL. |
- See also <a href="#KEYWORD">KEYWORD</a>. |
+ See also <a href="#tt_keyword">keyword</a>. |
</td> |
</tr> |
-<tr id="START_PAGE"> |
- <td>START_PAGE</td><td>6</td> |
+<tr id="tt_start_page"> |
+ <td>"start_page"</td> |
<td> |
The page was specified in the command line or is the start page. |
</td> |
</tr> |
-<tr id="FORM_SUBMIT"> |
- <td>FORM_SUBMIT</td><td>7</td> |
+<tr id="tt_form_submit"> |
+ <td>"form_submit"</td> |
<td> |
The user filled out values in a form and submitted it. |
Note that in some situations — |
@@ -384,8 +377,8 @@ The following table describes each transition type defined by |
submitting a form does not result in this transition type. |
</td> |
</tr> |
-<tr id="RELOAD"> |
- <td>RELOAD</td><td>8</td> |
+<tr id="tt_reload"> |
+ <td>"reload"</td> |
<td> |
The user reloaded the page, |
either by clicking the reload button |
@@ -393,20 +386,20 @@ The following table describes each transition type defined by |
Session restore and Reopen closed tab use this transition type, too. |
</td> |
</tr> |
-<tr id="KEYWORD"> |
- <td>KEYWORD</td><td>9</td> |
+<tr id="tt_keyword"> |
+ <td>"keyword"</td> |
<td> |
The URL was generated from a replaceable keyword |
other than the default search provider. |
See also |
- <a href="#KEYWORD_GENERATED">KEYWORD_GENERATED</a>. |
+ <a href="#tt_keyword_generated">keyword_generated</a>. |
</td> |
</tr> |
-<tr id="KEYWORD_GENERATED"> |
- <td>KEYWORD_GENERATED</td><td>10</td> |
+<tr id="tt_keyword_generated"> |
+ <td>"keyword_generated"</td> |
<td> |
Corresponds to a visit generated for a keyword. |
- See also <a href="#KEYWORD">KEYWORD</a>. |
+ See also <a href="#tt_keyword">keyword</a>. |
</td> |
</tr> |
</tbody></table> |
@@ -424,7 +417,7 @@ For an example of using this API, see the |
<!-- API PAGE --> |
<div class="apiPage"> |
<a name="apiReference"></a> |
- <h2>API reference: chrome.experimental.history</h2> |
+ <h2>API reference: chrome.history</h2> |
<!-- PROPERTIES --> |
<div class="apiGroup" style="display: none; "> |
@@ -456,12 +449,12 @@ For an example of using this API, see the |
<div class="summary"><span style="display: none; ">void</span> |
<!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.history.addUrl</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
- <var><span>undefined</span></var></span>)</div> |
+ <span>chrome.history.addUrl</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
+ <var><span>details</span></var></span>)</div> |
<div class="description"> |
<p class="todo" style="display: none; ">Undocumented.</p> |
- <p>Adds a URL to the history at the current time with a <a href="#transition_types">transition type</a> of LINK.</p> |
+ <p>Adds a URL to the history at the current time with a <a href="#transition_types">transition type</a> of "link".</p> |
<!-- PARAMETERS --> |
<h4>Parameters</h4> |
@@ -469,7 +462,7 @@ For an example of using this API, see the |
<div> |
<div> |
<dt> |
- <var style="display: none; ">paramName</var> |
+ <var>details</var> |
<em> |
<!-- TYPE --> |
@@ -591,7 +584,7 @@ For an example of using this API, see the |
<div class="summary"><span style="display: none; ">void</span> |
<!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.history.deleteAll</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> |
+ <span>chrome.history.deleteAll</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> |
<var><span>callback</span></var></span>)</div> |
<div class="description"> |
@@ -688,8 +681,8 @@ For an example of using this API, see the |
<div class="summary"><span style="display: none; ">void</span> |
<!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.history.deleteRange</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
- <var><span>undefined</span></var></span><span class="null"><span>, </span><span>function</span> |
+ <span>chrome.history.deleteRange</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
+ <var><span>range</span></var></span><span class="null"><span>, </span><span>function</span> |
<var><span>callback</span></var></span>)</div> |
<div class="description"> |
@@ -702,7 +695,7 @@ For an example of using this API, see the |
<div> |
<div> |
<dt> |
- <var style="display: none; ">paramName</var> |
+ <var>range</var> |
<em> |
<!-- TYPE --> |
@@ -908,8 +901,8 @@ For an example of using this API, see the |
<div class="summary"><span style="display: none; ">void</span> |
<!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.history.deleteUrl</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
- <var><span>undefined</span></var></span>)</div> |
+ <span>chrome.history.deleteUrl</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
+ <var><span>details</span></var></span>)</div> |
<div class="description"> |
<p class="todo" style="display: none; ">Undocumented.</p> |
@@ -921,7 +914,7 @@ For an example of using this API, see the |
<div> |
<div> |
<dt> |
- <var style="display: none; ">paramName</var> |
+ <var>details</var> |
<em> |
<!-- TYPE --> |
@@ -1043,8 +1036,8 @@ For an example of using this API, see the |
<div class="summary"><span style="display: none; ">void</span> |
<!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.history.getVisits</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
- <var><span>undefined</span></var></span><span class="null"><span>, </span><span>function</span> |
+ <span>chrome.history.getVisits</span>(<span class="null"><span style="display: none; ">, </span><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"> |
@@ -1057,7 +1050,7 @@ For an example of using this API, see the |
<div> |
<div> |
<dt> |
- <var style="display: none; ">paramName</var> |
+ <var>details</var> |
<em> |
<!-- TYPE --> |
@@ -1224,7 +1217,7 @@ For an example of using this API, see the |
<span> |
array of <span><span> |
<span> |
- <a href="experimental.history.html#type-VisitItem">VisitItem</a> |
+ <a href="history.html#type-VisitItem">VisitItem</a> |
</span> |
<span style="display: none; "> |
<span> |
@@ -1272,7 +1265,7 @@ For an example of using this API, see the |
<div class="summary"><span style="display: none; ">void</span> |
<!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.history.search</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
+ <span>chrome.history.search</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> |
<var><span>query</span></var></span><span class="null"><span>, </span><span>function</span> |
<var><span>callback</span></var></span>)</div> |
@@ -1576,7 +1569,7 @@ For an example of using this API, see the |
<span> |
array of <span><span> |
<span> |
- <a href="experimental.history.html#type-HistoryItem">HistoryItem</a> |
+ <a href="history.html#type-HistoryItem">HistoryItem</a> |
</span> |
<span style="display: none; "> |
<span> |
@@ -1634,7 +1627,7 @@ For an example of using this API, see the |
<div class="summary"> |
<!-- Note: intentionally longer 80 columns --> |
- <span class="subdued">chrome.experimental.history.</span><span>onVisitRemoved</span><span class="subdued">.addListener</span>(function(<span>object removed</span>) <span class="subdued">{...}</span>); |
+ <span class="subdued">chrome.history.</span><span>onVisitRemoved</span><span class="subdued">.addListener</span>(function(<span>object removed</span>) <span class="subdued">{...}</span>); |
</div> |
<div class="description"> |
@@ -1789,7 +1782,7 @@ For an example of using this API, see the |
<div class="summary"> |
<!-- Note: intentionally longer 80 columns --> |
- <span class="subdued">chrome.experimental.history.</span><span>onVisited</span><span class="subdued">.addListener</span>(function(<span>HistoryItem result</span>) <span class="subdued">{...}</span>); |
+ <span class="subdued">chrome.history.</span><span>onVisited</span><span class="subdued">.addListener</span>(function(<span>HistoryItem result</span>) <span class="subdued">{...}</span>); |
</div> |
<div class="description"> |
@@ -1811,7 +1804,7 @@ For an example of using this API, see the |
<span class="optional" style="display: none; ">optional</span> |
<span id="typeTemplate"> |
<span> |
- <a href="experimental.history.html#type-HistoryItem">HistoryItem</a> |
+ <a href="history.html#type-HistoryItem">HistoryItem</a> |
</span> |
<span style="display: none; "> |
<span> |
@@ -2076,7 +2069,7 @@ For an example of using this API, see the |
<span style="display: none; "> |
array of <span><span></span></span> |
</span> |
- <span>integer</span> |
+ <span>string</span> |
</span> |
</span> |
) |