Interface MessageSearchResults<T>

interface MessageSearchResults<T> {
    analyticsID?: string;
    channels?: AnyGuildChannelWithoutThreads[];
    documentsIndexed?: number;
    doingDeepHistoricalIndex?: boolean;
    members?: ThreadMember[];
    messages: Message<T>[][];
    threads?: AnyThreadChannel[];
    totalResults: number;
}

Type Parameters

Properties

analyticsID? channels? documentsIndexed? doingDeepHistoricalIndex? members? messages threads? totalResults

Properties

Optional analyticsID

analyticsID?: string

The search analytics ID returned by Discord, if present.

Optional channels

channels?: AnyGuildChannelWithoutThreads[]

The channels that contain the returned messages, if included.

Optional documentsIndexed

documentsIndexed?: number

The number of documents that have been indexed during the current indexing operation, if any.

Optional doingDeepHistoricalIndex

doingDeepHistoricalIndex?: boolean

Whether the guild is undergoing a deep historical indexing operation.

Optional members

members?: ThreadMember[]

Thread members for returned threads, if included.

messages

messages: Message<T>[][]

The messages that matched the query. Discord returns this as nested arrays for search-context compatibility.

Optional threads

threads?: AnyThreadChannel[]

Threads that contain the returned messages, if included.

totalResults

totalResults: number

The total number of results that match the query.

Settings

Member Visibility

Theme

On This Page

analyticsIDchannelsdocumentsIndexeddoingDeepHistoricalIndexmembersmessagesthreadstotalResults