Class MediaGalleryItem

constructor

• new MediaGalleryItem(data?: Partial<APIMediaGalleryItems>): MediaGalleryItem

  Constructs a new MediaGalleryItem.

  Parameters

  • data: Partial<APIMediaGalleryItems> = {}

    Optional initial data for the media gallery item.

  Returns MediaGalleryItem

data

setDescription

• setDescription(desc: string): MediaGalleryItem

  Sets the description for this gallery item.

  Parameters

  • desc: string

    The description text.

  Returns MediaGalleryItem

  The updated MediaGalleryItem instance.

setMedia

• setMedia(url: string): MediaGalleryItem

  Sets the media URL for this gallery item.

  Parameters

  • url: string

    The URL of the media.

  Returns MediaGalleryItem

  The updated MediaGalleryItem instance.

setSpoiler

• setSpoiler(spoiler?: boolean): MediaGalleryItem

  Sets whether this gallery item should be visually marked as a spoiler.

  Parameters

  • spoiler: boolean = true

    Whether the item is a spoiler (defaults to true).

  Returns MediaGalleryItem

  The updated MediaGalleryItem instance.

toJSON

• toJSON(): {
      description?: string;
      media?: APIUnfurledMediaItem;
      spoiler?: boolean;
  }

  Converts this MediaGalleryItem instance to its JSON representation.

  Returns { description?: string; media?: APIUnfurledMediaItem; spoiler?: boolean }

  The JSON representation of the item data.

  • Optionaldescription?: string

    Alt text for the media

  • Optionalmedia?: APIUnfurledMediaItem

    A url or attachment

  • Optionalspoiler?: boolean

    Whether the thumbnail should be a spoiler (or blurred out). Defaults to false