diff options
| author | Anu Aliyas <anu.aliyas@qt.io> | 2024-05-28 11:55:22 +0200 |
|---|---|---|
| committer | Anu Aliyas <anu.aliyas@qt.io> | 2024-05-31 15:42:07 +0200 |
| commit | 2df6e75cd1ea7f68ae8b91982bc6b378d64cf2fc (patch) | |
| tree | 8bde3a4760f7a7064cbff9f508ac993ffe4dd2ed /src/core/api/qwebenginewebauthuxrequest.cpp | |
| parent | 9f247e3067113bc47b5e2635bc0b4dc69f8289f3 (diff) | |
Add documentation for WebEngineWebAuthPinRequest qmltype
Added missing documentation for WebEngineWebAuthPinRequest
Fixes: QTBUG-123008
Change-Id: Iecf58499b1698688d5e8b8d64c8cb83f21cf0598
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'src/core/api/qwebenginewebauthuxrequest.cpp')
| -rw-r--r-- | src/core/api/qwebenginewebauthuxrequest.cpp | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/src/core/api/qwebenginewebauthuxrequest.cpp b/src/core/api/qwebenginewebauthuxrequest.cpp index 6a79daec9..1f09e55bb 100644 --- a/src/core/api/qwebenginewebauthuxrequest.cpp +++ b/src/core/api/qwebenginewebauthuxrequest.cpp @@ -94,6 +94,59 @@ */ /*! + \qmltype WebEngineWebAuthPinRequest + \instantiates QWebEngineWebAuthPinRequest + \inqmlmodule QtWebEngine + \since QtWebEngine 6.8 + \brief Encapsulates the data of a PIN WebAuth UX request. + + This encapsulates the following information related to a PIN request made by an authenticator. + \list + \li The reason for the PIN prompt. + \li The error details for the PIN prompt. + \li The number of attempts remaining before a hard lock. Should be ignored unless + \l{WebEngineWebAuthPinRequest::reason} is + \l{WebEngineWebAuthUxRequest.PinEntryReason.Challenge}. + \li The minimum PIN length that the authenticator will accept for the PIN. + \endlist + Use this structure to update the WebAuth UX dialog when the WebAuth UX state is \l + WebEngineWebAuthUxRequest.WebAuthUxState.CollectPin. +*/ + +/*! + \qmlproperty enumeration WebEngineWebAuthPinRequest::reason + \brief The reason for the PIN prompt. + + \value WebEngineWebAuthUxRequest.PinEntryReason.Set A new PIN is being set. + \value WebEngineWebAuthUxRequest.PinEntryReason.Change The existing PIN must be changed before using this authenticator. + \value WebEngineWebAuthUxRequest.PinEntryReason.Challenge The existing PIN is being collected to prove user verification. +*/ + +/*! + \qmlproperty enumeration WebEngineWebAuthPinRequest::error + \brief The error details for the PIN prompt. + + \value WebEngineWebAuthUxRequest.PinEntryError.NoError No error has occurred. + \value WebEngineWebAuthUxRequest.PinEntryError.InternalUvLocked Internal UV is locked, so we are falling back to PIN. + \value WebEngineWebAuthUxRequest.PinEntryError.WrongPin The PIN the user entered does not match the authenticator PIN. + \value WebEngineWebAuthUxRequest.PinEntryError.TooShort The new PIN the user entered is too short. + \value WebEngineWebAuthUxRequest.PinEntryError.InvalidCharacters The new PIN the user entered contains invalid characters. + \value WebEngineWebAuthUxRequest.PinEntryError.SameAsCurrentPin The new PIN the user entered is the same as the currently set PIN. +*/ + +/*! + \qmlproperty int WebEngineWebAuthPinRequest::remainingAttempts + \brief The number of attempts remaining before a hard lock. Should be ignored unless + \l{WebEngineWebAuthPinRequest::reason} is + \l{WebEngineWebAuthUxRequest.PinEntryReason.Challenge}. +*/ + +/*! + \qmlproperty int WebEngineWebAuthPinRequest::minPinLength + \brief The minimum PIN length that the authenticator will accept for the PIN. +*/ + +/*! \enum QWebEngineWebAuthUxRequest::WebAuthUxState This enum describes the state of the current WebAuth UX request. |