@archastro/sdk
    Preparing search index...

    Interface CustomObjectJoinResponse

    Initial authoritative snapshot returned by a custom-object channel join.

    interface CustomObjectJoinResponse {
        connection_id: string;
        fields: Record<string, unknown> | null;
        id: string | null;
        presence: Record<string, unknown>[];
        readonly: boolean;
    }
    Index

    Properties

    connection_id fields id presence readonly

    Properties

    connection_id: string

    Collision-free identifier for this browser connection.

    fields: Record<string, unknown> | null

    Current materialized fields, or null while waiting for object creation.

    id: string | null

    Custom-object ID, or null while a row-key subscription waits for creation.

    presence: Record<string, unknown>[]

    Current ephemeral collaborator presence.

    readonly: boolean

    Whether the current connection may only read the object.

    Settings

    Member Visibility

    On This Page

    Properties