OLD | NEW |
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> |
(...skipping 201 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
212 <ol> | 212 <ol> |
213 <li> | 213 <li> |
214 <a href="#method-addUrl">addUrl</a> | 214 <a href="#method-addUrl">addUrl</a> |
215 </li><li> | 215 </li><li> |
216 <a href="#method-deleteAll">deleteAll</a> | 216 <a href="#method-deleteAll">deleteAll</a> |
217 </li><li> | 217 </li><li> |
218 <a href="#method-deleteRange">deleteRange</a> | 218 <a href="#method-deleteRange">deleteRange</a> |
219 </li><li> | 219 </li><li> |
220 <a href="#method-deleteUrl">deleteUrl</a> | 220 <a href="#method-deleteUrl">deleteUrl</a> |
221 </li><li> | 221 </li><li> |
| 222 <a href="#method-getMostVisited">getMostVisited</a> |
| 223 </li><li> |
222 <a href="#method-getVisits">getVisits</a> | 224 <a href="#method-getVisits">getVisits</a> |
223 </li><li> | 225 </li><li> |
224 <a href="#method-search">search</a> | 226 <a href="#method-search">search</a> |
225 </li> | 227 </li> |
226 </ol> | 228 </ol> |
227 </li> | 229 </li> |
228 <li> | 230 <li> |
229 <a href="#global-events">Events</a> | 231 <a href="#global-events">Events</a> |
230 <ol> | 232 <ol> |
231 <li> | 233 <li> |
232 <a href="#event-onVisitRemoved">onVisitRemoved</a> | 234 <a href="#event-onVisitRemoved">onVisitRemoved</a> |
233 </li><li> | 235 </li><li> |
234 <a href="#event-onVisited">onVisited</a> | 236 <a href="#event-onVisited">onVisited</a> |
235 </li> | 237 </li> |
236 </ol> | 238 </ol> |
237 </li> | 239 </li> |
238 <li> | 240 <li> |
239 <a href="#types">Types</a> | 241 <a href="#types">Types</a> |
240 <ol> | 242 <ol> |
241 <li> | 243 <li> |
242 <a href="#type-HistoryItem">HistoryItem</a> | 244 <a href="#type-HistoryItem">HistoryItem</a> |
243 <ol> | 245 <ol> |
244 </ol> | 246 </ol> |
245 </li><li> | 247 </li><li> |
246 <a href="#type-VisitItem">VisitItem</a> | 248 <a href="#type-VisitItem">VisitItem</a> |
247 <ol> | 249 <ol> |
248 </ol> | 250 </ol> |
| 251 </li><li> |
| 252 <a href="#type-MostVisitedURL">MostVisitedURL</a> |
| 253 <ol> |
| 254 </ol> |
249 </li> | 255 </li> |
250 </ol> | 256 </ol> |
251 </li> | 257 </li> |
252 </ol> | 258 </ol> |
253 </li> | 259 </li> |
254 </ol> | 260 </ol> |
255 </div> | 261 </div> |
256 <!-- /TABLE OF CONTENTS --> | 262 <!-- /TABLE OF CONTENTS --> |
257 <!-- Standard content lead-in for experimental API pages --> | 263 <!-- Standard content lead-in for experimental API pages --> |
258 <!-- STATIC CONTENT PLACEHOLDER --> | 264 <!-- STATIC CONTENT PLACEHOLDER --> |
(...skipping 489 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
748 </div> | 754 </div> |
749 </div> | 755 </div> |
750 </dl> | 756 </dl> |
751 <!-- RETURNS --> | 757 <!-- RETURNS --> |
752 <dl> | 758 <dl> |
753 </dl> | 759 </dl> |
754 <!-- CALLBACK --> | 760 <!-- CALLBACK --> |
755 <!-- MIN_VERSION --> | 761 <!-- MIN_VERSION --> |
756 </div> <!-- /description --> | 762 </div> <!-- /description --> |
757 </div><div class="apiItem"> | 763 </div><div class="apiItem"> |
| 764 <a name="method-getMostVisited"></a> <!-- method-anchor --> |
| 765 <h4>getMostVisited</h4> |
| 766 <div class="summary"> |
| 767 <!-- Note: intentionally longer 80 columns --> |
| 768 <span>chrome.history.getMostVisited</span>(<span class="null">
<span>object</span> |
| 769 <var><span>details</span></var></span><span class="null"><
span>, </span><span>function</span> |
| 770 <var><span>callback</span></var></span>)</div> |
| 771 <div class="description"> |
| 772 <p>Retrieves the N most visited history items.</p> |
| 773 <!-- PARAMETERS --> |
| 774 <h4>Parameters</h4> |
| 775 <dl> |
| 776 <div> |
| 777 <div> |
| 778 <dt> |
| 779 <var>details</var> |
| 780 <em> |
| 781 <!-- TYPE --> |
| 782 <div style="display:inline"> |
| 783 ( |
| 784 <span id="typeTemplate"> |
| 785 <span> |
| 786 <span>object</span> |
| 787 </span> |
| 788 </span> |
| 789 ) |
| 790 </div> |
| 791 </em> |
| 792 </dt> |
| 793 <dd class="todo"> |
| 794 Undocumented. |
| 795 </dd> |
| 796 <!-- OBJECT PROPERTIES --> |
| 797 <dd> |
| 798 <dl> |
| 799 <div> |
| 800 <div> |
| 801 <dt> |
| 802 <var>maxResults</var> |
| 803 <em> |
| 804 <!-- TYPE --> |
| 805 <div style="display:inline"> |
| 806 ( |
| 807 <span id="typeTemplate"> |
| 808 <span> |
| 809 <span>integer</span> |
| 810 </span> |
| 811 </span> |
| 812 ) |
| 813 </div> |
| 814 </em> |
| 815 </dt> |
| 816 <dd>An integer representing the number of entries you want to retreive
.</dd> |
| 817 <!-- OBJECT PROPERTIES --> |
| 818 <!-- OBJECT METHODS --> |
| 819 <!-- OBJECT EVENT FIELDS --> |
| 820 <!-- FUNCTION PARAMETERS --> |
| 821 </div> |
| 822 </div> |
| 823 </dl> |
| 824 </dd> |
| 825 <!-- OBJECT METHODS --> |
| 826 <!-- OBJECT EVENT FIELDS --> |
| 827 <!-- FUNCTION PARAMETERS --> |
| 828 </div> |
| 829 </div><div> |
| 830 <div> |
| 831 <dt> |
| 832 <var>callback</var> |
| 833 <em> |
| 834 <!-- TYPE --> |
| 835 <div style="display:inline"> |
| 836 ( |
| 837 <span id="typeTemplate"> |
| 838 <span> |
| 839 <span>function</span> |
| 840 </span> |
| 841 </span> |
| 842 ) |
| 843 </div> |
| 844 </em> |
| 845 </dt> |
| 846 <dd class="todo"> |
| 847 Undocumented. |
| 848 </dd> |
| 849 <!-- OBJECT PROPERTIES --> |
| 850 <!-- OBJECT METHODS --> |
| 851 <!-- OBJECT EVENT FIELDS --> |
| 852 <!-- FUNCTION PARAMETERS --> |
| 853 </div> |
| 854 </div> |
| 855 </dl> |
| 856 <!-- RETURNS --> |
| 857 <dl> |
| 858 </dl> |
| 859 <!-- CALLBACK --> |
| 860 <div> |
| 861 <div> |
| 862 <h4>Callback function</h4> |
| 863 <p> |
| 864 The callback <em>parameter</em> should specify a function |
| 865 that looks like this: |
| 866 </p> |
| 867 <!-- Note: intentionally longer 80 columns --> |
| 868 <pre>function(<span>array of MostVisitedURL results</span>) <s
pan class="subdued">{...}</span>;</pre> |
| 869 <dl> |
| 870 <div> |
| 871 <div> |
| 872 <dt> |
| 873 <var>results</var> |
| 874 <em> |
| 875 <!-- TYPE --> |
| 876 <div style="display:inline"> |
| 877 ( |
| 878 <span id="typeTemplate"> |
| 879 <span> |
| 880 <span> |
| 881 array of <span><span> |
| 882 <span> |
| 883 <a href="history.html#type-MostVisitedURL">MostVisitedUR
L</a> |
| 884 </span> |
| 885 </span></span> |
| 886 </span> |
| 887 </span> |
| 888 </span> |
| 889 ) |
| 890 </div> |
| 891 </em> |
| 892 </dt> |
| 893 <dd class="todo"> |
| 894 Undocumented. |
| 895 </dd> |
| 896 <!-- OBJECT PROPERTIES --> |
| 897 <!-- OBJECT METHODS --> |
| 898 <!-- OBJECT EVENT FIELDS --> |
| 899 <!-- FUNCTION PARAMETERS --> |
| 900 </div> |
| 901 </div> |
| 902 </dl> |
| 903 </div> |
| 904 </div> |
| 905 <!-- MIN_VERSION --> |
| 906 </div> <!-- /description --> |
| 907 </div><div class="apiItem"> |
758 <a name="method-getVisits"></a> <!-- method-anchor --> | 908 <a name="method-getVisits"></a> <!-- method-anchor --> |
759 <h4>getVisits</h4> | 909 <h4>getVisits</h4> |
760 <div class="summary"> | 910 <div class="summary"> |
761 <!-- Note: intentionally longer 80 columns --> | 911 <!-- Note: intentionally longer 80 columns --> |
762 <span>chrome.history.getVisits</span>(<span class="null"><span
>object</span> | 912 <span>chrome.history.getVisits</span>(<span class="null"><span
>object</span> |
763 <var><span>details</span></var></span><span class="null"><
span>, </span><span>function</span> | 913 <var><span>details</span></var></span><span class="null"><
span>, </span><span>function</span> |
764 <var><span>callback</span></var></span>)</div> | 914 <var><span>callback</span></var></span>)</div> |
765 <div class="description"> | 915 <div class="description"> |
766 <p>Retrieves information about visits to a URL.</p> | 916 <p>Retrieves information about visits to a URL.</p> |
767 <!-- PARAMETERS --> | 917 <!-- PARAMETERS --> |
(...skipping 824 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1592 <!-- OBJECT EVENT FIELDS --> | 1742 <!-- OBJECT EVENT FIELDS --> |
1593 <!-- FUNCTION PARAMETERS --> | 1743 <!-- FUNCTION PARAMETERS --> |
1594 </div> | 1744 </div> |
1595 </div> | 1745 </div> |
1596 </dl> | 1746 </dl> |
1597 </dd> | 1747 </dd> |
1598 <!-- OBJECT METHODS --> | 1748 <!-- OBJECT METHODS --> |
1599 <!-- OBJECT EVENT FIELDS --> | 1749 <!-- OBJECT EVENT FIELDS --> |
1600 <!-- FUNCTION PARAMETERS --> | 1750 <!-- FUNCTION PARAMETERS --> |
1601 </div> | 1751 </div> |
| 1752 </div><div class="apiItem"> |
| 1753 <a name="type-MostVisitedURL"></a> |
| 1754 <h4>MostVisitedURL</h4> |
| 1755 <div> |
| 1756 <dt> |
| 1757 <em> |
| 1758 <!-- TYPE --> |
| 1759 <div style="display:inline"> |
| 1760 ( |
| 1761 <span id="typeTemplate"> |
| 1762 <span> |
| 1763 <span>object</span> |
| 1764 </span> |
| 1765 </span> |
| 1766 ) |
| 1767 </div> |
| 1768 </em> |
| 1769 </dt> |
| 1770 <dd>An object encapsulating a most visited URL, such as the URLs on th
e new tab page.</dd> |
| 1771 <!-- OBJECT PROPERTIES --> |
| 1772 <dd> |
| 1773 <dl> |
| 1774 <div> |
| 1775 <div> |
| 1776 <dt> |
| 1777 <var>url</var> |
| 1778 <em> |
| 1779 <!-- TYPE --> |
| 1780 <div style="display:inline"> |
| 1781 ( |
| 1782 <span id="typeTemplate"> |
| 1783 <span> |
| 1784 <span>string</span> |
| 1785 </span> |
| 1786 </span> |
| 1787 ) |
| 1788 </div> |
| 1789 </em> |
| 1790 </dt> |
| 1791 <dd>The most visited URL.</dd> |
| 1792 <!-- OBJECT PROPERTIES --> |
| 1793 <!-- OBJECT METHODS --> |
| 1794 <!-- OBJECT EVENT FIELDS --> |
| 1795 <!-- FUNCTION PARAMETERS --> |
| 1796 </div> |
| 1797 </div><div> |
| 1798 <div> |
| 1799 <dt> |
| 1800 <var>title</var> |
| 1801 <em> |
| 1802 <!-- TYPE --> |
| 1803 <div style="display:inline"> |
| 1804 ( |
| 1805 <span id="typeTemplate"> |
| 1806 <span> |
| 1807 <span>string</span> |
| 1808 </span> |
| 1809 </span> |
| 1810 ) |
| 1811 </div> |
| 1812 </em> |
| 1813 </dt> |
| 1814 <dd>The title of the page</dd> |
| 1815 <!-- OBJECT PROPERTIES --> |
| 1816 <!-- OBJECT METHODS --> |
| 1817 <!-- OBJECT EVENT FIELDS --> |
| 1818 <!-- FUNCTION PARAMETERS --> |
| 1819 </div> |
| 1820 </div><div> |
| 1821 <div> |
| 1822 <dt> |
| 1823 <var>redirects</var> |
| 1824 <em> |
| 1825 <!-- TYPE --> |
| 1826 <div style="display:inline"> |
| 1827 ( |
| 1828 <span id="typeTemplate"> |
| 1829 <span> |
| 1830 <span> |
| 1831 array of <span><span> |
| 1832 <span> |
| 1833 <span>string</span> |
| 1834 </span> |
| 1835 </span></span> |
| 1836 </span> |
| 1837 </span> |
| 1838 </span> |
| 1839 ) |
| 1840 </div> |
| 1841 </em> |
| 1842 </dt> |
| 1843 <dd>The redirect history of the URL.</dd> |
| 1844 <!-- OBJECT PROPERTIES --> |
| 1845 <!-- OBJECT METHODS --> |
| 1846 <!-- OBJECT EVENT FIELDS --> |
| 1847 <!-- FUNCTION PARAMETERS --> |
| 1848 </div> |
| 1849 </div> |
| 1850 </dl> |
| 1851 </dd> |
| 1852 <!-- OBJECT METHODS --> |
| 1853 <!-- OBJECT EVENT FIELDS --> |
| 1854 <!-- FUNCTION PARAMETERS --> |
| 1855 </div> |
1602 </div> <!-- /apiItem --> | 1856 </div> <!-- /apiItem --> |
1603 </div> <!-- /apiGroup --> | 1857 </div> <!-- /apiGroup --> |
1604 </div> <!-- /apiPage --> | 1858 </div> <!-- /apiPage --> |
1605 </div> <!-- /gc-pagecontent --> | 1859 </div> <!-- /gc-pagecontent --> |
1606 </div> <!-- /g-section --> | 1860 </div> <!-- /g-section --> |
1607 </div> <!-- /codesiteContent --> | 1861 </div> <!-- /codesiteContent --> |
1608 <div id="gc-footer" --=""> | 1862 <div id="gc-footer" --=""> |
1609 <div class="text"> | 1863 <div class="text"> |
1610 <p> | 1864 <p> |
1611 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, | 1865 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, |
(...skipping 20 matching lines...) Expand all Loading... |
1632 _uff=0; | 1886 _uff=0; |
1633 urchinTracker(); | 1887 urchinTracker(); |
1634 } | 1888 } |
1635 catch(e) {/* urchinTracker not available. */} | 1889 catch(e) {/* urchinTracker not available. */} |
1636 </script> | 1890 </script> |
1637 <!-- end analytics --> | 1891 <!-- end analytics --> |
1638 </div> | 1892 </div> |
1639 </div> <!-- /gc-footer --> | 1893 </div> <!-- /gc-footer --> |
1640 </div> <!-- /gc-container --> | 1894 </div> <!-- /gc-container --> |
1641 </body></html> | 1895 </body></html> |
OLD | NEW |