QWebEngineUrlRequestJob Class | Qt WebEngine 5.10

Qt 5.10 | Qt WebEngine | C++ Classes | QWebEngineUrlRequestJob

Qt 5.10.1 Reference Documentation

# QWebEngineUrlRequestJob Class

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

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

- List of all members, including inherited members

## 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
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables 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:

Constant | Value | Description
--- | --- | ---
`QWebEngineUrlRequestJob::NoError` | `0` | The request was successful.
`QWebEngineUrlRequestJob::UrlNotFound` | `1` | The requested URL was not found.
`QWebEngineUrlRequestJob::UrlInvalid` | `2` | The requested URL is invalid.
`QWebEngineUrlRequestJob::RequestAborted` | `3` | The request was canceled.
`QWebEngineUrlRequestJob::RequestDenied` | `4` | The request was denied.
`QWebEngineUrlRequestJob::RequestFailed` | `5` | The 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 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 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.