Package net.dv8tion.jda.api.components.mediagallery

Interface MediaGallery

All Superinterfaces:

Component, ContainerChildComponent, MessageTopLevelComponent

public interface MediaGallery
extends Component, MessageTopLevelComponent, ContainerChildComponent

Component which displays a group of images, videos, GIFs or WEBPs into a gallery grid.

This can contain up to 10 MediaGalleryItem.

Requirements: Components V2 needs to be enabled!

Nested Class Summary

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

Component.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_ITEMS	How many MediaGalleryItem can be in a media gallery.

Method Summary

Modifier and Type	Method	Description
@Unmodifiable List<MediaGalleryItem>	getItems()	Returns an immutable list with the items contained by this media gallery.
static MediaGallery	of(Collection<? extends MediaGalleryItem> items)	Constructs a new MediaGallery from the given items.
static MediaGallery	of(MediaGalleryItem item, MediaGalleryItem... items)	Constructs a new MediaGallery from the given items.
MediaGallery	withItems(Collection<? extends MediaGalleryItem> items)	Creates a new MediaGallery with the specified items.
default MediaGallery	withItems(MediaGalleryItem item, MediaGalleryItem... items)	Creates a new MediaGallery with the specified items.
MediaGallery	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

Field Details

MAX_ITEMS

static final int MAX_ITEMS

How many MediaGalleryItem can be in a media gallery. (10)

See Also:

• Constant Field Values

Method Details

of

@Nonnull
static MediaGallery of(@Nonnull
 Collection<? extends MediaGalleryItem> items)

Constructs a new MediaGallery from the given items.

Parameters:

items - The items to add

Returns:

The new MediaGallery

Throws:

IllegalArgumentException -

• If null is provided
• If more than 10 items are provided

of

@Nonnull
static MediaGallery of(@Nonnull
 MediaGalleryItem item,
 @Nonnull
 MediaGalleryItem... items)

Constructs a new MediaGallery from the given items.

Parameters:

item - The item to add

items - Additional items to add

Returns:

The new MediaGallery

Throws:

IllegalArgumentException -

• If null is provided
• If more than 10 items are provided

withUniqueId

@Nonnull
@CheckReturnValue
MediaGallery 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 MessageTopLevelComponent

Parameters:

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

Returns:

The new component

withItems

@Nonnull
@CheckReturnValue
MediaGallery withItems(@Nonnull
 Collection<? extends MediaGalleryItem> items)

Creates a new MediaGallery with the specified items.

Parameters:

items - The new items

Returns:

The new MediaGallery

Throws:

IllegalArgumentException - If the provided items are null or contains null

withItems

@Nonnull
@CheckReturnValue
default MediaGallery withItems(@Nonnull
 MediaGalleryItem item,
 @Nonnull
 MediaGalleryItem... items)

Creates a new MediaGallery with the specified items.

Parameters:

item - The first new items

items - Additional new items

Returns:

The new MediaGallery

Throws:

IllegalArgumentException - If the provided items are null or contains null

getItems

@Nonnull
@Unmodifiable List<MediaGalleryItem> getItems()

Returns an immutable list with the items contained by this media gallery.

Returns:

List of MediaGalleryItem in this media gallery