Class ComponentCommandInfo

Namespace

Discord.Interactions

Assembly

Discord.Net.Interactions.dll

Represents the info class of an attribute based method for handling Component Interaction events.

public class ComponentCommandInfo : CommandInfo<ComponentCommandParameterInfo>, ICommandInfo

Inheritance

object

CommandInfo<ComponentCommandParameterInfo>

ComponentCommandInfo

Implements

ICommandInfo

Inherited Members

CommandInfo<ComponentCommandParameterInfo>.Module

CommandInfo<ComponentCommandParameterInfo>.CommandService

CommandInfo<ComponentCommandParameterInfo>.Name

CommandInfo<ComponentCommandParameterInfo>.MethodName

CommandInfo<ComponentCommandParameterInfo>.IgnoreGroupNames

CommandInfo<ComponentCommandParameterInfo>.IsTopLevelCommand

CommandInfo<ComponentCommandParameterInfo>.RunMode

CommandInfo<ComponentCommandParameterInfo>.Attributes

CommandInfo<ComponentCommandParameterInfo>.Preconditions

CommandInfo<ComponentCommandParameterInfo>.TreatNameAsRegex

CommandInfo<ComponentCommandParameterInfo>.CheckPreconditionsAsync(IInteractionContext, IServiceProvider)

CommandInfo<ComponentCommandParameterInfo>.InvokeEventAndReturn<T>(IInteractionContext, T)

CommandInfo<ComponentCommandParameterInfo>.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Parameters

Gets a collection of the parameters of this command.

public override IReadOnlyList<ComponentCommandParameterInfo> Parameters { get; }

Property Value

IReadOnlyList<ComponentCommandParameterInfo>

SupportsWildCards

Gets whether this command supports wild card patterns.

public override bool SupportsWildCards { get; }

Property Value

bool

Methods

ExecuteAsync(IInteractionContext, IServiceProvider)

Executes the command with the provided context.

public override Task<IResult> ExecuteAsync(IInteractionContext context, IServiceProvider services)

Parameters

context IInteractionContext

The execution context.

services IServiceProvider

Dependencies that will be used to create the module instance.

Returns

Task<IResult>

A task representing the execution process. The task result contains the execution result.

GetLogString(IInteractionContext)

protected override string GetLogString(IInteractionContext context)

Parameters

context IInteractionContext

Returns

string

InvokeModuleEvent(IInteractionContext, IResult)

protected override Task InvokeModuleEvent(IInteractionContext context, IResult result)

Parameters

context IInteractionContext

result IResult

Returns

Task

ParseArgumentsAsync(IInteractionContext, IServiceProvider)

protected override Task<IResult> ParseArgumentsAsync(IInteractionContext context, IServiceProvider services)

Parameters

context IInteractionContext

services IServiceProvider

Returns

Task<IResult>