Class ComponentButton

Utils Component Button Structure

Hierarchy

ComponentActionBase
- ComponentButton

Index

Constructors

constructor

Properties

Constructors

constructor

new ComponentButton(data?: ComponentActionData): ComponentButton

Overrides ComponentActionBase.constructor
- Defined in src/utils/components/button.ts:37
Parameters
- data: ComponentActionData = {}
Returns ComponentButton

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Optional customId

customId: null | string

Optional disabled

disabled: boolean

Optional emoji

emoji: null | ComponentEmojiData

Optional label

label: null | string

style

style: MessageComponentButtonStyles = ...

type

type: MessageComponentTypes = ...

Optional url

url: null | string

Methods

[custom]

[custom](): object

Inherited from ComponentActionBase.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from ComponentActionBase._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

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

Inherited from ComponentActionBase._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

difference

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

Inherited from ComponentActionBase.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from ComponentActionBase.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from ComponentActionBase.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

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

Inherited from ComponentActionBase.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from ComponentActionBase.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from ComponentActionBase.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from ComponentActionBase.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

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

Overrides ComponentActionBase.mergeValue
- Defined in src/utils/components/button.ts:78
Parameters
- key: string
- value: any
Returns void

Optional onError

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

Inherited from ComponentActionBase.onError
- Defined in src/utils/components/actionbase.ts:48
Parameters
- context: ComponentContext
- error: Error
Returns any

Optional run

run(context: ComponentContext): any

Inherited from ComponentActionBase.run
- Defined in src/utils/components/actionbase.ts:47
Parameters
- context: ComponentContext
Returns any

setCustomId

setCustomId(customId: null | string): ComponentButton

- Defined in src/utils/components/button.ts:45
Parameters
- customId: null | string
Returns ComponentButton

setDisabled

setDisabled(disabled: boolean): ComponentButton

- Defined in src/utils/components/button.ts:50
Parameters
- disabled: boolean
Returns ComponentButton

setEmoji

setEmoji(emoji: null | ComponentEmojiData): ComponentButton

- Defined in src/utils/components/button.ts:55
Parameters
- emoji: null | ComponentEmojiData
Returns ComponentButton

setLabel

setLabel(label: null | string): ComponentButton

- Defined in src/utils/components/button.ts:60
Parameters
- label: null | string
Returns ComponentButton

setStyle

setStyle(style: MessageComponentButtonStyles): ComponentButton

- Defined in src/utils/components/button.ts:65
Parameters
- style: MessageComponentButtonStyles
Returns ComponentButton

setUrl

setUrl(url: null | string): ComponentButton

- Defined in src/utils/components/button.ts:70
Parameters
- url: null | string
Returns ComponentButton

toJSON

toJSON(): RawChannelMessageComponent

Inherited from ComponentActionBase.toJSON
- Defined in src/utils/components/actionbase.ts:63
Returns RawChannelMessageComponent

Generated using TypeDoc