Interface IDiscordInteraction

Namespace: Discord

Assembly: Discord.Net.Core.dll

Represents a discord interaction.

public interface IDiscordInteraction : ISnowflakeEntity, IEntity<ulong>

Inherited Members: ISnowflakeEntity.CreatedAt

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>)

Properties

ApplicationId

Gets the ID of the application this interaction is for.

ulong ApplicationId { get; }

Property Value

ulong

AttachmentSizeLimit

Gets the attachment size limit in bytes.

ulong AttachmentSizeLimit { get; }

Property Value

ulong

ChannelId

Gets the ID of the channel this interaction was executed in.

ulong? ChannelId { get; }

Property Value

ulong?

Remarks

This property returns null if the interaction is a REST ping interaction.

ContextType

Gets the context this interaction was created in. null if context type is unknown.

InteractionContextType? ContextType { get; }

Property Value

InteractionContextType?

Data

Gets the data sent within this interaction.

IDiscordInteractionData Data { get; }

Property Value

IDiscordInteractionData

Entitlements

Gets entitlements for the invoking user.

IReadOnlyCollection<IEntitlement> Entitlements { get; }

Property Value

IReadOnlyCollection<IEntitlement>

GuildId

Gets the ID of the guild this interaction was executed in.

ulong? GuildId { get; }

Property Value

ulong?

Remarks

This property returns null if the interaction was not executed in a guild.

GuildLocale

Gets the preferred locale of the guild this interaction was executed in. null if not executed in a guild.

string GuildLocale { get; }

Property Value

string

Remarks

Non-community guilds (With no locale setting available) will have en-US as the default value sent by Discord.

HasResponded

Gets whether or not this interaction has been responded to.

bool HasResponded { get; }

Property Value

bool

Remarks

This property is locally set -- if you're running multiple bots off the same token then this property won't be in sync with them.

Id

Gets the id of the interaction.

ulong Id { get; }

Property Value

ulong

IntegrationOwners

Gets which integrations authorized the interaction.

IReadOnlyDictionary<ApplicationIntegrationType, ulong> IntegrationOwners { get; }

Property Value

IReadOnlyDictionary<ApplicationIntegrationType, ulong>

IsDMInteraction

Gets whether or not this interaction was executed in a dm channel.

bool IsDMInteraction { get; }

Property Value

bool

Permissions

Gets the permissions the app or bot has within the channel the interaction was sent from.

GuildPermissions Permissions { get; }

Property Value

GuildPermissions

Token

Gets the continuation token for responding to the interaction.

string Token { get; }

Property Value

string

Type

Gets the type of this IDiscordInteraction.

InteractionType Type { get; }

Property Value

InteractionType

User

Gets the user who invoked the interaction.

IUser User { get; }

Property Value

IUser

UserLocale

Gets the preferred locale of the invoking User.

string UserLocale { get; }

Property Value

string

Remarks

This property returns null if the interaction is a REST ping interaction.

Version

Gets the version of the interaction, always 1.

int Version { get; }

Property Value

int

Methods

DeferAsync(bool, RequestOptions)

Acknowledges this interaction.

Task DeferAsync(bool ephemeral = false, RequestOptions options = null)

Parameters

ephemeral bool
options RequestOptions

Returns

Task: A task that represents the asynchronous operation of deferring the interaction.

DeleteOriginalResponseAsync(RequestOptions)

Deletes the original response to this interaction.

Task DeleteOriginalResponseAsync(RequestOptions options = null)

Parameters

options RequestOptions: The request options for this async request.

Returns

Task: A task that represents an asynchronous deletion operation.

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

Sends a followup message for this interaction.

Task<IUserMessage> 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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

Task<IUserMessage>: 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, PollProperties, MessageFlags)

Sends a followup message for this interaction.

Task<IUserMessage> 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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

Task<IUserMessage>: 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, PollProperties, MessageFlags)

Sends a followup message for this interaction.

Task<IUserMessage> 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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

Task<IUserMessage>: 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, PollProperties, MessageFlags)

Sends a followup message for this interaction.

