chrome/common/extensions/api/web_navigation.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": "webNavigation",
   8     "description": "Use the <code>chrome.webNavigation</code> API to receive notifications about the status of navigation requests in-flight.",
   9     "types": [],
  10     "functions": [
  11       {
  12         "name": "getFrame",
  13         "type": "function",
  14         "description": "Retrieves information about the given frame. A frame refers to an &lt;iframe&gt; or a &lt;frame&gt; of a web page and is identified by a tab ID and a frame ID.",
  15         "parameters": [
  16           {
  17             "type": "object",
  18             "name": "details",
  19             "description": "Information about the frame to retrieve information about.",
  20             "properties": {
  21               "tabId": { "type": "integer", "minimum": 0, "description": "The ID of the tab in which the frame is." },
  22               "processId": {"type": "integer", "description": "The ID of the process runs the renderer for this tab."},
  23               "frameId": { "type": "integer", "minimum": 0, "description": "The ID of the frame in the given tab." }
  24             }
  25           },
  26           {
  27             "type": "function", "name": "callback", "parameters": [
  28               {
  29                 "type": "object",
  30                 "name": "details",
  31                 "optional": true,
  32                 "description": "Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.",
  33                 "properties": {
  34                   "errorOccurred": {
  35                     "type": "boolean",
  36                     "description": "True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired."
  37                   },
  38                   "url": {
  39                     "type": "string",
  40                     "description": "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."
  41                   },
  42                   "parentFrameId": {
  43                     "type": "integer",
  44                     "description": "ID of frame that wraps the frame. Set to -1 of no parent frame exists."
  45                   }
  46                 }
  47               }
  48             ]
  49           }
  50         ]
  51       },
  52       {
  53         "name": "getAllFrames",
  54         "type": "function",
  55         "description": "Retrieves information about all frames of a given tab.",
  56         "parameters": [
  57           {
  58             "type": "object",
  59             "name": "details",
  60             "description": "Information about the tab to retrieve all frames from.",
  61             "properties": {
  62               "tabId": { "type": "integer", "minimum": 0, "description": "The ID of the tab." }
  63             }
  64           },
  65           {
  66             "type": "function", "name": "callback", "parameters": [
  67               {
  68                 "name": "details",
  69                 "type": "array",
  70                 "description": "A list of frames in the given tab, null if the specified tab ID is invalid.",
  71                 "optional": true,
  72                 "items": {
  73                   "type": "object",
  74                   "properties": {
  75                     "errorOccurred": {
  76                       "type": "boolean",
  77                       "description": "True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired."
  78                     },
  79                     "processId": {
  80                       "type": "integer",
  81                       "description": "The ID of the process runs the renderer for this tab."
  82                     },
  83                     "frameId": {
  84                       "type": "integer",
  85                       "description": "The ID of the frame. 0 indicates that this is the main frame; a positive value indicates the ID of a subframe."
  86                     },
  87                     "parentFrameId": {
  88                       "type": "integer",
  89                       "description": "ID of frame that wraps the frame. Set to -1 of no parent frame exists."
  90                     },
  91                     "url": {
  92                       "type": "string",
  93                       "description": "The URL currently associated with this frame."
  94                     }
  95                   }
  96                 }
  97               }
  98             ]
  99           }
 100         ]
 101       }
 102     ],
 103     "events": [
 104       {
 105         "name": "onBeforeNavigate",
 106         "type": "function",
 107         "description": "Fired when a navigation is about to occur.",
 108         "filters": [
 109           {
 110             "name": "url",
 111             "type": "array",
 112             "items": { "$ref": "events.UrlFilter" },
 113             "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
 114           }
 115         ],
 116         "parameters": [
 117           {
 118             "type": "object",
 119             "name": "details",
 120             "properties": {
 121               "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation is about to occur."},
 122               "url": {"type": "string"},
 123               "processId": {"type": "integer", "description": "The ID of the process runs the renderer for this tab."},
 124               "frameId": {"type": "integer", "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique for a given tab and process."},
 125               "parentFrameId": {"type": "integer", "description": "ID of frame that wraps the frame. Set to -1 of no parent frame exists."},
 126               "timeStamp": {"type": "number", "description": "The time when the browser was about to start the navigation, in milliseconds since the epoch."}
 127             }
 128           }
 129         ]
 130       },
 131       {
 132         "name": "onCommitted",
 133         "type": "function",
 134         "description": "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.",
 135         "filters": [
 136           {
 137             "name": "url",
 138             "type": "array",
 139             "items": { "$ref": "events.UrlFilter" },
 140             "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
 141           }
 142         ],
 143         "parameters": [
 144           {
 145             "type": "object",
 146             "name": "details",
 147             "properties": {
 148               "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
 149               "url": {"type": "string"},
 150               "processId": {"type": "integer", "description": "The ID of the process runs the renderer for this tab."},
 151               "frameId": {"type": "integer", "description": "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."},
 152               "transitionType": {"type": "string", "enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"], "description": "Cause of the navigation. The same transition types as defined in the history API are used. These are the same transition types as defined in the <a href=\"history.html#transition_types\">history API</a> except with <code>\"start_page\"</code> in place of <code>\"auto_toplevel\"</code> (for backwards compatibility)."},
 153               "transitionQualifiers": {"type": "array", "description": "A list of transition qualifiers.", "items": {"type": "string", "enum": ["client_redirect", "server_redirect", "forward_back", "from_address_bar"]}},
 154               "timeStamp": {"type": "number", "description": "The time when the navigation was committed, in milliseconds since the epoch."}
 155             }
 156           }
 157         ]
 158       },
 159       {
 160         "name": "onDOMContentLoaded",
 161         "type": "function",
 162         "description": "Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.",
 163         "filters": [
 164           {
 165             "name": "url",
 166             "type": "array",
 167             "items": { "$ref": "events.UrlFilter" },
 168             "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
 169           }
 170         ],
 171         "parameters": [
 172           {
 173             "type": "object",
 174             "name": "details",
 175             "properties": {
 176               "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
 177               "url": {"type": "string"},
 178               "processId": {"type": "integer", "description": "The ID of the process runs the renderer for this tab."},
 179               "frameId": {"type": "integer", "description": "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."},
 180               "timeStamp": {"type": "number", "description": "The time when the page's DOM was fully constructed, in milliseconds since the epoch."}
 181             }
 182           }
 183         ]
 184       },
 185       {
 186         "name": "onCompleted",
 187         "type": "function",
 188         "description": "Fired when a document, including the resources it refers to, is completely loaded and initialized.",
 189         "filters": [
 190           {
 191             "name": "url",
 192             "type": "array",
 193             "items": { "$ref": "events.UrlFilter" },
 194             "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
 195           }
 196         ],
 197         "parameters": [
 198           {
 199             "type": "object",
 200             "name": "details",
 201             "properties": {
 202               "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
 203               "url": {"type": "string"},
 204               "processId": {"type": "integer", "description": "The ID of the process runs the renderer for this tab."},
 205               "frameId": {"type": "integer", "description": "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."},
 206               "timeStamp": {"type": "number", "description": "The time when the document finished loading, in milliseconds since the epoch."}
 207             }
 208           }
 209         ]
 210       },
 211       {
 212         "name": "onErrorOccurred",
 213         "type": "function",
 214         "description": "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.",
 215         "filters": [
 216           {
 217             "name": "url",
 218             "type": "array",
 219             "items": { "$ref": "events.UrlFilter" },
 220             "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
 221           }
 222         ],
 223         "parameters": [
 224           {
 225             "type": "object",
 226             "name": "details",
 227             "properties": {
 228               "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
 229               "url": {"type": "string"},
 230               "processId": {"type": "integer", "description": "The ID of the process runs the renderer for this tab."},
 231               "frameId": {"type": "integer", "description": "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."},
 232               "error": {"type": "string", "description": "The error description."},
 233               "timeStamp": {"type": "number", "description": "The time when the error occurred, in milliseconds since the epoch."}
 234             }
 235           }
 236         ]
 237       },
 238       {
 239         "name": "onCreatedNavigationTarget",
 240         "type": "function",
 241         "description": "Fired when a new window, or a new tab in an existing window, is created to host a navigation.",
 242         "filters": [
 243           {
 244             "name": "url",
 245             "type": "array",
 246             "items": { "$ref": "events.UrlFilter" },
 247             "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
 248           }
 249         ],
 250         "parameters": [
 251           {
 252             "type": "object",
 253             "name": "details",
 254             "properties": {
 255               "sourceTabId": {"type": "integer", "description": "The ID of the tab in which the navigation is triggered."},
 256               "sourceProcessId": {"type": "integer", "description": "The ID of the process runs the renderer for the source tab."},
 257               "sourceFrameId": {"type": "integer", "description": "The ID of the frame with sourceTabId in which the navigation is triggered. 0 indicates the main frame."},
 258               "url": {"type": "string", "description": "The URL to be opened in the new window."},
 259               "tabId": {"type": "integer", "description": "The ID of the tab in which the url is opened"},
 260               "timeStamp": {"type": "number", "description": "The time when the browser was about to create a new view, in milliseconds since the epoch."}
 261             }
 262           }
 263         ]
 264       },
 265       {
 266         "name": "onReferenceFragmentUpdated",
 267         "type": "function",
 268         "description": "Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.",
 269         "filters": [
 270           {
 271             "name": "url",
 272             "type": "array",
 273             "items": { "$ref": "events.UrlFilter" },
 274             "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
 275           }
 276         ],
 277         "parameters": [
 278           {
 279             "type": "object",
 280             "name": "details",
 281             "properties": {
 282               "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
 283               "url": {"type": "string"},
 284               "processId": {"type": "integer", "description": "The ID of the process runs the renderer for this tab."},
 285               "frameId": {"type": "integer", "description": "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."},
 286               "transitionType": {"type": "string", "enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"], "description": "Cause of the navigation. The same transition types as defined in the history API are used. These are the same transition types as defined in the <a href=\"history.html#transition_types\">history API</a> except with <code>\"start_page\"</code> in place of <code>\"auto_toplevel\"</code> (for backwards compatibility)."},
 287               "transitionQualifiers": {"type": "array", "description": "A list of transition qualifiers.", "items": {"type": "string", "enum": ["client_redirect", "server_redirect", "forward_back", "from_address_bar"]}},
 288               "timeStamp": {"type": "number", "description": "The time when the navigation was committed, in milliseconds since the epoch."}
 289             }
 290           }
 291         ]
 292       },
 293       {
 294         "name": "onTabReplaced",
 295         "type": "function",
 296         "description": "Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.",
 297         "parameters": [
 298           {
 299             "type": "object",
 300             "name": "details",
 301             "properties": {
 302               "replacedTabId": {"type": "integer", "description": "The ID of the tab that was replaced."},
 303               "tabId": {"type": "integer", "description": "The ID of the tab that replaced the old tab."},
 304               "timeStamp": {"type": "number", "description": "The time when the replacement happened, in milliseconds since the epoch."}
 305             }
 306           }
 307         ]
 308       },
 309       {
 310         "name": "onHistoryStateUpdated",
 311         "type": "function",
 312         "description": "Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.",
 313         "filters": [
 314           {
 315             "name": "url",
 316             "type": "array",
 317             "items": { "$ref": "events.UrlFilter" },
 318             "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
 319           }
 320         ],
 321         "parameters": [
 322           {
 323             "type": "object",
 324             "name": "details",
 325             "properties": {
 326               "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
 327               "url": {"type": "string"},
 328               "processId": {"type": "integer", "description": "The ID of the process runs the renderer for this tab."},
 329               "frameId": {"type": "integer", "description": "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."},
 330               "transitionType": {"type": "string", "enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"], "description": "Cause of the navigation. The same transition types as defined in the history API are used. These are the same transition types as defined in the <a href=\"history.html#transition_types\">history API</a> except with <code>\"start_page\"</code> in place of <code>\"auto_toplevel\"</code> (for backwards compatibility)."},
 331               "transitionQualifiers": {"type": "array", "description": "A list of transition qualifiers.", "items": {"type": "string", "enum": ["client_redirect", "server_redirect", "forward_back", "from_address_bar"]}},
 332               "timeStamp": {"type": "number", "description": "The time when the navigation was committed, in milliseconds since the epoch."}
 333             }
 334           }
 335         ]
 336       }
 337     ]
 338   }
 339 ]