QAbstractOAuth2 Class
QAbstractOAuth2 クラスは、OAuth 2 認証メソッドのすべての実装のベースとなるものです。詳細...
| ヘッダ | #include <QAbstractOAuth2> |
| CMake： | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth)target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake： | QT += networkauth |
| を継承する： | QAbstractOAuth |
| 継承元： |
プロパティ
|
パブリック関数
| QAbstractOAuth2(QObject *parent = nullptr) | |
| QAbstractOAuth2(QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| virtual | ~QAbstractOAuth2() |
| QString | clientIdentifierSharedKey() const |
| virtual QUrl | createAuthenticatedUrl(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) |
| QDateTime | expirationAt() const |
(until 6.11) virtual QNetworkReply * | post(const QUrl &url, QHttpMultiPart *multiPart) |
(until 6.11) virtual QNetworkReply * | post(const QUrl &url, const QByteArray &data) |
(until 6.11) virtual QNetworkReply * | put(const QUrl &url, QHttpMultiPart *multiPart) |
(until 6.11) virtual QNetworkReply * | put(const QUrl &url, const QByteArray &data) |
| QString | refreshToken() const |
| QString | responseType() const |
| QString | scope() const |
| void | setClientIdentifierSharedKey(const QString &clientIdentifierSharedKey) |
| void | setRefreshToken(const QString &refreshToken) |
| void | setScope(const QString &scope) |
(since 6.5) void | setSslConfiguration(const QSslConfiguration &configuration) |
| void | setState(const QString &state) |
| void | setUserAgent(const QString &userAgent) |
(since 6.5) QSslConfiguration | sslConfiguration() const |
| QString | state() const |
| QString | userAgent() const |
再実装パブリック関数
(until 6.11) virtual QNetworkReply * | deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
(until 6.11) virtual QNetworkReply * | get(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
(until 6.11) virtual QNetworkReply * | head(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
(until 6.11) virtual QNetworkReply * | post(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual void | prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray()) override |
(until 6.11) virtual QNetworkReply * | put(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
シグナル
| void | authorizationCallbackReceived(const QVariantMap &data) |
| void | clientIdentifierSharedKeyChanged(const QString &clientIdentifierSharedKey) |
| void | error(const QString &error, const QString &errorDescription, const QUrl &uri) |
| void | expirationAtChanged(const QDateTime &expiration) |
| void | refreshTokenChanged(const QString &refreshToken) |
| void | scopeChanged(const QString &scope) |
(since 6.5) void | sslConfigurationChanged(const QSslConfiguration &configuration) |
| void | stateChanged(const QString &state) |
| void | userAgentChanged(const QString &userAgent) |
詳細説明
このクラスは OAuth 2 認証クラスの基本的なインターフェイスを定義します。このクラスを継承することで、さまざまなウェブサービス用の OAuth 2 標準を使用したカスタム認証メソッドを作成することができます。
OAuth 2 の仕組みについてはOAuth 2.0 認証フレームワーク
プロパティのドキュメント
clientIdentifierSharedKey : QString
このプロパティは、サーバがトークンを要求する際に認証を必要とする場合に、パスワードとして使用されるクライアント共有鍵を保持する。
アクセス関数
| QString | clientIdentifierSharedKey() const |
| void | setClientIdentifierSharedKey(const QString &clientIdentifierSharedKey) |
通知シグナル
| void | clientIdentifierSharedKeyChanged(const QString &clientIdentifierSharedKey) |
[read-only] expiration : const QDateTime
このプロパティは、現在のアクセストークンの有効期限を保持します。無効な値は、認証サーバが有効な有効期限を提供していないことを意味します。
アクセス関数：
| QDateTime | expirationAt() const |
Notifier シグナル：
| void | expirationAtChanged(const QDateTime &expiration) |
QDateTime::isValid()も参照 。
scope : QString
このプロパティは、クライアントが要求するパーミッションを定義する、希望するスコープを保持する。
スコープ値は、認可サーバから付与されたスコープ値に更新される。スコープ応答が空の場合、要求されたスコープは許可されたものとみなされ、変更されません。
アクセス関数
| QString | scope() const |
| void | setScope(const QString &scope) |
通知シグナル
| void | scopeChanged(const QString &scope) |
state : QString
このプロパティは、認証中にサーバに送信される文字列を保持する。この状態は、コールバックを受信した際にリクエストを識別し、検証するために使用されます。
アクセス関数：
| QString | state() const |
| void | setState(const QString &state) |
Notifier シグナル：
| void | stateChanged(const QString &state) |
userAgent : QString
このプロパティは、ネットワークリクエストの作成に使用される User-Agent ヘッダを保持します。
デフォルト値は "QtOAuth/1.0 (+https://www.qt.io) "です。
アクセス関数
| QString | userAgent() const |
| void | setUserAgent(const QString &userAgent) |
Notifier シグナル：
| void | userAgentChanged(const QString &userAgent) |
メンバ関数ドキュメント
[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] void QAbstractOAuth2::authorizationCallbackReceived(const QVariantMap &data)
リプライサーバーがサーバーから認可コールバックを受信したときに発せられるシグナル。data はサーバーから受信した値を含む。
[virtual invokable] QUrl QAbstractOAuth2::createAuthenticatedUrl(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
返される URL はurl を元に、与えられたparameters とアクセストークンを組み合わせたものです。
注： この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
この関数はバージョン6.11で廃止予定です。
再インプリメントです：QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap ¶meters) を再実装しています。
代わりにQtNetwork クラスを直接使用してください。
認証された DELETE リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。
こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照のこと：DELETE
注意: この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
[signal] void QAbstractOAuth2::error(const QString &error, const QString &errorDescription, const QUrl &uri)
RFC 6749のエラー応答に定義されているように、サーバーが認可リクエストに対して エラーを応答したときに発行されるシグナル。
error はエラーの名前である。 はエラーを説明し、 はエラーに関する詳細情報を含むオプションのURIである。errorDescription uri
QAbstractOAuth::requestFailed()も参照のこと 。
[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::get(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
この関数はバージョン6.11で廃止予定です。
再インプリメントです：QAbstractOAuth::get(const QUrl &url, const QVariantMap ¶meters) を再実装しています。
代わりにQtNetwork クラスを直接使用してください。
認証された GET リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。
こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください：GET
注意： この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::head(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
この関数はバージョン6.11で廃止予定です。
再インプリメントです：QAbstractOAuth::head(const QUrl &url, const QVariantMap ¶meters)を再実装しています。
代わりにQtNetwork クラスを直接使用してください。
認証された HEAD リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使われます。
こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照のこと：HEAD
注意: この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
この関数はバージョン6.11で廃止予定です。
再インプリメントです：QAbstractOAuth::post(const QUrl &url, const QVariantMap ¶meters) を再実装しています。
代わりにQtNetwork クラスを直接使用してください。
認証された POST リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。
こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください：POST
注意： この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, QHttpMultiPart *multiPart)
この関数はバージョン6.11で廃止予定です。
代わりにQtNetwork クラスを直接使用してください。
これはオーバーロードされた関数です。
認証された POST リクエストを送信し、新しいQNetworkReply を返します。リクエストの作成にはurl とmultiPart が使われます。
{ハイパーテキスト転送プロトコル - HTTP/1.1：POST｝
注意： この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
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｝
注意： この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
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 ¶meters = QVariantMap())
この関数はバージョン6.11で廃止予定です。
再インプリメントです：QAbstractOAuth::put(const QUrl &url, const QVariantMap ¶meters) を再実装しています。
代わりにQtNetwork クラスを直接使用してください。
認証された PUT リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。
こちらも参照してください：ハイパーテキスト転送プロトコル - HTTP/1.1 も参照のこと：PUT
注意: この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, QHttpMultiPart *multiPart)
この関数はバージョン6.11で廃止予定です。
代わりにQtNetwork クラスを直接使用してください。
これはオーバーロードされた関数です。
認証された PUT リクエストを送信し、新しいQNetworkReply を返します。url とmultiPart はリクエストの作成に使用されます。
{ハイパーテキスト転送プロトコル - HTTP/1.1：PUT｝
注意： この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
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｝
注意： この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
put() およびhttps://tools.ietf.org/html/rfc2616#section-9.6も参照してください 。
QString QAbstractOAuth2::refreshToken() const
現在のリフレッシュトークンを取得します。
リフレッシュトークンは通常、アクセストークンよりも寿命が長いので、 後で使うために保存しておくことは理にかなっています。
現在のリフレッシュ・トークン、あるいは利用可能なリフレッシュ・トークンがない場合は空の文字列を返します。
注意: プロパティ refreshToken のゲッター関数です。
setRefreshToken()も参照してください 。
QString QAbstractOAuth2::responseType() const
使用したresponse_type を返します。
void QAbstractOAuth2::setRefreshToken(const QString &refreshToken)
使用する新しいリフレッシュ・トークンrefreshToken を設定します。
カスタムのリフレッシュ・トークンを使用して、このメソッドでアクセストークンをリフレッシュし、QOAuth2AuthorizationCodeFlow::refreshAccessToken() でアクセストークンをリフレッシュすることができます。
注: プロパティrefreshToken のセッター関数です。
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()も参照してください 。
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
