QWebEngineUrlRequestInfo

The QWebEngineUrlRequestInfo class provides information about URL requests. More

Inheritance diagram of PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo

Synopsis

Functions

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 function interceptRequest() if an interceptor has been set.

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.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.ResourceTypeUnknown

Unknown request type.

Note

For forward compatibility all values not matched should be treated as unknown, not just ResourceTypeUnknown .

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.NavigationType

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.NavigationTypeOther

None of the above.

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.block(shouldBlock)
Parameters

shouldBlockbool

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.

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.changed()
Return type

bool

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.firstPartyUrl()
Return type

QUrl

Returns the first party URL of the request. The first party URL is the URL of the page that issued the request.

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.navigationType()
Return type

NavigationType

Returns the navigation type of the request.

See also

NavigationType

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.redirect(url)
Parameters

urlQUrl

Redirects this request to url . It is only possible to redirect requests that do not have payload data, such as GET requests.

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.requestMethod()
Return type

QByteArray

Returns the HTTP method of the request (for example, GET or POST).

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.requestUrl()
Return type

QUrl

Returns the requested URL.

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.resourceType()
Return type

ResourceType

Returns the resource type of the request.

See also

ResourceType

PySide2.QtWebEngineCore.QWebEngineUrlRequestInfo.setHttpHeader(name, value)
Parameters
  • nameQByteArray

  • valueQByteArray

Sets the request header name to value for this request.