QWebEngineWebAuthUxRequest Class
QWebEngineWebAuthUxRequest クラスは、WebAuth UX リクエストのデータをカプセル化します。詳細...
| Header: | #include <QWebEngineWebAuthUxRequest> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS WebEngineCore)target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore) |
| qmake: | QT += webenginecore |
| Since: | Qt 6.7 |
| In QML: | WebEngineWebAuthUxRequest |
| Inherits: | QObject |
パブリックタイプ
| 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 } |
プロパティ
|
パブリック関数
| QWebEngineWebAuthPinRequest | pinRequest() const |
| QString | relyingPartyId() const |
| QWebEngineWebAuthUxRequest::RequestFailureReason | requestFailureReason() const |
| QWebEngineWebAuthUxRequest::WebAuthUxState | state() const |
| QStringList | userNames() const |
パブリックスロット
| void | cancel() |
| void | retry() |
| void | setPin(const QString &pin) |
| void | setSelectedAccount(const QString &selectedAccount) |
シグナル
| void | stateChanged(QWebEngineWebAuthUxRequest::WebAuthUxState state) |
詳細説明
このクラスには、WebAuth UX の情報と API が含まれます。WebAuth は認証プロセス中にユーザとの対話を要求することがあります。これらのリクエストは、ユーザーにダイアログを表示することで処理されます。QtWebEngine は現在、ユーザー認証、資格情報の常駐、リクエスト失敗の UX リクエストの表示をサポートしています。
QWebEngineWebAuthUxRequest は、WebAuth UX リクエストのライフサイクル全体をモデル化し、UX ダイアログの表示から始まり、状態の変更によって内容を更新し、最後にダイアログを閉じます。
WebAuth UX リクエストは通常、認証側がユーザーとの対話を要求したときにトリガーされます。新しい WebAuth UX リクエストをアプリケーションに通知するのはQWebEnginePage の役割で、新しく作成された QWebEngineWebAuthUxRequest とともにwebAuthUxRequested シグナルを発信します。アプリケーションはこのリクエストを調べて、WebAuth UX ダイアログを表示できます。
QWebEngineWebAuthUxRequest オブジェクトは定期的にstateChanged シグナルを発信し、現在の WebAuth UX の状態を潜在的なオブザーバに通知します。オブザーバはそれに応じて WebAuth ダイアログを更新します。
Web エンジンからの認証リクエストの処理方法についての詳細はSimple Browser を参照してください。
メンバ型のドキュメント
enum class QWebEngineWebAuthUxRequest::PinEntryError
この列挙型は、認証者が PIN の入力を要求する際のエラーについて記述します。
| 定数 | 値 | 説明 |
|---|---|---|
QWebEngineWebAuthUxRequest::PinEntryError::NoError | 0 | エラーは発生していない。 |
QWebEngineWebAuthUxRequest::PinEntryError::InternalUvLocked | 1 | 内部 UV がロックされているため、PIN にフォールバックしています。 |
QWebEngineWebAuthUxRequest::PinEntryError::WrongPin | 2 | ユーザが入力したPINが認証PINと一致しません。 |
QWebEngineWebAuthUxRequest::PinEntryError::TooShort | 3 | ユーザーが入力した新しいPINが短すぎます。 |
QWebEngineWebAuthUxRequest::PinEntryError::InvalidCharacters | 4 | ユーザーが入力した新しいPINに無効な文字が含まれています。 |
QWebEngineWebAuthUxRequest::PinEntryError::SameAsCurrentPin | 5 | ユーザが入力した新しいPINが、現在設定されているPINと同じである。 |
enum class QWebEngineWebAuthUxRequest::PinEntryReason
この列挙型は、認証者が PIN の入力を要求する理由を記述する。
| 定数 | 値 | 説明 |
|---|---|---|
QWebEngineWebAuthUxRequest::PinEntryReason::Set | 0 | 新しい PIN が設定されています。 |
QWebEngineWebAuthUxRequest::PinEntryReason::Change | 1 | この認証機能を使用する前に、既存の PIN を変更する必要があります。 |
QWebEngineWebAuthUxRequest::PinEntryReason::Challenge | 2 | 既存の PIN は、ユーザ認証を証明するために収集されています。 |
enum class QWebEngineWebAuthUxRequest::RequestFailureReason
この列挙型は、WebAuth リクエストが失敗した理由を記述します。
| 定数 | 値 | 説明 |
|---|---|---|
QWebEngineWebAuthUxRequest::RequestFailureReason::Timeout | 0 | 認証セッションがタイムアウトした。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::KeyNotRegistered | 1 | キーが認証局に登録されていない。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::KeyAlreadyRegistered | 2 | キーはすでに認証機関に登録されています。別のキーで登録するか、別の認証機能を使用してください。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::SoftPinBlock | 3 | ユーザが間違ったキーを何度も入力したため、認証器がブロックされました。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::HardPinBlock | 4 | ユーザが何度も間違ったキーを入力したため認証器がブロックされ、再度特定の認証器を使用するためにPINをリセットしました。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorRemovedDuringPinEntry | 5 | PIN 入力中に認証器が削除された。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingResidentKeys | 6 | オーセンティケータが常駐キーをサポートしていない。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingUserVerification | 7 | オーセンティケータがユーザー検証をサポートしていない。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingLargeBlob | 8 | Authenticator がラージ・ブロブをサポートしていない。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::NoCommonAlgorithms | 9 | 共通のアルゴリズムがありません。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::StorageFull | 10 | 認証子のストレージが不足しているため、常駐クレデンシャルを作成できませんでした。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::UserConsentDenied | 11 | ユーザの同意が拒否されました。 |
QWebEngineWebAuthUxRequest::RequestFailureReason::WinUserCancelled | 12 | ユーザはネイティブのウィンドウズ UI でCancel をクリックした。 |
enum class QWebEngineWebAuthUxRequest::WebAuthUxState
この列挙型は、現在の WebAuth UX リクエストの状態を表します。
| 定数 | 値 | 説明 |
|---|---|---|
QWebEngineWebAuthUxRequest::WebAuthUxState::NotStarted | 0 | WebAuth UX リクエストはまだ開始されていません。 |
QWebEngineWebAuthUxRequest::WebAuthUxState::SelectAccount | 1 | 認証者は常駐クレデンシャルの詳細を要求している。アプリケーションはアカウントの詳細ダイアログを表示する必要があり、ユーザは続行するアカウントを選択する必要があります。 |
QWebEngineWebAuthUxRequest::WebAuthUxState::CollectPin | 2 | 認証機能にはユーザ認証が必要です。アプリケーションは PIN 要求ダイアログを表示する必要があります。 |
QWebEngineWebAuthUxRequest::WebAuthUxState::FinishTokenCollection | 3 | 認証を完了するには、トークン/ユーザ認証（FIDO キーのタップなど）が必要です。 |
QWebEngineWebAuthUxRequest::WebAuthUxState::RequestFailed | 4 | WebAuthリクエストに失敗しました。エラーの詳細を表示します。 |
QWebEngineWebAuthUxRequest::WebAuthUxState::Cancelled | 5 | WebAuth リクエストがキャンセルされました。WebAuth ダイアログを閉じる。 |
QWebEngineWebAuthUxRequest::WebAuthUxState::Completed | 6 | WebAuth リクエストが完了しました。WebAuth ダイアログを閉じる。 |
プロパティ Documentation
[read-only] pinRequest : const QWebEngineWebAuthPinRequest
このプロパティは WebAuth リクエストの PIN リクエスト情報を保持する。
これは、現在の WebAuth リクエストの状態がCollectPin である場合に必要となります。WebAuth ダイアログは PIN リクエストダイアログを表示します。ユーザは PIN を入力し、setPin() を呼び出して処理を進める必要がある。
アクセス関数：
| QWebEngineWebAuthPinRequest | pinRequest() const |
QWebEngineWebAuthPinRequest 、CollectPin 、およびsetPin()も参照してください 。
[read-only] relyingPartyId : const QString
このプロパティは、WebAuth リクエストの依拠当事者 ID を保持する。
アクセス関数：
| QString | relyingPartyId() const |
[read-only] requestFailureReason : const RequestFailureReason
このプロパティは WebAuth リクエストの失敗理由を保持する。
アクセス関数：
| QWebEngineWebAuthUxRequest::RequestFailureReason | requestFailureReason() const |
stateChanged() およびQWebEngineWebAuthUxRequest::RequestFailureReasonも参照 。
[read-only] state : const WebAuthUxState
このプロパティは WebAuth リクエストの現在の UX 状態を保持します。
stateChanged() は現在の状態が変更されたときに発行されます。状態の変化に応じて WebAuth ダイアログを更新します。
アクセス関数
| QWebEngineWebAuthUxRequest::WebAuthUxState | state() const |
Notifier シグナル：
| void | stateChanged(QWebEngineWebAuthUxRequest::WebAuthUxState state) |
[read-only] userNames : const QStringList
このプロパティは、常駐クレデンシャルサポートで利用可能なユーザー名を保持します。これは、現在の WebAuth リクエストの UX 状態がSelectAccount である場合に必要となります。WebAuth ダイアログはユーザー名を表示します。ユーザは先に進むためにアカウントを選択する必要があります。
アクセス関数：
| QStringList | userNames() const |
SelectAccount およびsetSelectedAccount()も参照 。
メンバー関数 ドキュメント
[slot] void QWebEngineWebAuthUxRequest::cancel()
現在の WebAuth リクエストをキャンセルします。
QWebEngineWebAuthUxRequest::Cancelled およびstateChanged() も参照 。
[slot] void QWebEngineWebAuthUxRequest::retry()
現在の WebAuth リクエストを再試行します。
stateChanged()も参照 。
[slot] void QWebEngineWebAuthUxRequest::setPin(const QString &pin)
PIN の入力を促すpin を認証デバイスに送信します。これは、現在の WebAuth リクエストの UX ステートがCollectPin の場合に必要です。WebAuth リクエストは、ユーザが PIN で応答するまでブロックされます。
QWebEngineWebAuthPinRequest およびCollectPinも参照のこと 。
[slot] void QWebEngineWebAuthUxRequest::setSelectedAccount(const QString &selectedAccount)
selectedAccount 名を認証者に送信します。これは現在の WebAuth リクエストの UX ステートがSelectAccount の場合に必要です。WebAuth リクエストは、ユーザがアカウントを選択してこのメソッドを呼び出すまでブロックされます。
userNames およびSelectAccountも参照してください 。
[signal] void QWebEngineWebAuthUxRequest::stateChanged(QWebEngineWebAuthUxRequest::WebAuthUxState state)
このシグナルは WebAuth UX のstate が変更されるたびに発行されます。
注意: state プロパティに対するノーティファイアシグナルです。
state およびWebAuthUxState も参照して ください。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
