Class: WebRequest
Class: WebRequest
Intercept and modify the contents of a request at various stages of its lifetime.
Processo: Principal
Esta classe não é exportada do módulo 'electron'
. Ele é somente disponibilizado como um valor de retorno de outros métodos na API Electron.
Instances of the WebRequest
class are accessed by using the webRequest
property of a Session
.
The methods of WebRequest
accept an optional filter
and a listener
. The listener
will be called with listener(details)
when the API's event has happened. The details
object describes the request.
⚠️ Only the last attached listener
will be used. Passing null
as listener
will unsubscribe from the event.
The filter
object has a urls
property which is an Array of URL patterns that will be used to filter out the requests that do not match the URL patterns. If the filter
is omitted then all requests will be matched.
For certain events the listener
is passed with a callback
, which should be called with a response
object when listener
has done its work.
An example of adding User-Agent
header for requests:
const { session } = require('electron')
// Modify the user agent for all requests to the following urls.
const filter = {
urls: ['https://*.github.com/*', '*://electron.github.io/*']
}
session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback) => {
details.requestHeaders['User-Agent'] = 'MyAgent'
callback({ requestHeaders: details.requestHeaders })
})
Métodos de Instância
The following methods are available on instances of WebRequest
:
webRequest.onBeforeRequest([filter, ]listener)
filter
WebRequestFilter (optional)listener
Function | null- Objeto
details
id
Inteiro- string
url
method
stringwebContentsId
Integer (opcional)webContents
WebContents (optional)frame
WebFrameMain | null (optional) - Requesting frame. May benull
if accessed after the frame has either navigated or been destroyed.resourceType
string - Can bemainFrame
,subFrame
,stylesheet
,script
,image
,font
,object
,xhr
,ping
,cspReport
,media
,webSocket
orother
.referrer
stringtimestamp
DoubleuploadData
UploadData[]
callback
Functionresponse
Objectcancel
boolean (opcional)redirectURL
string (optional) - The original request is prevented from being sent or completed and is instead redirected to the given URL.
- Objeto
The listener
will be called with listener(details, callback)
when a request is about to occur.
The uploadData
is an array of UploadData
objects.
O callback
tem que ser chamado com um objeto response
.
Alguns exemplos de urls
válidas:
'http://foo:1234/'
'http://foo.com/'
'http://foo:1234/bar'
'*://*/*'
'*://example.com/*'
'*://example.com/foo/*'
'http://*.foo:1234/'
'file://foo:1234/bar'
'http://foo:*/'
'*://www.foo.com/'
webRequest.onBeforeSendHeaders([filter, ]listener)
filter
WebRequestFilter (optional)listener
Function | null- Objeto
details
id
Inteiro- string
url
method
stringwebContentsId
Integer (opcional)webContents
WebContents (optional)frame
WebFrameMain | null (optional) - Requesting frame. May benull
if accessed after the frame has either navigated or been destroyed.resourceType
string - Can bemainFrame
,subFrame
,stylesheet
,script
,image
,font
,object
,xhr
,ping
,cspReport
,media
,webSocket
orother
.referrer
stringtimestamp
DoubleuploadData
UploadData[] (opcional)requestHeaders
Record<string, string>
callback
FunctionbeforeSendResponse
Objectcancel
boolean (opcional)requestHeaders
Record<string, string | string[]> (optional) - When provided, request will be made with these headers.
- Objeto
The listener
will be called with listener(details, callback)
before sending an HTTP request, once the request headers are available. Isto pode ocorrer após uma conexão TCP ser feita ao servidor, mas antes que qualquer dado http seja enviado.
The callback
has to be called with a response
object.
webRequest.onSendHeaders([filter, ]listener)
filter
WebRequestFilter (optional)listener
Function | null- Objeto
details
id
Inteiro- string
url
method
stringwebContentsId
Integer (opcional)webContents
WebContents (optional)frame
WebFrameMain | null (optional) - Requesting frame. May benull
if accessed after the frame has either navigated or been destroyed.resourceType
string - Can bemainFrame
,subFrame
,stylesheet
,script
,image
,font
,object
,xhr
,ping
,cspReport
,media
,webSocket
orother
.referrer
stringtimestamp
DoublerequestHeaders
Record<string, string>
- Objeto
The listener
will be called with listener(details)
just before a request is going to be sent to the server, modifications of previous onBeforeSendHeaders
response are visible by the time this listener is fired.
webRequest.onHeadersReceived([filter, ]listener)
filter
WebRequestFilter (optional)listener
Function | null- Objeto
details
id
Inteiro- string
url
method
stringwebContentsId
Integer (opcional)webContents
WebContents (optional)frame
WebFrameMain | null (optional) - Requesting frame. May benull
if accessed after the frame has either navigated or been destroyed.resourceType
string - Can bemainFrame
,subFrame
,stylesheet
,script
,image
,font
,object
,xhr
,ping
,cspReport
,media
,webSocket
orother
.referrer
stringtimestamp
DoublestatusLine
stringstatusCode
IntegerresponseHeaders
Record<string, string[]> (optional)
callback
FunctionheadersReceivedResponse
Objectcancel
boolean (opcional)responseHeaders
Record<string, string | string[]> (optional) - When provided, the server is assumed to have responded with these headers.statusLine
string (optional) - Should be provided when overridingresponseHeaders
to change header status otherwise original response header's status will be used.
- Objeto
The listener
will be called with listener(details, callback)
when HTTP response headers of a request have been received.
The callback
has to be called with a response
object.
webRequest.onResponseStarted([filter, ]listener)
filter
WebRequestFilter (optional)listener
Function | null- Objeto
details
id
Inteiro- string
url
method
stringwebContentsId
Integer (opcional)webContents
WebContents (optional)frame
WebFrameMain | null (optional) - Requesting frame. May benull
if accessed after the frame has either navigated or been destroyed.resourceType
string - Can bemainFrame
,subFrame
,stylesheet
,script
,image
,font
,object
,xhr
,ping
,cspReport
,media
,webSocket
orother
.referrer
stringtimestamp
DoubleresponseHeaders
Record<string, string[]> (optional)fromCache
boolean - Indicates whether the response was fetched from disk cache.statusCode
IntegerstatusLine
string
- Objeto
The listener
will be called with listener(details)
when first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available.
webRequest.onBeforeRedirect([filter, ]listener)
filter
WebRequestFilter (optional)listener
Function | null- Objeto
details
id
Inteiro- string
url
method
stringwebContentsId
Integer (opcional)webContents
WebContents (optional)frame
WebFrameMain | null (optional) - Requesting frame. May benull
if accessed after the frame has either navigated or been destroyed.resourceType
string - Can bemainFrame
,subFrame
,stylesheet
,script
,image
,font
,object
,xhr
,ping
,cspReport
,media
,webSocket
orother
.referrer
stringtimestamp
DoubleredirectURL
stringstatusCode
IntegerstatusLine
stringip
string (optional) - The server IP address that the request was actually sent to.fromCache
booleanresponseHeaders
Record<string, string[]> (optional)
- Objeto
The listener
will be called with listener(details)
when a server initiated redirect is about to occur.
webRequest.onCompleted([filter, ]listener)
filter
WebRequestFilter (optional)listener
Function | null- Objeto
details
id
Inteiro- string
url
method
stringwebContentsId
Integer (opcional)webContents
WebContents (optional)frame
WebFrameMain | null (optional) - Requesting frame. May benull
if accessed after the frame has either navigated or been destroyed.resourceType
string - Can bemainFrame
,subFrame
,stylesheet
,script
,image
,font
,object
,xhr
,ping
,cspReport
,media
,webSocket
orother
.referrer
stringtimestamp
DoubleresponseHeaders
Record<string, string[]> (optional)fromCache
booleanstatusCode
IntegerstatusLine
stringerror
string
- Objeto
The listener
will be called with listener(details)
when a request is completed.
webRequest.onErrorOccurred([filter, ]listener)
filter
WebRequestFilter (optional)listener
Function | null- Objeto
details
id
Inteiro- string
url
method
stringwebContentsId
Integer (opcional)webContents
WebContents (optional)frame
WebFrameMain | null (optional) - Requesting frame. May benull
if accessed after the frame has either navigated or been destroyed.resourceType
string - Can bemainFrame
,subFrame
,stylesheet
,script
,image
,font
,object
,xhr
,ping
,cspReport
,media
,webSocket
orother
.referrer
stringtimestamp
DoublefromCache
booleanerror
string - The error description.
- Objeto
The listener
will be called with listener(details)
when an error occurs.