Package net.dv8tion.jda.internal.components.buttons

Class ButtonImpl

java.lang.Object

net.dv8tion.jda.internal.components.AbstractComponentImpl

net.dv8tion.jda.internal.components.buttons.ButtonImpl

All Implemented Interfaces:

ActionComponent, ActionRowChildComponent, ActionRowChildComponentUnion, IDisableable, Button, Component, IComponentUnion, SectionAccessoryComponent, SectionAccessoryComponentUnion, SerializableData

public class ButtonImpl
extends AbstractComponentImpl
implements Button, ActionRowChildComponentUnion, SectionAccessoryComponentUnion

Nested Class Summary

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

Component.Type

Field Summary

Fields inherited from interface net.dv8tion.jda.api.components.buttons.Button

ID_MAX_LENGTH, LABEL_MAX_LENGTH, URL_MAX_LENGTH

Constructor Summary

Constructors

Constructor	Description
ButtonImpl(String customId, int uniqueId, String label, ButtonStyle style, String url, SkuSnowflake sku, boolean disabled, Emoji emoji)
ButtonImpl(String customId, String label, ButtonStyle style, boolean disabled, Emoji emoji)
ButtonImpl(String customId, String label, ButtonStyle style, String url, SkuSnowflake sku, boolean disabled, Emoji emoji)
ButtonImpl(DataObject data)

Method Summary

Modifier and Type	Method	Description
ButtonImpl	checkValid()
boolean	equals(Object obj)
String	getCustomId()	An unique component ID or null.
EmojiUnion	getEmoji()	The emoji attached to this button.
String	getLabel()	The visible text on the button, or an empty string if this is a PREMIUM-style button.
SkuSnowflake	getSku()	The target SKU for this button, if it is a PREMIUM-style Button.
ButtonStyle	getStyle()	The style of this button.
Component.Type	getType()	The type of component.
int	getUniqueId()	The unique, numeric identifier of this component.
String	getUrl()	The target URL for this button, if it is a LINK-Style Button.
int	hashCode()
boolean	isDisabled()	Whether this action component is disabled.
DataObject	toData()	Serialized DataObject for this object.
String	toString()
ButtonImpl	withUniqueId(int uniqueId)	Creates a new component with the provided numeric ID.

Methods inherited from class net.dv8tion.jda.internal.components.AbstractComponentImpl

asActionRow, asButton, asContainer, asEntitySelectMenu, asFileDisplay, asMediaGallery, asSection, asSeparator, asStringSelectMenu, asTextDisplay, asTextInput, asThumbnail

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getId

Methods inherited from interface net.dv8tion.jda.api.components.actionrow.ActionRowChildComponentUnion

asButton, asEntitySelectMenu, asStringSelectMenu

Methods inherited from interface net.dv8tion.jda.api.components.buttons.Button

asDisabled, asEnabled, withCustomId, withDisabled, withEmoji, withId, withLabel, withSku, withStyle, withUrl

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

isMessageCompatible, isModalCompatible

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

isUnknownComponent

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

isEnabled

Methods inherited from interface net.dv8tion.jda.api.components.section.SectionAccessoryComponentUnion

asButton, asThumbnail

Constructor Details

ButtonImpl

public ButtonImpl(DataObject data)

ButtonImpl

public ButtonImpl(String customId,
 String label,
 ButtonStyle style,
 boolean disabled,
 Emoji emoji)

ButtonImpl

public ButtonImpl(String customId,
 String label,
 ButtonStyle style,
 String url,
 SkuSnowflake sku,
 boolean disabled,
 Emoji emoji)

ButtonImpl

public ButtonImpl(String customId,
 int uniqueId,
 String label,
 ButtonStyle style,
 String url,
 SkuSnowflake sku,
 boolean disabled,
 Emoji emoji)

Method Details

checkValid

public ButtonImpl checkValid()

getType

@Nonnull
public Component.Type getType()

Description copied from interface: Component

The type of component.

Specified by:

getType in interface Component

Returns:

Component.Type

withUniqueId

@Nonnull
public ButtonImpl 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 ActionComponent

Specified by:

withUniqueId in interface ActionRowChildComponent

Specified by:

withUniqueId in interface ActionRowChildComponentUnion

Specified by:

withUniqueId in interface Button

Specified by:

withUniqueId in interface Component

Specified by:

withUniqueId in interface IComponentUnion

Specified by:

withUniqueId in interface IDisableable

Specified by:

withUniqueId in interface SectionAccessoryComponent

Specified by:

withUniqueId in interface SectionAccessoryComponentUnion

Parameters:

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

Returns:

The new component

getCustomId

@Nullable
public String getCustomId()

Description copied from interface: ActionComponent

An unique component ID or null.
Some components such as link buttons don't have this.

Custom IDs can contain custom data, this is typically used to pass data between a slash command and your button listener.

While this ID is unique and can be retrieved with ComponentInteraction.getComponentId(), you should use Component.getUniqueId() to identify a component in a single message, such as when replacing components using ComponentTree or IReplaceable.replace(ComponentReplacer).

Specified by:

getCustomId in interface ActionComponent

Returns:

The component ID or null if not present

See Also:

• ComponentInteraction.getComponentId()
• Component.getUniqueId()

getUniqueId

public int getUniqueId()

Description copied from interface: Component

The unique, numeric identifier of this component.
Can be set manually or automatically assigned by Discord (starting from 1). If it has not been assigned yet, this will return -1.

Note: Older messages may return 0.

Specified by:

getUniqueId in interface Component

Returns:

The unique identifier of this component, or -1 if not assigned yet, or 0 on older messages

getLabel

@Nonnull
public String getLabel()

Description copied from interface: Button

The visible text on the button, or an empty string if this is a PREMIUM-style button.

Specified by:

getLabel in interface Button

Returns:

The button label

getStyle

@Nonnull
public ButtonStyle getStyle()

Description copied from interface: Button

The style of this button.

Specified by:

getStyle in interface Button

Returns:

ButtonStyle

getUrl

@Nullable
public String getUrl()

Description copied from interface: Button

The target URL for this button, if it is a LINK-Style Button.

Specified by:

getUrl in interface Button

Returns:

The target URL or null

getSku

@Nullable
public SkuSnowflake getSku()

Description copied from interface: Button

The target SKU for this button, if it is a PREMIUM-style Button.

Specified by:

getSku in interface Button

Returns:

The target SKU or null

getEmoji

@Nullable
public EmojiUnion getEmoji()

Description copied from interface: Button

The emoji attached to this button.
This can be either unicode or custom.

You can use Button.withEmoji(Emoji) to create a button with an Emoji.

Specified by:

getEmoji in interface Button

Returns:

Emoji for this button

isDisabled

public boolean isDisabled()

Description copied from interface: ActionComponent

Whether this action component is disabled.

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

Specified by:

isDisabled in interface ActionComponent

Specified by:

isDisabled in interface IDisableable

Returns:

True, if this button is disabled

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object