Package net.dv8tion.jda.api.components

Interface ActionComponent

All Superinterfaces:

Component, ICustomId, IDisableable

All Known Subinterfaces:

Button, EntitySelectMenu, SelectMenu, StringSelectMenu

public interface ActionComponent
extends IDisableable, ICustomId

Component which supports interactions via ComponentInteraction.

Nested Class Summary

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

Component.Type

Method Summary

Modifier and Type	Method	Description
default ActionComponent	asDisabled()	Returns a copy of this component with isDisabled() set to true.
default ActionComponent	asEnabled()	Returns a copy of this component with isDisabled() set to false.
boolean	isDisabled()	Whether this action component is disabled.
ActionComponent	withDisabled(boolean disabled)	Returns a copy of this component with isDisabled() set to the provided value.
ActionComponent	withUniqueId(int uniqueId)	Creates a new component with the provided numeric ID.

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

getType, getUniqueId, isMessageCompatible, isModalCompatible

Methods inherited from interface net.dv8tion.jda.api.components.attribute.ICustomId

getCustomId

Methods inherited from interface net.dv8tion.jda.api.components.attribute.IDisableable

isEnabled

Method Details

withUniqueId

@Nonnull
ActionComponent 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 ICustomId

Specified by:

withUniqueId in interface IDisableable

Parameters:

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

Returns:

The new component

isDisabled

boolean isDisabled()

Whether this action component is disabled.

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

Specified by:

isDisabled in interface IDisableable

Returns:

True, if this button is disabled

asDisabled

@Nonnull
@CheckReturnValue
default ActionComponent asDisabled()

Returns a copy of this component with isDisabled() set to true.

Note: Components in modals cannot be disabled.

Specified by:

asDisabled in interface IDisableable

Returns:

New disabled component instance

See Also:

• ComponentTree.replace(ComponentReplacer)

asEnabled

@Nonnull
@CheckReturnValue
default ActionComponent asEnabled()

Returns a copy of this component with isDisabled() set to false.

Specified by:

asEnabled in interface IDisableable

Returns:

New enabled component instance

See Also:

• ComponentTree.replace(ComponentReplacer)

withDisabled

@Nonnull
@CheckReturnValue
ActionComponent withDisabled(boolean disabled)

Returns a copy of this component with isDisabled() set to the provided value.

Note: Components in modals cannot be disabled.

Specified by:

withDisabled in interface IDisableable

Parameters:

disabled - True, if this component should be disabled

Returns:

New enabled/disabled component instance

Throws:

UnsupportedOperationException - If this component type cannot be disabled

See Also:

• ComponentTree.replace(ComponentReplacer)