ComponentCheckboxGroupclass

Utils Component Checkbox Group Structure, only usable in modals inside of a label

On this page

Overview
Constructor1
Properties7
Accessors1
Methods20

Utils Component Checkbox Group Structure, only usable in modals inside of a label

import { Utils } from 'detritus-client';

Utils.ComponentCheckboxGroup;

Hierarchy

StructureComponentActionBaseComponentCheckboxGroup

6 properties7 methods15 inheritedsrc/utils/components/checkbox.ts:87

Constructor

new ComponentCheckboxGroup

src/utils/components/checkbox.ts:97

new ComponentCheckboxGroup(data?: ComponentActionData)

Properties

customId

string

Default ''

Overrides ComponentActionBase.customId

id?

number | null

optional

Inherited from ComponentActionBase.id

maxValues?

number | null

optional

minValues?

number | null

optional

options

ComponentSelectMenuOption[]

Default []

required?

boolean

optional

type

MessageComponentTypes

Default MessageComponentTypes.CHECKBOX_GROUP

Overrides ComponentActionBase.type

Accessors

hasRun

boolean

get

Inherited from ComponentActionBase.hasRun

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from ComponentActionBase._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from ComponentActionBase._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from ComponentActionBase.[custom]

addOption()

src/utils/components/checkbox.ts:110

addOption(option: ComponentSelectMenuOption): this

createOption()

src/utils/components/checkbox.ts:115

createOption(data?: ComponentSelectMenuOptionData): ComponentSelectMenuOption

difference()

src/structures/basestructure.ts:146

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

Inherited from ComponentActionBase.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from ComponentActionBase.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from ComponentActionBase.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

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

Inherited from ComponentActionBase.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from ComponentActionBase.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from ComponentActionBase.hasDifferencesBetween

merge()

src/utils/components/checkbox.ts:141

merge(data?: BaseStructureData): void

Overrides ComponentActionBase.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from ComponentActionBase.mergeValue

onError()

optional src/utils/components/actionbase.ts:77

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

Inherited from ComponentActionBase.onError

run()

optional src/utils/components/actionbase.ts:76

run(context: ComponentContext): unknown

Inherited from ComponentActionBase.run

setCustomId()

src/utils/components/checkbox.ts:121

setCustomId(customId: string): this

setMaxValues()

src/utils/components/checkbox.ts:126

setMaxValues(maxValues: number | null): this

setMinValues()

src/utils/components/checkbox.ts:131

setMinValues(minValues: number | null): this

setRequired()

src/utils/components/checkbox.ts:136

setRequired(required: boolean): this

toJSON()

src/utils/components/actionbase.ts:109

toJSON(): RawChannelMessageComponent

Inherited from ComponentActionBase.toJSON