QAbstractOAuth2 Class

成员函数文档

[explicit] QAbstractOAuth2::QAbstractOAuth2(QObject *parent = nullptr)

使用parent 作为父对象，构造一个 QAbstractOAuth2 对象。

[explicit] QAbstractOAuth2::QAbstractOAuth2(QNetworkAccessManager *manager, QObject *parent = nullptr)

使用parent 作为父对象构建 QAbstractOAuth2 对象，并将manager 设置为网络访问管理器。

[virtual noexcept] QAbstractOAuth2::~QAbstractOAuth2()

销毁QAbstractOAuth2 实例。

[signal, since 6.9] void QAbstractOAuth2::accessTokenAboutToExpire()

该信号在访问令牌即将过期时发出。

要发出该信号，访问令牌必须有有效的过期时间。手动处理该信号的另一种方法是使用autoRefresh 。

该函数在 Qt 6.9 中引入。

另请参阅 refreshLeadTime,autoRefresh, 和refreshTokens() 。

[signal] void QAbstractOAuth2::authorizationCallbackReceived(const QVariantMap &data)

当回复服务器收到来自服务器的授权回调时发出的信号：data 包含从服务器收到的值。

void QAbstractOAuth2::clearNetworkRequestModifier()

清除网络请求修改器。

另请参阅 setNetworkRequestModifier()。

[virtual invokable] QUrl QAbstractOAuth2::createAuthenticatedUrl(const QUrl &url, const QVariantMap &parameters = QVariantMap())

返回的 URL 基于url ，并与给定的parameters 和访问令牌相结合。

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::deleteResource(const QUrl &url, const QVariantMap &parameters = QVariantMap())

该函数计划在 6.11 版本中停用。

重实现：QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap &parameters).

请直接使用QtNetwork 类，参见HTTP 方法替代方法。

发送经过验证的 DELETE 请求，并返回一个新的QNetworkReply 。url 和parameters 用于创建请求。

另请参阅 超文本传输协议 - HTTP/1.1：DELETE

[signal, until 6.13] void QAbstractOAuth2::error(const QString &error, const QString &errorDescription, const QUrl &uri)

该函数计划在 6.13 版本中停用。

请使用serverReportedErrorOccurred 代替

当服务器以RFC 6749 错误响应中定义的错误响应授权请求时发出的信号。

error 是错误的名称； 描述了该错误； 是一个可选的 URI，包含有关该错误的更多信息。errorDescription uri

另请参阅 QAbstractOAuth::requestFailed() 和QAbstractOAuth2::serverReportedErrorOccurred()。

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::get(const QUrl &url, const QVariantMap &parameters = QVariantMap())

该函数计划在 6.11 版本中停用。

重实现：QAbstractOAuth::get(const QUrl &url, const QVariantMap &parameters).

请直接使用QtNetwork 类，参见HTTP 方法替代方法。

发送经过验证的 GET 请求，并返回一个新的QNetworkReply 。url 和parameters 用于创建请求。

另请参阅 超文本传输协议 - HTTP/1.1：GET

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::head(const QUrl &url, const QVariantMap &parameters = QVariantMap())

该函数计划在 6.11 版本中停用。

重实现：QAbstractOAuth::head(const QUrl &url, const QVariantMap &parameters).

请直接使用QtNetwork 类，参见HTTP 方法替代方法。

发送一个经过验证的 HEAD 请求，并返回一个新的QNetworkReply 。url 和parameters 用于创建请求。

另请参阅 超文本传输协议 - HTTP/1.1：HEAD

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QVariantMap &parameters = QVariantMap())

该函数计划在 6.11 版本中停用。

重实现：QAbstractOAuth::post(const QUrl &url, const QVariantMap &parameters).

请直接使用QtNetwork 类，参见HTTP 方法替代方法。

发送经过验证的 POST 请求，并返回一个新的QNetworkReply 。url 和parameters 用于创建请求。

另请参阅 超文本传输协议 - HTTP/1.1：POST

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, QHttpMultiPart *multiPart)

该函数计划在 6.11 版中废弃。

请直接使用QtNetwork 类，参见HTTP 方法替代方案。

这是一个重载函数。

发送一个经过验证的 POST 请求，并返回一个新的QNetworkReply 。url 和multiPart 用于创建请求。

{超文本传输协议 - HTTP/1.1：POST}

另请参阅 post(),QHttpMultiPart, 和https://tools.ietf.org/html/rfc2616#section-9.6。

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QByteArray &data)

该函数计划在 6.11 版中废弃。

请直接使用QtNetwork 类，参见HTTP 方法替代方案。

这是一个重载函数。

发送一个经过验证的 POST 请求，并返回一个新的QNetworkReply 。url 和data 用于创建请求。

{超文本传输协议 - HTTP/1.1：POST}

另请参阅 post() 和https://tools.ietf.org/html/rfc2616#section-9.6。

[override virtual] void QAbstractOAuth2::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())

重实现：QAbstractOAuth::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body).

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QVariantMap &parameters = QVariantMap())

该函数计划在 6.11 版本中停用。

重实现：QAbstractOAuth::put(const QUrl &url, const QVariantMap &parameters).

请直接使用QtNetwork 类，参见HTTP 方法替代方法。

发送经过验证的 PUT 请求并返回一个新的QNetworkReply 。url 和parameters 用于创建请求。

