OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 [ | 5 [ |
6 { | 6 { |
7 "namespace": "webNavigation", | 7 "namespace": "webNavigation", |
8 "description": "Use the <code>chrome.webNavigation</code> API to receive not
ifications about the status of navigation requests in-flight.", | 8 "description": "Use the <code>chrome.webNavigation</code> API to receive not
ifications about the status of navigation requests in-flight.", |
9 "types": [ | 9 "types": [ |
10 { | 10 { |
(...skipping 13 matching lines...) Expand all Loading... |
24 "name": "getFrame", | 24 "name": "getFrame", |
25 "type": "function", | 25 "type": "function", |
26 "description": "Retrieves information about the given frame. A frame ref
ers to an <iframe> or a <frame> of a web page and is identified by a
tab ID and a frame ID.", | 26 "description": "Retrieves information about the given frame. A frame ref
ers to an <iframe> or a <frame> of a web page and is identified by a
tab ID and a frame ID.", |
27 "parameters": [ | 27 "parameters": [ |
28 { | 28 { |
29 "type": "object", | 29 "type": "object", |
30 "name": "details", | 30 "name": "details", |
31 "description": "Information about the frame to retrieve information
about.", | 31 "description": "Information about the frame to retrieve information
about.", |
32 "properties": { | 32 "properties": { |
33 "tabId": { "type": "integer", "minimum": 0, "description": "The ID
of the tab in which the frame is." }, | 33 "tabId": { "type": "integer", "minimum": 0, "description": "The ID
of the tab in which the frame is." }, |
34 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 34 "processId": { |
| 35 "type": "integer", |
| 36 "optional": true, |
| 37 "deprecated": "Frames are now uniquely identified by their frame
ID; the process ID is no longer needed and therefore ignored.", |
| 38 "description": "The ID of the process runs the renderer for this
tab." |
| 39 }, |
35 "frameId": { "type": "integer", "minimum": 0, "description": "The
ID of the frame in the given tab." } | 40 "frameId": { "type": "integer", "minimum": 0, "description": "The
ID of the frame in the given tab." } |
36 } | 41 } |
37 }, | 42 }, |
38 { | 43 { |
39 "type": "function", "name": "callback", "parameters": [ | 44 "type": "function", "name": "callback", "parameters": [ |
40 { | 45 { |
41 "type": "object", | 46 "type": "object", |
42 "name": "details", | 47 "name": "details", |
43 "optional": true, | 48 "optional": true, |
44 "description": "Information about the requested frame, null if t
he specified frame ID and/or tab ID are invalid.", | 49 "description": "Information about the requested frame, null if t
he specified frame ID and/or tab ID are invalid.", |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
83 "optional": true, | 88 "optional": true, |
84 "items": { | 89 "items": { |
85 "type": "object", | 90 "type": "object", |
86 "properties": { | 91 "properties": { |
87 "errorOccurred": { | 92 "errorOccurred": { |
88 "type": "boolean", | 93 "type": "boolean", |
89 "description": "True if the last navigation in this frame
was interrupted by an error, i.e. the onErrorOccurred event fired." | 94 "description": "True if the last navigation in this frame
was interrupted by an error, i.e. the onErrorOccurred event fired." |
90 }, | 95 }, |
91 "processId": { | 96 "processId": { |
92 "type": "integer", | 97 "type": "integer", |
93 "description": "The ID of the process runs the renderer fo
r this tab." | 98 "deprecated": "Process IDs are no longer meaningful since
the frame ID uniquely identifies the frame.", |
| 99 "description": "The ID of the process runs the renderer fo
r this frame." |
94 }, | 100 }, |
95 "frameId": { | 101 "frameId": { |
96 "type": "integer", | 102 "type": "integer", |
97 "description": "The ID of the frame. 0 indicates that this
is the main frame; a positive value indicates the ID of a subframe." | 103 "description": "The ID of the frame. 0 indicates that this
is the main frame; a positive value indicates the ID of a subframe." |
98 }, | 104 }, |
99 "parentFrameId": { | 105 "parentFrameId": { |
100 "type": "integer", | 106 "type": "integer", |
101 "description": "ID of frame that wraps the frame. Set to -
1 of no parent frame exists." | 107 "description": "ID of frame that wraps the frame. Set to -
1 of no parent frame exists." |
102 }, | 108 }, |
103 "url": { | 109 "url": { |
(...skipping 21 matching lines...) Expand all Loading... |
125 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." | 131 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." |
126 } | 132 } |
127 ], | 133 ], |
128 "parameters": [ | 134 "parameters": [ |
129 { | 135 { |
130 "type": "object", | 136 "type": "object", |
131 "name": "details", | 137 "name": "details", |
132 "properties": { | 138 "properties": { |
133 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation is about to occur."}, | 139 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation is about to occur."}, |
134 "url": {"type": "string"}, | 140 "url": {"type": "string"}, |
135 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 141 "processId": {"type": "integer", "deprecated": "Process IDs are no
longer meaningful since the frame ID uniquely identifies the frame.", "descript
ion": "The ID of the process runs the renderer for this frame."}, |
136 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique for a given tab and process."}, | 142 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique for a given tab and process."}, |
137 "parentFrameId": {"type": "integer", "description": "ID of frame t
hat wraps the frame. Set to -1 of no parent frame exists."}, | 143 "parentFrameId": {"type": "integer", "description": "ID of frame t
hat wraps the frame. Set to -1 of no parent frame exists."}, |
138 "timeStamp": {"type": "number", "description": "The time when the
browser was about to start the navigation, in milliseconds since the epoch."} | 144 "timeStamp": {"type": "number", "description": "The time when the
browser was about to start the navigation, in milliseconds since the epoch."} |
139 } | 145 } |
140 } | 146 } |
141 ] | 147 ] |
142 }, | 148 }, |
143 { | 149 { |
144 "name": "onCommitted", | 150 "name": "onCommitted", |
145 "type": "function", | 151 "type": "function", |
146 "description": "Fired when a navigation is committed. The document (and
the resources it refers to, such as images and subframes) might still be downloa
ding, but at least part of the document has been received from the server and th
e browser has decided to switch to the new document.", | 152 "description": "Fired when a navigation is committed. The document (and
the resources it refers to, such as images and subframes) might still be downloa
ding, but at least part of the document has been received from the server and th
e browser has decided to switch to the new document.", |
147 "filters": [ | 153 "filters": [ |
148 { | 154 { |
149 "name": "url", | 155 "name": "url", |
150 "type": "array", | 156 "type": "array", |
151 "items": { "$ref": "events.UrlFilter" }, | 157 "items": { "$ref": "events.UrlFilter" }, |
152 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." | 158 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." |
153 } | 159 } |
154 ], | 160 ], |
155 "parameters": [ | 161 "parameters": [ |
156 { | 162 { |
157 "type": "object", | 163 "type": "object", |
158 "name": "details", | 164 "name": "details", |
159 "properties": { | 165 "properties": { |
160 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 166 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
161 "url": {"type": "string"}, | 167 "url": {"type": "string"}, |
162 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 168 "processId": {"type": "integer", "deprecated": "Process IDs are no
longer meaningful since the frame ID uniquely identifies the frame.", "descript
ion": "The ID of the process runs the renderer for this frame."}, |
163 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 169 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
164 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, | 170 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, |
165 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, | 171 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, |
166 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} | 172 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} |
167 } | 173 } |
168 } | 174 } |
169 ] | 175 ] |
170 }, | 176 }, |
171 { | 177 { |
172 "name": "onDOMContentLoaded", | 178 "name": "onDOMContentLoaded", |
173 "type": "function", | 179 "type": "function", |
174 "description": "Fired when the page's DOM is fully constructed, but the
referenced resources may not finish loading.", | 180 "description": "Fired when the page's DOM is fully constructed, but the
referenced resources may not finish loading.", |
175 "filters": [ | 181 "filters": [ |
176 { | 182 { |
177 "name": "url", | 183 "name": "url", |
178 "type": "array", | 184 "type": "array", |
179 "items": { "$ref": "events.UrlFilter" }, | 185 "items": { "$ref": "events.UrlFilter" }, |
180 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." | 186 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." |
181 } | 187 } |
182 ], | 188 ], |
183 "parameters": [ | 189 "parameters": [ |
184 { | 190 { |
185 "type": "object", | 191 "type": "object", |
186 "name": "details", | 192 "name": "details", |
187 "properties": { | 193 "properties": { |
188 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 194 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
189 "url": {"type": "string"}, | 195 "url": {"type": "string"}, |
190 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 196 "processId": {"type": "integer", "deprecated": "Process IDs are no
longer meaningful since the frame ID uniquely identifies the frame.", "descript
ion": "The ID of the process runs the renderer for this frame."}, |
191 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 197 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
192 "timeStamp": {"type": "number", "description": "The time when the
page's DOM was fully constructed, in milliseconds since the epoch."} | 198 "timeStamp": {"type": "number", "description": "The time when the
page's DOM was fully constructed, in milliseconds since the epoch."} |
193 } | 199 } |
194 } | 200 } |
195 ] | 201 ] |
196 }, | 202 }, |
197 { | 203 { |
198 "name": "onCompleted", | 204 "name": "onCompleted", |
199 "type": "function", | 205 "type": "function", |
200 "description": "Fired when a document, including the resources it refers
to, is completely loaded and initialized.", | 206 "description": "Fired when a document, including the resources it refers
to, is completely loaded and initialized.", |
201 "filters": [ | 207 "filters": [ |
202 { | 208 { |
203 "name": "url", | 209 "name": "url", |
204 "type": "array", | 210 "type": "array", |
205 "items": { "$ref": "events.UrlFilter" }, | 211 "items": { "$ref": "events.UrlFilter" }, |
206 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." | 212 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." |
207 } | 213 } |
208 ], | 214 ], |
209 "parameters": [ | 215 "parameters": [ |
210 { | 216 { |
211 "type": "object", | 217 "type": "object", |
212 "name": "details", | 218 "name": "details", |
213 "properties": { | 219 "properties": { |
214 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 220 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
215 "url": {"type": "string"}, | 221 "url": {"type": "string"}, |
216 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 222 "processId": {"type": "integer", "deprecated": "Process IDs are no
longer meaningful since the frame ID uniquely identifies the frame.", "descript
ion": "The ID of the process runs the renderer for this frame."}, |
217 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 223 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
218 "timeStamp": {"type": "number", "description": "The time when the
document finished loading, in milliseconds since the epoch."} | 224 "timeStamp": {"type": "number", "description": "The time when the
document finished loading, in milliseconds since the epoch."} |
219 } | 225 } |
220 } | 226 } |
221 ] | 227 ] |
222 }, | 228 }, |
223 { | 229 { |
224 "name": "onErrorOccurred", | 230 "name": "onErrorOccurred", |
225 "type": "function", | 231 "type": "function", |
226 "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 na
vigation.", | 232 "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 na
vigation.", |
227 "filters": [ | 233 "filters": [ |
228 { | 234 { |
229 "name": "url", | 235 "name": "url", |
230 "type": "array", | 236 "type": "array", |
231 "items": { "$ref": "events.UrlFilter" }, | 237 "items": { "$ref": "events.UrlFilter" }, |
232 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." | 238 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." |
233 } | 239 } |
234 ], | 240 ], |
235 "parameters": [ | 241 "parameters": [ |
236 { | 242 { |
237 "type": "object", | 243 "type": "object", |
238 "name": "details", | 244 "name": "details", |
239 "properties": { | 245 "properties": { |
240 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 246 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
241 "url": {"type": "string"}, | 247 "url": {"type": "string"}, |
242 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 248 "processId": {"type": "integer", "deprecated": "Process IDs are no
longer meaningful since the frame ID uniquely identifies the frame.", "descript
ion": "The ID of the process runs the renderer for this frame."}, |
243 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 249 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
244 "error": {"type": "string", "description": "The error description.
"}, | 250 "error": {"type": "string", "description": "The error description.
"}, |
245 "timeStamp": {"type": "number", "description": "The time when the
error occurred, in milliseconds since the epoch."} | 251 "timeStamp": {"type": "number", "description": "The time when the
error occurred, in milliseconds since the epoch."} |
246 } | 252 } |
247 } | 253 } |
248 ] | 254 ] |
249 }, | 255 }, |
250 { | 256 { |
251 "name": "onCreatedNavigationTarget", | 257 "name": "onCreatedNavigationTarget", |
252 "type": "function", | 258 "type": "function", |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
286 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." | 292 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." |
287 } | 293 } |
288 ], | 294 ], |
289 "parameters": [ | 295 "parameters": [ |
290 { | 296 { |
291 "type": "object", | 297 "type": "object", |
292 "name": "details", | 298 "name": "details", |
293 "properties": { | 299 "properties": { |
294 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 300 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
295 "url": {"type": "string"}, | 301 "url": {"type": "string"}, |
296 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 302 "processId": {"type": "integer", "deprecated": "Process IDs are no
longer meaningful since the frame ID uniquely identifies the frame.", "descript
ion": "The ID of the process runs the renderer for this frame."}, |
297 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 303 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
298 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, | 304 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, |
299 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, | 305 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, |
300 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} | 306 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} |
301 } | 307 } |
302 } | 308 } |
303 ] | 309 ] |
304 }, | 310 }, |
305 { | 311 { |
306 "name": "onTabReplaced", | 312 "name": "onTabReplaced", |
(...skipping 23 matching lines...) Expand all Loading... |
330 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." | 336 "description": "Conditions that the URL being navigated to must sati
sfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event." |
331 } | 337 } |
332 ], | 338 ], |
333 "parameters": [ | 339 "parameters": [ |
334 { | 340 { |
335 "type": "object", | 341 "type": "object", |
336 "name": "details", | 342 "name": "details", |
337 "properties": { | 343 "properties": { |
338 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 344 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
339 "url": {"type": "string"}, | 345 "url": {"type": "string"}, |
340 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 346 "processId": {"type": "integer", "deprecated": "Process IDs are no
longer meaningful since the frame ID uniquely identifies the frame.", "descript
ion": "The ID of the process runs the renderer for this frame."}, |
341 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 347 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
342 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, | 348 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, |
343 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, | 349 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, |
344 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} | 350 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} |
345 } | 351 } |
346 } | 352 } |
347 ] | 353 ] |
348 } | 354 } |
349 ] | 355 ] |
350 } | 356 } |
351 ] | 357 ] |
OLD | NEW |