Componentsclass

Utils Components Structure

On this page

Overview
Constructor1
Properties4
Accessors3
Methods38

Utils Components Structure

import { Utils } from 'detritus-client';

Utils.Components;

Hierarchy

StructureComponents

6 properties28 methods10 inheritedsrc/utils/components/components.ts:57

Constructor

new Components

src/utils/components/components.ts:69

new Components(data?: ComponentsOptions)

Properties

_timeout?

Timeout

optional

components

Default []

id?

string

optional

timeout

number

Default INTERACTION_TIMEOUT

Accessors

hasRun

boolean

get

isV2

boolean

get

length

number

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/components.ts:109

addActionRow(data?: ComponentActionRowData | ComponentActionRow): this

addButton()

src/utils/components/components.ts:118

addButton(data?: ComponentActionData | ComponentButton, inline?: boolean): this

Parameters

data?

ComponentActionData | ComponentButton

inline?

boolean

Default true

addContainer()

src/utils/components/components.ts:131

addContainer(data?: ComponentContainer | ComponentContainerData): this

addFile()

src/utils/components/components.ts:140

addFile(data?: ComponentFile | ComponentFileData): this

addInputText()

src/utils/components/components.ts:149

addInputText(data?: ComponentActionData | ComponentInputText): this

addLabel()

src/utils/components/components.ts:155

addLabel(data?: ComponentLabel | ComponentLabelData): this

addMediaGallery()

src/utils/components/components.ts:164

addMediaGallery(data?: ComponentMediaGallery | ComponentMediaGalleryData): this

addSection()

src/utils/components/components.ts:173

addSection(data?: ComponentSection | ComponentSectionData): this

addSelectMenu()

src/utils/components/components.ts:182

addSelectMenu(data?: ComponentActionData | ComponentSelectMenu): this

addSeparator()

src/utils/components/components.ts:188

addSeparator(data?: ComponentSeparator | ComponentSeparatorData): this

addTextDisplay()

src/utils/components/components.ts:197

addTextDisplay(data?: ComponentTextDisplay | ComponentTextDisplayData): this

clear()

src/utils/components/components.ts:206

clear(): void

createActionRow()

src/utils/components/components.ts:210

createActionRow(data?: ComponentActionRowData): ComponentActionRow

createButton()

src/utils/components/components.ts:216

createButton(data?: ComponentActionData, inline?: boolean): ComponentButton

Parameters

data?

ComponentActionData

inline?

boolean

Default true

createContainer()

src/utils/components/components.ts:228

createContainer(data?: ComponentContainerData): ComponentContainer

createFile()

src/utils/components/components.ts:234

createFile(data?: ComponentFileData): ComponentFile

createInputText()

src/utils/components/components.ts:240

createInputText(data?: ComponentActionData): ComponentInputText

createLabel()

src/utils/components/components.ts:245

createLabel(data?: ComponentLabelData): ComponentLabel

createMediaGallery()

src/utils/components/components.ts:251

createMediaGallery(data?: ComponentMediaGalleryData): ComponentMediaGallery

createSection()

src/utils/components/components.ts:257

createSection(data?: ComponentSectionData): ComponentSection

createSelectMenu()

src/utils/components/components.ts:263

createSelectMenu(data?: ComponentActionData): ComponentSelectMenu

createSeparator()

src/utils/components/components.ts:268

createSeparator(data?: ComponentSeparatorData): ComponentSeparator

createTextDisplay()

src/utils/components/components.ts:274

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/components.ts:280

merge(data?: BaseStructureData): void

Overrides Structure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from Structure.mergeValue

onError()

optional src/utils/components/components.ts:67

onError(context: ComponentContext, error: Error): unknown

onTimeout()

optional src/utils/components/components.ts:65

onTimeout(): unknown

run()

optional src/utils/components/components.ts:66

run(context: ComponentContext): unknown

toJSON()

src/utils/components/components.ts:347

toJSON(): RawChannelMessageComponent[]

Overrides Structure.toJSON