Interface SealedResponseBehavior

Interface that defines the behavior of a sealed response.

Extends ResponseBehavior with additional methods for managing sender information and state continuations.

interface SealedResponseBehavior {
    withState(state: EnvelopeEncodableValue): SealedResponse;
    withOptionalState(state: EnvelopeEncodableValue): SealedResponse;
    withPeerContinuation(
        peerContinuation: Envelope$1 | undefined,
    ): SealedResponse;
    sender(): XIDDocument;
    state(): Envelope$1 | undefined;
    peerContinuation(): Envelope$1 | undefined;
}

Implemented by

SealedResponse

Index

Methods

withState withOptionalState withPeerContinuation sender state peerContinuation

Methods

withState

withState(state: EnvelopeEncodableValue): SealedResponse
Adds state to the response that the peer may return at some future time.
Parameters
- state: EnvelopeEncodableValue
Returns SealedResponse
- Defined in sealed-response.ts:27

withOptionalState

withOptionalState(state: EnvelopeEncodableValue): SealedResponse
Adds optional state to the response.
Parameters
- state: EnvelopeEncodableValue
Returns SealedResponse
- Defined in sealed-response.ts:32

withPeerContinuation

withPeerContinuation(peerContinuation: Envelope$1 | undefined): SealedResponse
Adds a continuation previously received from the recipient.
Parameters
- peerContinuation: Envelope$1 | undefined
Returns SealedResponse
- Defined in sealed-response.ts:37

sender

sender(): XIDDocument
Returns the sender of the response.

Returns XIDDocument
- Defined in sealed-response.ts:42

state

state(): Envelope$1 | undefined
Returns the state to be sent to the peer.

Returns Envelope$1 | undefined
- Defined in sealed-response.ts:47

peerContinuation

peerContinuation(): Envelope$1 | undefined
Returns the continuation received from the peer.

Returns Envelope$1 | undefined
- Defined in sealed-response.ts:52