Package net.dv8tion.jda.internal.components.section

Class SectionImpl

java.lang.Object

net.dv8tion.jda.internal.components.AbstractComponentImpl

net.dv8tion.jda.internal.components.section.SectionImpl

All Implemented Interfaces:

IDisableable, Component, ContainerChildComponent, ContainerChildComponentUnion, IComponentUnion, MessageTopLevelComponent, MessageTopLevelComponentUnion, IReplaceable, Section, SerializableData

public class SectionImpl
extends AbstractComponentImpl
implements Section, MessageTopLevelComponentUnion, ContainerChildComponentUnion

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.section.Section

MAX_COMPONENTS

Constructor Summary

Constructors

Constructor	Description
SectionImpl(int uniqueId, Collection<SectionContentComponentUnion> components, SectionAccessoryComponentUnion accessory)
SectionImpl(Collection<SectionContentComponentUnion> components, SectionAccessoryComponentUnion accessory)
SectionImpl(DataObject data)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SectionAccessoryComponentUnion	getAccessory()	The accessory of this section.
@Unmodifiable List<SectionContentComponentUnion>	getContentComponents()	Returns an immutable list with the components contained by this section.
Component.Type	getType()	The type of component.
int	getUniqueId()	The unique, numeric identifier of this component.
int	hashCode()
static Section	of(SectionAccessoryComponent accessory, Collection<? extends SectionContentComponent> components)
Section	replace(ComponentReplacer replacer)	Replaces and/or removes children components using the provided ComponentReplacer, and construct a new component from the result.
DataObject	toData()	Serialized DataObject for this object.
String	toString()
SectionImpl	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.container.ContainerChildComponentUnion

asActionRow, asFileDisplay, asMediaGallery, asSection, asSeparator, asTextDisplay

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

isUnknownComponent

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

asActionRow, asContainer, asFileDisplay, asMediaGallery, asSection, asSeparator, asTextDisplay

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

asDisabled, asEnabled, isDisabled, isEnabled, isMessageCompatible, isModalCompatible, withDisabled

Constructor Details

SectionImpl

public SectionImpl(DataObject data)

SectionImpl

public SectionImpl(Collection<SectionContentComponentUnion> components,
 SectionAccessoryComponentUnion accessory)

SectionImpl

public SectionImpl(int uniqueId,
 Collection<SectionContentComponentUnion> components,
 SectionAccessoryComponentUnion accessory)

Method Details

of

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

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 SectionImpl 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 ContainerChildComponentUnion

Specified by:

withUniqueId in interface IComponentUnion

Specified by:

withUniqueId in interface IDisableable

Specified by:

withUniqueId in interface MessageTopLevelComponent

Specified by:

withUniqueId in interface MessageTopLevelComponentUnion

Specified by:

withUniqueId in interface Section

Parameters:

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

Returns:

The new component

replace

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

Specified by:

replace in interface Section

Parameters:

replacer - The ComponentReplacer to apply

Returns:

The new, updated component

See Also:

• ComponentReplacer

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

getContentComponents

@Nonnull
public @Unmodifiable List<SectionContentComponentUnion> getContentComponents()

Description copied from interface: Section

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

Specified by:

getContentComponents in interface Section

Returns:

List of SectionContentComponentUnion in this section

getAccessory

@Nonnull
public SectionAccessoryComponentUnion getAccessory()

Description copied from interface: Section

The accessory of this section.

Specified by:

getAccessory in interface Section

Returns:

Accessory of this section

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object