Task<IUserMessage> 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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

Task<IUserMessage>: 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, PollProperties, MessageFlags)

Sends a followup message for this interaction.

Task<IUserMessage> 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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

Task<IUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

GetOriginalResponseAsync(RequestOptions)

Gets the original response for this interaction.

Task<IUserMessage> GetOriginalResponseAsync(RequestOptions options = null)

Parameters

options RequestOptions: The request options for this async request.

Returns

Task<IUserMessage>: A IUserMessage that represents the initial response.

ModifyOriginalResponseAsync(Action<MessageProperties>, RequestOptions)

Edits original response for this interaction.

Task<IUserMessage> ModifyOriginalResponseAsync(Action<MessageProperties> func, RequestOptions options = null)

Parameters

func Action<MessageProperties>: A delegate containing the properties to modify the message with.
options RequestOptions: The request options for this async request.

Returns

Task<IUserMessage>: A task that represents an asynchronous modification operation. The task result contains the updated message.

RespondAsync(string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions, PollProperties, MessageFlags)

Responds to an Interaction with type ChannelMessageWithSource.

Task RespondAsync(string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, MessageComponent components = null, Embed embed = null, RequestOptions options = null, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

Task: A task that represents an asynchronous send operation for delivering the message.

RespondWithFileAsync(FileAttachment, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions, PollProperties, MessageFlags)

Responds to this interaction with a file attachment.

Task RespondWithFileAsync(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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

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

RespondWithFileAsync(Stream, string, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions, PollProperties, MessageFlags)

Responds to this interaction with a file attachment.

Task RespondWithFileAsync(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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

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

RespondWithFileAsync(string, string, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions, PollProperties, MessageFlags)

Responds to this interaction with a file attachment.

Task RespondWithFileAsync(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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

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

RespondWithFilesAsync(IEnumerable<FileAttachment>, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions, PollProperties, MessageFlags)

Responds to this interaction with a collection of file attachments.

Task RespondWithFilesAsync(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, PollProperties poll = null, MessageFlags flags = MessageFlags.None)

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.
poll PollProperties: A poll to send with the message.
flags MessageFlags

Returns

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

RespondWithModalAsync(Modal, RequestOptions)

Responds to the interaction with a modal.

Task RespondWithModalAsync(Modal modal, RequestOptions options = null)

Parameters

modal Modal: The modal to respond with.
options RequestOptions: The request options for this async request.

Returns

Task: A task that represents the asynchronous operation of responding to the interaction.

RespondWithPremiumRequiredAsync(RequestOptions)

Responds to the interaction with an ephemeral message the invoking user, instructing them that whatever they tried to do requires the premium benefits of your app.

Task RespondWithPremiumRequiredAsync(RequestOptions options = null)

Parameters

options RequestOptions

Returns

Task: A task that represents the asynchronous operation of responding to the interaction.

Table of Contents

Interface IDiscordInteraction

Properties

ApplicationId

Property Value

AttachmentSizeLimit

Property Value

ChannelId

Property Value

Remarks

ContextType

Property Value

Data

Property Value

Entitlements

Property Value

GuildId

Property Value

Remarks

GuildLocale

Property Value

Remarks

HasResponded

Property Value

Remarks

Id

Property Value

IntegrationOwners

Property Value

IsDMInteraction

Property Value

Permissions

Property Value

Token

Property Value

Type

Property Value

User

Property Value

UserLocale

Property Value

Remarks

Version

Property Value

Methods

DeferAsync(bool, RequestOptions)

Parameters

Returns

DeleteOriginalResponseAsync(RequestOptions)

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

GetOriginalResponseAsync(RequestOptions)

Parameters

Returns

ModifyOriginalResponseAsync(Action<MessageProperties>, RequestOptions)

Parameters

Returns

RespondAsync(string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions, PollProperties, MessageFlags)

Parameters

Returns

RespondWithFileAsync(FileAttachment, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions, PollProperties, MessageFlags)

Parameters

Returns

RespondWithFileAsync(Stream, string, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions, PollProperties, MessageFlags)

Parameters