Class MediaGalleryBuilder

constructor

• new MediaGalleryBuilder(
      data?: Partial<APIMediaGalleryComponent>,
  ): MediaGalleryBuilder

  Creates a new media gallery from API data.

  Parameters

  • Optionaldata: Partial<APIMediaGalleryComponent>

    The API data to create this media gallery with

  Returns MediaGalleryBuilder

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

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

Readonlyitems

addItems

• addItems(
      ...items: RestOrArray<
          | APIMediaGalleryItem
          | MediaGalleryItemBuilder
          | ((builder: MediaGalleryItemBuilder) => MediaGalleryItemBuilder),
      >,
  ): this

  Adds items to this media gallery.

  Parameters

  • ...items: RestOrArray<
        | APIMediaGalleryItem
        | MediaGalleryItemBuilder
        | ((builder: MediaGalleryItemBuilder) => MediaGalleryItemBuilder),
    >

    The items to add

  Returns this

spliceItems

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

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

  Parameters

  • index: number

    The index to start removing, replacing or inserting items

  • deleteCount: number

    The amount of items to remove

  • ...items: RestOrArray<
        | APIMediaGalleryItem
        | MediaGalleryItemBuilder
        | ((builder: MediaGalleryItemBuilder) => MediaGalleryItemBuilder),
    >

    The items to insert

  Returns this

toJSON

• toJSON(): APIMediaGalleryComponent

  Serializes this builder to API-compatible JSON data.

  Returns APIMediaGalleryComponent

  Remarks

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