discord.js | MediaGalleryItemBuilder

Search...

MediaGalleryItemBuilder

export declare class MediaGalleryItemBuilder implements JSONEncodable<APIMediaGalleryItem>

export declare class MediaGalleryItemBuilder implements JSONEncodable<APIMediaGalleryItem>

No summary provided.

constructor(data?)

Creates a new media gallery item from API data.

Creating a media gallery item from an API data object:

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

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

Creating a media gallery item using setters and API data:

const item = new MediaGalleryItemBuilder({
	media: {
		url: 'https://cdn.discordapp.com/embed/avatars/5.png',
	},
})
	.setDescription("alt text");

const item = new MediaGalleryItemBuilder({
	media: {
		url: 'https://cdn.discordapp.com/embed/avatars/5.png',
	},
})
	.setDescription("alt text");

Name	Type	Optional	Description
data	Partial<APIMediaGalleryItem>	Yes	The API data to create this media gallery item with

Readonly

The API data associated with this media gallery item.

clearDescription():this

Clears the description of this media gallery item.

setDescription(description):this

Sets the description of this media gallery item.

Name	Type	Optional	Description
description	string	No	The description to use

setSpoiler(spoiler?):this

Sets the spoiler status of this media gallery item.

Name	Type	Optional	Description
spoiler	boolean	Yes	The spoiler status to use

setURL(url):this

Sets the media URL of this media gallery item.

Name	Type	Optional	Description
url	string	No	The URL to use

Serializes this builder to API-compatible JSON data.

This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.