Package net.dv8tion.jda.api.components.section

Interface Section

All Superinterfaces:

Component, ContainerChildComponent, IDisableable, IReplaceable, MessageTopLevelComponent

public interface Section
extends MessageTopLevelComponent, ContainerChildComponent, IReplaceable, IDisableable

Component which contains the main content on the left and an accessory on the right.

This can contain up to 3 SectionContentComponent.

Requirements: Components V2 needs to be enabled!

See Also:

• SectionContentComponent
• SectionContentComponentUnion
• SectionAccessoryComponent
• SectionAccessoryComponentUnion

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.components.Component

Component.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_COMPONENTS	How many SectionContentComponent can be in this section.

Method Summary

Modifier and Type	Method	Description
default Section	asDisabled()	Returns a new instance of this component in a disabled state.
default Section	asEnabled()	Returns a new instance of this component in an enabled state.
SectionAccessoryComponentUnion	getAccessory()	The accessory of this section.
@Unmodifiable List<SectionContentComponentUnion>	getContentComponents()	Returns an immutable list with the components contained by this section.
default boolean	isDisabled()	Whether this component is disabled.
default boolean	isEnabled()	Whether this component is enabled.
default boolean	isMessageCompatible()	Whether this Component is compatible with Messages.
default boolean	isModalCompatible()	Whether this Component is compatible with Modals.
static Section	of(SectionAccessoryComponent accessory, Collection<? extends SectionContentComponent> components)	Constructs a new Section from the given accessory and components.
static Section	of(SectionAccessoryComponent accessory, SectionContentComponent component, SectionContentComponent... components)	Constructs a new Section from the given accessory and components.
Section	replace(ComponentReplacer replacer)	Replaces and/or removes children components using the provided ComponentReplacer, and construct a new component from the result.
Section	withAccessory(SectionAccessoryComponent accessory)	Creates a new Section with the specified accessory.
Section	withContentComponents(Collection<? extends SectionContentComponent> components)	Creates a new Section with the specified content components.
default Section	withContentComponents(SectionContentComponent component, SectionContentComponent... components)	Creates a new Section with the specified content components.
default Section	withDisabled(boolean disabled)	Returns a new instance of this component in an enabled/disabled state.
Section	withUniqueId(int uniqueId)	Creates a new component with the provided numeric ID.

Methods inherited from interface net.dv8tion.jda.api.components.Component

getType, getUniqueId

Field Details

MAX_COMPONENTS

static final int MAX_COMPONENTS

How many SectionContentComponent can be in this section. (3)

See Also:

• Constant Field Values

Method Details

of

@Nonnull
static Section of(@Nonnull
 SectionAccessoryComponent accessory,
 @Nonnull
 Collection<? extends SectionContentComponent> components)

Constructs a new Section from the given accessory and components.

Parameters:

accessory - The accessory of this section

components - The components to add

Returns:

The new Section

Throws:

IllegalArgumentException -

• If null is provided
• If more than 3 components are provided
• If one of the components is unknown

of

@Nonnull
static Section of(@Nonnull
 SectionAccessoryComponent accessory,
 @Nonnull
 SectionContentComponent component,
 @Nonnull
 SectionContentComponent... components)

Constructs a new Section from the given accessory and components.

Parameters:

accessory - The accessory of this section

component - The component to add

components - Additional components to add

Returns:

The new Section

Throws:

IllegalArgumentException -

• If null is provided
• If more than 3 components are provided
• If one of the components is unknown

isMessageCompatible

default boolean isMessageCompatible()

Description copied from interface: Component

Whether this Component is compatible with Messages.
If the component in question contains other components, this also checks every component inside it.

Specified by:

isMessageCompatible in interface Component

Returns:

True, if this Component (and its children) is compatible with messages.

isModalCompatible

default boolean isModalCompatible()

Description copied from interface: Component

Whether this Component is compatible with Modals.
If the component in question contains other components, this also checks every component inside it.

Specified by:

isModalCompatible in interface Component

Returns:

True, if this Component (and its children) is compatible with modals.

replace

@Nonnull
Section replace(@Nonnull
 ComponentReplacer replacer)

Description copied from interface: IReplaceable

