Class Checkbox

Hierarchy (View Summary)

BaseComponentBuilder<APICheckboxComponent>
- Checkbox

Index

Constructors

Properties

Methods

setCustomId setDefault setId toJSON

Constructors

constructor

new Checkbox(data?: Partial<APICheckboxComponent>): Checkbox
Parameters
- data: Partial<APICheckboxComponent> = {}
Returns Checkbox
Overrides BaseComponentBuilder.constructor
- Defined in src/builders/Checkbox.ts:5

Properties

data

data: Partial<TYPE> = {}

Methods

setCustomId

setCustomId(customId: string): Checkbox
Sets the custom ID for the checkbox.
Parameters
- customId: string
  The custom ID for the checkbox.
Returns Checkbox
The current Checkbox instance.
- Defined in src/builders/Checkbox.ts:25

setDefault

setDefault(value: boolean): Checkbox
Sets whether the checkbox is selected by default.
Parameters
- value: boolean
  Whether the checkbox is selected by default.
Returns Checkbox
The current Checkbox instance.
- Defined in src/builders/Checkbox.ts:35

setId

setId(id: number): Checkbox
Sets the ID for the checkbox.
Parameters
- id: number
  The ID for the checkbox.
Returns Checkbox
The current Checkbox instance.

Remarks
The ID is used by Discord to identify the component when an interaction is received. It must be unique within the message.
- Defined in src/builders/Checkbox.ts:15

toJSON

toJSON(): APICheckboxComponent
Returns APICheckboxComponent
Inherited from BaseComponentBuilder.toJSON
- Defined in src/builders/Base.ts:8