Class ApiChatChannel

constructor

• new ApiChatChannel(channel: Channel, joinResponse?: unknown): ApiChatChannel

  Parameters

  • channel: Channel
  • OptionaljoinResponse: unknown

  Returns ApiChatChannel

Optional ReadonlyjoinResponse

apiChatAddReaction

• apiChatAddReaction(payload: Record<string, unknown>): Promise<unknown>

  Add an emoji reaction to a message

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatDeleteMessage

• apiChatDeleteMessage(payload: Record<string, unknown>): Promise<unknown>

  Delete a message

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatEditMessage

• apiChatEditMessage(payload: Record<string, unknown>): Promise<unknown>

  Edit an existing message's content

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatForkThread

• apiChatForkThread(payload: Record<string, unknown>): Promise<unknown>

  Fork a sub-thread from an existing message

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatListMessages

• apiChatListMessages(payload: Record<string, unknown>): Promise<unknown>

  List all messages in the current thread

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatLoadMoreMessages

• apiChatLoadMoreMessages(payload: Record<string, unknown>): Promise<unknown>

  Load additional messages with cursor-based pagination

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatLocalToolResult

• apiChatLocalToolResult(payload: Record<string, unknown>): Promise<unknown>

  Return one complete result batch for a connection-local tool request

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatMarkThreadRead

• apiChatMarkThreadRead(payload: Record<string, unknown>): Promise<unknown>

  Mark a thread as read up to a given message

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatPostMessage

• apiChatPostMessage(payload: Record<string, unknown>): Promise<unknown>

  Post a new message with optional uploads and reply-to

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatPostSimpleMessage

• apiChatPostSimpleMessage(payload: Record<string, unknown>): Promise<unknown>

  Post a simple text message

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatPublishLocalTools

• apiChatPublishLocalTools(payload: Record<string, unknown>): Promise<unknown>

  Replace the local tools advertised by this connection for later messages it posts

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatRemoveReaction

• apiChatRemoveReaction(payload: Record<string, unknown>): Promise<unknown>

  Remove an emoji reaction from a message

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

apiChatTyping

• apiChatTyping(payload: Record<string, unknown>): Promise<unknown>

  Signal that the current user has started or stopped typing in the thread

  Parameters

  • payload: Record<string, unknown>

  Returns Promise<unknown>

leave

• leave(): Promise<void>

  Leave the underlying channel.

  Returns Promise<void>

onLocalToolCall

• onLocalToolCall(callback: (payload: unknown) => void): () => void

  Invoke local functions on the exact connection that published them

  Parameters

  • callback: (payload: unknown) => void

  Returns () => void

onLocalToolCancelled

• onLocalToolCancelled(callback: (payload: unknown) => void): () => void

  Stop local work because the server no longer accepts its result

  Parameters

  • callback: (payload: unknown) => void

  Returns () => void

onMessageAdded

• onMessageAdded(callback: (payload: unknown) => void): () => void

  Broadcast when a new message is added to a thread

  Parameters

  • callback: (payload: unknown) => void

  Returns () => void

onMessageUpdated

• onMessageUpdated(callback: (payload: unknown) => void): () => void

  Broadcast when a message is updated or removed

  Parameters

  • callback: (payload: unknown) => void

  Returns () => void

onSystemEvent

• onSystemEvent(callback: (payload: unknown) => void): () => void

  Broadcast system-wide events

  Parameters

  • callback: (payload: unknown) => void

  Returns () => void

onThreadEvent

• onThreadEvent(callback: (payload: unknown) => void): () => void

  Broadcast thread-level events (agent updates, read state, unread counts)

  Parameters

  • callback: (payload: unknown) => void

  Returns () => void

onTyping

• onTyping(callback: (payload: unknown) => void): () => void

  Broadcast when a participant (human or agent) starts or stops typing. Ephemeral; never persisted.

  Parameters

  • callback: (payload: unknown) => void

  Returns () => void

StaticjoinTeamKeyed

• joinTeamKeyed(
      socket: Socket,
      teamId: string,
      key: string,
      payload?: {
          after_cursor?: string;
          before_cursor?: string;
          include_metadata?: boolean;
          limit?: number;
      },
  ): Promise<ApiChatChannel>

  Join or create a team-scoped keyed thread

  Parameters

  • socket: Socket
  • teamId: string
  • key: string
  • Optionalpayload: {
        after_cursor?: string;
        before_cursor?: string;
        include_metadata?: boolean;
        limit?: number;
    }

  Returns Promise<ApiChatChannel>

