Types

Link copied to clipboard

The approved response is awaiting protected holder-key authorization.

Link copied to clipboard
data class AwaitingNextRequest(val completedExchanges: Int) : ProximityState

One response completed and the session remains open for another request.

Link copied to clipboard
data class AwaitingRequest(val exchange: Int) : ProximityState

Transport is connected and awaiting the next device request.

Link copied to clipboard

Session was cancelled locally and all owned resources were released.

Link copied to clipboard

Prerequisites are being evaluated or require host remediation.

Link copied to clipboard
data class Completed(val exchanges: Int, val declined: Boolean, val receipt: ProximitySharingReceipt? = null) : ProximityState

Session reached a normal terminal state after disclosure or holder decline.

Link copied to clipboard
data class Connecting(val engagements: List<ProximityEngagement>) : ProximityState

The reader has consumed engagement data and transport connection is in progress.

Link copied to clipboard
data class EngagementReady(val engagements: List<ProximityEngagement>) : ProximityState

Engagement data is ready for presentation to the reader.

Link copied to clipboard
data class Failed(val error: ProximityError) : ProximityState

Session terminated because of a stable Wallet SDK failure.

Link copied to clipboard
data class NoData(val exchange: Int) : ProximityState

The session ended without sharing data for its final request. Earlier exchanges may already have sent holder-approved data.

Link copied to clipboard
data class PreparationRequired(val plan: ProximitySharingPlan, val reason: ProximityReviewReason = ProximityReviewReason.RequestReceived) : ProximityState

Connection ended without disclosure. Review this verified request before explicitly preparing a new connection.

Link copied to clipboard
data class Preparing(val profile: ProximityProfile) : ProximityState

Session material and selected transports are being prepared.

Link copied to clipboard
data class ReviewRequired(val review: ProximityReview, val reason: ProximityReviewReason = ProximityReviewReason.RequestReceived) : ProximityState

An immutable request snapshot requires explicit holder consent.

Link copied to clipboard
data class SendingResponse(val exchange: Int) : ProximityState

The approved and authorized response is being sent.

Link copied to clipboard
data class Terminating(val exchange: Int) : ProximityState

Session termination is being sent after the final exchange.

Properties

Link copied to clipboard

Legal host actions derived exclusively from the current session state.