InteractionModalclass

The most basic Structure class, every structure extends this

On this page

Overview
Constructor1
Properties5
Accessors1
Methods29

The most basic Structure class, every structure extends this

import { Utils } from 'detritus-client';

Utils.InteractionModal;

Hierarchy

StructureInteractionModal

5 properties19 methods10 inheritedsrc/utils/modal/modal.ts:66

Constructor

new InteractionModal

src/utils/modal/modal.ts:79

new InteractionModal(data?: InteractionModalOptions)

Properties

_timeout?

Timeout

optional

components

Components

customId

string

Default ''

timeout

number

Default INTERACTION_TIMEOUT

title

string

Default ''

Accessors

string

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]

addActionRow()

src/utils/modal/modal.ts:102

addActionRow(data?: ComponentActionRowData | ComponentActionRow): this

addInputText()

src/utils/modal/modal.ts:107

addInputText(data?: ComponentActionData | ComponentInputText): this

addLabel()

src/utils/modal/modal.ts:112

addLabel(data?: ComponentLabel | ComponentLabelData): this

addTextDisplay()

src/utils/modal/modal.ts:117

addTextDisplay(data?: ComponentTextDisplay | ComponentTextDisplayData): this

clear()

src/utils/modal/modal.ts:122

clear(): void

createActionRow()

src/utils/modal/modal.ts:126

createActionRow(data?: ComponentActionRowData): ComponentActionRow

createCheckbox()

src/utils/modal/modal.ts:130

createCheckbox(label?: ComponentLabelData, data?: ComponentActionData): ComponentCheckbox

createCheckboxGroup()

src/utils/modal/modal.ts:134

createCheckboxGroup(
  label?: ComponentLabelData,
  data?: ComponentActionData,
): ComponentCheckboxGroup

createFileUpload()

src/utils/modal/modal.ts:138

createFileUpload(
  label?: ComponentLabelData,
  data?: ComponentActionData,
): ComponentFileUpload

createInputText()

src/utils/modal/modal.ts:142

createInputText(data?: ComponentActionData): ComponentInputText

createLabel()

src/utils/modal/modal.ts:147

createLabel(data?: ComponentLabelData): ComponentLabel

createRadioGroup()

src/utils/modal/modal.ts:151

createRadioGroup(
  label?: ComponentLabelData,
  data?: ComponentActionData,
): ComponentRadioGroup

createSelectMenu()

src/utils/modal/modal.ts:155

createSelectMenu(
  label?: ComponentLabelData,
  data?: ComponentActionData,
): ComponentSelectMenu

createTextDisplay()

src/utils/modal/modal.ts:159

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/structures/basestructure.ts:323

merge(data?: BaseStructureData): void

Inherited from Structure.merge

mergeValue()

src/utils/modal/modal.ts:163

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

Overrides Structure.mergeValue

onError()

optional src/utils/modal/modal.ts:77

onError(
  context: InteractionModalContext,
  args: InteractionModalArgs,
  error: Error,
): unknown

onTimeout()

optional src/utils/modal/modal.ts:75

onTimeout(): unknown

run()

optional src/utils/modal/modal.ts:76

run(context: InteractionModalContext, args: InteractionModalArgs): unknown

toJSON()

src/utils/modal/modal.ts:202

toJSON(): CreateInteractionResponseInnerPayload

Overrides Structure.toJSON