Class RestCommandBase
Represents a REST-based base command interaction.
Assembly: Discord.Net.Rest.dll​
View Source​
Declaration
public class RestCommandBase : RestInteraction, IDiscordInteraction, ISnowflakeEntity, IEntity<ulong>
Properties​
CommandName​
Gets the name of the invoked command.
View Source​
Declaration
public string CommandName { get; }
CommandId​
Gets the id of the invoked command.
View Source​
Declaration
public ulong CommandId { get; }
Methods​
Respond(String, Embed[], Boolean, Boolean, AllowedMentions, RequestOptions, MessageComponent, Embed)​
Responds to an Interaction with type Discord.InteractionResponseType.ChannelMessageWithSource.
View Source​
Declaration
public override string Respond(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.String:
A string that contains json to write back to the incoming http request.
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​
Declaration
public override async Task<RestFollowupMessage> 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.Rest.RestFollowupMessage>:
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. |
FollowupWithFileAsync(Stream, String, String, Embed[], Boolean, Boolean, AllowedMentions, RequestOptions, MessageComponent, Embed)​
Sends a followup message for this interaction.
View Source​
Declaration
public override async Task<RestFollowupMessage> FollowupWithFileAsync(Stream fileStream, string fileName, 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.Rest.RestFollowupMessage>:
The sent message.
Parameters​
| Type | Name | Description |
|---|---|---|
System.IO.Stream | fileStream | The file to upload. |
System.String | fileName | The file name of the attachment. |
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. |
FollowupWithFileAsync(String, String, String, Embed[], Boolean, Boolean, AllowedMentions, RequestOptions, MessageComponent, Embed)​
Sends a followup message for this interaction.
View Source​
Declaration
public override async Task<RestFollowupMessage> FollowupWithFileAsync(string filePath, string text = null, string fileName = 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.Rest.RestFollowupMessage>:
The sent message.
Parameters​
| Type | Name | Description |
|---|---|---|
System.String | filePath | The file to upload. |
System.String | text | The text of the message to be sent. |
System.String | fileName | The file name of the attachment. |
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. |
Defer(Boolean, RequestOptions)​
Acknowledges this interaction with the Discord.InteractionResponseType.DeferredChannelMessageWithSource.
View Source​
Declaration
public override string Defer(bool ephemeral = false, RequestOptions options = null)
Returns​
System.String:
A string that contains json to write back to the incoming http request.
Parameters​
| Type | Name |
|---|---|
System.Boolean | ephemeral |
| Discord.RequestOptions | options |