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 とアクセストークンを組み合わせたものです。

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::deleteResource(const QUrl &url, const QVariantMap &parameters = QVariantMap())

この関数はバージョン6.11で廃止予定です。

再インプリメントです：QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap &parameters) を再実装しています。

代わりにQtNetwork クラスを直接使用してください。

認証された DELETE リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。

こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照のこと：DELETE

[signal, until 6.13] void QAbstractOAuth2::error(const QString &error, const QString &errorDescription, const QUrl &uri)

この関数はバージョン6.13で廃止予定です。

代わりにserverReportedErrorOccurred を使用してください。

RFC 6749 のエラー応答に定義されているように、サーバが認可リクエストに対して エラーを応答したときに発行されるシグナルです。

error はエラーの名前である。 はエラーを説明し、 はエラーに関する詳細情報を含むオプションのURIである。errorDescription uri

QAbstractOAuth::requestFailed() およびQAbstractOAuth2::serverReportedErrorOccurred()も参照の こと。

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::get(const QUrl &url, const QVariantMap &parameters = QVariantMap())

この関数はバージョン6.11で廃止予定です。

再インプリメントです：QAbstractOAuth::get(const QUrl &url, const QVariantMap &parameters) を再実装しています。

代わりにQtNetwork クラスを直接使用してください。

認証された GET リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。

こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください：GET

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::head(const QUrl &url, const QVariantMap &parameters = QVariantMap())

この関数はバージョン6.11で廃止予定です。

再インプリメントです：QAbstractOAuth::head(const QUrl &url, const QVariantMap &parameters) を再実装しています。

代わりにQtNetwork クラスを直接使用してください。

認証された HEAD リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使われます。

こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照のこと：HEAD

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QVariantMap &parameters = QVariantMap())

この関数はバージョン6.11で廃止予定です。

再インプリメントです：QAbstractOAuth::post(const QUrl &url, const QVariantMap &parameters) を再実装しています。

代わりにQtNetwork クラスを直接使用してください。

認証された POST リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。

こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください：POST

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, QHttpMultiPart *multiPart)

この関数はバージョン6.11で廃止予定です。

代わりにQtNetwork クラスを直接使用してください。

これはオーバーロードされた関数です。

認証された POST リクエストを送信し、新しいQNetworkReply を返します。リクエストの作成にはurl とmultiPart が使われます。

{ハイパーテキスト転送プロトコル - HTTP/1.1：POST｝

post()、QHttpMultiPart 、https://tools.ietf.org/html/rfc2616#section-9.6 も参照してください。

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QByteArray &data)

この関数はバージョン6.11で廃止予定です。

代わりにQtNetwork クラスを直接使用してください。

これはオーバーロードされた関数です。

認証された POST リクエストを送信し、新しいQNetworkReply を返します。リクエストの作成にはurl とdata が使われます。

{ハイパーテキスト転送プロトコル - HTTP/1.1：POST｝

post() およびhttps://tools.ietf.org/html/rfc2616#section-9.6 も参照して ください。

[override virtual] void QAbstractOAuth2::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())

再実装：QAbstractOAuth::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body).

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QVariantMap &parameters = QVariantMap())

この関数はバージョン6.11で廃止予定です。

再インプリメントです：QAbstractOAuth::put(const QUrl &url, const QVariantMap &parameters) を再実装しています。

代わりにQtNetwork クラスを直接使用してください。

認証された PUT リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。

こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照のこと：PUT

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, QHttpMultiPart *multiPart)

この関数はバージョン6.11で廃止予定です。

代わりにQtNetwork クラスを直接使用してください。

これはオーバーロードされた関数です。

認証された PUT リクエストを送信し、新しいQNetworkReply を返します。url とmultiPart はリクエストの作成に使用されます。

{ハイパーテキスト転送プロトコル - HTTP/1.1：PUT｝

put()、QHttpMultiPart 、https://tools.ietf.org/html/rfc2616#section-9.6 も参照してください。

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QByteArray &data)

この関数はバージョン6.11で廃止予定です。

代わりにQtNetwork クラスを直接使用してください。

これはオーバーロードされた関数です。

認証された PUT リクエストを送信し、新しいQNetworkReply を返します。url とdata はリクエストの作成に使用されます。

{ハイパーテキスト転送プロトコル - HTTP/1.1：PUT｝

put() およびhttps://tools.ietf.org/html/rfc2616#section-9.6も参照してください 。

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 はエラーの名前である。 はエラーを説明し、 はエラーの詳細情報を含むオプションのURIである。errorDescription uri

これらのRFCで定義されたエラーを含むすべてのエラーを1つのシグナルでキャッチするには、QAbstractOAuth::requestFailed()を使用してください。

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

[since 6.9] template <typename Functor, QAbstractOAuth2::if_compatible_callback<Functor> = true> 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()も参照してください 。