chrome/common/extensions/api/history.json

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 [
   6   {
   7     "namespace": "history",
   8     "description": "Use the <code>chrome.history</code> API 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'>Override Pages</a>.",
   9     "types": [
  10       {
  11         "id": "TransitionType",
  12         "type": "string",
  13         "enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "auto_toplevel", "form_submit", "reload", "keyword", "keyword_generated"],
  14         "description": "The <a href='#transition_types'>transition type</a> for this visit from its referrer."
  15       },
  16       {
  17         "id": "HistoryItem",
  18         "type": "object",
  19         "description": "An object encapsulating one result of a history query.",
  20         "properties": {
  21           "id": {"type": "string", "minimum": 0, "description": "The unique identifier for the item."},
  22           "url": {"type": "string", "optional": true, "description": "The URL navigated to by a user."},
  23           "title": {"type": "string", "optional": true, "description": "The title of the page when it was last loaded."},
  24           "lastVisitTime": {"type": "number", "optional": true, "description": "When this page was last loaded, represented in milliseconds since the epoch."},
  25           "visitCount": {"type": "integer", "optional": true, "description": "The number of times the user has navigated to this page."},
  26           "typedCount": {"type": "integer", "optional": true, "description": "The number of times the user has navigated to this page by typing in the address."}
  27         }
  28       },
  29       {
  30         "id": "VisitItem",
  31         "type": "object",
  32         "description": "An object encapsulating one visit to a URL.",
  33         "properties": {
  34           "id": {"type": "string", "minimum": 0, "description": "The unique identifier for the item."},
  35           "visitId": {"type": "string", "description": "The unique identifier for this visit."},
  36           "visitTime": {"type": "number", "optional": true, "description": "When this visit occurred, represented in milliseconds since the epoch."},
  37           "referringVisitId": {"type": "string", "description": "The visit ID of the referrer."},
  38           "transition": {
  39             "$ref": "TransitionType",
  40             "description": "The <a href='#transition_types'>transition type</a> for this visit from its referrer."
  41           }
  42         }
  43       }
  44     ],
  45     "functions": [
  46       {
  47         "name": "search",
  48         "type": "function",
  49         "description": "Searches the history for the last visit time of each page matching the query.",
  50         "parameters": [
  51           {
  52             "name": "query",
  53             "type": "object",
  54             "properties": {
  55               "text": {"type": "string", "description": "A free-text query to the history service.  Leave empty to retrieve all pages."},
  56               "startTime": {"type": "number", "optional": true, "description": "Limit results to those visited after this date, represented in milliseconds since the epoch."},
  57               "endTime": {"type": "number", "optional": true, "description": "Limit results to those visited before this date, represented in milliseconds since the epoch."},
  58               "maxResults": {"type": "integer", "optional": true, "minimum": 0, "description": "The maximum number of results to retrieve.  Defaults to 100."}
  59             }
  60           },
  61           {
  62             "name": "callback",
  63             "type": "function",
  64             "parameters": [
  65               { "name": "results", "type": "array", "items": { "$ref": "HistoryItem"} }
  66             ]
  67           }
  68         ]
  69       },
  70       {
  71         "name": "getVisits",
  72         "type": "function",
  73         "description": "Retrieves information about visits to a URL.",
  74         "parameters": [
  75           {
  76             "name": "details",
  77             "type": "object",
  78             "properties": {
  79               "url": {"type": "string", "description": "The URL for which to retrieve visit information.  It must be in the format as returned from a call to history.search."}
  80             }
  81           },
  82           {
  83             "name": "callback",
  84             "type": "function",
  85             "parameters": [
  86               { "name": "results", "type": "array", "items": { "$ref": "VisitItem"} }
  87             ]
  88           }
  89         ]
  90       },
  91       {
  92         "name": "addUrl",
  93         "type": "function",
  94         "description": "Adds a URL to the history at the current time with a <a href='#transition_types'>transition type</a> of \"link\".",
  95         "parameters": [
  96           {
  97             "name": "details",
  98             "type": "object",
  99             "properties": {
 100               "url": {"type": "string", "description": "The URL to add."}
 101             }
 102           },
 103           {
 104             "name": "callback",
 105             "type": "function",
 106             "optional": true,
 107             "parameters": []
 108           }
 109         ]
 110       },
 111       {
 112         "name": "deleteUrl",
 113         "type": "function",
 114         "description": "Removes all occurrences of the given URL from the history.",
 115         "parameters": [
 116           {
 117             "name": "details",
 118             "type": "object",
 119             "properties": {
 120               "url": {"type": "string", "description": "The URL to remove."}
 121             }
 122           },
 123           {
 124             "name": "callback",
 125             "type": "function",
 126             "optional": true,
 127             "parameters": []
 128           }
 129         ]
 130       },
 131       {
 132         "name": "deleteRange",
 133         "type": "function",
 134         "description": "Removes all items within the specified date range from the history.  Pages will not be removed from the history unless all visits fall within the range.",
 135         "parameters": [
 136           {
 137             "name": "range",
 138             "type": "object",
 139             "properties": {
 140               "startTime": { "type": "number", "description": "Items added to history after this date, represented in milliseconds since the epoch." },
 141               "endTime": { "type": "number", "description": "Items added to history before this date, represented in milliseconds since the epoch." }
 142             }
 143           },
 144           {
 145             "name": "callback", "type": "function", "parameters": []
 146           }
 147         ]
 148       },
 149       {
 150         "name": "deleteAll",
 151         "type": "function",
 152         "description": "Deletes all items from the history.",
 153         "parameters": [
 154           {
 155             "name": "callback", "type": "function", "parameters": []
 156           }
 157         ]
 158       }
 159     ],
 160     "events": [
 161       {
 162         "name": "onVisited",
 163         "type": "function",
 164         "description": "Fired when a URL is visited, providing the HistoryItem data for that URL.  This event fires before the page has loaded.",
 165         "parameters": [
 166           { "name": "result", "$ref": "HistoryItem"}
 167         ]
 168       },
 169       {
 170         "name": "onVisitRemoved",
 171         "type": "function",
 172         "description": "Fired when one or more URLs are removed from the history service.  When all visits have been removed the URL is purged from history.",
 173         "parameters": [
 174           {
 175             "name": "removed",
 176             "type": "object",
 177             "properties": {
 178               "allHistory": { "type": "boolean", "description": "True if all history was removed.  If true, then urls will be empty." },
 179               "urls": { "type": "array", "items": { "type": "string" }, "optional": true}
 180             }
 181           }
 182         ]
 183       }
 184     ]
 185   }
 186 ]