Package net.dv8tion.jda.internal.components.container

Class ContainerImpl

java.lang.Object

net.dv8tion.jda.internal.components.AbstractComponentImpl

net.dv8tion.jda.internal.components.container.ContainerImpl

All Implemented Interfaces:

IDisableable, Component, Container, IComponentUnion, MessageTopLevelComponent, MessageTopLevelComponentUnion, IReplaceable, SerializableData

public class ContainerImpl
extends AbstractComponentImpl
implements Container, MessageTopLevelComponentUnion

Nested Class Summary

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

Component.Type

Constructor Summary

Constructors

Constructor	Description
ContainerImpl(int uniqueId, Collection<ContainerChildComponentUnion> components, boolean spoiler, Integer accentColor)
ContainerImpl(DataObject data)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Integer	getAccentColorRaw()	The raw RGB color value for the stripe/border on the side of the container.
List<ContainerChildComponentUnion>	getComponents()	Returns an immutable list with the components contained by this container.
Component.Type	getType()	The type of component.
int	getUniqueId()	The unique, numeric identifier of this component.
int	hashCode()
boolean	isSpoiler()	Whether this container is hidden until the user clicks on it.
static Container	of(Collection<? extends ContainerChildComponent> components)
Container	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()
Container	withAccentColor(Integer accentColor)	Creates a new Container with the specified accent color, which appears on the side.
Container	withSpoiler(boolean spoiler)	Creates a new Container with the specified spoiler status.
ContainerImpl	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.Container

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

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

Constructor Details

ContainerImpl

public ContainerImpl(DataObject data)

ContainerImpl

public ContainerImpl(int uniqueId,
 Collection<ContainerChildComponentUnion> components,
 boolean spoiler,
 Integer accentColor)

Method Details

of

public static Container of(Collection<? extends ContainerChildComponent> 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 ContainerImpl 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 Container

Specified by:

withUniqueId in interface IComponentUnion

Specified by:

withUniqueId in interface IDisableable

Specified by:

withUniqueId in interface MessageTopLevelComponent

Specified by:

withUniqueId in interface MessageTopLevelComponentUnion

Parameters:

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

Returns:

The new component

withSpoiler

@Nonnull
public Container withSpoiler(boolean spoiler)

Description copied from interface: Container

Creates a new Container with the specified spoiler status.
Spoilers are hidden until the user clicks on it.

Specified by:

withSpoiler in interface Container

Parameters:

spoiler - The new spoiler status

Returns:

The new Container

withAccentColor

@Nonnull
public Container withAccentColor(@Nullable
 Integer accentColor)

Description copied from interface: Container

Creates a new Container with the specified accent color, which appears on the side.

Specified by:

withAccentColor in interface Container

Parameters:

accentColor - The new accent color, or null to remove it

Returns:

The new Container

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

replace

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

Specified by:

replace in interface IReplaceable

Parameters:

replacer - The ComponentReplacer to apply

Returns:

The new, updated component

See Also:

• ComponentReplacer

getComponents

@Nonnull
public List<ContainerChildComponentUnion> getComponents()

Description copied from interface: Container

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

Specified by:

getComponents in interface Container

Returns:

List of ContainerChildComponentUnion in this container

getAccentColorRaw

@Nullable
public Integer getAccentColorRaw()

Description copied from interface: Container

The raw RGB color value for the stripe/border on the side of the container.
If no accent color has been set, this will return null.

Specified by:

getAccentColorRaw in interface Container

Returns:

The raw RGB color value or null.

isSpoiler

public boolean isSpoiler()

Description copied from interface: Container

Whether this container is hidden until the user clicks on it.

Specified by:

isSpoiler in interface Container

Returns:

true if this is hidden by default, false otherwise

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