Class ContextCommandBuilder

Namespace

Discord.Interactions.Builders

Assembly

Discord.Net.Interactions.dll

Represents a builder for creating ContextCommandInfo.

public sealed class ContextCommandBuilder : CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>, ICommandBuilder

Inheritance

object

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>

ContextCommandBuilder

Implements

ICommandBuilder

Inherited Members

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.Module

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.Callback

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.Name

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.MethodName

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.IgnoreGroupNames

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.TreatNameAsRegex

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.RunMode

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.Attributes

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.Parameters

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.Preconditions

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.WithName(string)

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.WithMethodName(string)

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.WithAttributes(params Attribute[])

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.SetRunMode(RunMode)

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.WithNameAsRegex(bool)

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.AddParameters(params CommandParameterBuilder[])

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.WithPreconditions(params PreconditionAttribute[])

CommandBuilder<ContextCommandInfo, ContextCommandBuilder, CommandParameterBuilder>.AddParameter(Action<CommandParameterBuilder>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ContextCommandBuilder(ModuleBuilder, string, ExecuteCallback)

Initializes a new ContextCommandBuilder.

public ContextCommandBuilder(ModuleBuilder module, string name, ExecuteCallback callback)

Parameters

module ModuleBuilder

Parent module of this command.

name string

Name of this command.

callback ExecuteCallback

Execution callback of this command.

Properties

CommandType

Gets the type of this command.

public ApplicationCommandType CommandType { get; set; }

Property Value

ApplicationCommandType

ContextTypes

Gets the context types this command can be executed in.

public HashSet<InteractionContextType> ContextTypes { get; set; }

Property Value

HashSet<InteractionContextType>

DefaultMemberPermissions

Gets the default permissions needed for executing this command.

public GuildPermission? DefaultMemberPermissions { get; set; }

Property Value

GuildPermission?

DefaultPermission

Gets the default permission of this command.

[Obsolete("To be deprecated soon, use IsEnabledInDm and DefaultMemberPermissions instead.")]
public bool DefaultPermission { get; set; }

Property Value

bool

Instance

protected override ContextCommandBuilder Instance { get; }

Property Value

ContextCommandBuilder

IntegrationTypes

Gets the install method for this command.

public HashSet<ApplicationIntegrationType> IntegrationTypes { get; set; }

Property Value

HashSet<ApplicationIntegrationType>

IsEnabledInDm

Gets whether this command can be used in DMs.

public bool IsEnabledInDm { get; set; }

Property Value

bool

IsNsfw

Gets whether this command is age restricted.

public bool IsNsfw { get; set; }

Property Value

bool

Methods

AddParameter(Action<CommandParameterBuilder>)

Adds a command parameter to the parameters collection.

public override ContextCommandBuilder AddParameter(Action<CommandParameterBuilder> configure)

Parameters

configure Action<CommandParameterBuilder>

CommandParameterBuilder factory.

Returns

ContextCommandBuilder

The builder instance.

SetDefaultPermission(bool)

Sets DefaultPermission.

[Obsolete("To be deprecated soon, use SetEnabledInDm and WithDefaultMemberPermissions instead.")]
public ContextCommandBuilder SetDefaultPermission(bool defaultPermision)

Parameters

defaultPermision bool

New value of the DefaultPermission.

Returns

ContextCommandBuilder

The builder instance.

SetEnabledInDm(bool)

Sets IsEnabledInDm.

public ContextCommandBuilder SetEnabledInDm(bool isEnabled)

Parameters

isEnabled bool

New value of the IsEnabledInDm.

Returns

ContextCommandBuilder

The builder instance.

SetNsfw(bool)

Sets IsNsfw.

public ContextCommandBuilder SetNsfw(bool isNsfw)

Parameters

isNsfw bool

New value of the IsNsfw.

Returns

ContextCommandBuilder

The builder instance.

SetType(ApplicationCommandType)

Sets CommandType.

public ContextCommandBuilder SetType(ApplicationCommandType commandType)

Parameters

commandType ApplicationCommandType

New value of the CommandType.

Returns

ContextCommandBuilder

The builder instance.

WithContextTypes(params InteractionContextType[])

Sets the ContextTypes of this ContextCommandBuilder.

public ContextCommandBuilder WithContextTypes(params InteractionContextType[] contextTypes)

Parameters

contextTypes InteractionContextType[]

Context types the command can be executed in.

Returns

ContextCommandBuilder

The builder instance.

WithDefaultMemberPermissions(GuildPermission)

Sets DefaultMemberPermissions.

public ContextCommandBuilder WithDefaultMemberPermissions(GuildPermission permissions)

Parameters

permissions GuildPermission

New value of the DefaultMemberPermissions.

Returns

ContextCommandBuilder

The builder instance.

WithIntegrationTypes(params ApplicationIntegrationType[])

Sets the IntegrationTypes of this ContextCommandBuilder.

public ContextCommandBuilder WithIntegrationTypes(params ApplicationIntegrationType[] integrationTypes)

Parameters

integrationTypes ApplicationIntegrationType[]

Install types for this command.

Returns

ContextCommandBuilder

The builder instance.