Class MediaGalleryItemBuilder

constructor

• new MediaGalleryItemBuilder(
      data?: Partial<APIMediaGalleryItem>,
  ): MediaGalleryItemBuilder

  Creates a new media gallery item from API data.

  Parameters

  • Optionaldata: Partial<APIMediaGalleryItem>

    The API data to create this media gallery item with

  Returns MediaGalleryItemBuilder

  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',
  	},
  });
  Copy

  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");
  Copy

Readonlydata

clearDescription

• clearDescription(): this

  Clears the description of this media gallery item.

  Returns this

setDescription

• setDescription(description: string): this

  Sets the description of this media gallery item.

  Parameters

  • description: string

    The description to use

  Returns this

setSpoiler

• setSpoiler(spoiler?: boolean): this

  Sets the spoiler status of this media gallery item.

  Parameters

  • Optionalspoiler: boolean

    The spoiler status to use

  Returns this

setURL

• setURL(url: string): this

  Sets the media URL of this media gallery item.

  Parameters

  • url: string

    The URL to use

  Returns this

toJSON

• toJSON(): APIMediaGalleryItem

  Serializes this builder to API-compatible JSON data.

  Returns APIMediaGalleryItem

  Remarks

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