ComponentActionBaseclass

The most basic Structure class, every structure extends this

On this page

Overview
Constructor1
Properties3
Accessors1
Methods14

The most basic Structure class, every structure extends this

import { Utils } from 'detritus-client';

Utils.ComponentActionBase;

Hierarchy

StructureComponentActionBase

Subclasses

ComponentButton, ComponentCheckbox, ComponentCheckboxGroup, ComponentFileUpload, ComponentInputText, ComponentRadioGroup, ComponentSelectMenu

4 properties3 methods11 inheritedsrc/utils/components/actionbase.ts:69

Constructor

new ComponentActionBase

src/utils/components/actionbase.ts:79

new ComponentActionBase(data?: ComponentActionData)

Properties

customId?

string | null

optional

id?

number | null

optional

type

MessageComponentTypes

Default MessageComponentTypes.BUTTON

Accessors

hasRun

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]

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/structures/basestructure.ts:323

merge(data?: BaseStructureData): void

Inherited from Structure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from Structure.mergeValue

onError()

optional src/utils/components/actionbase.ts:77

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

run()

optional src/utils/components/actionbase.ts:76

run(context: ComponentContext): unknown

toJSON()

src/utils/components/actionbase.ts:109

toJSON(): RawChannelMessageComponent

Overrides Structure.toJSON