Package org.javacord.api.entity.message.component

Class ActionRowBuilder

java.lang.Object

org.javacord.api.entity.message.component.ActionRowBuilder

All Implemented Interfaces:

ComponentBuilder, HighLevelComponentBuilder

public class ActionRowBuilder
extends java.lang.Object
implements HighLevelComponentBuilder

Constructor Summary

Constructors

Constructor	Description
ActionRowBuilder()

Method Summary

Modifier and Type	Method	Description
ActionRowBuilder	addComponents(java.util.List<LowLevelComponent> components)	Add a list containing low-level components builders.
ActionRowBuilder	addComponents(LowLevelComponent... components)	Add multiple low-level component builders.
ActionRow	build()	Creates a ActionRow instance with the given values.
ActionRowBuilder	copy(ActionRow actionRow)	Copy an action row into this action row builder's values.
java.util.List<LowLevelComponent>	getComponents()	Get the low-level components of this action row.
ActionRowBuilderDelegate	getDelegate()	Gets the delegate used by the component builder internally.
ComponentType	getType()	Get the type of this component (always ComponentType.ACTION_ROW).
ActionRowBuilder	removeComponent(int index)	Remove a low-level component from the ActionRow.
ActionRowBuilder	removeComponent(java.lang.String customId)	Remove a low-level component from the ActionRow.
ActionRowBuilder	removeComponent(LowLevelComponent component)	Remove a low-level component from the ActionRow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionRowBuilder

public ActionRowBuilder()

Method Detail

addComponents

public ActionRowBuilder addComponents(LowLevelComponent... components)

Add multiple low-level component builders.

Parameters:

components - The low-level components.

Returns:

The builder instance to chain methods.

addComponents

public ActionRowBuilder addComponents(java.util.List<LowLevelComponent> components)

Add a list containing low-level components builders.

Parameters:

components - The list containing low-level components.

Returns:

The builder instance to chain methods.

copy

public ActionRowBuilder copy(ActionRow actionRow)

Copy an action row into this action row builder's values.

Parameters:

actionRow - The action row to copy.

Returns:

The builder instance to chain methods.

removeComponent

public ActionRowBuilder removeComponent(LowLevelComponent component)

Remove a low-level component from the ActionRow.

Parameters:

component - The low-level component being removed.

Returns:

The builder instance to chain methods.

removeComponent

public ActionRowBuilder removeComponent(int index)

Remove a low-level component from the ActionRow.

Parameters:

index - The index placement to remove.

Returns:

The builder instance to chain methods.

removeComponent

public ActionRowBuilder removeComponent(java.lang.String customId)

Remove a low-level component from the ActionRow.

Parameters:

customId - The low-level component's identifier.

Returns:

The builder instance to chain methods.

getComponents

public java.util.List<LowLevelComponent> getComponents()

Get the low-level components of this action row.

Returns:

The components.

getType

public ComponentType getType()

Get the type of this component (always ComponentType.ACTION_ROW).

Specified by:

getType in interface ComponentBuilder

Returns:

The component type.

build

public ActionRow build()

Creates a ActionRow instance with the given values.

Returns:

The created action row instance.

getDelegate

public ActionRowBuilderDelegate getDelegate()

Gets the delegate used by the component builder internally.

Specified by:

getDelegate in interface ComponentBuilder

Returns:

The delegate used by this component builder internally.