Class Component

Hierarchy

Base
- Component

Index

Constructors

constructor

Properties

id

Accessors

container

Methods

Constructors

constructor

new Component(options: ComponentOptions): Component

Overrides Base.constructor
- Defined in src/structures/Component.ts:19
Parameters
- options: ComponentOptions
Returns Component

Properties

id

id: string

The custom ID of the component.

Accessors

Protected container

get container(): Container

Inherited from Base.container
- Defined in src/structures/Base.ts:10
A reference to the container.

Returns Container

Methods

onButton

onButton(button: Component.Button): void

- Defined in src/structures/Component.ts:37
When a button interaction is received with this components ID.

abstract
Parameters
- button: Component.Button
  
  The button interaction
Returns void

onModalSubmit

onModalSubmit(modal: Component.ModalSubmit | MessageModalSubmit): void

- Defined in src/structures/Component.ts:55
When a modal submit interaction is received with this components ID.

Parameters
- modal: Component.ModalSubmit | MessageModalSubmit
  
  The modal submit interaction
Returns void

onSelectMenu

onSelectMenu(menu: Component.SelectMenu): void

- Defined in src/structures/Component.ts:46
When a select menu interaction is received with this components ID.

Parameters
- menu: Component.SelectMenu
  
  The modal submit interaction
Returns void