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()

再インプリメント：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も参照してください 。