ComponentSelectMenuclass

Utils Component Select Menu Structure

On this page

Overview
Constructor1
Properties11
Accessors1
Methods26

Utils Component Select Menu Structure

import { Utils } from 'detritus-client';

Utils.ComponentSelectMenu;

Hierarchy

StructureComponentActionBaseComponentSelectMenu

10 properties13 methods15 inheritedsrc/utils/components/selectmenu.ts:51

Constructor

new ComponentSelectMenu

src/utils/components/selectmenu.ts:65

new ComponentSelectMenu(data?: ComponentActionData)

Properties

channelTypes?

ChannelTypes[] | null

optional

customId

string

Default ''

Overrides ComponentActionBase.customId

defaultValues?

ComponentSelectMenuDefaultValue[]

optional

Default []

disabled?

boolean

optional

id?

number | null

optional

Inherited from ComponentActionBase.id

maxValues?

number | null

optional

minValues?

number | null

optional

options

ComponentSelectMenuOption[]

Default []

placeholder?

string | null

optional

required?

boolean

optional

type

MessageComponentTypes

Default MessageComponentTypes.SELECT_MENU

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]

addChannelType()

src/utils/components/selectmenu.ts:95

addChannelType(channelType: ChannelTypes): this

addDefaultValue()

src/utils/components/selectmenu.ts:104

addDefaultValue(defaultValue: ComponentSelectMenuDefaultValue): this

addOption()

src/utils/components/selectmenu.ts:113

addOption(option: ComponentSelectMenuOption): this

createDefaultValue()

src/utils/components/selectmenu.ts:118

createDefaultValue(
  data: ComponentSelectMenuDefaultValueData,
): ComponentSelectMenuDefaultValue

createOption()

src/utils/components/selectmenu.ts:124

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

merge(data?: BaseStructureData): void

Inherited from ComponentActionBase.merge

mergeValue()

src/utils/components/selectmenu.ts:171

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

Overrides 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

setChannelTypes()

src/utils/components/selectmenu.ts:130

setChannelTypes(channelTypes?: ChannelTypes[]): this

Parameters

channelTypes?

ChannelTypes[]

Default []

setCustomId()

src/utils/components/selectmenu.ts:135

setCustomId(customId: string): this

setMaxValues()

src/utils/components/selectmenu.ts:151

setMaxValues(maxValues: number | null): this

setMinValues()

src/utils/components/selectmenu.ts:156

setMinValues(minValues: number | null): this

setPlaceholder()

src/utils/components/selectmenu.ts:161

setPlaceholder(placeholder: string | null): this

setRequired()

src/utils/components/selectmenu.ts:166

setRequired(required: boolean): this

setType()

src/utils/components/selectmenu.ts:140

setType(
  type: SELECT_MENU | USER_SELECT | ROLE_SELECT | MENTIONABLE_SELECT | CHANNEL_SELECT,
): this

toJSON()

src/utils/components/actionbase.ts:109

toJSON(): RawChannelMessageComponent

Inherited from ComponentActionBase.toJSON