Class RestAutocompleteInteraction

Namespace

Discord.Rest

Assembly

Discord.Net.Rest.dll

Represents a REST-based autocomplete interaction.

public class RestAutocompleteInteraction : RestInteraction, IAutocompleteInteraction, IDiscordInteraction, ISnowflakeEntity, IEntity<ulong>

Inheritance

object

RestEntity<ulong>

RestInteraction

RestAutocompleteInteraction

Implements

IAutocompleteInteraction

IDiscordInteraction

ISnowflakeEntity

IEntity<ulong>

Inherited Members

RestInteraction.Type

RestInteraction.Token

RestInteraction.Version

RestInteraction.User

RestInteraction.UserLocale

RestInteraction.GuildLocale

RestInteraction.CreatedAt

RestInteraction.IsValidToken

RestInteraction.Channel

RestInteraction.ChannelId

RestInteraction.Guild

RestInteraction.GuildId

RestInteraction.HasResponded

RestInteraction.IsDMInteraction

RestInteraction.ApplicationId

RestInteraction.ContextType

RestInteraction.Permissions

RestInteraction.Entitlements

RestInteraction.IntegrationOwners

RestInteraction.GetChannelAsync(RequestOptions)

RestInteraction.GetGuildAsync(RequestOptions)

RestInteraction.GetOriginalResponseAsync(RequestOptions)

RestInteraction.ModifyOriginalResponseAsync(Action<MessageProperties>, RequestOptions)

RestInteraction.DeleteOriginalResponseAsync(RequestOptions)

RestInteraction.RespondWithPremiumRequiredAsync(RequestOptions)

RestEntity<ulong>.Id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IDiscordInteractionExtentions.RespondWithModalAsync<T>(IDiscordInteraction, string, InteractionService, RequestOptions, Action<ModalBuilder>)

IDiscordInteractionExtentions.RespondWithModalAsync<T>(IDiscordInteraction, string, RequestOptions, Action<ModalBuilder>)

IDiscordInteractionExtentions.RespondWithModalAsync<T>(IDiscordInteraction, string, T, RequestOptions, Action<ModalBuilder>)

RestExtensions.RespondWithModal<T>(RestInteraction, string, RequestOptions, Action<ModalBuilder>)

RestExtensions.RespondWithModal<T>(RestInteraction, string, T, RequestOptions, Action<ModalBuilder>)

Properties

Data

Gets the autocomplete data of this interaction.

public RestAutocompleteInteractionData Data { get; }

Property Value

RestAutocompleteInteractionData

Methods

Defer(bool, RequestOptions)

public override string Defer(bool ephemeral = false, RequestOptions options = null)

Parameters

ephemeral bool

options RequestOptions

Returns

string

