Class SearchGuildMessages

Namespace

Discord

Assembly

Discord.Net.Core.dll

Represents guild message search filter options. Uses the following endpoint: https://docs.discord.com/developers/resources/message#search-guild-messages

public class SearchGuildMessages

Inheritance

object

SearchGuildMessages

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AuthorFilterBots

Whether to whitelist messages sent by bots.

public Optional<bool> AuthorFilterBots { get; set; }

Property Value

Optional<bool>

Remarks

If none of AuthorFilterUsers, AuthorFilterBots or AuthorFilterWebhooks are enabled, the author type of the message will be ignored in the search.

AuthorFilterUsers

Whether to whitelist messages sent by regular users.

public Optional<bool> AuthorFilterUsers { get; set; }

Property Value

Optional<bool>

Remarks

If none of AuthorFilterUsers, AuthorFilterBots or AuthorFilterWebhooks are enabled, the author type of the message will be ignored in the search.

AuthorFilterWebhooks

Whether to whitelist messages sent using webhooks.

public Optional<bool> AuthorFilterWebhooks { get; set; }

Property Value

Optional<bool>

Remarks

If none of AuthorFilterUsers, AuthorFilterBots or AuthorFilterWebhooks are enabled, the author type of the message will be ignored in the search.

AuthorIds

A list of user IDs used as a filter for the messages' authors.

public Optional<IEnumerable<ulong>> AuthorIds { get; set; }

Property Value

Optional<IEnumerable<ulong>>

ChannelIds

A list of channel IDs serving as a whitelist for the search.

public Optional<IEnumerable<ulong>> ChannelIds { get; set; }

Property Value

Optional<IEnumerable<ulong>>

Content

The message content to search for.

public Optional<string> Content { get; set; }

Property Value

Optional<string>

EveryoneMention

Whether the @everyone mention needs to be present in the message for it to be included in the response.

public Optional<bool> EveryoneMention { get; set; }

Property Value

Optional<bool>

IncludeNsfw

Whether to include messages from NSFW channels in the response.

public Optional<bool> IncludeNsfw { get; set; }

Property Value

Optional<bool>

IsPinned

Whether the message needs to be pinned for it to be included in the response.

public Optional<bool> IsPinned { get; set; }

Property Value

Optional<bool>

Limit

How many messages to fetch.

public Optional<int> Limit { get; set; }

Property Value

Optional<int>

MaxMessageId

The maximum message ID that can be returned in the response. ToSnowflake(DateTimeOffset) can be used if you do not have a message id.

public Optional<ulong> MaxMessageId { get; set; }

Property Value

Optional<ulong>

MinMessageId

The minimum message ID that can be returned in the response. ToSnowflake(DateTimeOffset) can be used if you do not have a message id.

public Optional<ulong> MinMessageId { get; set; }

Property Value

Optional<ulong>

Offset

How many messages to offset by.

public Optional<int> Offset { get; set; }

Property Value

Optional<int>

RepliedToMessageIds

A list of message IDs that is used as a whitelist checking whether a message replies to any of the specified messages.

public Optional<IEnumerable<ulong>> RepliedToMessageIds { get; set; }

Property Value

Optional<IEnumerable<ulong>>

RepliedToUserIds

A list of user IDs that is used as a whitelist checking whether a message replies to any of the specified users.

public Optional<IEnumerable<ulong>> RepliedToUserIds { get; set; }

Property Value

Optional<IEnumerable<ulong>>

RoleMentionIds

A list of role IDs that need to be mentioned in the response.

public Optional<IEnumerable<ulong>> RoleMentionIds { get; set; }

Property Value

Optional<IEnumerable<ulong>>

Slop

The slop amount. Dictates the maximum number of words to skip between matching tokens in the Content.

public Optional<int> Slop { get; set; }

Property Value

Optional<int>

SortAlgorithm

The slop amount. Dictates the maximum number of words to skip between matching tokens in the Content.

public Optional<SortAlgorithm> SortAlgorithm { get; set; }

Property Value

Optional<SortAlgorithm>

SortDirection

The slop amount. Dictates the maximum number of words to skip between matching tokens in the Content.

public Optional<SortDirection> SortDirection { get; set; }

Property Value

Optional<SortDirection>

UserMentionIds

A list of user IDs that need to be mentioned in the response.

public Optional<IEnumerable<ulong>> UserMentionIds { get; set; }

Property Value

Optional<IEnumerable<ulong>>