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

Side by Side Diff: extensions/common/api/web_request.json

Issue 1055673002: [Extensions API] Remove inline enums (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Latest master Created 5 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
OLDNEW
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": "webRequest", 7 "namespace": "webRequest",
8 "description": "Use the <code>chrome.webRequest</code> API to observe and an alyze traffic and to intercept, block, or modify requests in-flight.", 8 "description": "Use the <code>chrome.webRequest</code> API to observe and an alyze traffic and to intercept, block, or modify requests in-flight.",
9 "properties": { 9 "properties": {
10 "MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES": { 10 "MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES": {
11 "value": 20, 11 "value": 20,
12 "description": "The maximum number of times that <code>handlerBehaviorCh anged</code> can be called per 10 minute sustained interval. <code>handlerBehavi orChanged</code> is an expensive function call that shouldn't be called often." 12 "description": "The maximum number of times that <code>handlerBehaviorCh anged</code> can be called per 10 minute sustained interval. <code>handlerBehavi orChanged</code> is an expensive function call that shouldn't be called often."
13 } 13 }
14 }, 14 },
15 "types": [ 15 "types": [
16 { 16 {
17 "id": "ResourceType",
18 "type": "string",
19 "enum": ["main_frame", "sub_frame", "stylesheet", "script", "image", "ob ject", "xmlhttprequest", "other"]
20 },
21 {
22 "id": "OnBeforeRequestOptions",
23 "type": "string",
24 "enum": ["blocking", "requestBody"]
25 },
26 {
27 "id": "OnBeforeSendHeadersOptions",
28 "type": "string",
29 "enum": ["requestHeaders", "blocking"]
30 },
31 {
32 "id": "OnSendHeadersOptions",
33 "type": "string",
34 "enum": ["requestHeaders"]
35 },
36 {
37 "id": "OnHeadersReceivedOptions",
38 "type": "string",
39 "enum": ["blocking", "responseHeaders"]
40 },
41 {
42 "id": "OnAuthRequiredOptions",
43 "type": "string",
44 "enum": ["responseHeaders", "blocking", "asyncBlocking"]
45 },
46 {
47 "id": "OnResponseStartedOptions",
48 "type": "string",
49 "enum": ["responseHeaders"]
50 },
51 {
52 "id": "OnBeforeRedirectOptions",
53 "type": "string",
54 "enum": ["responseHeaders"]
55 },
56 {
57 "id": "OnCompletedOptions",
58 "type": "string",
59 "enum": ["responseHeaders"]
60 },
61 {
17 "id": "RequestFilter", 62 "id": "RequestFilter",
18 "type": "object", 63 "type": "object",
19 "description": "An object describing filters to apply to webRequest even ts.", 64 "description": "An object describing filters to apply to webRequest even ts.",
20 "properties": { 65 "properties": {
21 "urls": { 66 "urls": {
22 "type": "array", 67 "type": "array",
23 "description": "A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.", 68 "description": "A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.",
24 "items": { "type": "string" } 69 "items": { "type": "string" }
25 }, 70 },
26 "types": { 71 "types": {
27 "type": "array", 72 "type": "array",
28 "optional": true, 73 "optional": true,
29 "description": "A list of request types. Requests that cannot match any of the types will be filtered out.", 74 "description": "A list of request types. Requests that cannot match any of the types will be filtered out.",
30 "items": { "type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"] } 75 "items": { "$ref": "ResourceType" }
31 }, 76 },
32 "tabId": { "type": "integer", "optional": true }, 77 "tabId": { "type": "integer", "optional": true },
33 "windowId": { "type": "integer", "optional": true } 78 "windowId": { "type": "integer", "optional": true }
34 } 79 }
35 }, 80 },
36 { 81 {
37 "id": "HttpHeaders", 82 "id": "HttpHeaders",
38 "nocompile": true, 83 "nocompile": true,
39 "type": "array", 84 "type": "array",
40 "description": "An array of HTTP headers. Each header is represented as a dictionary containing the keys <code>name</code> and either <code>value</code> or <code>binaryValue</code>.", 85 "description": "An array of HTTP headers. Each header is represented as a dictionary containing the keys <code>name</code> and either <code>value</code> or <code>binaryValue</code>.",
(...skipping 109 matching lines...) Expand 10 before | Expand all | Expand 10 after
150 }, 195 },
151 "raw" : { 196 "raw" : {
152 "type": "array", 197 "type": "array",
153 "optional": true, 198 "optional": true,
154 "items": {"$ref": "UploadData"}, 199 "items": {"$ref": "UploadData"},
155 "description": "If the request method is PUT or POST, and th e body is not already parsed in formData, then the unparsed request body element s are contained in this array." 200 "description": "If the request method is PUT or POST, and th e body is not already parsed in formData, then the unparsed request body element s are contained in this array."
156 } 201 }
157 } 202 }
158 }, 203 },
159 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 204 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
160 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 205 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
161 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."} 206 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}
162 } 207 }
163 } 208 }
164 ], 209 ],
165 "extraParameters": [ 210 "extraParameters": [
166 { 211 {
167 "$ref": "RequestFilter", 212 "$ref": "RequestFilter",
168 "name": "filter", 213 "name": "filter",
169 "description": "A set of filters that restricts the events that will be sent to this listener." 214 "description": "A set of filters that restricts the events that will be sent to this listener."
170 }, 215 },
171 { 216 {
172 "type": "array", 217 "type": "array",
173 "optional": true, 218 "optional": true,
174 "name": "extraInfoSpec", 219 "name": "extraInfoSpec",
175 "description": "Array of extra information that should be passed to the listener function.", 220 "description": "Array of extra information that should be passed to the listener function.",
176 "items": { 221 "items": {
177 "type": "string", 222 "$ref": "OnBeforeRequestOptions"
178 "enum": ["blocking", "requestBody"]
179 } 223 }
180 } 224 }
181 ], 225 ],
182 "returns": { 226 "returns": {
183 "$ref": "BlockingResponse", 227 "$ref": "BlockingResponse",
184 "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", 228 "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.",
185 "optional": true 229 "optional": true
186 } 230 }
187 }, 231 },
188 { 232 {
189 "name": "onBeforeSendHeaders", 233 "name": "onBeforeSendHeaders",
190 "nocompile": true, 234 "nocompile": true,
191 "type": "function", 235 "type": "function",
192 "description": "Fired before sending an HTTP request, once the request h eaders are available. This may occur after a TCP connection is made to the serve r, but before any HTTP data is sent. ", 236 "description": "Fired before sending an HTTP request, once the request h eaders are available. This may occur after a TCP connection is made to the serve r, but before any HTTP data is sent. ",
193 "parameters": [ 237 "parameters": [
194 { 238 {
195 "type": "object", 239 "type": "object",
196 "name": "details", 240 "name": "details",
197 "properties": { 241 "properties": {
198 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."}, 242 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
199 "url": {"type": "string"}, 243 "url": {"type": "string"},
200 "method": {"type": "string", "description": "Standard HTTP method. "}, 244 "method": {"type": "string", "description": "Standard HTTP method. "},
201 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."}, 245 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."},
202 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "}, 246 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "},
203 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 247 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
204 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 248 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
205 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}, 249 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."},
206 "requestHeaders": {"$ref": "HttpHeaders", "optional": true, "descr iption": "The HTTP request headers that are going to be sent out with this reque st."} 250 "requestHeaders": {"$ref": "HttpHeaders", "optional": true, "descr iption": "The HTTP request headers that are going to be sent out with this reque st."}
207 } 251 }
208 } 252 }
209 ], 253 ],
210 "extraParameters": [ 254 "extraParameters": [
211 { 255 {
212 "$ref": "RequestFilter", 256 "$ref": "RequestFilter",
213 "name": "filter", 257 "name": "filter",
214 "description": "A set of filters that restricts the events that will be sent to this listener." 258 "description": "A set of filters that restricts the events that will be sent to this listener."
215 }, 259 },
216 { 260 {
217 "type": "array", 261 "type": "array",
218 "optional": true, 262 "optional": true,
219 "name": "extraInfoSpec", 263 "name": "extraInfoSpec",
220 "description": "Array of extra information that should be passed to the listener function.", 264 "description": "Array of extra information that should be passed to the listener function.",
221 "items": { 265 "items": {
222 "type": "string", 266 "$ref": "OnBeforeSendHeadersOptions"
223 "enum": ["requestHeaders", "blocking"]
224 } 267 }
225 } 268 }
226 ], 269 ],
227 "returns": { 270 "returns": {
228 "$ref": "BlockingResponse", 271 "$ref": "BlockingResponse",
229 "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", 272 "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.",
230 "optional": true 273 "optional": true
231 } 274 }
232 }, 275 },
233 { 276 {
234 "name": "onSendHeaders", 277 "name": "onSendHeaders",
235 "nocompile": true, 278 "nocompile": true,
236 "type": "function", 279 "type": "function",
237 "description": "Fired just before a request is going to be sent to the s erver (modifications of previous onBeforeSendHeaders callbacks are visible by th e time onSendHeaders is fired).", 280 "description": "Fired just before a request is going to be sent to the s erver (modifications of previous onBeforeSendHeaders callbacks are visible by th e time onSendHeaders is fired).",
238 "parameters": [ 281 "parameters": [
239 { 282 {
240 "type": "object", 283 "type": "object",
241 "name": "details", 284 "name": "details",
242 "properties": { 285 "properties": {
243 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."}, 286 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
244 "url": {"type": "string"}, 287 "url": {"type": "string"},
245 "method": {"type": "string", "description": "Standard HTTP method. "}, 288 "method": {"type": "string", "description": "Standard HTTP method. "},
246 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."}, 289 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."},
247 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "}, 290 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "},
248 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 291 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
249 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 292 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
250 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}, 293 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."},
251 "requestHeaders": {"$ref": "HttpHeaders", "optional": true, "descr iption": "The HTTP request headers that have been sent out with this request."} 294 "requestHeaders": {"$ref": "HttpHeaders", "optional": true, "descr iption": "The HTTP request headers that have been sent out with this request."}
252 } 295 }
253 } 296 }
254 ], 297 ],
255 "extraParameters": [ 298 "extraParameters": [
256 { 299 {
257 "$ref": "RequestFilter", 300 "$ref": "RequestFilter",
258 "name": "filter", 301 "name": "filter",
259 "description": "A set of filters that restricts the events that will be sent to this listener." 302 "description": "A set of filters that restricts the events that will be sent to this listener."
260 }, 303 },
261 { 304 {
262 "type": "array", 305 "type": "array",
263 "optional": true, 306 "optional": true,
264 "name": "extraInfoSpec", 307 "name": "extraInfoSpec",
265 "description": "Array of extra information that should be passed to the listener function.", 308 "description": "Array of extra information that should be passed to the listener function.",
266 "items": { 309 "items": {
267 "type": "string", 310 "$ref": "OnSendHeadersOptions"
268 "enum": ["requestHeaders"]
269 } 311 }
270 } 312 }
271 ] 313 ]
272 }, 314 },
273 { 315 {
274 "name": "onHeadersReceived", 316 "name": "onHeadersReceived",
275 "nocompile": true, 317 "nocompile": true,
276 "type": "function", 318 "type": "function",
277 "description": "Fired when HTTP response headers of a request have been received.", 319 "description": "Fired when HTTP response headers of a request have been received.",
278 "parameters": [ 320 "parameters": [
279 { 321 {
280 "type": "object", 322 "type": "object",
281 "name": "details", 323 "name": "details",
282 "properties": { 324 "properties": {
283 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."}, 325 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
284 "url": {"type": "string"}, 326 "url": {"type": "string"},
285 "method": {"type": "string", "description": "Standard HTTP method. "}, 327 "method": {"type": "string", "description": "Standard HTTP method. "},
286 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."}, 328 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."},
287 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "}, 329 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "},
288 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 330 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
289 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 331 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
290 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}, 332 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."},
291 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line)."}, 333 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line)."},
292 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that have been received with this response. "}, 334 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that have been received with this response. "},
293 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."} 335 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."}
294 } 336 }
295 } 337 }
296 ], 338 ],
297 "extraParameters": [ 339 "extraParameters": [
298 { 340 {
299 "$ref": "RequestFilter", 341 "$ref": "RequestFilter",
300 "name": "filter", 342 "name": "filter",
301 "description": "A set of filters that restricts the events that will be sent to this listener." 343 "description": "A set of filters that restricts the events that will be sent to this listener."
302 }, 344 },
303 { 345 {
304 "type": "array", 346 "type": "array",
305 "optional": true, 347 "optional": true,
306 "name": "extraInfoSpec", 348 "name": "extraInfoSpec",
307 "description": "Array of extra information that should be passed to the listener function.", 349 "description": "Array of extra information that should be passed to the listener function.",
308 "items": { 350 "items": {
309 "type": "string", 351 "$ref": "OnHeadersReceivedOptions"
310 "enum": ["blocking", "responseHeaders"]
311 } 352 }
312 } 353 }
313 ], 354 ],
314 "returns": { 355 "returns": {
315 "$ref": "BlockingResponse", 356 "$ref": "BlockingResponse",
316 "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", 357 "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.",
317 "optional": true 358 "optional": true
318 } 359 }
319 }, 360 },
320 { 361 {
321 "name": "onAuthRequired", 362 "name": "onAuthRequired",
322 "nocompile": true, 363 "nocompile": true,
323 "type": "function", 364 "type": "function",
324 "description": "Fired when an authentication failure is received. The li stener has three options: it can provide authentication credentials, it can canc el the request and display the error page, or it can take no action on the chall enge. If bad user credentials are provided, this may be called multiple times fo r the same request.", 365 "description": "Fired when an authentication failure is received. The li stener has three options: it can provide authentication credentials, it can canc el the request and display the error page, or it can take no action on the chall enge. If bad user credentials are provided, this may be called multiple times fo r the same request.",
325 "parameters": [ 366 "parameters": [
326 { 367 {
327 "type": "object", 368 "type": "object",
328 "name": "details", 369 "name": "details",
329 "properties": { 370 "properties": {
330 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."}, 371 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
331 "url": {"type": "string"}, 372 "url": {"type": "string"},
332 "method": {"type": "string", "description": "Standard HTTP method. "}, 373 "method": {"type": "string", "description": "Standard HTTP method. "},
333 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."}, 374 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."},
334 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "}, 375 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "},
335 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 376 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
336 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 377 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
337 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}, 378 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."},
338 "scheme": {"type": "string", "description": "The authentication sc heme, e.g. Basic or Digest."}, 379 "scheme": {"type": "string", "description": "The authentication sc heme, e.g. Basic or Digest."},
339 "realm": {"type": "string", "description": "The authentication rea lm provided by the server, if there is one.", "optional": true}, 380 "realm": {"type": "string", "description": "The authentication rea lm provided by the server, if there is one.", "optional": true},
340 "challenger": {"type": "object", "description": "The server reques ting authentication.", "properties": {"host": {"type": "string"}, "port": {"type ": "integer"}}}, 381 "challenger": {"type": "object", "description": "The server reques ting authentication.", "properties": {"host": {"type": "string"}, "port": {"type ": "integer"}}},
341 "isProxy": {"type": "boolean", "description": "True for Proxy-Auth enticate, false for WWW-Authenticate."}, 382 "isProxy": {"type": "boolean", "description": "True for Proxy-Auth enticate, false for WWW-Authenticate."},
342 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that were received along with this response ."}, 383 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that were received along with this response ."},
343 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line) or an empty string if there are no headers."}, 384 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line) or an empty string if there are no headers."},
344 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."} 385 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."}
345 } 386 }
346 }, 387 },
(...skipping 11 matching lines...) Expand all
358 "$ref": "RequestFilter", 399 "$ref": "RequestFilter",
359 "name": "filter", 400 "name": "filter",
360 "description": "A set of filters that restricts the events that will be sent to this listener." 401 "description": "A set of filters that restricts the events that will be sent to this listener."
361 }, 402 },
362 { 403 {
363 "type": "array", 404 "type": "array",
364 "optional": true, 405 "optional": true,
365 "name": "extraInfoSpec", 406 "name": "extraInfoSpec",
366 "description": "Array of extra information that should be passed to the listener function.", 407 "description": "Array of extra information that should be passed to the listener function.",
367 "items": { 408 "items": {
368 "type": "string", 409 "$ref": "OnAuthRequiredOptions"
369 "enum": ["responseHeaders", "blocking", "asyncBlocking"]
370 } 410 }
371 } 411 }
372 ], 412 ],
373 "returns": { 413 "returns": {
374 "$ref": "BlockingResponse", 414 "$ref": "BlockingResponse",
375 "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", 415 "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.",
376 "optional": true 416 "optional": true
377 } 417 }
378 }, 418 },
379 { 419 {
380 "name": "onResponseStarted", 420 "name": "onResponseStarted",
381 "nocompile": true, 421 "nocompile": true,
382 "type": "function", 422 "type": "function",
383 "description": "Fired when the first byte of the response body is receiv ed. For HTTP requests, this means that the status line and response headers are available.", 423 "description": "Fired when the first byte of the response body is receiv ed. For HTTP requests, this means that the status line and response headers are available.",
384 "parameters": [ 424 "parameters": [
385 { 425 {
386 "type": "object", 426 "type": "object",
387 "name": "details", 427 "name": "details",
388 "properties": { 428 "properties": {
389 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."}, 429 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
390 "url": {"type": "string"}, 430 "url": {"type": "string"},
391 "method": {"type": "string", "description": "Standard HTTP method. "}, 431 "method": {"type": "string", "description": "Standard HTTP method. "},
392 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."}, 432 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."},
393 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "}, 433 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "},
394 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 434 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
395 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 435 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
396 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}, 436 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."},
397 "ip": {"type": "string", "optional": true, "description": "The ser ver IP address that the request was actually sent to. Note that it may be a lite ral IPv6 address."}, 437 "ip": {"type": "string", "optional": true, "description": "The ser ver IP address that the request was actually sent to. Note that it may be a lite ral IPv6 address."},
398 "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."}, 438 "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."},
399 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."}, 439 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."},
400 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that were received along with this response ."}, 440 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that were received along with this response ."},
401 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line) or an empty string if there are no headers."} 441 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line) or an empty string if there are no headers."}
402 } 442 }
403 } 443 }
404 ], 444 ],
405 "extraParameters": [ 445 "extraParameters": [
406 { 446 {
407 "$ref": "RequestFilter", 447 "$ref": "RequestFilter",
408 "name": "filter", 448 "name": "filter",
409 "description": "A set of filters that restricts the events that will be sent to this listener." 449 "description": "A set of filters that restricts the events that will be sent to this listener."
410 }, 450 },
411 { 451 {
412 "type": "array", 452 "type": "array",
413 "optional": true, 453 "optional": true,
414 "name": "extraInfoSpec", 454 "name": "extraInfoSpec",
415 "description": "Array of extra information that should be passed to the listener function.", 455 "description": "Array of extra information that should be passed to the listener function.",
416 "items": { 456 "items": {
417 "type": "string", 457 "$ref": "OnResponseStartedOptions"
418 "enum": ["responseHeaders"]
419 } 458 }
420 } 459 }
421 ] 460 ]
422 }, 461 },
423 { 462 {
424 "name": "onBeforeRedirect", 463 "name": "onBeforeRedirect",
425 "type": "function", 464 "type": "function",
426 "nocompile": true, 465 "nocompile": true,
427 "description": "Fired when a server-initiated redirect is about to occur .", 466 "description": "Fired when a server-initiated redirect is about to occur .",
428 "parameters": [ 467 "parameters": [
429 { 468 {
430 "type": "object", 469 "type": "object",
431 "name": "details", 470 "name": "details",
432 "properties": { 471 "properties": {
433 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."}, 472 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
434 "url": {"type": "string"}, 473 "url": {"type": "string"},
435 "method": {"type": "string", "description": "Standard HTTP method. "}, 474 "method": {"type": "string", "description": "Standard HTTP method. "},
436 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."}, 475 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."},
437 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "}, 476 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "},
438 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 477 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
439 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 478 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
440 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}, 479 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."},
441 "ip": {"type": "string", "optional": true, "description": "The ser ver IP address that the request was actually sent to. Note that it may be a lite ral IPv6 address."}, 480 "ip": {"type": "string", "optional": true, "description": "The ser ver IP address that the request was actually sent to. Note that it may be a lite ral IPv6 address."},
442 "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."}, 481 "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."},
443 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."}, 482 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."},
444 "redirectUrl": {"type": "string", "description": "The new URL."}, 483 "redirectUrl": {"type": "string", "description": "The new URL."},
445 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that were received along with this redirect ."}, 484 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that were received along with this redirect ."},
446 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line) or an empty string if there are no headers."} 485 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line) or an empty string if there are no headers."}
447 } 486 }
448 } 487 }
449 ], 488 ],
450 "extraParameters": [ 489 "extraParameters": [
451 { 490 {
452 "$ref": "RequestFilter", 491 "$ref": "RequestFilter",
453 "name": "filter", 492 "name": "filter",
454 "description": "A set of filters that restricts the events that will be sent to this listener." 493 "description": "A set of filters that restricts the events that will be sent to this listener."
455 }, 494 },
456 { 495 {
457 "type": "array", 496 "type": "array",
458 "optional": true, 497 "optional": true,
459 "name": "extraInfoSpec", 498 "name": "extraInfoSpec",
460 "description": "Array of extra information that should be passed to the listener function.", 499 "description": "Array of extra information that should be passed to the listener function.",
461 "items": { 500 "items": {
462 "type": "string", 501 "$ref": "OnBeforeRedirectOptions"
463 "enum": ["responseHeaders"]
464 } 502 }
465 } 503 }
466 ] 504 ]
467 }, 505 },
468 { 506 {
469 "name": "onCompleted", 507 "name": "onCompleted",
470 "type": "function", 508 "type": "function",
471 "nocompile": true, 509 "nocompile": true,
472 "description": "Fired when a request is completed.", 510 "description": "Fired when a request is completed.",
473 "parameters": [ 511 "parameters": [
474 { 512 {
475 "type": "object", 513 "type": "object",
476 "name": "details", 514 "name": "details",
477 "properties": { 515 "properties": {
478 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."}, 516 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
479 "url": {"type": "string"}, 517 "url": {"type": "string"},
480 "method": {"type": "string", "description": "Standard HTTP method. "}, 518 "method": {"type": "string", "description": "Standard HTTP method. "},
481 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."}, 519 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."},
482 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "}, 520 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "},
483 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 521 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
484 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 522 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
485 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}, 523 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."},
486 "ip": {"type": "string", "optional": true, "description": "The ser ver IP address that the request was actually sent to. Note that it may be a lite ral IPv6 address."}, 524 "ip": {"type": "string", "optional": true, "description": "The ser ver IP address that the request was actually sent to. Note that it may be a lite ral IPv6 address."},
487 "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."}, 525 "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."},
488 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."}, 526 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."},
489 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that were received along with this response ."}, 527 "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "desc ription": "The HTTP response headers that were received along with this response ."},
490 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line) or an empty string if there are no headers."} 528 "statusLine": {"type": "string", "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., re sponses that lack a status line) or an empty string if there are no headers."}
491 } 529 }
492 } 530 }
493 ], 531 ],
494 "extraParameters": [ 532 "extraParameters": [
495 { 533 {
496 "$ref": "RequestFilter", 534 "$ref": "RequestFilter",
497 "name": "filter", 535 "name": "filter",
498 "description": "A set of filters that restricts the events that will be sent to this listener." 536 "description": "A set of filters that restricts the events that will be sent to this listener."
499 }, 537 },
500 { 538 {
501 "type": "array", 539 "type": "array",
502 "optional": true, 540 "optional": true,
503 "name": "extraInfoSpec", 541 "name": "extraInfoSpec",
504 "description": "Array of extra information that should be passed to the listener function.", 542 "description": "Array of extra information that should be passed to the listener function.",
505 "items": { 543 "items": {
506 "type": "string", 544 "$ref": "OnCompletedOptions"
507 "enum": ["responseHeaders"]
508 } 545 }
509 } 546 }
510 ] 547 ]
511 }, 548 },
512 { 549 {
513 "name": "onErrorOccurred", 550 "name": "onErrorOccurred",
514 "type": "function", 551 "type": "function",
515 "description": "Fired when an error occurs.", 552 "description": "Fired when an error occurs.",
516 "parameters": [ 553 "parameters": [
517 { 554 {
518 "type": "object", 555 "type": "object",
519 "name": "details", 556 "name": "details",
520 "properties": { 557 "properties": {
521 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."}, 558 "requestId": {"type": "string", "description": "The ID of the requ est. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
522 "url": {"type": "string"}, 559 "url": {"type": "string"},
523 "method": {"type": "string", "description": "Standard HTTP method. "}, 560 "method": {"type": "string", "description": "Standard HTTP method. "},
524 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."}, 561 "frameId": {"type": "integer", "description": "The value 0 indicat es that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>) , <code>frameId</code> indicates the ID of this frame, not the ID of the outer f rame. Frame IDs are unique within a tab."},
525 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "}, 562 "parentFrameId": {"type": "integer", "description": "ID of frame t hat wraps the frame which sent the request. Set to -1 if no parent frame exists. "},
526 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." }, 563 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab." },
527 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description ": "How the requested resource will be used."}, 564 "type": {"$ref": "ResourceType", "description": "How the requested resource will be used."},
528 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}, 565 "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."},
529 "ip": {"type": "string", "optional": true, "description": "The ser ver IP address that the request was actually sent to. Note that it may be a lite ral IPv6 address."}, 566 "ip": {"type": "string", "optional": true, "description": "The ser ver IP address that the request was actually sent to. Note that it may be a lite ral IPv6 address."},
530 "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."}, 567 "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."},
531 "error": {"type": "string", "description": "The error description. This string is <em>not</em> guaranteed to remain backwards compatible between r eleases. You must not parse and act based upon its content."} 568 "error": {"type": "string", "description": "The error description. This string is <em>not</em> guaranteed to remain backwards compatible between r eleases. You must not parse and act based upon its content."}
532 } 569 }
533 } 570 }
534 ], 571 ],
535 "extraParameters": [ 572 "extraParameters": [
536 { 573 {
537 "$ref": "RequestFilter", 574 "$ref": "RequestFilter",
538 "name": "filter", 575 "name": "filter",
539 "description": "A set of filters that restricts the events that will be sent to this listener." 576 "description": "A set of filters that restricts the events that will be sent to this listener."
540 } 577 }
541 ] 578 ]
542 } 579 }
543 ] 580 ]
544 } 581 }
545 ] 582 ]
OLDNEW
« no previous file with comments | « extensions/common/api/virtual_keyboard_private.json ('k') | extensions/common/api/web_request_internal.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698