QOAuth2DeviceAuthorizationFlow Class

m_deviceFlow.setAuthorizationUrl(QUrl(authorizationUrl));
m_deviceFlow.setTokenUrl(QUrl(accessTokenUrl));
m_deviceFlow.setRequestedScopeTokens({scope});
m_deviceFlow.setClientIdentifier(clientIdentifier);
// The need for a client secret depends on the authorization server
m_deviceFlow.setClientIdentifierSharedKey(clientSecret);

connect(&m_deviceFlow, &QOAuth2DeviceAuthorizationFlow::authorizeWithUserCode, this,
    [](constQUrl&verificationUrl, constQString&userCode, constQUrl&completeVerificationUrl) {
        if(completeVerificationUrl.isValid()) {
            // 如果授权服务器提供了一个完整的 URL，
            // 且该 URL 参数中已包含必要数据，
            // 则可以选择使用该 URL
            qDebug() << "Complete verification uri:" << completeVerificationUrl;
        }else{
            // 授权服务器仅提供了验证 URL；使用该 URL
            qDebug() << "Verification uri and usercode:" << verificationUrl << userCode;
        }
    }
);

connect(&m_deviceFlow, &QAbstractOAuth::requestFailed, this, [](QAbstractOAuth::Error error) {
    Q_UNUSED(error);
    // Handle error
});

connect(&m_deviceFlow, &QAbstractOAuth2::serverReportedErrorOccurred, this,
    [](const QString &error, const QString &errorDescription, const QUrl &uri) {
        // Check server reported error details if needed
        Q_UNUSED(error);
        Q_UNUSED(errorDescription);
        Q_UNUSED(uri);
    }
);

connect(&m_deviceFlow, &QAbstractOAuth::granted, this, [this](){
    // Here we use QNetworkRequestFactory to store the access token
    m_api.setBearerToken(m_deviceFlow.token().toLatin1());
});
m_deviceFlow.grant();

成员函数文档

QOAuth2DeviceAuthorizationFlow::QOAuth2DeviceAuthorizationFlow()

创建一个 QOAuth2DeviceAuthorizationFlow 对象。

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

创建一个 QOAuth2DeviceAuthorizationFlow 对象，其父对象为parent 。

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

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

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

销毁QOAuth2DeviceAuthorizationFlow 实例。

[signal] void QOAuth2DeviceAuthorizationFlow::authorizeWithUserCode(const QUrl &verificationUrl, const QString &userCode, const QUrl &completeVerificationUrl)

当用户需要完成授权时，会发出此信号。

如果授权服务器提供了completeVerificationUrl ，用户可以导航至该 URL。该 URL 包含所需的userCode 以及任何其他必需的参数。

或者，用户需要访问verificationUrl 并手动输入userCode 。

另请参阅 Device Flow Usage 。

[override virtual slot] void QOAuth2DeviceAuthorizationFlow::grant()

重写了：QAbstractOAuth::grant()。

启动《设备授权 RFC》中所述的授权流程。

该流程包括以下步骤：

• 向授权服务器发送授权请求
• 用户授权访问，详见authorizeWithUserCode()
• 持续轮询授权服务器，直至用户接受或拒绝授权（或代码过期）
• 向应用程序返回结果（参见granted() 和QAbstractOAuth::requestFailed())

该流程会自动从授权阶段过渡到令牌轮询阶段。

调用此函数将重置任何先前的授权数据。

另请参阅 authorizeWithUserCode()、granted()、QAbstractOAuth::requestFailed()、polling 、startTokenPolling()、stopTokenPolling() 和Device Flow Usage 。

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

此函数发送令牌刷新请求。

如果刷新请求成功发起，状态将设置为QAbstractOAuth::Status::RefreshingToken ；否则将发出requestFailed()信号，且状态保持不变。当isPolling 的值为true 时，无法刷新令牌。

如果令牌刷新过程已经在进行中，则此函数无效。

如果令牌刷新失败且存在访问令牌，则状态将设置为QAbstractOAuth::Status::Granted ；如果不存在访问令牌，则状态将设置为QAbstractOAuth::Status::NotAuthenticated 。

此函数在 Qt 6.9 中引入。

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

[slot] bool QOAuth2DeviceAuthorizationFlow::startTokenPolling()

开始令牌轮询。如果启动成功（或轮询已处于活动状态），则返回true ；否则返回false 。

在典型用例中无需调用此函数。一旦授权请求通过调用 `grant()` 完成，轮询将自动启动。

当需要在稍后时间恢复（重试）令牌轮询，而无需重启整个授权流程时，此函数会非常有用。例如，在发生短暂的网络连接中断时。

轮询间隔由授权服务器定义，通常为 5 秒。第一个轮询请求将在第一个间隔结束后发送。

另请参阅 polling 、stopTokenPolling() 以及Device Flow Usage 。

[slot] void QOAuth2DeviceAuthorizationFlow::stopTokenPolling()

停止令牌轮询。任何潜在的未处理轮询请求都将被静默丢弃。

另请参阅 polling 和startTokenPolling()。