Class MediaGalleryBuilder

Namespace

Discord

Assembly

Discord.Net.Core.dll

public class MediaGalleryBuilder : IMessageComponentBuilder

Inheritance

object

MediaGalleryBuilder

Implements

IMessageComponentBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComponentBuilderExtensions.WithId<BuilderT>(BuilderT, int?)

Constructors

MediaGalleryBuilder()

Initializes a new instance of the MediaGalleryBuilder.

public MediaGalleryBuilder()

MediaGalleryBuilder(MediaGalleryComponent)

Initializes a new MediaGalleryBuilder from existing component.

public MediaGalleryBuilder(MediaGalleryComponent mediaGallery)

Parameters

mediaGallery MediaGalleryComponent

MediaGalleryBuilder(params IEnumerable<MediaGalleryItemProperties>)

Initializes a new instance of the MediaGalleryBuilder.

public MediaGalleryBuilder(params IEnumerable<MediaGalleryItemProperties> items)

Parameters

items IEnumerable<MediaGalleryItemProperties>

Fields

MaxItems

Gets the maximum number of items that can be added to a media gallery.

public const int MaxItems = 10

Field Value

int

Properties

Id

Gets or sets the id for the component. An autoincremented id will be assigned if not set.

public int? Id { get; set; }

Property Value

int?

Items

Gets or sets the items in this media gallery.

public List<MediaGalleryItemProperties> Items { get; set; }

Property Value

List<MediaGalleryItemProperties>

Type

Gets the type of the component.

public ComponentType Type { get; }

Property Value

ComponentType

Methods

AddItem(MediaGalleryItemProperties)

Adds a new item to the media gallery.

public MediaGalleryBuilder AddItem(MediaGalleryItemProperties item)

Parameters

item MediaGalleryItemProperties

Returns

MediaGalleryBuilder

The current builder.

AddItem(string, string, bool)

Adds a new item to the media gallery.

public MediaGalleryBuilder AddItem(string url, string description = null, bool isSpoiler = false)

Parameters

url string

description string

isSpoiler bool

Returns

MediaGalleryBuilder

The current builder.

AddItems(params IEnumerable<MediaGalleryItemProperties>)

Adds a list of items to the media gallery.

public MediaGalleryBuilder AddItems(params IEnumerable<MediaGalleryItemProperties> items)

Parameters

items IEnumerable<MediaGalleryItemProperties>

Returns

MediaGalleryBuilder

The current builder.

Build()

Runs validation checks and builds the component.

public MediaGalleryComponent Build()

Returns

MediaGalleryComponent

WithItems(IEnumerable<MediaGalleryItemProperties>)

Sets the items in the media gallery.

public MediaGalleryBuilder WithItems(IEnumerable<MediaGalleryItemProperties> items)

Parameters

items IEnumerable<MediaGalleryItemProperties>

Returns

MediaGalleryBuilder

The current builder.