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

    Interface PrincipalLifecycleOptions

    interface PrincipalLifecycleOptions {
        maxAttempts?: number;
        setupTimeoutMs?: number;
        pollIntervalMs?: number;
        expectedPrincipalKind?: PrincipalKind;
        signal?: AbortSignal;
        inputHandler?: InputHandler;
        taskOptions?: Omit<TaskOptions, "signal">;
        createIdempotencyKey?: () => string;
    }
    Index
    maxAttempts? setupTimeoutMs? pollIntervalMs? expectedPrincipalKind? signal? inputHandler? taskOptions? createIdempotencyKey?
    maxAttempts?: number

    Maximum total guarded replacement attempts, including the first write. Defaults to 3; maximum 10.

    setupTimeoutMs?: number

    Maximum wall-clock time spent waiting for destination setup. Defaults to 60 seconds; maximum 24 hours.

    pollIntervalMs?: number

    Delay between setup-state reads. Defaults to one second; maximum 2^31-1 milliseconds.

    expectedPrincipalKind?: PrincipalKind

    Optional caller assertion for the authenticated principal kind.

    signal?: AbortSignal

    Caller cancellation for reads, replacement, and polling delays.

    inputHandler?: InputHandler

    Handler forwarded to each protocol task.

    taskOptions?: Omit<TaskOptions, "signal">

    Per-call task options. The lifecycle signal takes precedence.

    createIdempotencyKey?: () => string

    Test/host override. Called once per guarded replacement attempt.

    Settings
    Member Visibility

    On This Page
    Properties