| 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": "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": { |
| (...skipping 344 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 355 "returns": { | 355 "returns": { |
| 356 "$ref": "BlockingResponse", | 356 "$ref": "BlockingResponse", |
| 357 "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.", |
| 358 "optional": true | 358 "optional": true |
| 359 } | 359 } |
| 360 }, | 360 }, |
| 361 { | 361 { |
| 362 "name": "onAuthRequired", | 362 "name": "onAuthRequired", |
| 363 "nocompile": true, | 363 "nocompile": true, |
| 364 "type": "function", | 364 "type": "function", |
| 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.", | 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. Note, only one of <code>'blocking'</code> or <code>'asyncBlo
cking'</code> modes must be specified in the <code>extraInfoSpec</code> paramete
r.", |
| 366 "parameters": [ | 366 "parameters": [ |
| 367 { | 367 { |
| 368 "type": "object", | 368 "type": "object", |
| 369 "name": "details", | 369 "name": "details", |
| 370 "properties": { | 370 "properties": { |
| 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."}, | 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."}, |
| 372 "url": {"type": "string"}, | 372 "url": {"type": "string"}, |
| 373 "method": {"type": "string", "description": "Standard HTTP method.
"}, | 373 "method": {"type": "string", "description": "Standard HTTP method.
"}, |
| 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."}, | 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."}, |
| 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.
"}, | 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.
"}, |
| 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."
}, | 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."
}, |
| 377 "type": {"$ref": "ResourceType", "description": "How the requested
resource will be used."}, | 377 "type": {"$ref": "ResourceType", "description": "How the requested
resource will be used."}, |
| 378 "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."}, |
| 379 "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."}, |
| 380 "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}, |
| 381 "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"}}}, |
| 382 "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."}, |
| 383 "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
."}, |
| 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."}, | 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."}, |
| 385 "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."} |
| 386 } | 386 } |
| 387 }, | 387 }, |
| 388 { | 388 { |
| 389 "type": "function", | 389 "type": "function", |
| 390 "optional": true, | 390 "optional": true, |
| 391 "name": "callback", | 391 "description" : "Only valid if <code>'asyncBlocking'</code> is speci
fied as one of the <code>OnAuthRequiredOptions</code>.", |
| 392 "name": "asyncCallback", |
| 392 "parameters": [ | 393 "parameters": [ |
| 393 {"name": "response", "$ref": "BlockingResponse"} | 394 {"name": "response", "$ref": "BlockingResponse"} |
| 394 ] | 395 ] |
| 395 } | 396 } |
| 396 ], | 397 ], |
| 397 "extraParameters": [ | 398 "extraParameters": [ |
| 398 { | 399 { |
| 399 "$ref": "RequestFilter", | 400 "$ref": "RequestFilter", |
| 400 "name": "filter", | 401 "name": "filter", |
| 401 "description": "A set of filters that restricts the events that will
be sent to this listener." | 402 "description": "A set of filters that restricts the events that will
be sent to this listener." |
| (...skipping 171 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 573 { | 574 { |
| 574 "$ref": "RequestFilter", | 575 "$ref": "RequestFilter", |
| 575 "name": "filter", | 576 "name": "filter", |
| 576 "description": "A set of filters that restricts the events that will
be sent to this listener." | 577 "description": "A set of filters that restricts the events that will
be sent to this listener." |
| 577 } | 578 } |
| 578 ] | 579 ] |
| 579 } | 580 } |
| 580 ] | 581 ] |
| 581 } | 582 } |
| 582 ] | 583 ] |
| OLD | NEW |