Fired when the first byte of the response body is received.
This event is informational only.
Syntax
browser.webRequest.onResponseStarted.addListener(function( details // object ) {...}) 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. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
callback
-
A function that will be called when this event occurs. The function will be passed the following arguments:
filter
webRequest.RequestFilter
. A filter that restricts the events that will be sent to this listener.extraInfoSpec
Optionalarray
ofstring
. Extra options for the event. You can pass just one value:-
"
responseHeaders
"
: includeresponseHeaders
in thedetails
object passed to the listener
Additional objects
details
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.url
string
. Target of the request.method
string
. Standard HTTP method: for example, "GET" or "POST".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
ismain_frame
orsub_frame
),frameId
indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.parentFrameId
integer
. ID of the frame that contains the frame which sent the request. Set to -1 if no parent frame exists.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.type
webRequest.ResourceType
. The type of resource being requested: for example, "image", "script", "stylesheet".timeStamp
number
. The time when this event fired, in milliseconds since the epoch.ip
Optionalstring
. The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.fromCache
boolean
. Indicates if this response was fetched from disk cache.statusCode
integer
. Standard HTTP status code returned by the server.responseHeaders
OptionalwebRequest.HttpHeaders
. The HTTP response headers that were received along with this response.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.
Browser compatibility
Examples
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); } chrome.webRequest.onResponseStarted.addListener( logResponse, {urls: [target]} );
Acknowledgements
This API is based on Chromium's chrome.webRequest
API. This documentation is derived from web_request.json
in the Chromium code.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.