ComponentSectionclass

Utils Component Section Structure

On this page

Overview
Constructor1
Properties4
Accessors4
Methods19

Utils Component Section Structure

import { Utils } from 'detritus-client';

Utils.ComponentSection;

Hierarchy

StructureComponentSection

8 properties9 methods10 inheritedsrc/utils/components/section.ts:36

Constructor

new ComponentSection

src/utils/components/section.ts:44

new ComponentSection(data?: ComponentSectionData)

Properties

accessory?

ComponentButton | ComponentThumbnail

optional

components

ComponentTextDisplay[]

Default []

id?

number

optional

type

MessageComponentTypes

Default MessageComponentTypes.SECTION

Accessors

hasButton

boolean

get

hasRun

boolean

get

isEmpty

boolean

get

isFull

boolean

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from Structure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from Structure.[custom]

addTextDisplay()

src/utils/components/section.ts:72

addTextDisplay(data?: ComponentTextDisplay | ComponentTextDisplayData): this

clear()

src/utils/components/section.ts:81

clear(): void

createAccessoryButton()

src/utils/components/section.ts:85

createAccessoryButton(data?: ComponentActionData): ComponentButton

createTextDisplay()

src/utils/components/section.ts:91

createTextDisplay(data?: ComponentTextDisplayData): ComponentTextDisplay

difference()

src/structures/basestructure.ts:146

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

Inherited from Structure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from Structure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from Structure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

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

Inherited from Structure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween

merge()

src/utils/components/section.ts:134

merge(data?: BaseStructureData): void

Overrides Structure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from Structure.mergeValue

setAccessory()

src/utils/components/section.ts:97

setAccessory(
  data?: ComponentActionData | ComponentButton | ComponentThumbnail | ComponentThumbnailData,
): this

setAccessoryButton()

src/utils/components/section.ts:116

setAccessoryButton(data?: ComponentActionData | ComponentButton): this

setAccessoryThumbnail()

src/utils/components/section.ts:125

setAccessoryThumbnail(data?: ComponentThumbnail | ComponentThumbnailData): this

toJSON()

src/utils/components/section.ts:158

toJSON(): RawChannelMessageComponent

Overrides Structure.toJSON