Class SocketCommandBase

Namespace

Discord.WebSocket

Assembly

Discord.Net.WebSocket.dll

Base class for User, Message, and Slash command interactions.

public class SocketCommandBase : SocketInteraction, IDiscordInteraction, ISnowflakeEntity, IEntity<ulong>

Inheritance

object

SocketEntity<ulong>

SocketInteraction

SocketCommandBase

Implements

IDiscordInteraction

ISnowflakeEntity

IEntity<ulong>

Derived

SocketMessageCommand

SocketSlashCommand

SocketUserCommand

Inherited Members

SocketInteraction.Channel

SocketInteraction.ChannelId

SocketInteraction.User

SocketInteraction.Type

SocketInteraction.Token

SocketInteraction.Data

SocketInteraction.UserLocale

SocketInteraction.GuildLocale

SocketInteraction.Version

SocketInteraction.CreatedAt

SocketInteraction.IsValidToken

SocketInteraction.IsDMInteraction

SocketInteraction.GuildId

SocketInteraction.ApplicationId

SocketInteraction.ContextType

SocketInteraction.Permissions

SocketInteraction.Entitlements

SocketInteraction.IntegrationOwners

SocketInteraction.RespondWithFileAsync(Stream, string, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

SocketInteraction.RespondWithFileAsync(string, string, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

SocketInteraction.RespondWithFileAsync(FileAttachment, string, Embed[], bool, bool, AllowedMentions, MessageComponent, Embed, RequestOptions)

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

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

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

SocketInteraction.GetOriginalResponseAsync(RequestOptions)

SocketInteraction.ModifyOriginalResponseAsync(Action<MessageProperties>, RequestOptions)

SocketInteraction.DeleteOriginalResponseAsync(RequestOptions)

SocketInteraction.RespondWithPremiumRequiredAsync(RequestOptions)

SocketInteraction.GetChannelAsync(RequestOptions)

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

Properties

CommandId

Gets the id of the invoked command.

public ulong CommandId { get; }

Property Value

ulong

CommandName

Gets the name of the invoked command.

public string CommandName { get; }

Property Value

string

HasResponded

Gets whether or not this interaction has been responded to.

public override 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.

Methods

DeferAsync(bool, RequestOptions)

Acknowledges this interaction with the DeferredChannelMessageWithSource.

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

Parameters

ephemeral bool

options RequestOptions

Returns

Task

A task that represents the asynchronous operation of acknowledging the interaction.

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>

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.

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

Responds to an Interaction with type ChannelMessageWithSource.

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

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

Exceptions

ArgumentOutOfRangeException

Message content is too long, length must be less or equal to MaxMessageSize.

InvalidOperationException

The parameters provided were invalid or the token was invalid.

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

Responds to this interaction with a collection of file attachments.

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

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

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

RespondWithModalAsync(Modal, RequestOptions)

Responds to this interaction with a Modal.

public override 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.