另请参阅 超文本传输协议 - HTTP/1.1：PUT

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, QHttpMultiPart *multiPart)

该函数计划在 6.11 版中废弃。

请直接使用QtNetwork 类，参见HTTP 方法替代方案。

这是一个重载函数。

发送一个经过验证的 PUT 请求，并返回一个新的QNetworkReply 。url 和multiPart 用于创建请求。

{超文本传输协议 - HTTP/1.1：PUT}

另请参阅 put(),QHttpMultiPart, 和https://tools.ietf.org/html/rfc2616#section-9.6。

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QByteArray &data)

该函数计划在 6.11 版中废弃。

请直接使用QtNetwork 类，参见HTTP 方法替代方案。

这是一个重载函数。

发送一个经过验证的 PUT 请求，并返回一个新的QNetworkReply 。url 和data 用于创建请求。

{超文本传输协议 - HTTP/1.1：PUT}

另请参阅 put() 和https://tools.ietf.org/html/rfc2616#section-9.6。

QString QAbstractOAuth2::refreshToken() const

获取当前刷新令牌。

刷新令牌的有效期通常比访问令牌长，因此保存刷新令牌以供日后使用是合理的。

返回当前刷新令牌，如果没有可用的刷新令牌，则返回空字符串。

另请参阅 setRefreshToken()。

[slot, since 6.9] void QAbstractOAuth2::refreshTokens()

调用该函数刷新令牌。该函数调用refreshTokensImplementation() 来执行实际刷新。

此函数在 Qt 6.9 中引入。

另请参阅 refreshTokensImplementation() 和autoRefresh 。

[protected slot, since 6.9] void QAbstractOAuth2::refreshTokensImplementation()

refreshTokens() 调用此槽来发送令牌刷新请求。

派生类应重新实现此槽，以支持令牌刷新：

classMyClass :publicQAbstractOAuth2 { ...protectedQ_SLOTS:voidrefreshTokensImplementation() QT7_ONLY(override); };voidMyClass::refreshTokensImplementation(){
    qDebug("refresh");
}

此函数在 Qt 6.9 中引入。

另请参阅 autoRefresh 和accessTokenAboutToExpire()。

QString QAbstractOAuth2::responseType() const

返回使用的response_type。

[signal, since 6.9] void QAbstractOAuth2::serverReportedErrorOccurred(const QString &error, const QString &errorDescription, const QUrl &uri)

当服务器以RFC 6749 错误响应中定义的错误响应授权请求时发出的信号。

error 是错误的名称； 描述了错误； 是一个可选的 URI，包含有关错误的更多信息。errorDescription uri

要使用单个信号捕获所有错误（包括这些 RFC 定义的错误），请使用QAbstractOAuth::requestFailed() 。

此函数在 Qt 6.9 中引入。

[since 6.9] template <typename Functor, QAbstractOAuth2::if_compatible_callback<Functor> = true> void QAbstractOAuth2::setNetworkRequestModifier(const QAbstractOAuth2::ContextTypeForFunctor<Functor> *context, Functor &&callback)

将网络请求修改功能设置为callback 。该功能用于定制发送到服务器的网络请求。

callback 必须实现签名 。 可以是函数指针、lambda、成员函数或任何可调用对象。所提供的 可用于检查请求与哪个阶段有关（令牌请求、令牌刷新请求或 中的授权请求）。void(QNetworkRequest&, QAbstractOAuth::Stage) QNetworkRequest callback QAbstractOAuth::Stage QOAuth2DeviceAuthorizationFlow

context 在 被销毁的情况下，"...... "将控制调用的生命周期，并防止访问已解除分配的资源。换句话说，如果作为上下文提供的对象被销毁，回调将不会被执行。 必须指向一个有效的 （如果回调是一个成员函数，则需要实际拥有该成员函数）。由于回调的结果会立即被使用，因此 必须与 实例位于同一线程中。context context QObject context QAbstractOAuth2

该函数在 Qt 6.9 中引入。

另请参阅 clearNetworkRequestModifier() 和QNetworkRequest。

void QAbstractOAuth2::setRefreshToken(const QString &refreshToken)

设置要使用的新刷新令牌refreshToken 。

可使用自定义刷新令牌通过此方法刷新访问令牌，然后通过refreshTokens() 刷新访问令牌。

另请参阅 refreshToken()。

[since 6.5] void QAbstractOAuth2::setSslConfiguration(const QSslConfiguration &configuration)

设置在客户端与授权服务器之间建立相互 TLS 连接时使用的 TLSconfiguration 。

此函数在 Qt 6.5 中引入。

另请参阅 sslConfiguration() 和sslConfigurationChanged()。

[since 6.5] QSslConfiguration QAbstractOAuth2::sslConfiguration() const

返回在客户端与授权服务器之间建立相互 TLS 连接时使用的 TLS 配置。

此函数在 Qt 6.5 中引入。

另请参阅 setSslConfiguration() 和sslConfigurationChanged()。

[signal, since 6.5] void QAbstractOAuth2::sslConfigurationChanged(const QSslConfiguration &configuration)

该信号在 TLS 配置发生变化时发出。configuration 参数包含新的 TLS 配置。

该函数在 Qt 6.5 中引入。

另请参阅 sslConfiguration() 和setSslConfiguration()。