Class CheckboxGroup

Hierarchy (View Summary)

BaseComponentBuilder<APICheckboxGroupComponent>
- CheckboxGroup

Index

Constructors

Properties

Methods

addOptions setCustomId setId setOptions setRequired setSelectionLimit toJSON

Constructors

constructor

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

Properties

data

data: Partial<TYPE> = {}

Methods

addOptions

addOptions(...options: RestOrArray<CheckboxGroupOption>): CheckboxGroup
Parameters
- ...options: RestOrArray<CheckboxGroupOption>
Returns CheckboxGroup
- Defined in src/builders/CheckboxGroup.ts:58

setCustomId

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

setId

setId(id: number): CheckboxGroup
Sets the ID for the checkbox group.
Parameters
- id: number
  The ID for the checkbox group.
Returns CheckboxGroup
The current CheckboxGroup 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/CheckboxGroup.ts:17

setOptions

setOptions(...options: RestOrArray<CheckboxGroupOption>): CheckboxGroup
Parameters
- ...options: RestOrArray<CheckboxGroupOption>
Returns CheckboxGroup
- Defined in src/builders/CheckboxGroup.ts:53

setRequired

setRequired(required: boolean): CheckboxGroup
Sets whether the checkbox group is required.
Parameters
- required: boolean
  Whether the checkbox group is required (true by discord side).
Returns CheckboxGroup
The current CheckboxGroup instance.
- Defined in src/builders/CheckboxGroup.ts:48

setSelectionLimit

setSelectionLimit(options: Partial<OptionValuesLength>): this
Sets the maximum and minimum number of selected values for the checkbox group. [max = options length] 10, [min = 1] 0
Parameters
- options: Partial<OptionValuesLength>
  The maximum and minimum values.
Returns this
The current CheckboxGroup instance.
- Defined in src/builders/CheckboxGroup.ts:37

toJSON

toJSON(): APICheckboxGroupComponent
Returns APICheckboxGroupComponent
Overrides BaseComponentBuilder.toJSON
- Defined in src/builders/CheckboxGroup.ts:63