Package net.dv8tion.jda.api.interactions.modals

Class Modal.Builder

java.lang.Object

net.dv8tion.jda.api.interactions.modals.Modal.Builder

Enclosing interface:

Modal

public static class Modal.Builder
extends Object

A preconfigured builder for the creation of modals.

Method Summary

Modifier and Type	Method	Description
Modal.Builder	addActionRow(Collection<? extends ItemComponent> components)	Adds an ActionRow to this modal
Modal.Builder	addActionRow(ItemComponent... components)	Adds an ActionRow to this modal
Modal.Builder	addComponents(Collection<? extends LayoutComponent> components)	Adds LayoutComponents to this modal
Modal.Builder	addComponents(LayoutComponent... components)	Adds LayoutComponents to this modal
Modal	build()	Builds and returns the Modal
List<LayoutComponent>	getComponents()	Returns a modifiable list of all components
String	getId()	Returns the custom id
String	getTitle()	Returns the title
Modal.Builder	setId(String customId)	Sets the custom id for this modal.
Modal.Builder	setTitle(String title)	Sets the title for this modal.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setId

@Nonnull
public Modal.Builder setId(@Nonnull
 String customId)

Sets the custom id for this modal.

Parameters:

customId - Custom id

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If the provided id is null, blank, or is longer than 100 characters.

setTitle

@Nonnull
public Modal.Builder setTitle(@Nonnull
 String title)

Sets the title for this modal.

Parameters:

title - The title

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If the provided title is null, blank or longer than 45 characters

addComponents

@Nonnull
public Modal.Builder addComponents(@Nonnull
 LayoutComponent... components)

Adds LayoutComponents to this modal

Parameters:

components - LayoutComponents to add to the modal, up to 5 total

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException -

• If any of the provided layouts are null
• If any of the provided components are not compatible with Modals

See Also:

• LayoutComponent.isModalCompatible()

addComponents

@Nonnull
public Modal.Builder addComponents(@Nonnull
 Collection<? extends LayoutComponent> components)

Adds LayoutComponents to this modal

Parameters:

components - LayoutComponents to add to the modal, up to 5 total

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException -

• If any of the provided layouts are null
• If any of the provided components are not compatible with Modals

See Also:

• LayoutComponent.isModalCompatible()

addActionRow

@Nonnull
public Modal.Builder addActionRow(@Nonnull
 Collection<? extends ItemComponent> components)

Adds an ActionRow to this modal

Parameters:

components - The components to add

Returns:

Same builder for chaining convenience

Throws:

IllegalArgumentException -

• If any of the provided ItemComponents are null, or an invalid number of components are provided
• If any of the provided ItemComponents are not compatible with Modals

See Also:

• ItemComponent.isModalCompatible()

addActionRow

@Nonnull
public Modal.Builder addActionRow(@Nonnull
 ItemComponent... components)

Adds an ActionRow to this modal

Parameters:

components - The components to add

Returns:

Same builder for chaining convenience

Throws:

IllegalArgumentException -

• If any of the provided ItemComponents are null, or an invalid number of components are provided
• If any of the provided ItemComponents are not compatible with Modals

See Also:

• ItemComponent.isModalCompatible()

getComponents

@Nonnull
public List<LayoutComponent> getComponents()

Returns a modifiable list of all components

Returns:

A modifiable list of all components

getTitle

@Nonnull
public String getTitle()

Returns the title

Returns:

the title

getId

@Nonnull
public String getId()

Returns the custom id

Returns:

the id

build

@Nonnull
public Modal build()

Builds and returns the Modal

Returns:

A Modal

Throws:

IllegalArgumentException -

• If no components are added
• If more than 5 component layouts are added