Back to Qt.io
Contact Us Blog Download Qt

QWebEngineWebAuthUxRequest Class

QWebEngineWebAuthUxRequest クラスは、WebAuth UX リクエストのデータをカプセル化します。詳細...

ヘッダー #include <QWebEngineWebAuthUxRequest>
CMake： find_package(Qt6 REQUIRED COMPONENTS WebEngineCore)
target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore)
qmake： QT += webenginecore
以来：Qt 6.7
QML で WebEngineWebAuthUxRequest
継承： 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::NoError0エラーは発生していません。
QWebEngineWebAuthUxRequest::PinEntryError::InternalUvLocked1内部 UV がロックされているため、PIN にフォールバックしています。
QWebEngineWebAuthUxRequest::PinEntryError::WrongPin2ユーザが入力したPINが認証PINと一致しません。
QWebEngineWebAuthUxRequest::PinEntryError::TooShort3ユーザーが入力した新しいPINが短すぎます。
QWebEngineWebAuthUxRequest::PinEntryError::InvalidCharacters4ユーザーが入力した新しいPINに無効な文字が含まれています。
QWebEngineWebAuthUxRequest::PinEntryError::SameAsCurrentPin5ユーザーが入力した新しいPINは、現在設定されているPINと同じです。

enum class QWebEngineWebAuthUxRequest::PinEntryReason

この列挙型は、認証者が PIN を要求する理由を記述する。

定数値説明
QWebEngineWebAuthUxRequest::PinEntryReason::Set0新しい PIN が設定されています。
QWebEngineWebAuthUxRequest::PinEntryReason::Change1この認証機能を使用する前に、既存の PIN を変更する必要があります。
QWebEngineWebAuthUxRequest::PinEntryReason::Challenge2既存の PIN は、ユーザ認証を証明するために収集されています。

enum class QWebEngineWebAuthUxRequest::RequestFailureReason

この列挙型は WebAuth リクエストが失敗した理由を記述する。

定数値説明
QWebEngineWebAuthUxRequest::RequestFailureReason::Timeout0認証セッションがタイムアウトした。
QWebEngineWebAuthUxRequest::RequestFailureReason::KeyNotRegistered1キーが認証局に登録されていない。
QWebEngineWebAuthUxRequest::RequestFailureReason::KeyAlreadyRegistered2キーはすでに認証機関に登録されています。別のキーで登録するか、別の認証機能を使用してください。
QWebEngineWebAuthUxRequest::RequestFailureReason::SoftPinBlock3ユーザが間違ったキーを何度も入力したため、認証器がブロックされました。
QWebEngineWebAuthUxRequest::RequestFailureReason::HardPinBlock4ユーザが何度も間違ったキーを入力したため認証器がブロックされ、再度特定の認証器を使用するためにPINをリセットしました。
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorRemovedDuringPinEntry5PIN 入力中に認証器が削除された。
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingResidentKeys6オーセンティケータが常駐キーをサポートしていない。
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingUserVerification7オーセンティケータがユーザー検証をサポートしていない。
QWebEngineWebAuthUxRequest::RequestFailureReason::AuthenticatorMissingLargeBlob8Authenticator がラージ・ブロブをサポートしていない。
QWebEngineWebAuthUxRequest::RequestFailureReason::NoCommonAlgorithms9共通のアルゴリズムがありません。
QWebEngineWebAuthUxRequest::RequestFailureReason::StorageFull10認証子のストレージが不足しているため、常駐クレデンシャルを作成できませんでした。
QWebEngineWebAuthUxRequest::RequestFailureReason::UserConsentDenied11ユーザの同意が拒否されました。
QWebEngineWebAuthUxRequest::RequestFailureReason::WinUserCancelled12ユーザが Windows ネイティブ UI でCancel をクリックしました。

enum class QWebEngineWebAuthUxRequest::WebAuthUxState

この列挙型は、現在の WebAuth UX リクエストの状態を記述します。

定数値説明
QWebEngineWebAuthUxRequest::WebAuthUxState::NotStarted0WebAuth UX リクエストはまだ開始されていません。
QWebEngineWebAuthUxRequest::WebAuthUxState::SelectAccount1認証者は常駐クレデンシャルの詳細を要求している。アプリケーションはアカウントの詳細ダイアログを表示する必要があり、ユーザは続行するアカウントを選択する必要があります。
QWebEngineWebAuthUxRequest::WebAuthUxState::CollectPin2認証機能にはユーザ認証が必要です。アプリケーションは PIN 要求ダイアログを表示する必要があります。
QWebEngineWebAuthUxRequest::WebAuthUxState::FinishTokenCollection3認証を完了するには、トークン/ユーザ認証（FIDO キーのタップなど）が必要です。
QWebEngineWebAuthUxRequest::WebAuthUxState::RequestFailed4WebAuthリクエストに失敗しました。エラーの詳細を表示します。
QWebEngineWebAuthUxRequest::WebAuthUxState::Cancelled5WebAuth リクエストがキャンセルされました。WebAuth ダイアログを閉じる。
QWebEngineWebAuthUxRequest::WebAuthUxState::Completed6WebAuth リクエストが完了しました。WebAuth ダイアログを閉じる。

プロパティの説明

[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も参照してください 。

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