QWebEngineWebAuthUxRequest Class
Die Klasse QWebEngineWebAuthUxRequest kapselt die Daten einer WebAuth UX-Anfrage. Mehr...
Kopfzeile: | #include <QWebEngineWebAuthUxRequest> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS WebEngineCore) target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore) |
qmake: | QT += webenginecore |
Seit: | Qt 6.7 |
In QML: | WebEngineWebAuthUxRequest |
Vererbt: | QObject |
Öffentliche Typen
enum class | PinEntryError { NoError, InternalUvLocked, WrongPin, TooShort, InvalidCharacters, SameAsCurrentPin } |
enum class | PinEntryReason { Set, Change, Challenge } |
enum class | RequestFailureReason { Timeout, KeyNotRegistered, KeyAlreadyRegistered, SoftPinBlock, HardPinBlock, …, WinUserCancelled } |
enum class | WebAuthUxState { NotStarted, SelectAccount, CollectPin, FinishTokenCollection, RequestFailed, …, Completed } |
Eigenschaften
|
Öffentliche Funktionen
QWebEngineWebAuthPinRequest | pinRequest() const |
QString | relyingPartyId() const |
QWebEngineWebAuthUxRequest::RequestFailureReason | requestFailureReason() const |
QWebEngineWebAuthUxRequest::WebAuthUxState | state() const |
QStringList | userNames() const |
Öffentliche Slots
void | cancel() |
void | retry() |
void | setPin(const QString &pin) |
void | setSelectedAccount(const QString &selectedAccount) |
Signale
void | stateChanged(QWebEngineWebAuthUxRequest::WebAuthUxState state) |
Detaillierte Beschreibung
Diese Klasse enthält die Informationen und die API für WebAuth UX. WebAuth kann eine Benutzerinteraktion während des Authentifizierungsprozesses erfordern. Diese Anfragen werden durch die Anzeige eines Dialogs an den Benutzer behandelt. QtWebEngine unterstützt derzeit Benutzerüberprüfung, residente Anmeldeinformationen und UX-Anfragen mit Anzeigefehler.
QWebEngineWebAuthUxRequest modelliert eine WebAuth UX-Anfrage während ihres gesamten Lebenszyklus, beginnend mit der Anzeige eines UX-Dialogs, der Aktualisierung seines Inhalts durch Zustandsänderungen und schließlich dem Schließen des Dialogs.
WebAuth UX-Anfragen werden normalerweise ausgelöst, wenn der Authentifikator eine Benutzerinteraktion erfordert. Es liegt in der Verantwortung von QWebEnginePage, die Anwendung über neue WebAuth UX-Anfragen zu informieren. Dies geschieht durch das Aussenden des webAuthUxRequested Signals zusammen mit einer neu erstellten QWebEngineWebAuthUxRequest. Die Anwendung kann dann diese Anfrage untersuchen und einen WebAuth UX-Dialog anzeigen.
Das QWebEngineWebAuthUxRequest-Objekt sendet in regelmäßigen Abständen das Signal stateChanged, um potenzielle Beobachter über den aktuellen WebAuth UX-Zustand zu informieren. Die Beobachter aktualisieren den WebAuth-Dialog entsprechend.
Weitere Informationen über die Handhabung von Web-Engine-Authentifizierungsanforderungen finden Sie im Simple Browser.
Dokumentation der Mitgliedstypen
enum class QWebEngineWebAuthUxRequest::PinEntryError
Diese Aufzählung beschreibt die Fehler, die den Authentifikator veranlassen können, eine PIN zu verlangen.
Konstante | Wert | Beschreibung |
---|---|---|
QWebEngineWebAuthUxRequest::PinEntryError::NoError | 0 | Es ist kein Fehler aufgetreten. |
QWebEngineWebAuthUxRequest::PinEntryError::InternalUvLocked | 1 | Die interne UV ist gesperrt, daher wird auf die PIN zurückgegriffen. |
QWebEngineWebAuthUxRequest::PinEntryError::WrongPin | 2 | Die vom Benutzer eingegebene PIN stimmt nicht mit der Authentifikator-PIN überein. |
QWebEngineWebAuthUxRequest::PinEntryError::TooShort | 3 | Die neue PIN, die der Benutzer eingegeben hat, ist zu kurz. |
QWebEngineWebAuthUxRequest::PinEntryError::InvalidCharacters | 4 | Die neue PIN, die der Benutzer eingegeben hat, enthält ungültige Zeichen. |
QWebEngineWebAuthUxRequest::PinEntryError::SameAsCurrentPin | 5 | Die neue PIN, die der Benutzer eingegeben hat, ist mit der aktuell eingestellten PIN identisch. |
enum class QWebEngineWebAuthUxRequest::PinEntryReason
Diese Aufzählung beschreibt die Gründe, die den Authentifikator zur Abfrage einer PIN veranlassen können.
Konstante | Wert | Beschreibung |
---|---|---|
QWebEngineWebAuthUxRequest::PinEntryReason::Set | 0 | Es wird eine neue PIN festgelegt. |
QWebEngineWebAuthUxRequest::PinEntryReason::Change | 1 | Die bestehende PIN muss vor der Verwendung dieses Authentifikators geändert werden. |
QWebEngineWebAuthUxRequest::PinEntryReason::Challenge | 2 | Die bestehende PIN wird zum Nachweis der Benutzerverifizierung abgefragt. |
enum class QWebEngineWebAuthUxRequest::RequestFailureReason
Diese Aufzählung beschreibt den Grund für das Scheitern einer WebAuth-Anfrage.
Konstante | Wert | Beschreibung |
---|---|---|
QWebEngineWebAuthUxRequest::RequestFailureReason::Timeout | 0 | Die Authentifizierungssitzung hat ein Zeitlimit überschritten. |
QWebEngineWebAuthUxRequest::RequestFailureReason::KeyNotRegistered | 1 | Der Schlüssel ist nicht beim Authentifikator registriert. |
QWebEngineWebAuthUxRequest::RequestFailureReason::KeyAlreadyRegistered | 2 | Der Schlüssel ist bereits beim Authentifikator registriert. Versuchen Sie, sich mit einem anderen Schlüssel zu registrieren oder einen anderen Authentifikator zu verwenden. |
QWebEngineWebAuthUxRequest::RequestFailureReason::SoftPinBlock | 3 | Der Authentifikator ist blockiert, da der Benutzer mehrmals einen falschen Schlüssel eingegeben hat. |
QWebEngineWebAuthUxRequest::RequestFailureReason::HardPinBlock | 4 | Der Authentifikator ist blockiert, da der Benutzer mehrmals den falschen Schlüssel eingegeben hat und die PIN zurückgesetzt hat, um den spezifischen Authentifikator erneut zu verwenden. |
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorRemovedDuringPinEntry | 5 | Authentifikator wurde während der PIN-Eingabe entfernt. |
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingResidentKeys | 6 | Der Authentifikator unterstützt keine residenten Schlüssel. |
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingUserVerification | 7 | Der Authentifikator unterstützt keine Benutzerverifizierung. |
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingLargeBlob | 8 | Authentifikator hat keine Unterstützung für große Blob-Dateien. |
QWebEngineWebAuthUxRequest::RequestFailureReason::NoCommonAlgorithms | 9 | Kein gemeinsamer Algorithmus. |
QWebEngineWebAuthUxRequest::RequestFailureReason::StorageFull | 10 | Der residente Berechtigungsnachweis konnte nicht erstellt werden, da der Authentifikator nicht über genügend Speicherplatz verfügt. |
QWebEngineWebAuthUxRequest::RequestFailureReason::UserConsentDenied | 11 | Benutzerzustimmung verweigert. |
QWebEngineWebAuthUxRequest::RequestFailureReason::WinUserCancelled | 12 | Der Benutzer hat auf Cancel in der nativen Windows-Benutzeroberfläche geklickt. |
enum class QWebEngineWebAuthUxRequest::WebAuthUxState
Diese Aufzählung beschreibt den Status der aktuellen WebAuth UX-Anfrage.
Konstante | Wert | Beschreibung |
---|---|---|
QWebEngineWebAuthUxRequest::WebAuthUxState::NotStarted | 0 | WebAuth UX-Anfrage noch nicht gestartet. |
QWebEngineWebAuthUxRequest::WebAuthUxState::SelectAccount | 1 | Der Authentifikator benötigt die Details der residenten Anmeldedaten. Die Anwendung muss ein Dialogfeld mit Kontodetails anzeigen, und der Benutzer muss ein Konto auswählen, um fortzufahren. |
QWebEngineWebAuthUxRequest::WebAuthUxState::CollectPin | 2 | Der Authentifikator erfordert eine Benutzerverifizierung. Die Anwendung muss einen PIN-Anforderungsdialog anzeigen. |
QWebEngineWebAuthUxRequest::WebAuthUxState::FinishTokenCollection | 3 | Der Authentifikator erfordert eine Token-/Benutzerverifizierung (z. B. Tippen auf den FIDO-Schlüssel), um den Vorgang abzuschließen. |
QWebEngineWebAuthUxRequest::WebAuthUxState::RequestFailed | 4 | WebAuth-Anfrage fehlgeschlagen. Fehlerdetails anzeigen. |
QWebEngineWebAuthUxRequest::WebAuthUxState::Cancelled | 5 | WebAuth-Anfrage wird abgebrochen. Schließen Sie den WebAuth-Dialog. |
QWebEngineWebAuthUxRequest::WebAuthUxState::Completed | 6 | WebAuth-Anfrage ist abgeschlossen. Schließt das WebAuth-Dialogfeld. |
Eigenschaft Dokumentation
[read-only]
pinRequest : const QWebEngineWebAuthPinRequest
Diese Eigenschaft enthält die PIN-Anforderungsinformationen der WebAuth-Anfrage.
Sie wird benötigt, wenn der aktuelle Status der WebAuth-Anfrage CollectPin lautet. WebAuth Dialog zeigt einen PIN-Anforderungsdialog an. Der Benutzer muss eine PIN eingeben und setPin() aufrufen, um fortzufahren.
Zugriffsfunktionen:
QWebEngineWebAuthPinRequest | pinRequest() const |
Siehe auch QWebEngineWebAuthPinRequest, CollectPin, und setPin().
[read-only]
relyingPartyId : const QString
Diese Eigenschaft enthält die Kennung der vertrauenden Partei der WebAuth-Anfrage.
Zugriffsfunktionen:
QString | relyingPartyId() const |
[read-only]
requestFailureReason : const RequestFailureReason
Diese Eigenschaft enthält den Fehlergrund der WebAuth-Anfrage.
Zugriffsfunktionen:
QWebEngineWebAuthUxRequest::RequestFailureReason | requestFailureReason() const |
Siehe auch stateChanged() und QWebEngineWebAuthUxRequest::RequestFailureReason.
[read-only]
state : const WebAuthUxState
Diese Eigenschaft enthält den aktuellen UX-Status der WebAuth-Anfrage.
stateChanged() wird ausgegeben, wenn sich der aktuelle Zustand ändert. Aktualisieren Sie den WebAuth-Dialog als Reaktion auf die Zustandsänderungen.
Zugriffsfunktionen:
QWebEngineWebAuthUxRequest::WebAuthUxState | state() const |
Benachrichtigungssignal:
void | stateChanged(QWebEngineWebAuthUxRequest::WebAuthUxState state) |
[read-only]
userNames : const QStringList
Diese Eigenschaft enthält die verfügbaren Benutzernamen für die Unterstützung der residenten Anmeldeinformationen. Dies wird benötigt, wenn der UX-Status der aktuellen WebAuth-Anfrage SelectAccount lautet. Das WebAuth-Dialogfeld zeigt Benutzernamen an. Der Benutzer muss ein Konto auswählen, um fortzufahren.
Zugriffsfunktionen:
QStringList | userNames() const |
Siehe auch SelectAccount und setSelectedAccount().
Dokumentation der Mitgliedsfunktionen
[slot]
void QWebEngineWebAuthUxRequest::cancel()
Bricht die aktuelle WebAuth-Anfrage ab.
Siehe auch QWebEngineWebAuthUxRequest::Cancelled und stateChanged().
[slot]
void QWebEngineWebAuthUxRequest::retry()
Wiederholt die aktuelle WebAuth-Anfrage.
Siehe auch stateChanged().
[slot]
void QWebEngineWebAuthUxRequest::setPin(const QString &pin)
Sendet die pin an den Authentifikator, der zur Eingabe einer PIN auffordert. Dies ist erforderlich, wenn der UX-Status der aktuellen WebAuth-Anfrage CollectPin lautet. Die WebAuth-Anfrage wird blockiert, bis der Benutzer mit einer PIN antwortet.
Siehe auch QWebEngineWebAuthPinRequest und CollectPin.
[slot]
void QWebEngineWebAuthUxRequest::setSelectedAccount(const QString &selectedAccount)
Sendet den selectedAccount Namen an den Authentifikator. Dies ist erforderlich, wenn der UX-Status der aktuellen WebAuth-Anfrage SelectAccount lautet. Die WebAuth-Anfrage wird blockiert, bis der Benutzer ein Konto auswählt und diese Methode aufruft.
Siehe auch userNames und SelectAccount.
[signal]
void QWebEngineWebAuthUxRequest::stateChanged(QWebEngineWebAuthUxRequest::WebAuthUxState state)
Dieses Signal wird immer dann ausgegeben, wenn sich die state der WebAuth UX ändert.
Hinweis: Benachrichtigungssignal für die Eigenschaft state.
Siehe auch state und WebAuthUxState.
© 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.