class ContainerBuilder

external
declare class ContainerBuilder extends ComponentBuilder<APIContainerComponent>

A builder that creates API-compatible JSON data for containers.

components
addActionRowComponents
addFileComponents
addMediaGalleryComponents
addSectionComponents
addSeparatorComponents
addTextDisplayComponents
clearAccentColor
clearId
setAccentColor
setId
setSpoiler
spliceComponents
toJSON

Constructors

external
constructor(
data?: Partial<APIContainerComponent>
)

Creates a new container builder.

readonlyexternal
components : readonly ContainerComponentBuilders[]

Gets the components within this container.

external
addActionRowComponents(
...input: RestOrArray<ActionRowBuilder | APIActionRowComponent<APIComponentInMessageActionRow> | ((builder: ActionRowBuilder) => ActionRowBuilder)>
) : this

Adds action row components to this container.

external
addFileComponents(
...input: RestOrArray<APIFileComponent | FileBuilder | ((builder: FileBuilder) => FileBuilder)>
) : this

Adds file components to this container.

external
addMediaGalleryComponents(
...input: RestOrArray<APIMediaGalleryComponent | MediaGalleryBuilder | ((builder: MediaGalleryBuilder) => MediaGalleryBuilder)>
) : this

Adds media gallery components to this container.

external
addSectionComponents(
...input: RestOrArray<APISectionComponent | SectionBuilder | ((builder: SectionBuilder) => SectionBuilder)>
) : this

Adds section components to this container.

external
addSeparatorComponents(
...input: RestOrArray<APISeparatorComponent | SeparatorBuilder | ((builder: SeparatorBuilder) => SeparatorBuilder)>
) : this

Adds separator components to this container.

external
addTextDisplayComponents(
...input: RestOrArray<APITextDisplayComponent | TextDisplayBuilder | ((builder: TextDisplayBuilder) => TextDisplayBuilder)>
) : this

Adds text display components to this container.

external
clearAccentColor() : this

Clears the accent color of this container.

external
clearId() : this

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

Inherited from: ComponentBuilder

external
setAccentColor(
color: number
) : this

Sets the accent color of this container.

external
setId(
id: number
) : this

Sets the id of this component.

Inherited from: ComponentBuilder

external
setSpoiler(
spoiler?: boolean
) : this

Sets the spoiler status of this container.

external
spliceComponents(
index: number
deleteCount: number
...components: RestOrArray<APIComponentInContainer | ContainerComponentBuilders>
) : this

Removes, replaces, or inserts components for this container

Examples:Remove the first component:
container.spliceComponents(0, 1);
Remove the first n components:
const n = 4;
container.spliceComponents(0, n);
Remove the last component:
container.spliceComponents(-1, 1);

external
toJSON(
validationOverride?: boolean
) : APIContainerComponent

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.