QWebEngineUrlRequestJob Class

The QWebEngineUrlRequestJob class represents a custom URL request. More...

Header: #include <QWebEngineUrlRequestJob>
CMake: find_package(Qt6 REQUIRED COMPONENTS WebEngineCore)
target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore)
qmake: QT += webenginecore
Inherits: QObject

Public Types

enum Error { NoError, UrlNotFound, UrlInvalid, RequestAborted, RequestDenied, RequestFailed }

Public Functions

void fail(QWebEngineUrlRequestJob::Error r)
QUrl initiator() const
void redirect(const QUrl &url)
void reply(const QByteArray &contentType, QIODevice *device)
(since 6.7) QIODevice *requestBody() const
QMap<QByteArray, QByteArray> requestHeaders() const
QByteArray requestMethod() const
QUrl requestUrl() const
(since 6.6) void setAdditionalResponseHeaders(const QMultiMap<QByteArray, QByteArray> &additionalResponseHeaders) const

Detailed Description

A QWebEngineUrlRequestJob is given to QWebEngineUrlSchemeHandler::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.

Member Type Documentation

enum QWebEngineUrlRequestJob::Error

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

QWebEngineUrlRequestJob::NoError0The request was successful.
QWebEngineUrlRequestJob::UrlNotFound1The requested URL was not found.
QWebEngineUrlRequestJob::UrlInvalid2The requested URL is invalid.
QWebEngineUrlRequestJob::RequestAborted3The request was canceled.
QWebEngineUrlRequestJob::RequestDenied4The request was denied.
QWebEngineUrlRequestJob::RequestFailed5The request failed.

Member Function Documentation

void QWebEngineUrlRequestJob::fail(QWebEngineUrlRequestJob::Error r)

Fails the request with the error r.

See also Error.

QUrl QWebEngineUrlRequestJob::initiator() const

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 QWebEnginePage::setUrl().

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

void QWebEngineUrlRequestJob::redirect(const QUrl &url)

Redirects the request to url.

void QWebEngineUrlRequestJob::reply(const QByteArray &contentType, QIODevice *device)

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);

[since 6.7] QIODevice *QWebEngineUrlRequestJob::requestBody() const

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.

This function was introduced in Qt 6.7.

See also QIODevice.

QMap<QByteArray, QByteArray> QWebEngineUrlRequestJob::requestHeaders() const

Returns any HTTP headers added to the request.

QByteArray QWebEngineUrlRequestJob::requestMethod() const

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

QUrl QWebEngineUrlRequestJob::requestUrl() const

Returns the requested URL.

[since 6.6] void QWebEngineUrlRequestJob::setAdditionalResponseHeaders(const QMultiMap<QByteArray, QByteArray> &additionalResponseHeaders) const

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

This function was introduced in Qt 6.6.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.