Member Junction
    Preparing search index...

    Context passed to BaseRealtimeClient.Reconnect(context) on a scheduled or error-recovery mid-call reconnect.

    interface RealtimeClientReconnectContext {
        Abandoned: boolean;
        Attempt: number;
        ConversationSeed: RealtimeMemorySeed;
        Credential: RefreshedRealtimeClientCredential;
        ElapsedConnectionSeconds: number;
        MaxAttempts: number;
        Reason: RealtimeReconnectReason;
        RefreshCredential: (
            options?: RealtimeClientTokenRefreshOptions,
        ) => Promise<RefreshedRealtimeClientCredential>;
        ResumptionHandle: string;
        Seed: RealtimeMemorySeed;
        Signal: AbortSignal;
        UseNativeResumption: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Abandoned: boolean

    Turns true when the attempt timed out, failed, or the session/client was closed. Drivers MUST check context.Abandoned after asynchronous setup steps and immediately close any newly opened socket/peer-connection without swapping it into active state.

    Attempt: number

    1-based attempt number within the current reconnect cycle (1..MaxAttempts).

    ConversationSeed: RealtimeMemorySeed

    Snapshot of accumulated conversation history from RealtimeConversationMemory.Seed(). Populated when UseNativeResumption is false (or on retry fallback after a native handle is rejected); null when UseNativeResumption is true on the primary attempt or when no turns have occurred yet.

    ElapsedConnectionSeconds: number

    Elapsed seconds on the current connection when the reconnect began.

    MaxAttempts: number

    The most attempts the cycle can make (MAX_REALTIME_RESUMPTION_ATTEMPTS). The recovery window usually ends the cycle sooner, so this is an upper bound, not a promise that a failed attempt is followed by another.

    Why the reconnect was triggered ('duration-expiry' | 'connection-ending' | 'connection-lost').

    RefreshCredential: (
        options?: RealtimeClientTokenRefreshOptions,
    ) => Promise<RefreshedRealtimeClientCredential>
    ResumptionHandle: string

    Native provider resumption handle or conversation ID captured from the active connection, or null if none has been recorded or native resumption is disabled/untrusted.

    Signal: AbortSignal

    AbortSignal that fires when Abandoned turns true (attempt timeout, failure, or session close).

    UseNativeResumption: boolean

    True when the driver should use ResumptionHandle for native continuation and MUST NOT re-send conversation history. False when the driver must seed from ConversationSeed.