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 インスタンスを破棄します。

QUrl QOAuth2AuthorizationCodeFlow::accessTokenUrl() const

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

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

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

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

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

を使用して認証リクエストで使用する認証 URL を生成します：QAbstractOAuth::grant().

The OAuth 2.0 Authorization Frameworkで説明されている認証フローを開始します。

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

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

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

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

[slot] void QOAuth2AuthorizationCodeFlow::refreshAccessToken()

トークンをリフレッシュするには、この関数を呼び出します。アクセストークンは永続的ではありません。アクセストークンの取得時に指定された時間が経過すると、アクセストークンは無効になります。

トークンのリフレッシュに失敗し、アクセストークンが存在する場合、ステータスはQAbstractOAuth::Status::Granted に設定され、そうでない場合はQAbstractOAuth::Status::NotAuthenticated に設定されます。

QAbstractOAuth::requestFailed()およびRefresh Tokenも参照のこと 。

[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() シグナルを発行し、ユーザの操作を要求します。

void QOAuth2AuthorizationCodeFlow::setAccessTokenUrl(const QUrl &accessTokenUrl)

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

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

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

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

オプションとして、length パラメータを使用して、code_verifier の長さを設定することができる。 値は 43 バイトから 128 バイトの間でなければならない。コード・ベリファイア」自体は、ライブラリによってランダムに生成されます。

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

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