StaticjoinTeamThread

• joinTeamThread(
      socket: Socket,
      teamId: string,
      threadId: string,
      payload?: {
          after_cursor?: string;
          before_cursor?: string;
          include_metadata?: boolean;
          limit?: number;
      },
  ): Promise<ApiChatChannel>

  Join a team-scoped thread by ID

  Parameters

  • socket: Socket
  • teamId: string
  • threadId: string
  • Optionalpayload: {
        after_cursor?: string;
        before_cursor?: string;
        include_metadata?: boolean;
        limit?: number;
    }

  Returns Promise<ApiChatChannel>

StaticjoinTeamTransient

• joinTeamTransient(
      socket: Socket,
      teamId: string,
      key: string,
      payload?: {
          after_cursor?: string;
          before_cursor?: string;
          include_metadata?: boolean;
          limit?: number;
      },
  ): Promise<ApiChatChannel>

  Join a team-scoped transient (ephemeral) thread

  Parameters

  • socket: Socket
  • teamId: string
  • key: string
  • Optionalpayload: {
        after_cursor?: string;
        before_cursor?: string;
        include_metadata?: boolean;
        limit?: number;
    }

  Returns Promise<ApiChatChannel>

StaticjoinUserKeyed

• joinUserKeyed(
      socket: Socket,
      key: string,
      payload?: {
          after_cursor?: string;
          before_cursor?: string;
          include_metadata?: boolean;
          limit?: number;
      },
  ): Promise<ApiChatChannel>

  Join or create a user-scoped keyed thread

  Parameters

  • socket: Socket
  • key: string
  • Optionalpayload: {
        after_cursor?: string;
        before_cursor?: string;
        include_metadata?: boolean;
        limit?: number;
    }

  Returns Promise<ApiChatChannel>

StaticjoinUserThread

• joinUserThread(
      socket: Socket,
      threadId: string,
      payload?: {
          after_cursor?: string;
          before_cursor?: string;
          include_metadata?: boolean;
          limit?: number;
          local_tool_provider_id?: string;
          local_tools?: {
              function: {
                  description: string;
                  name: string;
                  parameters: Record<string, unknown>;
              };
              type: "function";
          }[];
      },
  ): Promise<ApiChatChannel>

  Join a user-scoped thread by ID, optionally supplying local tools for a personal thread

  Parameters

  • socket: Socket
  • threadId: string
  • Optionalpayload: {
        after_cursor?: string;
        before_cursor?: string;
        include_metadata?: boolean;
        limit?: number;
        local_tool_provider_id?: string;
        local_tools?: {
            function: {
                description: string;
                name: string;
                parameters: Record<string, unknown>;
            };
            type: "function";
        }[];
    }

  Returns Promise<ApiChatChannel>

StaticjoinUserTransient

• joinUserTransient(
      socket: Socket,
      key: string,
      payload?: {
          after_cursor?: string;
          before_cursor?: string;
          include_metadata?: boolean;
          limit?: number;
      },
  ): Promise<ApiChatChannel>

  Join a user-scoped transient (ephemeral) thread

  Parameters

  • socket: Socket
  • key: string
  • Optionalpayload: {
        after_cursor?: string;
        before_cursor?: string;
        include_metadata?: boolean;
        limit?: number;
    }

  Returns Promise<ApiChatChannel>

StatictopicTeamKeyed

• topicTeamKeyed(teamId: string, key: string): string

  Join or create a team-scoped keyed thread

  Parameters

  • teamId: string
  • key: string

  Returns string

StatictopicTeamThread

• topicTeamThread(teamId: string, threadId: string): string

  Join a team-scoped thread by ID

  Parameters

  • teamId: string
  • threadId: string

  Returns string

StatictopicTeamTransient

• topicTeamTransient(teamId: string, key: string): string

  Join a team-scoped transient (ephemeral) thread

  Parameters

  • teamId: string
  • key: string

  Returns string

StatictopicUserKeyed

• topicUserKeyed(key: string): string

  Join or create a user-scoped keyed thread

  Parameters

  • key: string

  Returns string

StatictopicUserThread

• topicUserThread(threadId: string): string

  Join a user-scoped thread by ID, optionally supplying local tools for a personal thread

  Parameters

  • threadId: string

  Returns string

StatictopicUserTransient

• topicUserTransient(key: string): string

  Join a user-scoped transient (ephemeral) thread

  Parameters

  • key: string

  Returns string