Interface SearchMessagesOptions

interface SearchMessagesOptions {
    authorIDs?: string | string[];
    channelIDs?: string | string[];
    commandID?: string;
    commandName?: string;
    content?: string;
    has?: MessageSearchHasFilter | MessageSearchHasFilter[];
    includeNSFW?: boolean;
    maxID?: string;
    mentions?: string | string[];
    minID?: string;
    offset?: number;
    pinned?: boolean;
    sortBy?: MessageSearchSortBy;
    sortOrder?: SearchSortOrder;
}

Properties

authorIDs? channelIDs? commandID? commandName? content? has? includeNSFW? maxID? mentions? minID? offset? pinned? sortBy? sortOrder?

Properties

Optional authorIDs

authorIDs?: string | string[]

Restrict results to messages sent by these users.

Optional channelIDs

channelIDs?: string | string[]

Restrict results to these channels.

Optional commandID

commandID?: string

Restrict results to messages created by this application command.

Optional commandName

commandName?: string

Restrict results to messages created by this application command name.

Optional content

content?: string

The content to search for.

Optional has

has?: MessageSearchHasFilter | MessageSearchHasFilter[]

Restrict results to messages containing these attachment/embed types.

Optional includeNSFW

includeNSFW?: boolean

Include results from NSFW channels.

Optional maxID

maxID?: string

Search messages before this message ID.

Optional mentions

mentions?: string | string[]

Search for messages mentioning these users.

Optional minID

minID?: string

Search messages after this message ID.

Optional offset

offset?: number

The offset into the search results.

Optional pinned

pinned?: boolean

Restrict results to pinned messages.

Optional sortBy

sortBy?: MessageSearchSortBy

The field to sort by.

Optional sortOrder

sortOrder?: SearchSortOrder

The sort order.

Settings

Member Visibility

Theme

On This Page

authorIDschannelIDscommandIDcommandNamecontenthasincludeNSFWmaxIDmentionsminIDoffsetpinnedsortBysortOrder