ComponentButtonclass

Utils Component Button Structure

On this page

Overview
Constructor1
Properties9
Accessors1
Methods21

Utils Component Button Structure

import { Utils } from 'detritus-client';

Utils.ComponentButton;

Hierarchy

StructureComponentActionBaseComponentButton

8 properties8 methods15 inheritedsrc/utils/components/button.ts:31

Constructor

new ComponentButton

src/utils/components/button.ts:44

new ComponentButton(data?: ComponentActionData)

Properties

customId?

string | null

optional

Overrides ComponentActionBase.customId

disabled?

boolean

optional

emoji?

ComponentEmojiData | null

optional

id?

number | null

optional

Inherited from ComponentActionBase.id

label?

string | null

optional

skuId?

string | null

optional

style

MessageComponentButtonStyles

Default MessageComponentButtonStyles.PRIMARY

type

MessageComponentTypes

Default MessageComponentTypes.BUTTON

Overrides ComponentActionBase.type

url?

string | null

optional

Accessors

hasRun

boolean

get

Inherited from ComponentActionBase.hasRun

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from ComponentActionBase._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from ComponentActionBase._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from ComponentActionBase.[custom]

difference()

src/structures/basestructure.ts:146

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

Inherited from ComponentActionBase.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from ComponentActionBase.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from ComponentActionBase.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

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

Inherited from ComponentActionBase.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from ComponentActionBase.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from ComponentActionBase.hasDifferencesBetween

merge()

src/structures/basestructure.ts:323

merge(data?: BaseStructureData): void

Inherited from ComponentActionBase.merge

mergeValue()

src/utils/components/button.ts:107

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

Overrides ComponentActionBase.mergeValue

onError()

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

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

Inherited from ComponentActionBase.onError

run()

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

run(context: ComponentContext): unknown

Inherited from ComponentActionBase.run

setCustomId()

src/utils/components/button.ts:66

setCustomId(customId: string | null): this

setDisabled()

src/utils/components/button.ts:71

setDisabled(disabled: boolean): this

setEmoji()

src/utils/components/button.ts:76

setEmoji(emoji: ComponentEmojiData | null): this

setLabel()

src/utils/components/button.ts:81

setLabel(label: string | null): this

setSkuId()

src/utils/components/button.ts:86

setSkuId(skuId: string | null): this

setStyle()

src/utils/components/button.ts:94

setStyle(style: MessageComponentButtonStyles): this

setUrl()

src/utils/components/button.ts:99

setUrl(url: string | null): this

toJSON()

src/utils/components/actionbase.ts:109

toJSON(): RawChannelMessageComponent

Inherited from ComponentActionBase.toJSON