API reference for @discord-types/builders/message/components/selectMenu/selectMenu

selectMenu

Types

SelectMenu

Raw Type

type SelectMenu = SelectMenu.Prototype, & {
	type: channelTypes.SelectMenuType?,

	customId: string?,

	options: {option.JSON},

	channelTypes: {channelTypes.ChannelType},

	placeholder: string?,

	defaultValues: {defaultValue.JSON},

	minValues: number?,

	maxValues: number?,

	disabled: boolean?
}

Intersection with variants:

Variant 2

Prop	Type	Description
`type?`	`channelTypes.SelectMenuType?`	-
`customId?`	`string?`	-
`options`	`{option.JSON}`	-
`channelTypes`	`{channelTypes.ChannelType}`	-
`placeholder?`	`string?`	-
`defaultValues`	`{defaultValue.JSON}`	-
`minValues?`	`number?`	-
`maxValues?`	`number?`	-
`disabled?`	`boolean?`	-

JSON

Raw Type

type JSON = SelectMenu.Prototype.build(nil :: any),

Functions

SelectMenu.Prototype.setType

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.setType(self: SelectMenu, selectMenuType: channelTypes.SelectMenuType) -> SelectMenu end

Arguments

selectMenuType

channelTypes.SelectMenuType

Returns

ret1

SelectMenu

SelectMenu.Prototype.setCustomId

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.setCustomId(self: SelectMenu, customId: string) -> SelectMenu end

Arguments

customId

string

Returns

ret1

SelectMenu

SelectMenu.Prototype.setPlaceholder

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.setPlaceholder(self: SelectMenu, placeholder: string) -> SelectMenu end

Arguments

placeholder

string

Returns

ret1

SelectMenu

SelectMenu.Prototype.setMinValues

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.setMinValues(self: SelectMenu, minValueCount: number) -> SelectMenu end

Arguments

minValueCount

number

Returns

ret1

SelectMenu

SelectMenu.Prototype.setMaxValues

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.setMaxValues(self: SelectMenu, maxValueCount: number) -> SelectMenu end

Arguments

maxValueCount

number

Returns

ret1

SelectMenu

SelectMenu.Prototype.setDisabled

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.setDisabled(self: SelectMenu, disabled: boolean) -> SelectMenu end

Arguments

disabled

boolean

Returns

ret1

SelectMenu

SelectMenu.Prototype.addDefaultValue

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.addDefaultValue(self: SelectMenu, defaultValue: defaultValue.JSON) -> SelectMenu end

Arguments

defaultValue

defaultValue.JSON

Returns

ret1

SelectMenu

SelectMenu.Prototype.addChannelType

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.addChannelType(self: SelectMenu, channelType: channelTypes.ChannelType) -> SelectMenu end

Arguments

channelType

channelTypes.ChannelType

Returns

ret1

SelectMenu

SelectMenu.Prototype.addOption

[[

]]

Function Signature

--[[
	
]]
function SelectMenu.Prototype.addOption(self: SelectMenu, option: option.JSON) -> SelectMenu end

Arguments

option

option.JSON

Returns

ret1

SelectMenu

SelectMenu.Prototype.build

[[ Responsible for building the SelectMenu JSON that can be parsed by the Discord API. ]]

Function Signature

--[[
	Responsible for building the SelectMenu JSON that can be parsed by the Discord API.
]]
function SelectMenu.Prototype.build(self: SelectMenu) -> JSON end

Returns

ret1

JSON

SelectMenu.Interface.new

[[ Responsible for creating a new SelectMenu.

```lua

``` ]]

Function Signature

--[[
	Responsible for creating a new SelectMenu.

	\`\`\`lua
	
	\`\`\`
]]
function SelectMenu.Interface.new(resource: {
		type: channelTypes.SelectMenuType?,

		customId: string?,

		options: {option.JSON},

		channelTypes: {channelTypes.ChannelType},

		placeholder: string?,

		defaultValues: {defaultValue.JSON},

		minValues: number?,

		maxValues: number?,

		disabled: boolean?
	}?) -> SelectMenu end

Arguments

resource

This field is optional and may not be specified

{type: channelTypes.SelectMenuType?, customId: string?, options: {option.JSON}, channelTypes: {channelTypes.ChannelType}, placeholder: string?, defaultValues: {defaultValue.JSON}, minValues: number?, maxValues: number?, disabled: boolean?}?

Returns

ret1

SelectMenu

@discord-types/builders/message/components/selectMenu/selectMenu

On this page