QWebEngineUrlRequestInfo 类

The QWebEngineUrlRequestInfo 类提供 URL 请求的有关信息。 更多...

头: #include <QWebEngineUrlRequestInfo>
CMake: find_package(Qt6 REQUIRED COMPONENTS WebEngineCore)
target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore)
qmake: QT += webenginecore

公共类型

enum NavigationType { NavigationTypeLink, NavigationTypeTyped, NavigationTypeFormSubmitted, NavigationTypeBackForward, NavigationTypeReload, …, NavigationTypeOther }
enum ResourceType { ResourceTypeMainFrame, ResourceTypeSubFrame, ResourceTypeStylesheet, ResourceTypeScript, ResourceTypeImage, …, ResourceTypeJson }

公共函数

void block (bool shouldBlock )
QUrl firstPartyUrl () const
(从 6.5 起) QHash<QByteArray, QByteArray> httpHeaders () const
QUrl initiator () const
(从 6.9 起) bool isDownload () const
QWebEngineUrlRequestInfo::NavigationType navigationType () const
void redirect (const QUrl & url )
(从 6.7 起) QIODevice * requestBody () const
QByteArray requestMethod () const
QUrl requestUrl () const
QWebEngineUrlRequestInfo::ResourceType resourceType () const
void setHttpHeader (const QByteArray & name , const QByteArray & value )

详细描述

The QWebEngineUrlRequestInfo is useful for setting extra header fields for requests, or for redirecting certain requests without payload data to another URL. This class cannot be instantiated or copied by the user; instead, it will be created by Qt WebEngine and sent through the virtual function QWebEngineUrlRequestInterceptor::interceptRequest () 若拦截器有设置。

成员类型文档编制

此枚举类型描述请求的导航类型:

常量 描述
QWebEngineUrlRequestInfo::NavigationTypeLink 0 通过点击链接初启导航。
QWebEngineUrlRequestInfo::NavigationTypeTyped 1 通过键入 URL 明确初启导航。
QWebEngineUrlRequestInfo::NavigationTypeFormSubmitted 2 提交表单导航。
QWebEngineUrlRequestInfo::NavigationTypeBackForward 3 通过历史动作初启导航。
QWebEngineUrlRequestInfo::NavigationTypeReload 4 通过刷新页面初启导航。
QWebEngineUrlRequestInfo::NavigationTypeRedirect 6 通过页面内容 (或远程服务器) 自动触发导航 (在 Qt 5.14 添加)。
QWebEngineUrlRequestInfo::NavigationTypeOther 5 以上都不是。

enum QWebEngineUrlRequestInfo:: ResourceType

此枚举类型保持请求资源的类型:

常量 描述
QWebEngineUrlRequestInfo::ResourceTypeMainFrame 0 顶层页面。
QWebEngineUrlRequestInfo::ResourceTypeSubFrame 1 框架或 iframe。
QWebEngineUrlRequestInfo::ResourceTypeStylesheet 2 CSS 样式表。
QWebEngineUrlRequestInfo::ResourceTypeScript 3 外部脚本。
QWebEngineUrlRequestInfo::ResourceTypeImage 4 图像 (JPG、GIF、PNG、等等)。
QWebEngineUrlRequestInfo::ResourceTypeFontResource 5 字体。
QWebEngineUrlRequestInfo::ResourceTypeSubResource 6 Other 子资源。
QWebEngineUrlRequestInfo::ResourceTypeObject 7 插件请求的用于插件的对象 (或嵌入) 标签或资源。
QWebEngineUrlRequestInfo::ResourceTypeMedia 8 媒体资源。
QWebEngineUrlRequestInfo::ResourceTypeWorker 9 专用工作者的主要资源。
QWebEngineUrlRequestInfo::ResourceTypeSharedWorker 10 共享工作者的主要资源。
QWebEngineUrlRequestInfo::ResourceTypePrefetch 11 明确请求的预抓取。
QWebEngineUrlRequestInfo::ResourceTypeFavicon 12 favicon。
QWebEngineUrlRequestInfo::ResourceTypeXhr 13 An XMLHttpRequest .
QWebEngineUrlRequestInfo::ResourceTypePing 14 用于 <ping> 的 ping 请求
QWebEngineUrlRequestInfo::ResourceTypeServiceWorker 15 服务工作者的主要资源。
QWebEngineUrlRequestInfo::ResourceTypeCspReport 16 违反 CSP (内容安全策略) 的报告。CSP 报告采用 JSON 格式,并通过 HTTP POST 请求把它们交付给指定服务器 (在 Qt 5.7 添加)。
QWebEngineUrlRequestInfo::ResourceTypePluginResource 17 由插件请求的资源 (在 Qt 5.7 添加)。
QWebEngineUrlRequestInfo::ResourceTypeNavigationPreloadMainFrame 19 主框架服务工作者导航预加载请求 (在 Qt 5.14 添加)。
QWebEngineUrlRequestInfo::ResourceTypeNavigationPreloadSubFrame 20 子架服务工作者导航预加载请求 (在 Qt 5.14 添加)。
QWebEngineUrlRequestInfo::ResourceTypeWebSocket 254 A WebSocket request. (Added in Qt 6.4)
QWebEngineUrlRequestInfo::ResourceTypeUnknown 255 未知请求类型。
QWebEngineUrlRequestInfo::ResourceTypeJson 21 A JSON module. (Added in Qt 6.8)

注意: 为前向兼容应视为未知的所有不匹配值,而不仅仅是 ResourceTypeUnknown .

成员函数文档编制

void QWebEngineUrlRequestInfo:: block ( bool shouldBlock )

阻塞此请求若 shouldBlock 为 true,所以它不会继续进行。

例如,可以使用此函数阻止从给定域导航出去。

QUrl QWebEngineUrlRequestInfo:: firstPartyUrl () const

返回请求的第 1 方 URL (统一资源定位符)。第 1 方 URL 是发出请求页面的 URL。

[since 6.5] QHash < QByteArray , QByteArray > QWebEngineUrlRequestInfo:: httpHeaders () const

Returns the request headers.

注意: Not all headers are visible at this stage as Chromium will add security and proxy headers at a later stage.

该函数在 Qt 6.5 引入。

QUrl QWebEngineUrlRequestInfo:: initiator () const

返回初启框架导航到另一框架的文档源 URL (统一资源定位符)。

[since 6.9] bool QWebEngineUrlRequestInfo:: isDownload () const

Returns true if the request was initiated by an explicit download action from the user.

A download can still occurs, even when this function return false.

该函数在 Qt 6.9 引入。

返回请求的导航类型。

另请参阅 NavigationType .

void QWebEngineUrlRequestInfo:: redirect (const QUrl & url )

重定向此请求到 url .

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

返回指针指向 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.

该函数在 Qt 6.7 引入。

QByteArray QWebEngineUrlRequestInfo:: requestMethod () const

返回请求的 HTTP 方法 (例如 GET 或 POST)。

QUrl QWebEngineUrlRequestInfo:: requestUrl () const

返回请求的 URL (统一资源定位符)。

QWebEngineUrlRequestInfo::ResourceType QWebEngineUrlRequestInfo:: resourceType () const

返回请求的资源类型。

另请参阅 ResourceType .

void QWebEngineUrlRequestInfo:: setHttpHeader (const QByteArray & name , const QByteArray & value )

设置请求头 name to value 为此请求。