webRequest.onResponseStarted

Cette traduction est en cours.

Fired when the first byte of the response body is received.

This event is informational only.

Syntaxe

browser.webRequest.onResponseStarted.addListener(
  listener,             // function
  filter,               //  object
  extraInfoSpec         //  optional array of strings
)
browser.webRequest.onResponseStarted.removeListener(listener)
browser.webRequest.onResponseStarted.hasListener(listener)

Events have three functions:

addListener(callback, filter, extraInfoSpec)
Adds a listener to this event.
removeListener(listener)
Stop listening to this event. The listener argument is the listener to remove.
hasListener(listener)
Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

syntaxe addListener

Paramètres

callback

A function that will be called when this event occurs. The function will be passed the following arguments:

details
object. Details about the request. See details below.
filter
webRequest.RequestFilter. A filter that restricts the events that will be sent to this listener.
extraInfoSpecFacultatif
array of string. Extra options for the event. You can pass just one value:
  • "responseHeaders": include responseHeaders in the details object passed to the listener

Additional objects

details

documentUrl
string. URL of the document in which the resource will be loaded. For example, if the web page at "https://example.com" contains an image or an iframe, then the documentUrl for the image or iframe will be "https://example.com". For a top-level document, documentUrl is undefined.
frameId
integer. Zero if the request happens in the main frame; a positive value is the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.
fromCache
boolean. Indicates if this response was fetched from disk cache.
ipFacultatif
string. The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.
method
string. Standard HTTP method: for example, "GET" or "POST".
originUrl

string. URL of the resource which triggered the request. For example, if "https://example.com" contains a link, and the user clicks the link, then the originUrl for the resulting request is "https://example.com".

The originUrl is often but not always the same as the documentUrl. For example, if a page contains an iframe, and the iframe contains a link that loads a new document into the iframe, then the documentUrl for the resulting request will be the iframe's parent document, but the originUrl will be the URL of the document in the iframe that contained the link.

parentFrameId
integer. ID of the frame that contains the frame which sent the request. Set to -1 if no parent frame exists.
proxyInfo

object. This property is present only if the request is being proxied. It contains the following properties:

host
string. The hostname of the proxy server.
port
integer. The port number of the proxy server.
type

string. The type of proxy server. One of:

  • "http": HTTP proxy (or SSL CONNECT for HTTPS)
  • "https": HTTP proxying over TLS connection to proxy
  • "socks": SOCKS v5 proxy
  • "socks4": SOCKS v4 proxy
  • "direct": no proxy
  • "unknown": unknown proxy
username
string. Username for the proxy service.
proxyDNS
boolean. True if the proxy will perform domain name resolution based on the hostname supplied, meaning that the client should not do its own DNS lookup.
failoverTimeout
integer. Failover timeout in seconds. If the proxy connection fails, the proxy will not be used again for this period.
requestId
string. The ID of the request. Request IDs are unique within a browser session, so you can use them to relate different events associated with the same request.
responseHeadersFacultatif
webRequest.HttpHeaders. The HTTP response headers that were received along with this response.
statusCode
integer. Standard HTTP status code returned by the server.
statusLine
string. HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line) or an empty string if there are no headers.
tabId
integer. The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.
timeStamp
number. The time when this event fired, in milliseconds since the epoch.
type
webRequest.ResourceType. The type of resource being requested: for example, "image", "script", "stylesheet".
url
string. Target of the request.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple Oui144548 Oui
details.frameId Oui144548 Oui
details.fromCache Oui144548 Oui
details.ip Oui144548 Oui
details.method Oui144548 Oui
details.originUrl Non Non4848 Non
details.parentFrameId Oui144548 Oui
details.proxyInfo Non Non5757 Non
details.requestId Oui144548 Oui
details.responseHeaders Oui144548 Oui
details.statusCode Oui144548 Oui
details.statusLine Oui144548 Oui
details.tabId Oui144548 Oui
details.timeStamp Oui144548 Oui
details.type Oui144548 Oui
details.url Oui144548 Oui

Exemples

var target = "https://developer.mozilla.org/*";

/*
e.g.
"https://developer.mozilla.org/en-US/Firefox/Releases"
200
HTTP/1.1 200 OK
*/
function logResponse(responseDetails) {
  console.log(responseDetails.url);
  console.log(responseDetails.statusCode);
  console.log(responseDetails.statusLine);
}

browser.webRequest.onResponseStarted.addListener(
  logResponse,
  {urls: [target]}
);

Remerciements :

Cette API est basée sur l'API Chromium chrome.webRequest. Cette documentation est dérivée de web_request.json dans le code Chromium.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.

Étiquettes et contributeurs liés au document

Contributeurs à cette page : hellosct1
Dernière mise à jour par : hellosct1,