Interface SealedRequestBehavior

Interface that defines the behavior of a sealed request.

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

interface SealedRequestBehavior {
    withState(state: EnvelopeEncodableValue): SealedRequest;
    withOptionalState(state: EnvelopeEncodableValue): SealedRequest;
    withPeerContinuation(peerContinuation: Envelope$1): SealedRequest;
    withOptionalPeerContinuation(
        peerContinuation: Envelope$1 | undefined,
    ): SealedRequest;
    request(): Request;
    sender(): XIDDocument;
    state(): Envelope$1 | undefined;
    peerContinuation(): Envelope$1 | undefined;
}

Implemented by

SealedRequest

Index

Methods

withState withOptionalState withPeerContinuation withOptionalPeerContinuation request sender state peerContinuation

Methods

withState

withState(state: EnvelopeEncodableValue): SealedRequest
Adds state to the request that the receiver must return in the response.
Parameters
- state: EnvelopeEncodableValue
Returns SealedRequest
- Defined in sealed-request.ts:34

withOptionalState

withOptionalState(state: EnvelopeEncodableValue): SealedRequest
Adds optional state to the request.
Parameters
- state: EnvelopeEncodableValue
Returns SealedRequest
- Defined in sealed-request.ts:39

withPeerContinuation

withPeerContinuation(peerContinuation: Envelope$1): SealedRequest
Adds a continuation previously received from the recipient.
Parameters
- peerContinuation: Envelope$1
Returns SealedRequest
- Defined in sealed-request.ts:44

withOptionalPeerContinuation

withOptionalPeerContinuation(
peerContinuation: Envelope$1 | undefined,
): SealedRequest
Adds an optional continuation previously received from the recipient.
Parameters
- peerContinuation: Envelope$1 | undefined
Returns SealedRequest
- Defined in sealed-request.ts:49

request

request(): Request
Returns the underlying request.

Returns Request
- Defined in sealed-request.ts:54

sender

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

Returns XIDDocument
- Defined in sealed-request.ts:59

state

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

Returns Envelope$1 | undefined
- Defined in sealed-request.ts:64

peerContinuation

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

Returns Envelope$1 | undefined
- Defined in sealed-request.ts:69