@theophilusdev/conduit
    Preparing search index...

    Class ConduitThreadsAPI

    High-level thread management API for Conduit.

    Provides utilities for interacting with group chats, message threads, participants, and thread-level metadata.

    This class wraps the FCA callback-based API into Promise-based methods. Certain mutating operations may be queued when a ConduitQueue is provided (e.g. nickname changes, title updates, polls).

    Accessible via client.threads.

    Index

    Constructors

    Methods

    • Adds a user to a group thread.

      Parameters

      • userID: string

        User to add

      • threadID: string

        Target group thread

      Returns Promise<any>

    • Changes a participant's admin status.

      Parameters

      • userID: string

        Target user

      • threadID: string

        Group thread

      • admin: boolean

        true to promote, false to demote

      Returns Promise<any>

    • Updates the group profile image.

      Parameters

      • image: any

        Image stream or buffer

      • threadID: string

        Target group thread

      Returns Promise<any>

    • Sets a participant's nickname in a thread.

      Parameters

      • nickname: string

        New nickname (empty string clears it)

      • threadID: string

        Target thread

      • userID: string

        Target user

      Returns Promise<any>

      This operation may be queued if a ConduitQueue is configured.

    • Creates a new group conversation.

      Parameters

      • userIDs: string[]

        Participants to include in the group

      • Optionalname: string

        Optional group title

      Returns Promise<any>

      Newly created thread data

    • Creates a poll in a thread.

      Parameters

      • title: string

        Poll question

      • threadID: string

        Target thread

      • options: string[]

        Answer choices

      Returns Promise<any>

    • Retrieves message history for a thread.

      Parameters

      • threadID: string

        Target conversation ID

      • limit: number

        Number of messages to fetch

      Returns Promise<any>

    • Retrieves detailed metadata about a thread.

      Parameters

      • threadID: string

        Target conversation ID

      Returns Promise<any>

      Thread information object from FCA

    • Fetches a paginated list of threads.

      Parameters

      • limit: number

        Maximum number of threads to return

      • cursor: any

        Pagination cursor or null for first page

      • folders: string[]

        Thread folders to include (e.g. ["INBOX"])

      Returns Promise<any>

    • Accepts or rejects a message request thread.

      Parameters

      • threadID: string

        Request thread

      • accept: boolean

        true to accept, false to decline

      Returns Promise<any>

    • Mutes or unmutes a thread.

      Parameters

      • threadID: string

        Target thread

      • muteUntil: number

        Timestamp in ms, -1 for permanent mute, 0 to unmute

      Returns Promise<any>

    • Removes a user from a group thread.

      Parameters

      • userID: string

        User to remove

      • threadID: string

        Target group thread

      Returns Promise<any>

    • Searches for threads by keyword or name.

      Parameters

      • query: string

        Search term

      Returns Promise<any>

      Matching thread results

    • Updates the title of a group thread.

      Parameters

      • title: string

        New group name

      • threadID: string

        Target group thread

      Returns Promise<any>