@archastro/sdk
    Preparing search index...

    Interface CustomObjectSubscriptionOptions<TFields>

    interface CustomObjectSubscriptionOptions<TFields extends object> {
        connectionId?: string;
        fieldsSchema?: ZodType<TFields, ZodTypeDef, TFields>;
        maxQueuedPatches?: number;
        maxReconnectDelayMs?: number;
        objectId: string;
        onError(error: ApiError): void;
        onPresence?(presence: CustomObjectPresence): void;
        onPresenceLeave?(presence: CustomObjectPresenceLeave): void;
        onSnapshot(snapshot: CustomObjectSnapshot<TFields>): void;
        onStateChange(state: CustomObjectConnectionState): void;
        onUpdate(update: CustomObjectUpdate<TFields>): void;
    }

    Type Parameters

    • TFields extends object
    Index

    Properties

    connectionId? fieldsSchema? maxQueuedPatches? maxReconnectDelayMs? objectId

    Methods

    onError onPresence? onPresenceLeave? onSnapshot onStateChange onUpdate

    Properties

    connectionId?: string

    Stable identity for this browser tab. Generated when omitted.

    fieldsSchema?: ZodType<TFields, ZodTypeDef, TFields>

    Optional runtime validator for authoritative snapshots.

    maxQueuedPatches?: number

    Maximum number of pending offline update calls. Defaults to 100.

    maxReconnectDelayMs?: number

    Maximum reconnect delay. Defaults to 10 seconds.

    objectId: string

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods