@archastro/sdk
    Preparing search index...

    Interface ChatRoomModel

    A point-in-time snapshot of a chat room's state, including its loaded messages, member roster, and pagination cursors. Returned when loading or refreshing a thread's message list.

    interface ChatRoomModel {
        after_cursor?: string;
        agent?: Agent;
        before_cursor?: string;
        is_transient: boolean;
        members: ChatMember[];
        messages: Message[];
        messages_loaded_on_last_update?: number;
        team?: Team;
        thread: Thread;
    }
    Index

    Properties

    after_cursor?: string

    Opaque cursor to pass when fetching messages newer than those in this snapshot. null when this snapshot already reflects the latest messages.

    agent?: Agent

    The agent associated with this chat room. null when no agent is attached.

    before_cursor?: string

    Opaque cursor to pass when fetching messages older than those in this snapshot. null when the beginning of the thread history has been reached.

    is_transient: boolean

    Whether this thread is ephemeral. Transient threads are not retained in long-term storage and may be deleted when the session ends.

    members: ChatMember[]

    All active members of the chat room, including both human users and agents.

    messages: Message[]

    The page of messages currently loaded for the thread, ordered chronologically. Use before_cursor or after_cursor to page through additional history.

    messages_loaded_on_last_update?: number

    Number of messages that were added to the snapshot in the most recent incremental update. null on the initial load.

    team?: Team

    The team that owns this thread. null for threads scoped to an individual user rather than a team.

    thread: Thread

    The parent thread whose message history and membership this snapshot represents.