QAbstractOAuth2 Class
Die Klasse QAbstractOAuth2 ist die Basis für alle Implementierungen von OAuth 2-Authentifizierungsmethoden. Mehr...
| Kopfzeile: | #include <QAbstractOAuth2> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth)target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake: | QT += networkauth |
| Vererbt: | QAbstractOAuth |
| Vererbt von: |
Eigenschaften
|
Öffentliche Funktionen
| 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 |
Reimplementierte öffentliche Funktionen
(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 |
Signale
| 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) |
Detaillierte Beschreibung
Die Klasse definiert die grundlegende Schnittstelle der OAuth 2-Authentifizierungsklassen. Durch Vererbung dieser Klasse können Sie benutzerdefinierte Authentifizierungsmethoden unter Verwendung des OAuth 2-Standards für verschiedene Webdienste erstellen.
Eine Beschreibung, wie OAuth 2 funktioniert, finden Sie in: Das OAuth 2.0 Autorisierungs-Framework
Dokumentation der Eigenschaften
clientIdentifierSharedKey : QString
Diese Eigenschaft enthält den gemeinsamen Client-Schlüssel, der als Kennwort verwendet wird, wenn der Server für die Anforderung des Tokens eine Authentifizierung verlangt.
Zugriffsfunktionen:
| QString | clientIdentifierSharedKey() const |
| void | setClientIdentifierSharedKey(const QString &clientIdentifierSharedKey) |
Benachrichtigungssignal:
| void | clientIdentifierSharedKeyChanged(const QString &clientIdentifierSharedKey) |
[read-only] expiration : const QDateTime
Diese Eigenschaft enthält die Ablaufzeit des aktuellen Zugriffstokens. Ein ungültiger Wert bedeutet, dass der Autorisierungsserver keine gültige Ablaufzeit angegeben hat.
Zugriffsfunktionen:
| QDateTime | expirationAt() const |
Benachrichtigungssignal:
| void | expirationAtChanged(const QDateTime &expiration) |
Siehe auch QDateTime::isValid().
scope : QString
Diese Eigenschaft enthält den gewünschten Bereich, der die vom Client angeforderten Berechtigungen definiert.
Der Wert des Bereichs wird auf den vom Autorisierungsserver gewährten Wert aktualisiert. Im Falle einer leeren Scope-Antwort wird der angeforderte Bereich als gewährt angenommen und nicht geändert.
Zugriffsfunktionen:
| QString | scope() const |
| void | setScope(const QString &scope) |
Benachrichtigungssignal:
| void | scopeChanged(const QString &scope) |
state : QString
Diese Eigenschaft enthält die Zeichenfolge, die während der Authentifizierung an den Server gesendet wird. Der Status wird verwendet, um die Anfrage zu identifizieren und zu validieren, wenn der Callback empfangen wird.
Zugriffsfunktionen:
| QString | state() const |
| void | setState(const QString &state) |
Benachrichtigungssignal:
| void | stateChanged(const QString &state) |
userAgent : QString
Diese Eigenschaft enthält den User-Agent-Header, der für die Erstellung der Netzwerkanfragen verwendet wird.
Der Standardwert ist "QtOAuth/1.0 (+https://www.qt.io)".
Zugriffsfunktionen:
| QString | userAgent() const |
| void | setUserAgent(const QString &userAgent) |
Notifier Signal:
| void | userAgentChanged(const QString &userAgent) |
Dokumentation der Mitgliedsfunktionen
[explicit] QAbstractOAuth2::QAbstractOAuth2(QObject *parent = nullptr)
Konstruiert ein QAbstractOAuth2-Objekt mit parent als Elternteil.
[explicit] QAbstractOAuth2::QAbstractOAuth2(QNetworkAccessManager *manager, QObject *parent = nullptr)
Konstruiert ein QAbstractOAuth2-Objekt mit parent als übergeordnetem Objekt und setzt manager als Netzwerkzugriffsmanager.
[virtual noexcept] QAbstractOAuth2::~QAbstractOAuth2()
Zerstört die Instanz QAbstractOAuth2.
[signal] void QAbstractOAuth2::authorizationCallbackReceived(const QVariantMap &data)
Signal, das ausgegeben wird, wenn der Antwortserver den Autorisierungs-Callback vom Server erhält: data enthält die vom Server erhaltenen Werte.
[virtual invokable] QUrl QAbstractOAuth2::createAuthenticatedUrl(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Die zurückgegebene URL basiert auf url und kombiniert diese mit dem angegebenen parameters und dem Zugriffstoken.
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Diese Funktion soll in Version 6.11 veraltet sein.
Reimplements: QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap ¶meters).
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP Methoden Alternativen.
Sendet eine authentifizierte DELETE-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: DELETE
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
[signal] void QAbstractOAuth2::error(const QString &error, const QString &errorDescription, const QUrl &uri)
Signal, das ausgegeben wird, wenn der Server auf die Autorisierungsanfrage mit einem Fehler gemäß der Definition in RFC 6749 error response antwortet.
error ist der Name des Fehlers; errorDescription beschreibt den Fehler und uri ist ein optionaler URI, der weitere Informationen über den Fehler enthält.
Siehe auch QAbstractOAuth::requestFailed().
[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::get(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Diese Funktion soll in Version 6.11 veraltet sein.
Reimplements: QAbstractOAuth::get(const QUrl &url, const QVariantMap ¶meters).
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP Methoden Alternativen.
Sendet eine authentifizierte GET-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: GET
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::head(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Diese Funktion soll in Version 6.11 veraltet sein.
Reimplements: QAbstractOAuth::head(const QUrl &url, const QVariantMap ¶meters).
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP Methoden Alternativen.
Sendet eine authentifizierte HEAD-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: HEAD
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Diese Funktion soll in Version 6.11 veraltet sein.
Reimplements: QAbstractOAuth::post(const QUrl &url, const QVariantMap ¶meters).
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP Methoden Alternativen.
Sendet eine authentifizierte POST-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: POST
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, QHttpMultiPart *multiPart)
Diese Funktion soll in Version 6.11 abgeschafft werden.
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP-Methodenalternativen.
Dies ist eine überladene Funktion.
Sendet eine authentifizierte POST-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und multiPart werden verwendet, um die Anfrage zu erstellen.
{Hypertext Transfer Protocol - HTTP/1.1: POST}
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
Siehe auch post(), QHttpMultiPart, und https://tools.ietf.org/html/rfc2616#section-9.6.
[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QByteArray &data)
Diese Funktion soll in Version 6.11 abgeschafft werden.
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP-Methodenalternativen.
Dies ist eine überladene Funktion.
Sendet eine authentifizierte POST-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und data werden verwendet, um die Anfrage zu erstellen.
{Hypertext Transfer Protocol - HTTP/1.1: POST}
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
Siehe auch post() und https://tools.ietf.org/html/rfc2616#section-9.6.
[override virtual] void QAbstractOAuth2::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())
Reimplements: 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())
Diese Funktion soll in Version 6.11 veraltet sein.
Reimplements: QAbstractOAuth::put(const QUrl &url, const QVariantMap ¶meters).
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP Methoden Alternativen.
Sendet eine authentifizierte PUT-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: PUT
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, QHttpMultiPart *multiPart)
Diese Funktion soll in Version 6.11 abgeschafft werden.
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP-Methodenalternativen.
Dies ist eine überladene Funktion.
Sendet eine authentifizierte PUT-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und multiPart werden verwendet, um die Anfrage zu erstellen.
{Hypertext Transfer Protocol - HTTP/1.1: PUT}
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
Siehe auch put(), QHttpMultiPart, und https://tools.ietf.org/html/rfc2616#section-9.6.
[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QByteArray &data)
Diese Funktion soll in Version 6.11 abgeschafft werden.
Bitte verwenden Sie stattdessen direkt die QtNetwork Klassen, siehe HTTP-Methodenalternativen.
Dies ist eine überladene Funktion.
Sendet eine authentifizierte PUT-Anfrage und gibt eine neue QNetworkReply zurück. Die Klassen url und data werden verwendet, um die Anfrage zu erstellen.
{Hypertext Transfer Protocol - HTTP/1.1: PUT}
Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.
Siehe auch put() und https://tools.ietf.org/html/rfc2616#section-9.6.
QString QAbstractOAuth2::refreshToken() const
Ruft das aktuelle Aktualisierungs-Token ab.
Refresh-Token haben in der Regel eine längere Lebensdauer als Access-Token, daher ist es sinnvoll, sie für eine spätere Verwendung zu speichern.
Gibt das aktuelle Refresh-Token oder einen leeren String zurück, wenn kein Refresh-Token verfügbar ist.
Hinweis: Getter-Funktion für die Eigenschaft refreshToken.
Siehe auch setRefreshToken().
QString QAbstractOAuth2::responseType() const
Gibt den verwendeten response_type zurück.
void QAbstractOAuth2::setRefreshToken(const QString &refreshToken)
Legt das zu verwendende neue Aktualisierungs-Token refreshToken fest.
Ein benutzerdefiniertes Aktualisierungs-Token kann verwendet werden, um das Zugriffs-Token über diese Methode zu aktualisieren, und dann kann das Zugriffs-Token über QOAuth2AuthorizationCodeFlow::refreshAccessToken() aktualisiert werden.
Hinweis: Setter-Funktion für die Eigenschaft refreshToken.
Siehe auch refreshToken().
[since 6.5] void QAbstractOAuth2::setSslConfiguration(const QSslConfiguration &configuration)
Legt die TLS configuration fest, die beim Aufbau einer gegenseitigen TLS-Verbindung zwischen dem Client und dem Autorisierungsserver verwendet werden soll.
Diese Funktion wurde in Qt 6.5 eingeführt.
Siehe auch sslConfiguration() und sslConfigurationChanged().
[since 6.5] QSslConfiguration QAbstractOAuth2::sslConfiguration() const
Gibt die TLS-Konfiguration zurück, die beim Aufbau einer gegenseitigen TLS-Verbindung zwischen dem Client und dem Autorisierungsserver verwendet werden soll.
Diese Funktion wurde in Qt 6.5 eingeführt.
Siehe auch setSslConfiguration() und sslConfigurationChanged().
[signal, since 6.5] void QAbstractOAuth2::sslConfigurationChanged(const QSslConfiguration &configuration)
Das Signal wird ausgegeben, wenn sich die TLS-Konfiguration geändert hat. Der Parameter configuration enthält die neue TLS-Konfiguration.
Diese Funktion wurde in Qt 6.5 eingeführt.
Siehe auch sslConfiguration() und 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.
