Class InteractiveComponent<T>

Type Parameters

T extends InteractiveComponentTargets

Hierarchy

InteractiveBase<T>
- InteractiveComponent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InteractiveComponent<T>(name: string, access: AccessTarget[], module: Module, builder: T, registry: Map<string, InteractiveComponent<InteractiveComponentTargets>>): InteractiveComponent<T>

Overrides InteractiveBase.constructor
- Defined in src/Interactions/InteractiveComponent.ts:8
Type Parameters
- T extends InteractiveComponentTargets
Parameters
- name: string
- access: AccessTarget[]
- module: Module
- builder: T
- registry: Map<string, InteractiveComponent<InteractiveComponentTargets>>
Returns InteractiveComponent<T>

Properties

access

access: AccessTarget[]

builder

builder: T

Optional lastInteraction

lastInteraction?: InteractionTypeOf<T>

module

module: Module

Readonly name

name: string

Methods

_exec

_exec(interaction: InteractionTypeOf<T>, user: User): Promise<void>

Inherited from InteractiveBase._exec
- Defined in src/Interactions/InteractiveBase.ts:25
Don't execute this function directly! It is for internal calls

Parameters
- interaction: InteractionTypeOf<T>
- user: User
Returns Promise<void>

build

build(f: ((builder: T) => Omit<T, any>)): InteractiveComponent<T>

- Defined in src/Interactions/InteractiveComponent.ts:24
Get component structure builder

Parameters
- f: ((builder: T) => Omit<T, any>)
  - - (builder: T): Omit<T, any>
    - Parameters
      - builder: T
      Returns Omit<T, any>
Returns InteractiveComponent<T>

destroy

destroy(): void

- Defined in src/Interactions/InteractiveComponent.ts:32
Remove component from registry

Returns void

isButton

isButton(): this is InteractiveComponent<MessageButton>

- Defined in src/Interactions/InteractiveComponent.ts:17
Returns this is InteractiveComponent<MessageButton>

isMenu

isMenu(): this is InteractiveComponent<MessageSelectMenu>

- Defined in src/Interactions/InteractiveComponent.ts:13
Returns this is InteractiveComponent<MessageSelectMenu>

onExecute

onExecute(callback: CallbackTypeOf<T>): InteractiveComponent<T>

Inherited from InteractiveBase.onExecute
- Defined in src/Interactions/InteractiveBase.ts:17
Set command callback function

Parameters
- callback: CallbackTypeOf<T>
  
  function to execute when received interaction
Returns InteractiveComponent<T>

Generated using TypeDoc