class QWebEngineUrlRequestJob

The QWebEngineUrlRequestJob class represents a custom URL request. More…

Synopsis

Methods

• def fail()

• def initiator()

• def redirect()

• def reply()

• def requestBody()

• def requestHeaders()

• def requestMethod()

• def requestUrl()

• def setAdditionalResponseHeaders()

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

A QWebEngineUrlRequestJob is given to requestStarted() and must be handled by the derived implementations of the class. The job can be handled by calling either reply() , redirect() , or fail() .

The class is owned by the web engine and does not need to be deleted. However, the web engine may delete the job when it is no longer needed, and therefore the signal QObject::destroyed() must be monitored if a pointer to the object is stored.

class Error

This enum type holds the type of the error that occurred:

Constant	Description
QWebEngineUrlRequestJob.NoError	The request was successful.
QWebEngineUrlRequestJob.UrlNotFound	The requested URL was not found.
QWebEngineUrlRequestJob.UrlInvalid	The requested URL is invalid.
QWebEngineUrlRequestJob.RequestAborted	The request was canceled.
QWebEngineUrlRequestJob.RequestDenied	The request was denied.
QWebEngineUrlRequestJob.RequestFailed	The request failed.

fail(error)

Parameters:

error – Error

Fails the request with the error r.

See also

Error

initiator()

Return type:

QUrl

Returns the serialized origin of the content that initiated the request.

Generally, the origin consists of a scheme, hostname, and port. For example, "http://localhost:8080" would be a valid origin. The port is omitted if it is the scheme’s default port (80 for http, 443 for https). The hostname is omitted for non-network schemes such as file and qrc.

However, there is also the special value "null" representing a unique origin. It is, for example, the origin of a sandboxed iframe. The purpose of this special origin is to be always different from all other origins in the same-origin check. In other words, content with a unique origin should never have privileged access to any other content.

Finally, if the request was not initiated by web content, the function will return an empty QUrl. This happens, for example, when you call setUrl() .

This value can be used for implementing secure cross-origin checks.

redirect(url)

Parameters:

url – QUrl

Redirects the request to url.

reply(contentType, device)

Parameters:

• contentType – QByteArray

• device – QIODevice

Replies to the request with device and the content type contentType. Content type is similar to the HTTP Content-Type header, and can either be a MIME type, or a MIME type and charset encoding combined like this: “text/html; charset=utf-8”.

The user has to be aware that device will be used on another thread until the job is deleted. In case simultaneous access from the main thread is desired, the user is reponsible for making access to device thread-safe for example by using QMutex. Note that the device object is not owned by the web engine. Therefore, the signal QObject::destroyed() of QWebEngineUrlRequestJob must be monitored.

The device should remain available at least as long as the job exists. When calling this method with a newly constructed device, one solution is to make the device as a child of the job or delete itself when job is deleted, like this:

connect(job, &QObject::destroyed, device, &QObject::deleteLater);

requestBody()

Return type:

QIODevice

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.

See also

QIODevice

requestHeaders()

Return type:

Dictionary with keys of type .QByteArray and values of type QByteArray.

Returns any HTTP headers added to the request.

requestMethod()

Return type:

QByteArray

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

requestUrl()

Return type:

QUrl

Returns the requested URL.

setAdditionalResponseHeaders(additionalResponseHeaders)

Parameters:

additionalResponseHeaders – .QMultiMapQByteArray,QByteArray

Set additionalResponseHeaders. These additional headers of the response are only used when reply (const QByteArray&, QIODevice*) is called.