Documentation/detritus-client/Structures

ComponentCheckboxclass

Component Checkbox Structure, received from modal submits

On this page

Overview
Constructor1
Properties5
Accessors2
Methods13

Component Checkbox Structure, received from modal submits

import { Structures } from 'detritus-client';

Structures.ComponentCheckbox;

Hierarchy

StructureBaseStructureComponentCheckbox

4 properties1 method15 inheritedsrc/structures/components.ts:239

Constructor

new ComponentCheckbox

src/structures/components.ts:248

new ComponentCheckbox(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

client

ShardClient

readonly

Inherited from BaseStructure.client

customId

string

Default ''

id?

number

optional

type

CHECKBOX

Default MessageComponentTypes.CHECKBOX

value

boolean

Default false

Accessors

isClone

boolean

get

Inherited from BaseStructure.isClone

shardId

number

get

Inherited from BaseStructure.shardId

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

difference()

src/structures/basestructure.ts:146

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

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

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

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/components.ts:257

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON