ComponentContainerclass

Utils Component Container Structure

On this page

Overview
Constructor1
Properties5
Accessors2
Methods27

Utils Component Container Structure

import { Utils } from 'detritus-client';

Utils.ComponentContainer;

Hierarchy

StructureComponentContainer

7 properties17 methods10 inheritedsrc/utils/components/container.ts:50

Constructor

new ComponentContainer

src/utils/components/container.ts:59

new ComponentContainer(data?: ComponentContainerData)

Properties

accentColor?

number

optional

components

Default []

id?

number

optional

spoiler?

boolean

optional

type

MessageComponentTypes

Default MessageComponentTypes.CONTAINER

Accessors

hasRun

boolean

get

isEmpty

boolean

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from Structure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from Structure.[custom]

addActionRow()

src/utils/components/container.ts:84

addActionRow(data?: ComponentActionRowData | ComponentActionRow): this

addFile()

src/utils/components/container.ts:93

addFile(data?: ComponentFile | ComponentFileData): this

addMediaGallery()

src/utils/components/container.ts:102

addMediaGallery(data?: ComponentMediaGallery | ComponentMediaGalleryData): this

addSection()

src/utils/components/container.ts:111

addSection(data?: ComponentSection | ComponentSectionData): this

addSeparator()

src/utils/components/container.ts:120

addSeparator(data?: ComponentSeparator | ComponentSeparatorData): this

addTextDisplay()

src/utils/components/container.ts:129

addTextDisplay(data?: ComponentTextDisplay | ComponentTextDisplayData): this

clear()

src/utils/components/container.ts:138

clear(): void

createActionRow()

src/utils/components/container.ts:142

createActionRow(data?: ComponentActionRowData): ComponentActionRow

createFile()

src/utils/components/container.ts:148

createFile(data?: ComponentFileData): ComponentFile

createMediaGallery()

src/utils/components/container.ts:154

createMediaGallery(data?: ComponentMediaGalleryData): ComponentMediaGallery

createSection()

src/utils/components/container.ts:160

createSection(data?: ComponentSectionData): ComponentSection

createSeparator()

src/utils/components/container.ts:166

createSeparator(data?: ComponentSeparatorData): ComponentSeparator

createTextDisplay()

src/utils/components/container.ts:172

createTextDisplay(data?: ComponentTextDisplayData): ComponentTextDisplay

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from Structure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from Structure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from Structure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from Structure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween

merge()

src/utils/components/container.ts:188

merge(data?: BaseStructureData): void

Overrides Structure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from Structure.mergeValue

setAccentColor()

src/utils/components/container.ts:178

setAccentColor(value: number): this

setSpoiler()

src/utils/components/container.ts:183

setSpoiler(spoiler: boolean): this

toJSON()

src/utils/components/container.ts:251

toJSON(): RawChannelMessageComponent

Overrides Structure.toJSON