Class MessageStringSelectMenuBuilder

a helper to build SelectMenu for oceanic.js

Hierarchy

MessageActionRowComponentsBuilder<StringSelectMenu>
- MessageStringSelectMenuBuilder

Index

Constructors

Accessors

customId disabled maxValues minValues options placeholder type

Methods

addOptions setCustomId setDisabled setMaxValues setMinValues setOptions setPlaceholder spliceOptions toOceanic

Constructors

constructor

new MessageStringSelectMenuBuilder(_data?): MessageStringSelectMenuBuilder
Parameters
- Optional _data: StringSelectMenu
Returns MessageStringSelectMenuBuilder
Overrides MessageActionRowComponentsBuilder.constructor
- Defined in helper/component/stringSelectMenu.ts:19

Accessors

customId

get customId(): undefined | string
Returns undefined | string
- Defined in helper/component/stringSelectMenu.ts:32

disabled

get disabled(): undefined | boolean
Returns undefined | boolean
- Defined in helper/component/stringSelectMenu.ts:36

maxValues

get maxValues(): undefined | number
Returns undefined | number
- Defined in helper/component/stringSelectMenu.ts:40

minValues

get minValues(): undefined | number
Returns undefined | number
- Defined in helper/component/stringSelectMenu.ts:44

options

get options(): readonly SelectOption[]
Returns readonly SelectOption[]
- Defined in helper/component/stringSelectMenu.ts:48

placeholder

get placeholder(): undefined | string
Returns undefined | string
- Defined in helper/component/stringSelectMenu.ts:52

type

get type(): STRING_SELECT
Returns STRING_SELECT
- Defined in helper/component/stringSelectMenu.ts:56

Methods

addOptions

addOptions(...options): MessageStringSelectMenuBuilder
Parameters
- Rest ...options: SelectOption[]
Returns MessageStringSelectMenuBuilder
- Defined in helper/component/stringSelectMenu.ts:60

setCustomId

setCustomId(customId): MessageStringSelectMenuBuilder
Parameters
- customId: string
Returns MessageStringSelectMenuBuilder
- Defined in helper/component/stringSelectMenu.ts:65

setDisabled

setDisabled(disabled?): MessageStringSelectMenuBuilder
Parameters
- disabled: boolean = true
Returns MessageStringSelectMenuBuilder
- Defined in helper/component/stringSelectMenu.ts:70

setMaxValues

setMaxValues(maxValues): MessageStringSelectMenuBuilder
Parameters
- maxValues: number
Returns MessageStringSelectMenuBuilder
- Defined in helper/component/stringSelectMenu.ts:75

setMinValues

setMinValues(minValues): MessageStringSelectMenuBuilder
Parameters
- minValues: number
Returns MessageStringSelectMenuBuilder
- Defined in helper/component/stringSelectMenu.ts:80

setOptions

setOptions(...options): MessageStringSelectMenuBuilder
Parameters
- Rest ...options: SelectOption[]
Returns MessageStringSelectMenuBuilder
- Defined in helper/component/stringSelectMenu.ts:85

setPlaceholder

setPlaceholder(placeholder): MessageStringSelectMenuBuilder
Parameters
- placeholder: string
Returns MessageStringSelectMenuBuilder
- Defined in helper/component/stringSelectMenu.ts:90

spliceOptions

spliceOptions(index, deleteCount, ...options): SelectOption[]
Parameters
- index: number
- deleteCount: number
- Rest ...options: SelectOption[]
Returns SelectOption[]
- Defined in helper/component/stringSelectMenu.ts:95

toOceanic

toOceanic(): StringSelectMenu
Returns StringSelectMenu
Overrides MessageActionRowComponentsBuilder.toOceanic
- Defined in helper/component/stringSelectMenu.ts:99

Generated using TypeDoc