QWebEngineUrlRequestJob¶
The
QWebEngineUrlRequestJob
class represents a custom URL request. More…
Synopsis¶
Functions¶
def
fail
(error)def
initiator
()def
redirect
(url)def
reply
(contentType, device)def
requestHeaders
()def
requestMethod
()def
requestUrl
()
Detailed Description¶
A
QWebEngineUrlRequestJob
is given torequestStarted()
and must be handled by the derived implementations of the class. The job can be handled by calling eitherreply()
,redirect()
, orfail()
.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
destroyed()
must be monitored if a pointer to the object is stored.
- class PySide2.QtWebEngineCore.QWebEngineUrlRequestJob¶
- PySide2.QtWebEngineCore.QWebEngineUrlRequestJob.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.
- PySide2.QtWebEngineCore.QWebEngineUrlRequestJob.fail(error)¶
- Parameters:
error –
Error
Fails the request with the error
r
.See also
Error
- PySide2.QtWebEngineCore.QWebEngineUrlRequestJob.initiator()¶
- Return type:
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 forhttp
, 443 forhttps
). The hostname is omitted for non-network schemes such asfile
andqrc
.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 callsetUrl()
.This value can be used for implementing secure cross-origin checks.
- PySide2.QtWebEngineCore.QWebEngineUrlRequestJob.redirect(url)¶
- Parameters:
url –
PySide2.QtCore.QUrl
Redirects the request to
url
.
- PySide2.QtWebEngineCore.QWebEngineUrlRequestJob.reply(contentType, device)¶
- Parameters:
contentType –
PySide2.QtCore.QByteArray
device –
PySide2.QtCore.QIODevice
Replies to the request with
device
and the MIME typecontentType
.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 todevice
thread-safe for example by usingQMutex
. Note that thedevice
object is not owned by the web engine. Therefore, the signaldestroyed()
ofQWebEngineUrlRequestJob
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);
- PySide2.QtWebEngineCore.QWebEngineUrlRequestJob.requestHeaders()¶
- Return type:
Returns any HTTP headers added to the request.
- PySide2.QtWebEngineCore.QWebEngineUrlRequestJob.requestMethod()¶
- Return type:
Returns the HTTP method of the request (for example, GET or POST).
- PySide2.QtWebEngineCore.QWebEngineUrlRequestJob.requestUrl()¶
- Return type:
Returns the requested URL.
© 2022 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.