discord.js | MediaGalleryBuilder

Search...

MediaGalleryBuilder

export declare class MediaGalleryBuilder extends ComponentBuilder<APIMediaGalleryComponent>

export declare class MediaGalleryBuilder extends ComponentBuilder<APIMediaGalleryComponent>

No summary provided.

Extends

ComponentBuilder<APIMediaGalleryComponent>

constructor(data?)

Creates a new media gallery from API data.

Example

Creating a media gallery from an API data object:

const mediaGallery = new MediaGalleryBuilder({
	items: [
		{
			description: "Some text here",
			media: {
				url: 'https://cdn.discordapp.com/embed/avatars/2.png',
			},
		},
	],
});

const mediaGallery = new MediaGalleryBuilder({
	items: [
		{
			description: "Some text here",
			media: {
				url: 'https://cdn.discordapp.com/embed/avatars/2.png',
			},
		},
	],
});

Example

Creating a media gallery using setters and API data:

const mediaGallery = new MediaGalleryBuilder({
	items: [
		{
			description: "alt text",
			media: {
				url: 'https://cdn.discordapp.com/embed/avatars/5.png',
			},
		},
	],
})
	.addItems(item2, item3);

const mediaGallery = new MediaGalleryBuilder({
	items: [
		{
			description: "alt text",
			media: {
				url: 'https://cdn.discordapp.com/embed/avatars/5.png',
			},
		},
	],
})
	.addItems(item2, item3);

Name	Type	Optional	Description
data	Partial<APIMediaGalleryComponent>	Yes	The API data to create this container with

ProtectedReadonly

data:MediaGalleryBuilderData

Readonly

items:readonly MediaGalleryItemBuilder[]

The items in this media gallery.

addItems(...input):this

Adds a media gallery item to this media gallery.

Name	Type	Optional	Description
...input	RestOrArray<APIMediaGalleryItem \| MediaGalleryItemBuilder \| ((builder: MediaGalleryItemBuilder) => MediaGalleryItemBuilder)>	No	The items to add

clearId():this

Clears the id of this component, defaulting to a default incremented id.

Inherited from ComponentBuilder

setId(id):this

Sets the id of this component.

Name	Type	Optional	Description
id	number	No	The id to use

Inherited from ComponentBuilder

spliceItems(index, deleteCount, ...items):this

Removes, replaces, or inserts media gallery items for this media gallery.

Name	Type	Optional	Description
index	number	No	The index to start removing, replacing or inserting items
deleteCount	number	No	The amount of items to remove
...items	RestOrArray<APIMediaGalleryItem \| MediaGalleryItemBuilder \| ((builder: MediaGalleryItemBuilder) => MediaGalleryItemBuilder)>	No	The items to insert

toJSON(validationOverride?):APIMediaGalleryComponent

Serializes this builder to API-compatible JSON data.

Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference