QAbstractOAuth2 Class

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, since 6.9] void QAbstractOAuth2::accessTokenAboutToExpire()

Das Signal wird ausgegeben, wenn das Zugangstoken in Kürze abläuft.

Die Ausgabe dieses Signals setzt voraus, dass das Zugriffstoken eine gültige Verfallszeit hat. Eine Alternative zur manuellen Handhabung dieses Signals ist die Verwendung von autoRefresh.

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch refreshLeadTime, autoRefresh, und refreshTokens().

[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.

void QAbstractOAuth2::clearNetworkRequestModifier()

Löscht den Netzanforderungsmodifikator.

Siehe auch setNetworkRequestModifier().

[virtual invokable] QUrl QAbstractOAuth2::createAuthenticatedUrl(const QUrl &url, const QVariantMap &parameters = QVariantMap())

Die zurückgegebene URL basiert auf url und kombiniert diese mit dem angegebenen parameters und dem Zugriffstoken.

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

Diese Funktion soll in Version 6.11 veraltet sein.

Reimplements: QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap &parameters).

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

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

Diese Funktion soll in Version 6.13 veraltet sein.

Verwenden Sie stattdessen serverReportedErrorOccurred

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() und QAbstractOAuth2::serverReportedErrorOccurred().

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

Diese Funktion soll in Version 6.11 veraltet sein.

Reimplements: QAbstractOAuth::get(const QUrl &url, const QVariantMap &parameters).

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

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

Diese Funktion soll in Version 6.11 veraltet sein.

Reimplements: QAbstractOAuth::head(const QUrl &url, const QVariantMap &parameters).

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

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

Diese Funktion soll in Version 6.11 veraltet sein.

Reimplements: QAbstractOAuth::post(const QUrl &url, const QVariantMap &parameters).

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

[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}

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}

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 &parameters = QVariantMap())

Diese Funktion soll in Version 6.11 veraltet sein.

Reimplements: QAbstractOAuth::put(const QUrl &url, const QVariantMap &parameters).

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

[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}

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}

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.

Siehe auch setRefreshToken().

[slot, since 6.9] void QAbstractOAuth2::refreshTokens()

Rufen Sie diese Funktion auf, um die Token zu aktualisieren. Die Funktion ruft refreshTokensImplementation() auf, um die eigentliche Aktualisierung durchzuführen.

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch refreshTokensImplementation() und autoRefresh.

[protected slot, since 6.9] void QAbstractOAuth2::refreshTokensImplementation()

Dieser Slot wird von refreshTokens() aufgerufen, um die Token-Aktualisierungsanforderung zu senden.

Die abgeleiteten Klassen sollten diesen Slot reimplementieren, um die Token-Aktualisierung zu unterstützen:

class MyClass : public QAbstractOAuth2 { ...protected Q_SLOTS: void refreshTokensImplementation() QT7_ONLY(override); };void MyClass::refreshTokensImplementation(){
    qDebug("refresh");
}

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch autoRefresh und accessTokenAboutToExpire().

QString QAbstractOAuth2::responseType() const

Gibt den verwendeten response_type zurück.

[signal, since 6.9] void QAbstractOAuth2::serverReportedErrorOccurred(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.

Um alle Fehler, einschließlich dieser RFC definierten Fehler, mit einem einzigen Signal abzufangen, verwenden Sie QAbstractOAuth::requestFailed().

Diese Funktion wurde in Qt 6.9 eingeführt.

[since 6.9] template <typename Functor, QAbstractOAuth2::if_compatible_callback<Functor> = true> void QAbstractOAuth2::setNetworkRequestModifier(const QAbstractOAuth2::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Setzt die Funktion zur Änderung von Netzwerkanfragen auf callback. Diese Funktion wird zur Anpassung der an den Server gesendeten Netzwerkanfragen verwendet.

callback muss die Signatur void(QNetworkRequest&, QAbstractOAuth::Stage) implementieren. Die bereitgestellte QNetworkRequest kann direkt geändert werden und wird direkt nach Beendigung des Rückrufs verwendet. callback kann ein Funktionszeiger, Lambda, eine Mitgliedsfunktion oder ein beliebiges aufrufbares Objekt sein. Die bereitgestellte QAbstractOAuth::Stage kann verwendet werden, um zu prüfen, auf welche Stufe sich die Anforderung bezieht (Token-Anforderung, Token-Auffrischungsanforderung oder Autorisierungsanforderung im Falle von QOAuth2DeviceAuthorizationFlow).

context kontrolliert die Lebensdauer der Aufrufe und verhindert den Zugriff auf freigegebene Ressourcen, falls context zerstört wird. Mit anderen Worten, wenn das als Kontext bereitgestellte Objekt zerstört wird, werden die Callbacks nicht ausgeführt. context muss auf ein gültiges QObject verweisen (und falls der Callback eine Mitgliedsfunktion ist, muss er diese auch haben). Da die Ergebnisse des Callbacks sofort verwendet werden, muss sich context im selben Thread wie die QAbstractOAuth2 Instanz befinden.

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch clearNetworkRequestModifier() und QNetworkRequest.

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 refreshTokens() aktualisiert werden.

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