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 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()も参照してください 。