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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 1530002: Move history API out of experimental. Allow extensions to override history page. (Closed)
Patch Set: Rebase for commit. Created 10 years, 8 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
« no previous file with comments | « chrome/common/extensions/docs/getstarted.html ('k') | chrome/common/extensions/docs/hosting.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js"> 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script> 15 </script>
16 <script type="text/javascript" src="js/api_page_generator.js"></script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script>
17 <script type="text/javascript" src="js/bootstrap.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <title>chrome.experimental.history - Google Chrome Extensions - Google Code</t itle></head><body> <div id="gc-container" class="labs"> 18 <title>chrome.history - Google Chrome Extensions - Google Code</title></head>< body> <div id="gc-container" class="labs">
19 <div id="devModeWarning"> 19 <div id="devModeWarning">
20 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. 20 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.
21 </div> 21 </div>
22 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 22 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
23 <!-- In particular, sub-templates that recurse, must be used by allowing 23 <!-- In particular, sub-templates that recurse, must be used by allowing
24 jstemplate to make a copy of the template in this section which 24 jstemplate to make a copy of the template in this section which
25 are not operated on by way of the jsskip="true" --> 25 are not operated on by way of the jsskip="true" -->
26 <div style="display:none"> 26 <div style="display:none">
27 27
28 <!-- VALUE --> 28 <!-- VALUE -->
(...skipping 109 matching lines...) Expand 10 before | Expand all | Expand 10 after
138 <li><a href="options.html">Options Pages</a></li> 138 <li><a href="options.html">Options Pages</a></li>
139 <li><a href="override.html">Override Pages</a></li> 139 <li><a href="override.html">Override Pages</a></li>
140 <li><a href="pageAction.html">Page Actions</a></li> 140 <li><a href="pageAction.html">Page Actions</a></li>
141 <li><a href="themes.html">Themes</a></li> 141 <li><a href="themes.html">Themes</a></li>
142 </ul> 142 </ul>
143 </li> 143 </li>
144 <li>Browser Interaction 144 <li>Browser Interaction
145 <ul> 145 <ul>
146 <li><a href="bookmarks.html">Bookmarks</a></li> 146 <li><a href="bookmarks.html">Bookmarks</a></li>
147 <li><a href="events.html">Events</a></li> 147 <li><a href="events.html">Events</a></li>
148 <li class="leftNavSelected">History</li>
148 <li><a href="tabs.html">Tabs</a></li> 149 <li><a href="tabs.html">Tabs</a></li>
149 <li><a href="windows.html">Windows</a></li> 150 <li><a href="windows.html">Windows</a></li>
150 </ul> 151 </ul>
151 </li> 152 </li>
152 <li>Implementation 153 <li>Implementation
153 <ul> 154 <ul>
154 <li><a href="background_pages.html">Background Pages</a></li> 155 <li><a href="background_pages.html">Background Pages</a></li>
155 <li><a href="content_scripts.html">Content Scripts</a></li> 156 <li><a href="content_scripts.html">Content Scripts</a></li>
156 <li><a href="xhr.html">Cross-Origin XHR</a></li> 157 <li><a href="xhr.html">Cross-Origin XHR</a></li>
157 <li><a href="i18n.html">Internationalization</a></li> 158 <li><a href="i18n.html">Internationalization</a></li>
(...skipping 29 matching lines...) Expand all
187 <li><a href="api_index.html">chrome.* APIs</a></li> 188 <li><a href="api_index.html">chrome.* APIs</a></li>
188 <li><a href="api_other.html">Other APIs</a></li> 189 <li><a href="api_other.html">Other APIs</a></li>
189 </ul> 190 </ul>
190 </li> 191 </li>
191 <li><h2><a href="samples.html">Samples</a></h2></li> 192 <li><h2><a href="samples.html">Samples</a></h2></li>
192 </ul> 193 </ul>
193 </div> 194 </div>
194 195
195 <div class="g-unit" id="gc-pagecontent"> 196 <div class="g-unit" id="gc-pagecontent">
196 <div id="pageTitle"> 197 <div id="pageTitle">
197 <h1 class="page_title">chrome.experimental.history</h1> 198 <h1 class="page_title">chrome.history</h1>
198 </div> 199 </div>
199 <!-- TABLE OF CONTENTS --> 200 <!-- TABLE OF CONTENTS -->
200 <div id="toc"> 201 <div id="toc">
201 <h2>Contents</h2> 202 <h2>Contents</h2>
202 <ol> 203 <ol>
203 <li> 204 <li>
204 <a href="#transition_types">Transition types</a> 205 <a href="#transition_types">Transition types</a>
205 <ol> 206 <ol>
206 <li style="display: none; "> 207 <li style="display: none; ">
207 <a>h3Name</a> 208 <a>h3Name</a>
208 </li> 209 </li>
209 </ol> 210 </ol>
210 </li><li> 211 </li><li>
211 <a href="#examples">Examples</a> 212 <a href="#examples">Examples</a>
212 <ol> 213 <ol>
213 <li style="display: none; "> 214 <li style="display: none; ">
214 <a>h3Name</a> 215 <a>h3Name</a>
215 </li> 216 </li>
216 </ol> 217 </ol>
217 </li> 218 </li>
218 <li> 219 <li>
219 <a href="#apiReference">API reference: chrome.experimental.histo ry</a> 220 <a href="#apiReference">API reference: chrome.history</a>
220 <ol> 221 <ol>
221 <li style="display: none; "> 222 <li style="display: none; ">
222 <a href="#properties">Properties</a> 223 <a href="#properties">Properties</a>
223 <ol> 224 <ol>
224 <li> 225 <li>
225 <a href="#property-anchor">propertyName</a> 226 <a href="#property-anchor">propertyName</a>
226 </li> 227 </li>
227 </ol> 228 </ol>
228 </li> 229 </li>
229 <li> 230 <li>
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
266 </li> 267 </li>
267 </ol> 268 </ol>
268 </li> 269 </li>
269 </ol> 270 </ol>
270 </div> 271 </div>
271 <!-- /TABLE OF CONTENTS --> 272 <!-- /TABLE OF CONTENTS -->
272 273
273 <!-- STATIC CONTENT PLACEHOLDER --> 274 <!-- STATIC CONTENT PLACEHOLDER -->
274 <div id="static"><!-- BEGIN AUTHORED CONTENT --> 275 <div id="static"><!-- BEGIN AUTHORED CONTENT -->
275 <p id="classSummary"> 276 <p id="classSummary">
276 For information on how to use experimental APIs, 277 Use the <code>chrome.history</code> module to interact with the
277 see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 278 browser's record of visited pages. You can add, remove, and query
279 for URLs in the browser's history.
280
281 To override the history page with your own version, see
282 <a href="override.html">Override Pages</a>.
283
278 </p> 284 </p>
279 285
280 <h2 id="transition_types">Transition types</h2> 286 <h2 id="transition_types">Transition types</h2>
281 287
282 <p> 288 <p>
283 The history API uses a <em>transition type</em> to describe 289 The history API uses a <em>transition type</em> to describe
284 how the browser navigated to a particular URL 290 how the browser navigated to a particular URL
285 on a particular visit. 291 on a particular visit.
286 For example, if a user visits a page 292 For example, if a user visits a page
287 by clicking a link on another page, 293 by clicking a link on another page,
288 the transition type is LINK. 294 the transition type is "link".
289 To be precise,
290 the type is
291 <a href="#LINK"><code>chrome.experimental.history.transitionType.LINK</code></a> ,
292 which has an integer value of 0.
293 </p>
294
295 <p class="note">
296 <b>Note:</b>
297 The spelling of
298 <code>transitionType</code> changed in
299 <a href="http://src.chromium.org/viewvc/chrome?view=rev&amp;revision=38850">revi sion 38850</a>.
300 Previously, it was <code>transistionType</code>.
301 </p> 295 </p>
302 296
303 <p> 297 <p>
304 The following table describes each transition type defined by 298 The following table describes each transition type.
305 <code>chrome.experimental.history.transitionType</code>.
306 </p> 299 </p>
307 300
308 <table> 301 <table>
309 <tbody><tr> 302 <tbody><tr>
310 <th> Transition type </th> <th> Value </th> <th> Description </th> 303 <th> Transition type </th> <th> Description </th>
311 </tr> 304 </tr>
312 <tr id="LINK"> 305 <tr id="tt_link">
313 <td>LINK</td> <td>0</td> 306 <td>"link"</td>
314 <td> 307 <td>
315 The user got to this page by clicking a link on another page. 308 The user got to this page by clicking a link on another page.
316 </td> 309 </td>
317 </tr> 310 </tr>
318 <tr id="TYPED"> 311 <tr id="tt_typed">
319 <td>TYPED</td> <td>1</td> 312 <td>"typed"</td>
320 <td> 313 <td>
321 The user got this page by typing the URL in the address bar. 314 The user got this page by typing the URL in the address bar.
322 Also used for other explicit navigation actions. 315 Also used for other explicit navigation actions.
323 See also <a href="#GENERATED">GENERATED</a>, 316 See also <a href="#tt_generated">generated</a>,
324 which is used for cases where the user selected a choice 317 which is used for cases where the user selected a choice
325 that didn't look at all like a URL. 318 that didn't look at all like a URL.
326 </td> 319 </td>
327 </tr> 320 </tr>
328 <tr id="AUTO_BOOKMARK"> 321 <tr id="tt_auto_bookmark">
329 <td>AUTO_BOOKMARK</td><td>2</td> 322 <td>"auto_bookmark"</td>
330 <td> 323 <td>
331 The user got to this page through a suggestion in the UI — 324 The user got to this page through a suggestion in the UI —
332 for example, through a menu item. 325 for example, through a menu item.
333 </td> 326 </td>
334 </tr> 327 </tr>
335 <tr id="AUTO_SUBFRAME"> 328 <tr id="tt_auto_subframe">
336 <td>AUTO_SUBFRAME</td><td>3</td> 329 <td>"auto_subframe"</td>
337 <td> 330 <td>
338 Subframe navigation. 331 Subframe navigation.
339 This is any content that is automatically 332 This is any content that is automatically
340 loaded in a non-top-level frame. 333 loaded in a non-top-level frame.
341 For example, if a page consists of 334 For example, if a page consists of
342 several frames containing ads, 335 several frames containing ads,
343 those ad URLs have this transition type. 336 those ad URLs have this transition type.
344 The user may not even realize the content in these pages 337 The user may not even realize the content in these pages
345 is a separate frame, and so may not care about the URL 338 is a separate frame, and so may not care about the URL
346 (see also <a href="#MANUAL_SUBFRAME">MANUAL_SUBFRAME</a>). 339 (see also <a href="#tt_manual_subframe">manual_subframe</a>).
347 </td> 340 </td>
348 </tr> 341 </tr>
349 <tr id="MANUAL_SUBFRAME"> 342 <tr id="tt_manual_subframe">
350 <td>MANUAL_SUBFRAME</td><td>4</td> 343 <td>"manual_subframe"</td>
351 <td> 344 <td>
352 For subframe navigations that are explicitly requested by the user 345 For subframe navigations that are explicitly requested by the user
353 and generate new navigation entries in the back/forward list. 346 and generate new navigation entries in the back/forward list.
354 An explicitly requested frame is probably more important than 347 An explicitly requested frame is probably more important than
355 an automatically loaded frame 348 an automatically loaded frame
356 because the user probably cares about the fact that 349 because the user probably cares about the fact that
357 the requested frame was loaded. 350 the requested frame was loaded.
358 </td> 351 </td>
359 </tr> 352 </tr>
360 <tr id="GENERATED"> 353 <tr id="tt_generated">
361 <td>GENERATED</td><td>5</td> 354 <td>"generated"</td>
362 <td> 355 <td>
363 The user got to this page by typing in the address bar 356 The user got to this page by typing in the address bar
364 and selecting an entry that did not look like a URL. 357 and selecting an entry that did not look like a URL.
365 For example, a match might have the URL of a Google search result page, 358 For example, a match might have the URL of a Google search result page,
366 but it might appear to the user as "Search Google for ...". 359 but it might appear to the user as "Search Google for ...".
367 These are not quite the same as <a href="#TYPED">TYPED</a> navigations 360 These are not quite the same as <a href="#tt_typed">typed</a> navigations
368 because the user didn't type or see the destination URL. 361 because the user didn't type or see the destination URL.
369 See also <a href="#KEYWORD">KEYWORD</a>. 362 See also <a href="#tt_keyword">keyword</a>.
370 </td> 363 </td>
371 </tr> 364 </tr>
372 <tr id="START_PAGE"> 365 <tr id="tt_start_page">
373 <td>START_PAGE</td><td>6</td> 366 <td>"start_page"</td>
374 <td> 367 <td>
375 The page was specified in the command line or is the start page. 368 The page was specified in the command line or is the start page.
376 </td> 369 </td>
377 </tr> 370 </tr>
378 <tr id="FORM_SUBMIT"> 371 <tr id="tt_form_submit">
379 <td>FORM_SUBMIT</td><td>7</td> 372 <td>"form_submit"</td>
380 <td> 373 <td>
381 The user filled out values in a form and submitted it. 374 The user filled out values in a form and submitted it.
382 Note that in some situations — 375 Note that in some situations —
383 such as when a form uses script to submit contents — 376 such as when a form uses script to submit contents —
384 submitting a form does not result in this transition type. 377 submitting a form does not result in this transition type.
385 </td> 378 </td>
386 </tr> 379 </tr>
387 <tr id="RELOAD"> 380 <tr id="tt_reload">
388 <td>RELOAD</td><td>8</td> 381 <td>"reload"</td>
389 <td> 382 <td>
390 The user reloaded the page, 383 The user reloaded the page,
391 either by clicking the reload button 384 either by clicking the reload button
392 or by pressing Enter in the address bar. 385 or by pressing Enter in the address bar.
393 Session restore and Reopen closed tab use this transition type, too. 386 Session restore and Reopen closed tab use this transition type, too.
394 </td> 387 </td>
395 </tr> 388 </tr>
396 <tr id="KEYWORD"> 389 <tr id="tt_keyword">
397 <td>KEYWORD</td><td>9</td> 390 <td>"keyword"</td>
398 <td> 391 <td>
399 The URL was generated from a replaceable keyword 392 The URL was generated from a replaceable keyword
400 other than the default search provider. 393 other than the default search provider.
401 See also 394 See also
402 <a href="#KEYWORD_GENERATED">KEYWORD_GENERATED</a>. 395 <a href="#tt_keyword_generated">keyword_generated</a>.
403 </td> 396 </td>
404 </tr> 397 </tr>
405 <tr id="KEYWORD_GENERATED"> 398 <tr id="tt_keyword_generated">
406 <td>KEYWORD_GENERATED</td><td>10</td> 399 <td>"keyword_generated"</td>
407 <td> 400 <td>
408 Corresponds to a visit generated for a keyword. 401 Corresponds to a visit generated for a keyword.
409 See also <a href="#KEYWORD">KEYWORD</a>. 402 See also <a href="#tt_keyword">keyword</a>.
410 </td> 403 </td>
411 </tr> 404 </tr>
412 </tbody></table> 405 </tbody></table>
413 406
414 <h2 id="examples">Examples</h2> 407 <h2 id="examples">Examples</h2>
415 408
416 <p> 409 <p>
417 For an example of using this API, see the 410 For an example of using this API, see the
418 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/test/data/extens ions/api_test/history/">history API test directory</a>. 411 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/test/data/extens ions/api_test/history/">history API test directory</a>.
419 </p> 412 </p>
420 413
421 <!-- END AUTHORED CONTENT --> 414 <!-- END AUTHORED CONTENT -->
422 </div> 415 </div>
423 416
424 <!-- API PAGE --> 417 <!-- API PAGE -->
425 <div class="apiPage"> 418 <div class="apiPage">
426 <a name="apiReference"></a> 419 <a name="apiReference"></a>
427 <h2>API reference: chrome.experimental.history</h2> 420 <h2>API reference: chrome.history</h2>
428 421
429 <!-- PROPERTIES --> 422 <!-- PROPERTIES -->
430 <div class="apiGroup" style="display: none; "> 423 <div class="apiGroup" style="display: none; ">
431 <a name="properties"></a> 424 <a name="properties"></a>
432 <h3 id="properties">Properties</h3> 425 <h3 id="properties">Properties</h3>
433 426
434 <div> 427 <div>
435 <a></a> 428 <a></a>
436 <h4>getLastError</h4> 429 <h4>getLastError</h4>
437 <div class="summary"> 430 <div class="summary">
(...skipping 11 matching lines...) Expand all
449 <a name="methods"></a> 442 <a name="methods"></a>
450 <h3>Methods</h3> 443 <h3>Methods</h3>
451 444
452 <!-- iterates over all functions --> 445 <!-- iterates over all functions -->
453 <div class="apiItem"> 446 <div class="apiItem">
454 <a name="method-addUrl"></a> <!-- method-anchor --> 447 <a name="method-addUrl"></a> <!-- method-anchor -->
455 <h4>addUrl</h4> 448 <h4>addUrl</h4>
456 449
457 <div class="summary"><span style="display: none; ">void</span> 450 <div class="summary"><span style="display: none; ">void</span>
458 <!-- Note: intentionally longer 80 columns --> 451 <!-- Note: intentionally longer 80 columns -->
459 <span>chrome.experimental.history.addUrl</span>(<span class="n ull"><span style="display: none; ">, </span><span>object</span> 452 <span>chrome.history.addUrl</span>(<span class="null"><span st yle="display: none; ">, </span><span>object</span>
460 <var><span>undefined</span></var></span>)</div> 453 <var><span>details</span></var></span>)</div>
461 454
462 <div class="description"> 455 <div class="description">
463 <p class="todo" style="display: none; ">Undocumented.</p> 456 <p class="todo" style="display: none; ">Undocumented.</p>
464 <p>Adds a URL to the history at the current time with a <a href= "#transition_types">transition type</a> of LINK.</p> 457 <p>Adds a URL to the history at the current time with a <a href= "#transition_types">transition type</a> of "link".</p>
465 458
466 <!-- PARAMETERS --> 459 <!-- PARAMETERS -->
467 <h4>Parameters</h4> 460 <h4>Parameters</h4>
468 <dl> 461 <dl>
469 <div> 462 <div>
470 <div> 463 <div>
471 <dt> 464 <dt>
472 <var style="display: none; ">paramName</var> 465 <var>details</var>
473 <em> 466 <em>
474 467
475 <!-- TYPE --> 468 <!-- TYPE -->
476 <div style="display:inline"> 469 <div style="display:inline">
477 ( 470 (
478 <span class="optional" style="display: none; ">optional</spa n> 471 <span class="optional" style="display: none; ">optional</spa n>
479 <span id="typeTemplate"> 472 <span id="typeTemplate">
480 <span style="display: none; "> 473 <span style="display: none; ">
481 <a> Type</a> 474 <a> Type</a>
482 </span> 475 </span>
(...skipping 101 matching lines...) Expand 10 before | Expand all | Expand 10 after
584 </div> 577 </div>
585 578
586 </div> <!-- /description --> 579 </div> <!-- /description -->
587 580
588 </div><div class="apiItem"> 581 </div><div class="apiItem">
589 <a name="method-deleteAll"></a> <!-- method-anchor --> 582 <a name="method-deleteAll"></a> <!-- method-anchor -->
590 <h4>deleteAll</h4> 583 <h4>deleteAll</h4>
591 584
592 <div class="summary"><span style="display: none; ">void</span> 585 <div class="summary"><span style="display: none; ">void</span>
593 <!-- Note: intentionally longer 80 columns --> 586 <!-- Note: intentionally longer 80 columns -->
594 <span>chrome.experimental.history.deleteAll</span>(<span class ="null"><span style="display: none; ">, </span><span>function</span> 587 <span>chrome.history.deleteAll</span>(<span class="null"><span style="display: none; ">, </span><span>function</span>
595 <var><span>callback</span></var></span>)</div> 588 <var><span>callback</span></var></span>)</div>
596 589
597 <div class="description"> 590 <div class="description">
598 <p class="todo" style="display: none; ">Undocumented.</p> 591 <p class="todo" style="display: none; ">Undocumented.</p>
599 <p>Deletes all items from the history.</p> 592 <p>Deletes all items from the history.</p>
600 593
601 <!-- PARAMETERS --> 594 <!-- PARAMETERS -->
602 <h4>Parameters</h4> 595 <h4>Parameters</h4>
603 <dl> 596 <dl>
604 <div> 597 <div>
(...skipping 76 matching lines...) Expand 10 before | Expand all | Expand 10 after
681 </div> 674 </div>
682 675
683 </div> <!-- /description --> 676 </div> <!-- /description -->
684 677
685 </div><div class="apiItem"> 678 </div><div class="apiItem">
686 <a name="method-deleteRange"></a> <!-- method-anchor --> 679 <a name="method-deleteRange"></a> <!-- method-anchor -->
687 <h4>deleteRange</h4> 680 <h4>deleteRange</h4>
688 681
689 <div class="summary"><span style="display: none; ">void</span> 682 <div class="summary"><span style="display: none; ">void</span>
690 <!-- Note: intentionally longer 80 columns --> 683 <!-- Note: intentionally longer 80 columns -->
691 <span>chrome.experimental.history.deleteRange</span>(<span cla ss="null"><span style="display: none; ">, </span><span>object</span> 684 <span>chrome.history.deleteRange</span>(<span class="null"><sp an style="display: none; ">, </span><span>object</span>
692 <var><span>undefined</span></var></span><span class="null" ><span>, </span><span>function</span> 685 <var><span>range</span></var></span><span class="null"><sp an>, </span><span>function</span>
693 <var><span>callback</span></var></span>)</div> 686 <var><span>callback</span></var></span>)</div>
694 687
695 <div class="description"> 688 <div class="description">
696 <p class="todo" style="display: none; ">Undocumented.</p> 689 <p class="todo" style="display: none; ">Undocumented.</p>
697 <p>Removes all items within the specified date range from the hi story. Pages will not be removed from the history unless all visits fall within the range.</p> 690 <p>Removes all items within the specified date range from the hi story. Pages will not be removed from the history unless all visits fall within the range.</p>
698 691
699 <!-- PARAMETERS --> 692 <!-- PARAMETERS -->
700 <h4>Parameters</h4> 693 <h4>Parameters</h4>
701 <dl> 694 <dl>
702 <div> 695 <div>
703 <div> 696 <div>
704 <dt> 697 <dt>
705 <var style="display: none; ">paramName</var> 698 <var>range</var>
706 <em> 699 <em>
707 700
708 <!-- TYPE --> 701 <!-- TYPE -->
709 <div style="display:inline"> 702 <div style="display:inline">
710 ( 703 (
711 <span class="optional" style="display: none; ">optional</spa n> 704 <span class="optional" style="display: none; ">optional</spa n>
712 <span id="typeTemplate"> 705 <span id="typeTemplate">
713 <span style="display: none; "> 706 <span style="display: none; ">
714 <a> Type</a> 707 <a> Type</a>
715 </span> 708 </span>
(...skipping 185 matching lines...) Expand 10 before | Expand all | Expand 10 after
901 </div> 894 </div>
902 895
903 </div> <!-- /description --> 896 </div> <!-- /description -->
904 897
905 </div><div class="apiItem"> 898 </div><div class="apiItem">
906 <a name="method-deleteUrl"></a> <!-- method-anchor --> 899 <a name="method-deleteUrl"></a> <!-- method-anchor -->
907 <h4>deleteUrl</h4> 900 <h4>deleteUrl</h4>
908 901
909 <div class="summary"><span style="display: none; ">void</span> 902 <div class="summary"><span style="display: none; ">void</span>
910 <!-- Note: intentionally longer 80 columns --> 903 <!-- Note: intentionally longer 80 columns -->
911 <span>chrome.experimental.history.deleteUrl</span>(<span class ="null"><span style="display: none; ">, </span><span>object</span> 904 <span>chrome.history.deleteUrl</span>(<span class="null"><span style="display: none; ">, </span><span>object</span>
912 <var><span>undefined</span></var></span>)</div> 905 <var><span>details</span></var></span>)</div>
913 906
914 <div class="description"> 907 <div class="description">
915 <p class="todo" style="display: none; ">Undocumented.</p> 908 <p class="todo" style="display: none; ">Undocumented.</p>
916 <p>Removes all occurrences of the given URL from the history.</p > 909 <p>Removes all occurrences of the given URL from the history.</p >
917 910
918 <!-- PARAMETERS --> 911 <!-- PARAMETERS -->
919 <h4>Parameters</h4> 912 <h4>Parameters</h4>
920 <dl> 913 <dl>
921 <div> 914 <div>
922 <div> 915 <div>
923 <dt> 916 <dt>
924 <var style="display: none; ">paramName</var> 917 <var>details</var>
925 <em> 918 <em>
926 919
927 <!-- TYPE --> 920 <!-- TYPE -->
928 <div style="display:inline"> 921 <div style="display:inline">
929 ( 922 (
930 <span class="optional" style="display: none; ">optional</spa n> 923 <span class="optional" style="display: none; ">optional</spa n>
931 <span id="typeTemplate"> 924 <span id="typeTemplate">
932 <span style="display: none; "> 925 <span style="display: none; ">
933 <a> Type</a> 926 <a> Type</a>
934 </span> 927 </span>
(...skipping 101 matching lines...) Expand 10 before | Expand all | Expand 10 after
1036 </div> 1029 </div>
1037 1030
1038 </div> <!-- /description --> 1031 </div> <!-- /description -->
1039 1032
1040 </div><div class="apiItem"> 1033 </div><div class="apiItem">
1041 <a name="method-getVisits"></a> <!-- method-anchor --> 1034 <a name="method-getVisits"></a> <!-- method-anchor -->
1042 <h4>getVisits</h4> 1035 <h4>getVisits</h4>
1043 1036
1044 <div class="summary"><span style="display: none; ">void</span> 1037 <div class="summary"><span style="display: none; ">void</span>
1045 <!-- Note: intentionally longer 80 columns --> 1038 <!-- Note: intentionally longer 80 columns -->
1046 <span>chrome.experimental.history.getVisits</span>(<span class ="null"><span style="display: none; ">, </span><span>object</span> 1039 <span>chrome.history.getVisits</span>(<span class="null"><span style="display: none; ">, </span><span>object</span>
1047 <var><span>undefined</span></var></span><span class="null" ><span>, </span><span>function</span> 1040 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
1048 <var><span>callback</span></var></span>)</div> 1041 <var><span>callback</span></var></span>)</div>
1049 1042
1050 <div class="description"> 1043 <div class="description">
1051 <p class="todo" style="display: none; ">Undocumented.</p> 1044 <p class="todo" style="display: none; ">Undocumented.</p>
1052 <p>Retrieve information about visits to a URL.</p> 1045 <p>Retrieve information about visits to a URL.</p>
1053 1046
1054 <!-- PARAMETERS --> 1047 <!-- PARAMETERS -->
1055 <h4>Parameters</h4> 1048 <h4>Parameters</h4>
1056 <dl> 1049 <dl>
1057 <div> 1050 <div>
1058 <div> 1051 <div>
1059 <dt> 1052 <dt>
1060 <var style="display: none; ">paramName</var> 1053 <var>details</var>
1061 <em> 1054 <em>
1062 1055
1063 <!-- TYPE --> 1056 <!-- TYPE -->
1064 <div style="display:inline"> 1057 <div style="display:inline">
1065 ( 1058 (
1066 <span class="optional" style="display: none; ">optional</spa n> 1059 <span class="optional" style="display: none; ">optional</spa n>
1067 <span id="typeTemplate"> 1060 <span id="typeTemplate">
1068 <span style="display: none; "> 1061 <span style="display: none; ">
1069 <a> Type</a> 1062 <a> Type</a>
1070 </span> 1063 </span>
(...skipping 146 matching lines...) Expand 10 before | Expand all | Expand 10 after
1217 ( 1210 (
1218 <span class="optional" style="display: none; ">optional</spa n> 1211 <span class="optional" style="display: none; ">optional</spa n>
1219 <span id="typeTemplate"> 1212 <span id="typeTemplate">
1220 <span style="display: none; "> 1213 <span style="display: none; ">
1221 <a> Type</a> 1214 <a> Type</a>
1222 </span> 1215 </span>
1223 <span> 1216 <span>
1224 <span> 1217 <span>
1225 array of <span><span> 1218 array of <span><span>
1226 <span> 1219 <span>
1227 <a href="experimental.history.html#type-VisitItem">Visit Item</a> 1220 <a href="history.html#type-VisitItem">VisitItem</a>
1228 </span> 1221 </span>
1229 <span style="display: none; "> 1222 <span style="display: none; ">
1230 <span> 1223 <span>
1231 array of <span><span></span></span> 1224 array of <span><span></span></span>
1232 </span> 1225 </span>
1233 <span>paramType</span> 1226 <span>paramType</span>
1234 </span> 1227 </span>
1235 </span></span> 1228 </span></span>
1236 </span> 1229 </span>
1237 <span style="display: none; ">paramType</span> 1230 <span style="display: none; ">paramType</span>
(...skipping 27 matching lines...) Expand all
1265 </div> 1258 </div>
1266 1259
1267 </div> <!-- /description --> 1260 </div> <!-- /description -->
1268 1261
1269 </div><div class="apiItem"> 1262 </div><div class="apiItem">
1270 <a name="method-search"></a> <!-- method-anchor --> 1263 <a name="method-search"></a> <!-- method-anchor -->
1271 <h4>search</h4> 1264 <h4>search</h4>
1272 1265
1273 <div class="summary"><span style="display: none; ">void</span> 1266 <div class="summary"><span style="display: none; ">void</span>
1274 <!-- Note: intentionally longer 80 columns --> 1267 <!-- Note: intentionally longer 80 columns -->
1275 <span>chrome.experimental.history.search</span>(<span class="n ull"><span style="display: none; ">, </span><span>object</span> 1268 <span>chrome.history.search</span>(<span class="null"><span st yle="display: none; ">, </span><span>object</span>
1276 <var><span>query</span></var></span><span class="null"><sp an>, </span><span>function</span> 1269 <var><span>query</span></var></span><span class="null"><sp an>, </span><span>function</span>
1277 <var><span>callback</span></var></span>)</div> 1270 <var><span>callback</span></var></span>)</div>
1278 1271
1279 <div class="description"> 1272 <div class="description">
1280 <p class="todo" style="display: none; ">Undocumented.</p> 1273 <p class="todo" style="display: none; ">Undocumented.</p>
1281 <p>Search the history for the last visit time of each page match ing the query.</p> 1274 <p>Search the history for the last visit time of each page match ing the query.</p>
1282 1275
1283 <!-- PARAMETERS --> 1276 <!-- PARAMETERS -->
1284 <h4>Parameters</h4> 1277 <h4>Parameters</h4>
1285 <dl> 1278 <dl>
(...skipping 283 matching lines...) Expand 10 before | Expand all | Expand 10 after
1569 ( 1562 (
1570 <span class="optional" style="display: none; ">optional</spa n> 1563 <span class="optional" style="display: none; ">optional</spa n>
1571 <span id="typeTemplate"> 1564 <span id="typeTemplate">
1572 <span style="display: none; "> 1565 <span style="display: none; ">
1573 <a> Type</a> 1566 <a> Type</a>
1574 </span> 1567 </span>
1575 <span> 1568 <span>
1576 <span> 1569 <span>
1577 array of <span><span> 1570 array of <span><span>
1578 <span> 1571 <span>
1579 <a href="experimental.history.html#type-HistoryItem">His toryItem</a> 1572 <a href="history.html#type-HistoryItem">HistoryItem</a>
1580 </span> 1573 </span>
1581 <span style="display: none; "> 1574 <span style="display: none; ">
1582 <span> 1575 <span>
1583 array of <span><span></span></span> 1576 array of <span><span></span></span>
1584 </span> 1577 </span>
1585 <span>paramType</span> 1578 <span>paramType</span>
1586 </span> 1579 </span>
1587 </span></span> 1580 </span></span>
1588 </span> 1581 </span>
1589 <span style="display: none; ">paramType</span> 1582 <span style="display: none; ">paramType</span>
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
1627 <a name="events"></a> 1620 <a name="events"></a>
1628 <h3 id="events">Events</h3> 1621 <h3 id="events">Events</h3>
1629 1622
1630 <!-- iterates over all events --> 1623 <!-- iterates over all events -->
1631 <div class="apiItem"> 1624 <div class="apiItem">
1632 <a name="event-onVisitRemoved"></a> 1625 <a name="event-onVisitRemoved"></a>
1633 <h4>onVisitRemoved</h4> 1626 <h4>onVisitRemoved</h4>
1634 1627
1635 <div class="summary"> 1628 <div class="summary">
1636 <!-- Note: intentionally longer 80 columns --> 1629 <!-- Note: intentionally longer 80 columns -->
1637 <span class="subdued">chrome.experimental.history.</span><span>o nVisitRemoved</span><span class="subdued">.addListener</span>(function(<span>obj ect removed</span>) <span class="subdued">{...}</span>); 1630 <span class="subdued">chrome.history.</span><span>onVisitRemoved </span><span class="subdued">.addListener</span>(function(<span>object removed</ span>) <span class="subdued">{...}</span>);
1638 </div> 1631 </div>
1639 1632
1640 <div class="description"> 1633 <div class="description">
1641 <p class="todo" style="display: none; ">Undocumented.</p> 1634 <p class="todo" style="display: none; ">Undocumented.</p>
1642 <p>Fired when one or more URLs are removed from the history serv ice. When all visits have been removed the URL is purged from history.</p> 1635 <p>Fired when one or more URLs are removed from the history serv ice. When all visits have been removed the URL is purged from history.</p>
1643 1636
1644 <!-- PARAMETERS --> 1637 <!-- PARAMETERS -->
1645 <h4>Parameters</h4> 1638 <h4>Parameters</h4>
1646 <dl> 1639 <dl>
1647 <div> 1640 <div>
(...skipping 134 matching lines...) Expand 10 before | Expand all | Expand 10 after
1782 </dl> 1775 </dl>
1783 1776
1784 </div> <!-- /decription --> 1777 </div> <!-- /decription -->
1785 1778
1786 </div><div class="apiItem"> 1779 </div><div class="apiItem">
1787 <a name="event-onVisited"></a> 1780 <a name="event-onVisited"></a>
1788 <h4>onVisited</h4> 1781 <h4>onVisited</h4>
1789 1782
1790 <div class="summary"> 1783 <div class="summary">
1791 <!-- Note: intentionally longer 80 columns --> 1784 <!-- Note: intentionally longer 80 columns -->
1792 <span class="subdued">chrome.experimental.history.</span><span>o nVisited</span><span class="subdued">.addListener</span>(function(<span>HistoryI tem result</span>) <span class="subdued">{...}</span>); 1785 <span class="subdued">chrome.history.</span><span>onVisited</spa n><span class="subdued">.addListener</span>(function(<span>HistoryItem result</s pan>) <span class="subdued">{...}</span>);
1793 </div> 1786 </div>
1794 1787
1795 <div class="description"> 1788 <div class="description">
1796 <p class="todo" style="display: none; ">Undocumented.</p> 1789 <p class="todo" style="display: none; ">Undocumented.</p>
1797 <p>Fired when a URL is visited, providing the HistoryItem data f or that URL.</p> 1790 <p>Fired when a URL is visited, providing the HistoryItem data f or that URL.</p>
1798 1791
1799 <!-- PARAMETERS --> 1792 <!-- PARAMETERS -->
1800 <h4>Parameters</h4> 1793 <h4>Parameters</h4>
1801 <dl> 1794 <dl>
1802 <div> 1795 <div>
1803 <div> 1796 <div>
1804 <dt> 1797 <dt>
1805 <var>result</var> 1798 <var>result</var>
1806 <em> 1799 <em>
1807 1800
1808 <!-- TYPE --> 1801 <!-- TYPE -->
1809 <div style="display:inline"> 1802 <div style="display:inline">
1810 ( 1803 (
1811 <span class="optional" style="display: none; ">optional</spa n> 1804 <span class="optional" style="display: none; ">optional</spa n>
1812 <span id="typeTemplate"> 1805 <span id="typeTemplate">
1813 <span> 1806 <span>
1814 <a href="experimental.history.html#type-HistoryItem">His toryItem</a> 1807 <a href="history.html#type-HistoryItem">HistoryItem</a>
1815 </span> 1808 </span>
1816 <span style="display: none; "> 1809 <span style="display: none; ">
1817 <span> 1810 <span>
1818 array of <span><span></span></span> 1811 array of <span><span></span></span>
1819 </span> 1812 </span>
1820 <span>paramType</span> 1813 <span>paramType</span>
1821 </span> 1814 </span>
1822 </span> 1815 </span>
1823 ) 1816 )
1824 </div> 1817 </div>
(...skipping 244 matching lines...) Expand 10 before | Expand all | Expand 10 after
2069 ( 2062 (
2070 <span class="optional" style="display: none; ">optional</spa n> 2063 <span class="optional" style="display: none; ">optional</spa n>
2071 <span id="typeTemplate"> 2064 <span id="typeTemplate">
2072 <span style="display: none; "> 2065 <span style="display: none; ">
2073 <a> Type</a> 2066 <a> Type</a>
2074 </span> 2067 </span>
2075 <span> 2068 <span>
2076 <span style="display: none; "> 2069 <span style="display: none; ">
2077 array of <span><span></span></span> 2070 array of <span><span></span></span>
2078 </span> 2071 </span>
2079 <span>integer</span> 2072 <span>string</span>
2080 </span> 2073 </span>
2081 </span> 2074 </span>
2082 ) 2075 )
2083 </div> 2076 </div>
2084 2077
2085 </em> 2078 </em>
2086 </dt> 2079 </dt>
2087 <dd class="todo" style="display: none; "> 2080 <dd class="todo" style="display: none; ">
2088 Undocumented. 2081 Undocumented.
2089 </dd> 2082 </dd>
(...skipping 340 matching lines...) Expand 10 before | Expand all | Expand 10 after
2430 _uff=0; 2423 _uff=0;
2431 urchinTracker(); 2424 urchinTracker();
2432 } 2425 }
2433 catch(e) {/* urchinTracker not available. */} 2426 catch(e) {/* urchinTracker not available. */}
2434 </script> 2427 </script>
2435 <!-- end analytics --> 2428 <!-- end analytics -->
2436 </div> 2429 </div>
2437 </div> <!-- /gc-footer --> 2430 </div> <!-- /gc-footer -->
2438 </div> <!-- /gc-container --> 2431 </div> <!-- /gc-container -->
2439 </body></html> 2432 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/getstarted.html ('k') | chrome/common/extensions/docs/hosting.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698