- class QWebEngineUrlRequestInfo#
The
QWebEngineUrlRequestInfo
class provides information about URL requests. More…Synopsis#
Methods#
def
block()
def
changed()
def
firstPartyUrl()
def
httpHeaders()
def
initiator()
def
navigationType()
def
redirect()
def
requestBody()
def
requestMethod()
def
requestUrl()
def
resourceType()
def
setHttpHeader()
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
The
QWebEngineUrlRequestInfo
is useful for setting extra header fields for requests or for redirecting certain requests without payload data to another URL. This class cannot be instantiated or copied by the user, instead it will be created by Qt WebEngine and sent through the virtual functioninterceptRequest()
if an interceptor has been set.- class ResourceType#
This enum type holds the type of the requested resource:
Constant
Description
QWebEngineUrlRequestInfo.ResourceTypeMainFrame
Top level page.
QWebEngineUrlRequestInfo.ResourceTypeSubFrame
Frame or iframe.
QWebEngineUrlRequestInfo.ResourceTypeStylesheet
A CSS stylesheet.
QWebEngineUrlRequestInfo.ResourceTypeScript
An external script.
QWebEngineUrlRequestInfo.ResourceTypeImage
An image (JPG, GIF, PNG, and so on).
QWebEngineUrlRequestInfo.ResourceTypeFontResource
A font.
QWebEngineUrlRequestInfo.ResourceTypeSubResource
An “other” subresource.
QWebEngineUrlRequestInfo.ResourceTypeObject
An object (or embed) tag for a plugin or a resource that a plugin requested.
QWebEngineUrlRequestInfo.ResourceTypeMedia
A media resource.
QWebEngineUrlRequestInfo.ResourceTypeWorker
The main resource of a dedicated worker.
QWebEngineUrlRequestInfo.ResourceTypeSharedWorker
The main resource of a shared worker.
QWebEngineUrlRequestInfo.ResourceTypePrefetch
An explicitly requested prefetch.
QWebEngineUrlRequestInfo.ResourceTypeFavicon
A favicon.
QWebEngineUrlRequestInfo.ResourceTypeXhr
An XMLHttpRequest.
QWebEngineUrlRequestInfo.ResourceTypePing
A ping request for <a ping>.
QWebEngineUrlRequestInfo.ResourceTypeServiceWorker
The main resource of a service worker.
QWebEngineUrlRequestInfo.ResourceTypeCspReport
A report of Content Security Policy (CSP) violations. CSP reports are in JSON format and they are delivered by HTTP POST requests to specified servers. (Added in Qt 5.7)
QWebEngineUrlRequestInfo.ResourceTypePluginResource
A resource requested by a plugin. (Added in Qt 5.7)
QWebEngineUrlRequestInfo.ResourceTypeNavigationPreloadMainFrame
A main-frame service worker navigation preload request. (Added in Qt 5.14)
QWebEngineUrlRequestInfo.ResourceTypeNavigationPreloadSubFrame
A sub-frame service worker navigation preload request. (Added in Qt 5.14)
QWebEngineUrlRequestInfo.ResourceTypeWebSocket
A WebSocket request. (Added in Qt 6.4)
QWebEngineUrlRequestInfo.ResourceTypeUnknown
Unknown request type.
Note
For forward compatibility all values not matched should be treated as unknown, not just
ResourceTypeUnknown
.
This enum type describes the navigation type of the request:
Constant
Description
QWebEngineUrlRequestInfo.NavigationTypeLink
Navigation initiated by clicking a link.
QWebEngineUrlRequestInfo.NavigationTypeTyped
Navigation explicitly initiated by typing a URL.
QWebEngineUrlRequestInfo.NavigationTypeFormSubmitted
Navigation submits a form.
QWebEngineUrlRequestInfo.NavigationTypeBackForward
Navigation initiated by a history action.
QWebEngineUrlRequestInfo.NavigationTypeReload
Navigation initiated by refreshing the page.
QWebEngineUrlRequestInfo.NavigationTypeRedirect
Navigation triggered automatically by page content or remote server. (Added in Qt 5.14)
QWebEngineUrlRequestInfo.NavigationTypeOther
None of the above.
- block(shouldBlock)#
- Parameters:
shouldBlock – bool
Blocks this request if
shouldBlock
is true, so that it will not proceed.This function can be used to prevent navigating away from a given domain, for example.
- changed()#
- Return type:
bool
Returns the first party URL of the request. The first party URL is the URL of the page that issued the request.
- httpHeaders()#
- Return type:
Dictionary with keys of type .QByteArray and values of type QByteArray.
Returns the request headers.
Note
Not all headers are visible at this stage as Chromium will add security and proxy headers at a later stage.
Returns the origin URL of the document that initiated the navigation of a frame to another frame.
- Return type:
Returns the navigation type of the request.
See also
Redirects this request to
url
. It is only possible to redirect requests that do not have payload data, such as GET requests.Returns a pointer to a QIODevice that gives access to the request body. The request body can contain data for example when the request is a POST request. If the request body is empty the QIODevice reflects this and does not return any data when performing read operations on it.
- requestMethod()#
- Return type:
Returns the HTTP method of the request (for example, GET or POST).
Returns the requested URL.
- resourceType()#
- Return type:
Returns the resource type of the request.
See also
- setHttpHeader(name, value)#
- Parameters:
name –
QByteArray
value –
QByteArray
Sets the request header
name
tovalue
for this request.