@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface DeferredTaskState

    Deferred task state for resumption

    interface DeferredTaskState {
        continuationVersion: string;
        continuationClaimed?: boolean;
        settlementResumeDispatchLease?: {
            ownerId: string;
            phase: "admission" | "dispatch-committed";
            expiresAt: number;
        };
        taskId: string;
        contextId?: string;
        a2aTaskId: string;
        serverVersion: "v3"
        | "v2";
        wireAdcpVersion?: string;
        versionEnvelope?: VersionEnvelopeMode;
        serverVersionSynthetic?: boolean;
        agentId: string;
        taskName: string;
        params: any;
        messages: Message[];
        pauseStatus?: "input-required" | "auth-required" | "deferred";
        pauseQuestion?: string;
        clientContext?: unknown;
        settlementOperationId?: string;
        settlementOperationRouteRequired?: true;
        directContinuationRecovery?: true;
        directContinuationRecoveryKeyDigest?: string;
        directContinuationOwnerBindingDigest?: string;
        settlementResumeAuthorizationRequired?: boolean;
        settlementServerTaskId?: string;
        settlementPendingTaskId?: string;
        settlementTerminalResult?: unknown;
        settlementFinalizationLease?: { ownerId: string; expiresAt: number };
        settlementFinalizedResult?: unknown;
        settlementCompletionHandlerPublished?: boolean;
        createdAt: number;
        expiresAt: number;
    }
    Index
    continuationVersion continuationClaimed? settlementResumeDispatchLease? taskId contextId? a2aTaskId serverVersion wireAdcpVersion? versionEnvelope? serverVersionSynthetic? agentId taskName params messages pauseStatus? pauseQuestion? clientContext? settlementOperationId? settlementOperationRouteRequired? directContinuationRecovery? directContinuationRecoveryKeyDigest? directContinuationOwnerBindingDigest? settlementResumeAuthorizationRequired? settlementServerTaskId? settlementPendingTaskId? settlementTerminalResult? settlementFinalizationLease? settlementFinalizedResult? settlementCompletionHandlerPublished? createdAt expiresAt
    continuationVersion: string

    Opaque record generation used for atomic claim/replace fencing.

    continuationClaimed?: boolean

    True after the human continuation has been claimed for seller dispatch.

    settlementResumeDispatchLease?: {
        ownerId: string;
        phase: "admission" | "dispatch-committed";
        expiresAt: number;
    }

    Renewable owner fence for a committed continuation between human-input admission and the seller protocol call. Only an expired admission phase may be reclaimed; dispatch-committed is an uncertain-dispatch fence and must never permit the input to be sent again.

    taskId: string

    Client-minted correlation ID for the original request.

    contextId?: string

    Seller-issued A2A conversation identity, when one was supplied.

    a2aTaskId: string

    Live A2A transport Task.id used to resume the exact seller task.

    serverVersion: "v3" | "v2"

    Seller wire generation used for the original task and every continuation.

    wireAdcpVersion?: string

    Per-operation AdCP wire release retained across durable resume.

    versionEnvelope?: VersionEnvelopeMode

    Per-operation version-envelope mode retained across durable resume.

    serverVersionSynthetic?: boolean

    True when the original seller-version decision used the SDK's synthetic fallback.

    agentId: string

    Trusted agent identifier resolved through current client configuration.

    taskName: string

    Task/tool name.

    params: any

    Snapshotted original task parameters.

    messages: Message[]

    Message history through the response that caused the pause.

    pauseStatus?: "input-required" | "auth-required" | "deferred"

    Exact resumable pause status retained for crash-safe route discovery.

    pauseQuestion?: string

    Human-facing prompt retained for crash-safe route discovery.

    clientContext?: unknown

    Opaque, serializable owner context. Storage adapters must round-trip it unchanged.

    settlementOperationId?: string

    Trusted committed-mutation route that must durably settle any terminal resume.

    settlementOperationRouteRequired?: true

    New-format records whose operation index must fence every state transition.

    directContinuationRecovery?: true

    Operation-routed direct pause that does not require compatibility-coordinator settlement.

    directContinuationRecoveryKeyDigest?: string

    SHA-256 digest of the separate SDK-minted recovery capability.

    directContinuationOwnerBindingDigest?: string

    SHA-256 digest binding authenticated principal/account scope to trusted seller ID and origin.

    settlementResumeAuthorizationRequired?: boolean

    Require the owning durable coordinator to authorize this token before sending seller continuation input.

    settlementServerTaskId?: string

    Seller work handle bound by the durable mutation owner before the pause.

    settlementPendingTaskId?: string

    Seller work handle retained while a committed resume remains nonterminal.

    settlementTerminalResult?: unknown

    Opaque terminal observation retained when seller continuation succeeded but committed-mutation settlement has not yet been acknowledged. Storage adapters must round-trip it unchanged so retry never redispatches the seller mutation.

    settlementFinalizationLease?: { ownerId: string; expiresAt: number }

    Internal renewable active-owner lease for settlement finalization.

    settlementFinalizedResult?: unknown

    Exact public result after settlement and completion handlers succeeded.

    settlementCompletionHandlerPublished?: boolean

    Internal fence proving callback publication already invoked the configured completion handler.

    createdAt: number

    Epoch milliseconds when this resumable state was stored.

    expiresAt: number

    Epoch milliseconds after which this token must not be resumed.

    Settings
    Member Visibility

    On This Page
    Properties