API Core - v1.5.0
    Preparing search index...

    Interface SessionAPIConfig<TSyncParams>

    User-facing configuration every session-bearing SDK client accepts. A consuming SDK extends it with its own surface (credentials, locale, timezone, transport options, protocol switches).

    interface SessionAPIConfig<TSyncParams = unknown> {
        abortSignal?: AbortSignal;
        events?: LifecycleEvents<TSyncParams>;
        logger?: Logger;
        settingManager?: SettingManager;
        syncIntervalMinutes?: number | false;
    }

    Type Parameters

    • TSyncParams = unknown

      Shape of the consumer-defined parameters the sync notification carries (device ids, type filters…).

    Index
    abortSignal? events? logger? settingManager? syncIntervalMinutes?
    abortSignal?: AbortSignal

    Optional shutdown signal applied to every outgoing request, and to the transient-retry backoff sleeps.

    events?: LifecycleEvents<TSyncParams>

    Structured-events callbacks invoked around SDK lifecycle moments.

    logger?: Logger

    Custom logger. Defaults to console.

    settingManager?: SettingManager

    External setting manager for persisting credentials and session data.

    syncIntervalMinutes?: number | false

    Auto-sync timer in minutes. false disables the timer entirely. Omit to use the subclass default.

    Settings
    Member Visibility

    On This Page
    Properties