Replaces and/or removes children components using the provided ComponentReplacer, and construct a new component from the result.

Specified by:

replace in interface IReplaceable

Parameters:

replacer - The ComponentReplacer to apply

Returns:

The new, updated component

See Also:

• ComponentReplacer

withUniqueId

@Nonnull
@CheckReturnValue
Section withUniqueId(int uniqueId)

Description copied from interface: Component

Creates a new component with the provided numeric ID.
If no ID is set, Discord will generate IDs incrementally starting from 1 and will not use existing IDs from the same message/modal.

Specified by:

withUniqueId in interface Component

Specified by:

withUniqueId in interface ContainerChildComponent

Specified by:

withUniqueId in interface IDisableable

Specified by:

withUniqueId in interface MessageTopLevelComponent

Parameters:

uniqueId - The new ID; must be higher or equal to 1

Returns:

The new component

withDisabled

@Nonnull
@CheckReturnValue
default Section withDisabled(boolean disabled)

Description copied from interface: IDisableable

Returns a new instance of this component in an enabled/disabled state.
For layout components, this enables/disables all the components it contains.

Specified by:

withDisabled in interface IDisableable

Returns:

The new component in an enabled/disabled state

See Also:

• ComponentTree.replace(ComponentReplacer)

asDisabled

@Nonnull
@CheckReturnValue
default Section asDisabled()

Description copied from interface: IDisableable

Returns a new instance of this component in a disabled state.
For layout components, this disables all the components it contains.

Specified by:

asDisabled in interface IDisableable

Returns:

The new component in a disabled state

See Also:

• ComponentTree.replace(ComponentReplacer)

asEnabled

@Nonnull
@CheckReturnValue
default Section asEnabled()

Description copied from interface: IDisableable

Returns a new instance of this component in an enabled state.
For layout components, this enables all the components it contains.

Specified by:

asEnabled in interface IDisableable

Returns:

The new component in an enabled state

See Also:

• ComponentTree.replace(ComponentReplacer)

withContentComponents

@Nonnull
@CheckReturnValue
Section withContentComponents(@Nonnull
 Collection<? extends SectionContentComponent> components)

Creates a new Section with the specified content components.

Parameters:

components - The new content components

Returns:

The new Section

Throws:

IllegalArgumentException - If the provided components are null or contains null

withContentComponents

@Nonnull
@CheckReturnValue
default Section withContentComponents(@Nonnull
 SectionContentComponent component,
 @Nonnull
 SectionContentComponent... components)

Creates a new Section with the specified content components.

Parameters:

component - The first new content component

components - Additional new content components

Returns:

The new Section

Throws:

IllegalArgumentException - If the provided components are null or contains null

withAccessory

@Nonnull
@CheckReturnValue
Section withAccessory(@Nonnull
 SectionAccessoryComponent accessory)

Creates a new Section with the specified accessory.

Parameters:

accessory - The new accessory

Returns:

The new Section

Throws:

IllegalArgumentException - If the provided accessory is null

getContentComponents

@Nonnull
@Unmodifiable List<SectionContentComponentUnion> getContentComponents()

Returns an immutable list with the components contained by this section.

Returns:

List of SectionContentComponentUnion in this section

getAccessory

@Nonnull
SectionAccessoryComponentUnion getAccessory()

The accessory of this section.

Returns:

Accessory of this section

isDisabled

default boolean isDisabled()

Description copied from interface: IDisableable

Whether this component is disabled.

For layout components, this means all children are enabled.
When this returns false, this does not mean IDisableable.isEnabled() is true! (for example, when one component is enabled and the other is disabled)

You can use IDisableable.asDisabled() or IDisableable.asEnabled() to create enabled/disabled instances.

Specified by:

isDisabled in interface IDisableable

Returns:

true, if this component is disabled

isEnabled

default boolean isEnabled()

Description copied from interface: IDisableable

Whether this component is enabled.

For layout components, this means all children are enabled.
When this returns false, this does not mean IDisableable.isDisabled() is true! (for example, when one component is enabled and the other is disabled)

You can use IDisableable.asDisabled() or IDisableable.asEnabled() to create enabled/disabled instances.

Specified by:

isEnabled in interface IDisableable

Returns:

true if this component is enabled