Preview environment

class MediaGalleryBuilder

export declare class MediaGalleryBuilder extends ComponentBuilder<APIMediaGalleryComponent>

A builder that creates API-compatible JSON data for a container.

Constructors

constructor(
data?: Partial<APIMediaGalleryComponent>
)

Creates a new media gallery from API data.

readonly
data : Partial<APIMediaGalleryComponent>

The API data associated with this component.

Inherited from: ComponentBuilder

readonly
items : MediaGalleryItemBuilder[]

The components within this container.

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

Adds items to this media gallery.

clearId() : this

Clears the id of this component, defaulting to a default incremented id.

Inherited from: ComponentBuilder

setId(
id: number
) : this

Sets the id (not the custom id) for this component.

Inherited from: ComponentBuilder

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

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

toJSON() : APIMediaGalleryComponent

Serializes this builder to API-compatible JSON data.