QOAuthUriSchemeReplyHandler Class

QOAuth2AuthorizationCodeFlow m_oauth;
QOAuthUriSchemeReplyHandler m_handler;

m_oauth.setAuthorizationUrl(QUrl(authorizationUrl));
m_oauth.setTokenUrl(QUrl(accessTokenUrl));
m_oauth.setClientIdentifier(clientIdentifier);
m_oauth.setRequestedScopeTokens({scope});

connect(&m_oauth, &QAbstractOAuth::authorizeWithBrowser, this, &QDesktopServices::openUrl);
connect(&m_oauth, &QAbstractOAuth::granted, this, [this]() {
    // Here we use QNetworkRequestFactory to store the access token
    m_api.setBearerToken(m_oauth.token().toLatin1());
    m_handler.close();
});

m_handler.setRedirectUrl(QUrl{"com.example.myqtapp://oauth2redirect"_L1});
m_oauth.setReplyHandler(&m_handler);

// Initiate the authorization
if (m_handler.listen()) {
    m_oauth.grant();
}

// Example with path:
com.example.myapp:/oauth2/callback
// Example with host:
com.example.myapp://oauth2.callback

https://myapp.example.com/oauth2/callback

成员函数文档

QOAuthUriSchemeReplyHandler::QOAuthUriSchemeReplyHandler()

创建一个 QOAuthUriSchemeReplyHandler 对象，其 `callback` 和 `redirectUrl` 均为空，且没有父对象。该对象不会自动监听。

[explicit] QOAuthUriSchemeReplyHandler::QOAuthUriSchemeReplyHandler(QObject *parent)

使用parent 以及空的callback()/redirectUrl() 构造一个 QOAuthUriSchemeReplyHandler 对象。该构造对象不会自动监听。

[explicit] QOAuthUriSchemeReplyHandler::QOAuthUriSchemeReplyHandler(const QUrl &redirectUrl, QObject *parent = nullptr)

创建一个 QOAuthUriSchemeReplyHandler 对象，并将parent 设为父对象，redirectUrl 设为重定向 URL。该对象会自动尝试监听。

另请参阅 redirectUrl()、setRedirectUrl()、listen() 和isListening()。

[override virtual noexcept] QOAuthUriSchemeReplyHandler::~QOAuthUriSchemeReplyHandler()

销毁QOAuthUriSchemeReplyHandler 对象。关闭此处理程序。

另请参阅 close()。

void QOAuthUriSchemeReplyHandler::close()

指示该处理程序停止监听传入的 URL。

另请参阅 listen() 和isListening()。

[since 6.9] bool QOAuthUriSchemeReplyHandler::handleAuthorizationRedirect(const QUrl &url)

此函数用于提供授权服务器在授权阶段结束时提供的重定向 URL。所提供的url 将经过与redirectUrl 中描述相同的 URL 匹配过程。

在某些场景下，提供该 URL 可能很有用，例如当该重定向 URL 通过其他方式被捕获时，比如 Qt WebEngine 或通过其他自定义安排。这样，此类代理的使用便可与 OAuth2 流程的其余部分集成。

该处理程序无需保持监听状态，因此建议调用close() 方法来关闭处理程序，以避免不必要的监听。

如果 URL 匹配且已被处理，则返回true ；否则返回false 。

另请参阅使用Qt WebEngine 的重定向 URI 方案。

该函数在 Qt 6.9 中引入。

[noexcept] bool QOAuthUriSchemeReplyHandler::isListening() const

如果该处理程序当前正在监听，则返回true ；否则返回false 。

另请参阅 listen() 和close()。

bool QOAuthUriSchemeReplyHandler::listen()

指示该处理程序监听传入的 URL。若监听成功，则返回true ；否则返回false 。

该处理程序将通过redirectUrl() 函数对 URL 进行匹配。如果接收到的 URL 不匹配，则将其转发给 QDesktopServices::openURL()。

仅在执行初始授权阶段时才需要进行主动监听，该阶段通常由QOAuth2AuthorizationCodeFlow::grant() 调用触发。

建议在授权成功后关闭监听器。对于acquiring access tokens ，无需进行监听。