FollowupAsync(string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

Sends a followup message for this interaction.

public override Task<RestFollowupMessage> FollowupAsync(string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, MessageComponent components = null, Embed embed = null, RequestOptions options = null)

Parameters

text string

The text of the message to be sent.

embeds Embed[]

A array of embeds to send with this response. Max 10.

isTTS bool

true if the message should be read out by a text-to-speech reader, otherwise false.

ephemeral bool

true if the response should be hidden to everyone besides the invoker of the command, otherwise false.

allowedMentions AllowedMentions

The allowed mentions for this response.

components MessageComponent

A MessageComponent to be sent with this response.

embed Embed

A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.

options RequestOptions

The request options for this response.

Returns

Task<RestFollowupMessage>

A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

FollowupWithFileAsync(FileAttachment, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

Sends a followup message for this interaction.

public override Task<RestFollowupMessage> FollowupWithFileAsync(FileAttachment attachment, string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, MessageComponent components = null, Embed embed = null, RequestOptions options = null)

Parameters

attachment FileAttachment

The attachment containing the file and description.

text string

The text of the message to be sent.

embeds Embed[]

A array of embeds to send with this response. Max 10.

isTTS bool

true if the message should be read out by a text-to-speech reader, otherwise false.

ephemeral bool

true if the response should be hidden to everyone besides the invoker of the command, otherwise false.

allowedMentions AllowedMentions

The allowed mentions for this response.

components MessageComponent

A MessageComponent to be sent with this response.

embed Embed

A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.

options RequestOptions

The request options for this response.

Returns

Task<RestFollowupMessage>

A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

FollowupWithFileAsync(Stream, string, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

Sends a followup message for this interaction.

public override Task<RestFollowupMessage> FollowupWithFileAsync(Stream fileStream, string fileName, string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, MessageComponent components = null, Embed embed = null, RequestOptions options = null)

Parameters

fileStream Stream

The file to upload.

fileName string

The file name of the attachment.

text string

The text of the message to be sent.

embeds Embed[]

A array of embeds to send with this response. Max 10.

isTTS bool

true if the message should be read out by a text-to-speech reader, otherwise false.

ephemeral bool

true if the response should be hidden to everyone besides the invoker of the command, otherwise false.

allowedMentions AllowedMentions

The allowed mentions for this response.

components MessageComponent

A MessageComponent to be sent with this response.

embed Embed

A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.

options RequestOptions

The request options for this response.

Returns

Task<RestFollowupMessage>

A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

FollowupWithFileAsync(string, string, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

Sends a followup message for this interaction.

public override Task<RestFollowupMessage> FollowupWithFileAsync(string filePath, string fileName = null, string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, MessageComponent components = null, Embed embed = null, RequestOptions options = null)

Parameters

filePath string

The file to upload.

fileName string

The file name of the attachment.

text string

The text of the message to be sent.

embeds Embed[]

A array of embeds to send with this response. Max 10.

isTTS bool

true if the message should be read out by a text-to-speech reader, otherwise false.

ephemeral bool

true if the response should be hidden to everyone besides the invoker of the command, otherwise false.

allowedMentions AllowedMentions

The allowed mentions for this response.

components MessageComponent

A MessageComponent to be sent with this response.

embed Embed

A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.

options RequestOptions

The request options for this response.

Returns

Task<RestFollowupMessage>

A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

FollowupWithFilesAsync(IEnumerable<FileAttachment>, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

Sends a followup message for this interaction.

public override Task<RestFollowupMessage> FollowupWithFilesAsync(IEnumerable<FileAttachment> attachments, string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, MessageComponent components = null, Embed embed = null, RequestOptions options = null)

Parameters

attachments IEnumerable<FileAttachment>

A collection of attachments to upload.

text string

The text of the message to be sent.

embeds Embed[]

A array of embeds to send with this response. Max 10.

isTTS bool

true if the message should be read out by a text-to-speech reader, otherwise false.

ephemeral bool

true if the response should be hidden to everyone besides the invoker of the command, otherwise false.

allowedMentions AllowedMentions

The allowed mentions for this response.

components MessageComponent

A MessageComponent to be sent with this response.

embed Embed

A single embed to send with this response. If this is passed alongside an array of embeds, the single embed will be ignored.

options RequestOptions

The request options for this response.

Returns

Task<RestFollowupMessage>

A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Respond(RequestOptions, params AutocompleteResult[])

Responds to this interaction with a set of choices.

public string Respond(RequestOptions options = null, params AutocompleteResult[] result)

Parameters

options RequestOptions

The request options for this response.

result AutocompleteResult[]

The set of choices for the user to pick from. A max of 25 choices are allowed. Passing null for this argument will show the executing user that there is no choices for their autocompleted input.

Returns

string

A string that contains json to write back to the incoming http request.

Respond(IEnumerable<AutocompleteResult>, RequestOptions)

Responds to this interaction with a set of choices.

public string Respond(IEnumerable<AutocompleteResult> result, RequestOptions options = null)

Parameters

result IEnumerable<AutocompleteResult>

The set of choices for the user to pick from. A max of 25 choices are allowed. Passing null for this argument will show the executing user that there is no choices for their autocompleted input.

options RequestOptions

The request options for this response.

Returns

string

A string that contains json to write back to the incoming http request.

Respond(string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

public override string Respond(string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, MessageComponent components = null, Embed embed = null, RequestOptions options = null)

Parameters

text string

embeds Embed[]

isTTS bool

ephemeral bool

allowedMentions AllowedMentions

components MessageComponent

embed Embed

options RequestOptions

Returns

string

RespondWithModal(Modal, RequestOptions)

public override string RespondWithModal(Modal modal, RequestOptions options = null)

Parameters

modal Modal

options RequestOptions

Returns

string