Class ModalBuilder

Namespace

Discord.Interactions.Builders

Assembly

Discord.Net.Interactions.dll

Represents a builder for creating ModalInfo.

public class ModalBuilder

Inheritance

object

ModalBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ModalBuilder(Type, ModalInitializer, InteractionService)

Initializes a new ModalBuilder

public ModalBuilder(Type type, ModalInitializer modalInitializer, InteractionService interactionService)

Parameters

type Type

modalInitializer ModalInitializer

The initialization delegate for this modal.

interactionService InteractionService

Properties

Components

Gets a collection of the components of this modal.

public IReadOnlyCollection<IModalComponentBuilder> Components { get; }

Property Value

IReadOnlyCollection<IModalComponentBuilder>

ModalInitializer

Gets the initialization delegate for this modal.

public ModalInitializer ModalInitializer { get; }

Property Value

ModalInitializer

Title

Gets the title of this modal.

public string Title { get; set; }

Property Value

string

Type

Gets the IModal implementation used to initialize this object.

public Type Type { get; }

Property Value

Type

Methods

AddChannelSelectInputComponent(Action<ChannelSelectComponentBuilder>)

Adds a channel select component to Components.

public ModalBuilder AddChannelSelectInputComponent(Action<ChannelSelectComponentBuilder> configure)

Parameters

configure Action<ChannelSelectComponentBuilder>

Channel select component builder factory.

Returns

ModalBuilder

The builder instance.

AddFileUploadInputComponent(Action<FileUploadComponentBuilder>)

Adds a file upload component to Components.

public ModalBuilder AddFileUploadInputComponent(Action<FileUploadComponentBuilder> configure)

Parameters

configure Action<FileUploadComponentBuilder>

File upload component builder factory.

Returns

ModalBuilder

The builder instance.

AddMentionableSelectInputComponent(Action<MentionableSelectComponentBuilder>)

Adds a mentionable select component to Components.

public ModalBuilder AddMentionableSelectInputComponent(Action<MentionableSelectComponentBuilder> configure)

Parameters

configure Action<MentionableSelectComponentBuilder>

Mentionable select component builder factory.

Returns

ModalBuilder

The builder instance.

AddRoleSelectInputComponent(Action<RoleSelectComponentBuilder>)

Adds a role select component to Components.

public ModalBuilder AddRoleSelectInputComponent(Action<RoleSelectComponentBuilder> configure)

Parameters

configure Action<RoleSelectComponentBuilder>

Role select component builder factory.

Returns

ModalBuilder

The builder instance.

AddSelectMenuInputComponent(Action<SelectMenuComponentBuilder>)

Adds a select menu component to Components.

public ModalBuilder AddSelectMenuInputComponent(Action<SelectMenuComponentBuilder> configure)

Parameters

configure Action<SelectMenuComponentBuilder>

Select menu component builder factory.

Returns

ModalBuilder

The builder instance.

AddTextDisplayComponent(Action<TextDisplayComponentBuilder>)

Adds a text display component to Components.

public ModalBuilder AddTextDisplayComponent(Action<TextDisplayComponentBuilder> configure)

Parameters

configure Action<TextDisplayComponentBuilder>

Text display component builder factory.

Returns

ModalBuilder

The builder instance.

AddTextInputComponent(Action<TextInputComponentBuilder>)

Adds text components to Components.

public ModalBuilder AddTextInputComponent(Action<TextInputComponentBuilder> configure)

Parameters

configure Action<TextInputComponentBuilder>

Text Component builder factory.

Returns

ModalBuilder

The builder instance.

AddUserSelectInputComponent(Action<UserSelectComponentBuilder>)

Adds a user select component to Components.

public ModalBuilder AddUserSelectInputComponent(Action<UserSelectComponentBuilder> configure)

Parameters

configure Action<UserSelectComponentBuilder>

User select component builder factory.

Returns

ModalBuilder

The builder instance.

WithTitle(string)

Sets Title.

public ModalBuilder WithTitle(string title)

Parameters

title string

New value of the Title.

Returns

ModalBuilder

The builder instance.