本文へ移動

イベントと進行状況

診断情報でSDKのライフサイクルを制御せず、安定したウォレットフローのフェーズと状態を表示します。

イベントと進行状況 ​

登録、アンロック、署名、アカウント同期、鍵のエクスポート、デバイス連携は、WalletFlowEventの分岐を通知できます。 進行状況UI、アクセシビリティーの通知、テレメトリー、サポートの診断に使います。

メインのエントリーポイントは、フェーズの列挙型、イベントコンストラクター、安定したイベントメッセージとステップ、境界ガードのisWalletFlowEventを公開します。

イベントの契約 ​

WalletFlowEventは、バージョン2を使います。 各イベントは、フロー、flowId、フェーズ、状態、ステップ、表示メッセージを識別します。 ステップ番号は、1つのフロー内の順序を示します。相互に排他的な分岐は、同じステップを使う場合があります。 独自のフェーズ・ステップ対応表を維持せず、公開する列挙型とコンストラクターを使ってください。 失敗とキャンセルのフェーズは、ステップ0です。

指定したinteraction.overlayは、show、hide、noneを明示的に要求します。 フェーズ名やメッセージから、オーバーレイの表示状態を推測しないでください。 操作情報を省略した失敗・キャンセルイベントでは、コンストラクターが既定でオーバーレイを非表示にします。 対話用の画面は、ウォレットiframeが管理します。

メッセージは、表示に適した内容にしてください。 公開の進行状況は、ユーザーに見える意味のある処理を説明します。Worker内部の詳細なステップは、内部診断に保持します。 対応するフローとペイロードは、現在のSDKのイベント型が定義します。

表示の指針 ​

  • 意味のあるフェーズ変更を、1つのpoliteライブリージョンで通知してください。
  • 操作ボタンのラベルを維持し、近くの状態表示で現在のステップを説明してください。
  • ユーザーの存在確認や外部サービスを待つ間も、キャンセルと再試行の操作を保持してください。
  • イベントのバージョン、フェーズ、状態、操作IDを記録してください。認証情報、OTP、鍵素材、トークン、生のアサーションデータは除いてください。

進行状況のイベントは、SDKの動作を説明します。 テレメトリーは遅延、フィルター、無効化の影響を受けるため、制御には操作結果とドメイン状態を使ってください。