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.
Example
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',
},
});
Example
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");
NameTypeOptionalDescription
dataPartial<APIMediaGalleryItem>YesThe API data to create this media gallery item with
clearDescription():this
Clears the description of this thumbnail.
setDescription(description):this
Sets the description of this thumbnail.
NameTypeOptionalDescription
descriptionstringNoThe description to use
setSpoiler(spoiler?):this
Sets the spoiler status of this thumbnail.
NameTypeOptionalDescription
spoilerbooleanYesThe spoiler status to use
setURL(url):this
Sets the source URL of this media gallery item.
NameTypeOptionalDescription
urlstringNoThe URL to use
toJSON(validationOverride?):APIMediaGalleryItem
Transforms this object to its JSON format
NameTypeOptionalDescription
validationOverridebooleanYesNone