class MediaGalleryBuilder

export declare class MediaGalleryBuilder extends ComponentBuilder<APIMediaGalleryComponent>

A builder that creates API-compatible JSON data for media galleries.

items
addItems
clearId
setId
spliceItems
toJSON

Constructors

constructor(
data?: Partial<APIMediaGalleryComponent>
)

Creates a new media gallery.

Examples: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',
			},
		},
	],
});
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);

readonly
items : readonly MediaGalleryItemBuilder[]

The items in this media gallery.

addItems(
...input: RestOrArray<APIMediaGalleryItem | MediaGalleryItemBuilder | ((builder: MediaGalleryItemBuilder) => MediaGalleryItemBuilder)>
) : this

Adds a media gallery item to this media gallery.

clearId() : this

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

Inherited from: ComponentBuilder

setId(
id: number
) : this

Sets the id of this component.

Inherited from: ComponentBuilder

spliceItems(
index: number
deleteCount: number
...items: RestOrArray<APIMediaGalleryItem | MediaGalleryItemBuilder | ((builder: MediaGalleryItemBuilder) => MediaGalleryItemBuilder)>
) : this

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

toJSON(
validationOverride?: boolean
) : 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.