Interface IDiscordInteraction
Represents a discord interaction.
Assembly: Discord.Net.Core.dll​
View Source​
public interface IDiscordInteraction : ISnowflakeEntity, IEntity<ulong>
Properties​
Id​
Gets the id of the interaction.
View Source​
ulong Id { get; }
Type​
Gets the type of this Discord.IDiscordInteraction.
View Source​
InteractionType Type { get; }
Data​
Gets the data sent within this interaction.
View Source​
IDiscordInteractionData Data { get; }
Token​
Gets the continuation token for responding to the interaction.
View Source​
string Token { get; }
Version​
Gets the version of the interaction, always 1.
View Source​
int Version { get; }
Methods​
RespondAsync(String, Embed[], Boolean, Boolean, AllowedMentions, RequestOptions, MessageComponent, Embed)​
Responds to an Interaction with type Discord.InteractionResponseType.ChannelMessageWithSource.
View Source​
Task RespondAsync(string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, RequestOptions options = null, MessageComponent component = null, Embed embed = null)
Returns​
System.Threading.Tasks.Task
Parameters​
Type | Name | Description |
---|---|---|
System.String | text | The text of the message to be sent. |
Discord.Embed[] | embeds | A array of embeds to send with this response. Max 10. |
System.Boolean | isTTS | true if the message should be read out by a text-to-speech reader, otherwise false . |
System.Boolean | ephemeral | true if the response should be hidden to everyone besides the invoker of the command, otherwise false . |
Discord.AllowedMentions | allowedMentions | The allowed mentions for this response. |
Discord.RequestOptions | options | The request options for this response. |
Discord.MessageComponent | component | A Discord.MessageComponent to be sent with this response. |
Discord.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. |
FollowupAsync(String, Embed[], Boolean, Boolean, AllowedMentions, RequestOptions, MessageComponent, Embed)​
Sends a followup message for this interaction.
View Source​
Task<IUserMessage> FollowupAsync(string text = null, Embed[] embeds = null, bool isTTS = false, bool ephemeral = false, AllowedMentions allowedMentions = null, RequestOptions options = null, MessageComponent component = null, Embed embed = null)
Returns​
System.Threading.Tasks.Task<Discord.IUserMessage>
:
The sent message.
Parameters​
Type | Name | Description |
---|---|---|
System.String | text | The text of the message to be sent. |
Discord.Embed[] | embeds | A array of embeds to send with this response. Max 10. |
System.Boolean | isTTS | true if the message should be read out by a text-to-speech reader, otherwise false . |
System.Boolean | ephemeral | true if the response should be hidden to everyone besides the invoker of the command, otherwise false . |
Discord.AllowedMentions | allowedMentions | The allowed mentions for this response. |
Discord.RequestOptions | options | The request options for this response. |
Discord.MessageComponent | component | A Discord.MessageComponent to be sent with this response. |
Discord.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. |
GetOriginalResponseAsync(RequestOptions)​
Gets the original response for this interaction.
View Source​
Task<IUserMessage> GetOriginalResponseAsync(RequestOptions options = null)
Returns​
System.Threading.Tasks.Task<Discord.IUserMessage>
: A Discord.IUserMessage that represents the initial response.
Parameters​
Type | Name | Description |
---|---|---|
Discord.RequestOptions | options | The request options for this async request. |
ModifyOriginalResponseAsync(Action<MessageProperties>, RequestOptions)​
Edits original response for this interaction.
View Source​
Task<IUserMessage> ModifyOriginalResponseAsync(Action<MessageProperties> func, RequestOptions options = null)
Returns​
System.Threading.Tasks.Task<Discord.IUserMessage>
: A Discord.IUserMessage that represents the initial response.
Parameters​
Type | Name | Description |
---|---|---|
System.Action<Discord.MessageProperties> | func | A delegate containing the properties to modify the message with. |
Discord.RequestOptions | options | The request options for this async request. |
DeferAsync(Boolean, RequestOptions)​
Acknowledges this interaction.
View Source​
Task DeferAsync(bool ephemeral = false, RequestOptions options = null)
Returns​
System.Threading.Tasks.Task
:
A task that represents the asynchronous operation of acknowledging the interaction.
Parameters​
Type | Name |
---|---|
System.Boolean | ephemeral |
Discord.RequestOptions | options |