QOAuth2AuthorizationCodeFlow Class

メンバ関数のドキュメント

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

親オブジェクトparent を持つQOAuth2AuthorizationCodeFlowオブジェクトを生成します。

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

parent を親としてQOAuth2AuthorizationCodeFlowオブジェクトを生成し、manager をネットワークアクセスマネージャーとして設定します。

QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, QNetworkAccessManager *manager, QObject *parent = nullptr)

parent を親としてQOAuth2AuthorizationCodeFlowオブジェクトを構築し、manager をネットワークアクセスマネージャーとして設定します。クライアント識別子はclientIdentifier に設定されます。

QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr)

parent を親としてQOAuth2AuthorizationCodeFlowオブジェクトを生成し、manager をネットワークアクセスマネージャーとして設定します。認証URLはauthenticateUrl に、アクセストークンURLはaccessTokenUrl に設定されます。

QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr)

parent を親としてQOAuth2AuthorizationCodeFlowオブジェクトを作成し、manager をネットワークアクセスマネージャーとして設定します。クライアント識別子はclientIdentifier に、認証URLはauthenticateUrl に、アクセストークンURLはaccessTokenUrl にそれぞれ設定されます。

[virtual noexcept] QOAuth2AuthorizationCodeFlow::~QOAuth2AuthorizationCodeFlow()

QOAuth2AuthorizationCodeFlow のインスタンスを破棄します。

[until 6.13] QUrl QOAuth2AuthorizationCodeFlow::accessTokenUrl() const

この関数は、バージョン 6.13 で非推奨となる予定です。

代わりに `QAbstractOAuth2::tokenUrl()` を使用してください。

アクセストークンの取得に使用された URL を返します。

setAccessTokenUrl()も参照してください 。

[protected] QUrl QOAuth2AuthorizationCodeFlow::buildAuthenticateUrl(const QMultiMap<QString, QVariant> &parameters = {})

parameters を使用して、認証リクエストで使用する認証 URL を生成します。

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

QAbstractOAuth::grant() を再実装します。

『OAuth 2.0 認証フレームワーク』に記載されているとおりに、認証フローを開始します。

[noexcept, since 6.8] QOAuth2AuthorizationCodeFlow::PkceMethod QOAuth2AuthorizationCodeFlow::pkceMethod() const

現在の PKCE メソッドを返します。

この関数は Qt 6.8 で導入されました。

setPkceMethod() およびQOAuth2AuthorizationCodeFlow::PkceMethodも参照してください 。

[slot, until 6.13] void QOAuth2AuthorizationCodeFlow::refreshAccessToken()

この関数は、バージョン 6.13 で非推奨となる予定です。

代わりにQAbstractOAuth2::refreshTokens()を使用してください。

トークンを更新するには、この関数を呼び出してください。

この関数は、refreshTokensImplementation() を呼び出します。

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

この関数は、トークンの更新リクエストを送信します。

更新リクエストが正常に開始された場合、ステータスはQAbstractOAuth::Status::RefreshingToken に設定されます。そうでない場合は、requestFailed()シグナルが発行され、ステータスは変更されません。

トークンの更新処理がすでに進行中の場合、この関数は何の効果も持ちません。

トークンの更新に失敗し、アクセストークンが存在する場合、ステータスは `QAbstractOAuth::Status::Granted` に設定され、アクセストークンが存在しない場合は `QAbstractOAuth::Status::NotAuthenticated ` に設定されます。

この関数は Qt 6.9 で導入されました。

QAbstractOAuth::requestFailed() およびQAbstractOAuth2::refreshTokens()も参照してください 。

[protected] void QOAuth2AuthorizationCodeFlow::requestAccessToken(const QString &code)

受信したcode に対してアクセストークンをリクエストします。code は、ユーザーがブラウザで認証に成功した際にレスポンスとして受信されます。

[override virtual protected] void QOAuth2AuthorizationCodeFlow::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> &parameters = {})

QAbstractOAuth::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> &parameters) を再実装します。

url およびparameters を使用して、認証用 URL を生成します。この関数は、ユーザーの操作を要求するためにauthorizeWithBrowser() シグナルを発行します。

[until 6.13] void QOAuth2AuthorizationCodeFlow::setAccessTokenUrl(const QUrl &accessTokenUrl)

この関数は、バージョン 6.13 で非推奨となる予定です。

代わりにQAbstractOAuth2::setTokenUrl() を使用してください。

アクセストークンのリクエストに使用する URL をaccessTokenUrl に設定します。

accessTokenUrl()も参照してください 。

[since 6.8] void QOAuth2AuthorizationCodeFlow::setPkceMethod(QOAuth2AuthorizationCodeFlow::PkceMethod method, qsizetype length = 43)

現在のPKCEメソッドをmethod に設定します。

オプションで、length パラメータを使用してcode_verifier の長さを設定できます。値は43～128バイトの範囲でなければなりません。「コード検証子」自体はライブラリによってランダムに生成されます。

method をPkceMethod::None またはPkceMethod::Plain に設定すると、認証コードの傍受に対する保護が弱まります。

この関数は Qt 6.8 で導入されました。

pkceMethod() およびQOAuth2AuthorizationCodeFlow::PkceMethodも参照してください 。