QWebEngineUrlRequestJob Class

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

Header: #include <QWebEngineUrlRequestJob>
Since: Qt 5.6
Inherits: QObject

Public Types

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

Public Functions

void fail(Error r)
void redirect(const QUrl &url)
void reply(const QByteArray &contentType, QIODevice *device)
QByteArray requestMethod() const
QUrl requestUrl() const
  • 32 public functions inherited from QObject

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 2 signals inherited from QObject
  • 11 static public members inherited from QObject
  • 9 protected functions inherited from QObject

Detailed Description

The QWebEngineUrlRequestJob class represents a custom URL request.

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(Error r)

Fails the request with the error r.

See also Error.

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 MIME type contentType.

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 delete itself when closed, like this:

connect(device, &QIODevice::aboutToClose, device, &QObject::deleteLater);

QByteArray QWebEngineUrlRequestJob::requestMethod() const

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

QUrl QWebEngineUrlRequestJob::requestUrl() const

Returns the requested URL.

© 2019 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.