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 以及访问令牌相结合。

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

该函数计划在 6.13 版本中被废弃。

请改用serverReportedErrorOccurred

当授权服务器在处理授权或令牌请求（包括令牌刷新请求）时报告错误，会触发此信号，具体定义参见RFC 6749 中的错误响应。

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

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

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

重写了：QAbstractOAuth::prepareRequest （QNetworkRequest *request, const QByteArray &verb, const QByteArray &body）。

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 是错误的名称；errorDescription 描述了该错误，而uri 是一个可选的 URI，其中包含有关该错误的更多信息。

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

该函数在 Qt 6.9 中引入。

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

将网络请求修改函数设置为callback 。该函数用于自定义发送到服务器的网络请求。

callback 必须实现void(QNetworkRequest&, QAbstractOAuth::Stage) 接口。提供的QNetworkRequest 参数可直接修改，且会在回调函数执行完成后立即被使用。callback 可以是函数指针、lambda表达式、成员函数或任何可调用的对象。提供的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()。