Class MentionableSelectMenu

Represents a Select Menu for selecting mentionable entities.

Example

const mentionableSelectMenu = new MentionableSelectMenu();
mentionableSelectMenu.setCustomId("mentionable-select");

Hierarchy (View Summary)

SelectMenu<APIMentionableSelectComponent>
- MentionableSelectMenu

Index

Constructors

constructor

new MentionableSelectMenu(
data?: Partial<APIMentionableSelectComponent>,
): MentionableSelectMenu
Parameters
- data: Partial<APIMentionableSelectComponent> = {}
Returns MentionableSelectMenu
Overrides SelectMenu.constructor
- Defined in src/builders/SelectMenu.ts:173

Properties

data

data: Partial<TYPE> = {}

Methods

addDefaultMentionables

addDefaultMentionables(
...mentionables: RestOrArray<MentionableDefaultElement>,
): MentionableSelectMenu
Adds default selected roles or users for the select menu.
Parameters
- ...mentionables: RestOrArray<MentionableDefaultElement>
  Role/User id and type to be added as default.
Returns MentionableSelectMenu
The current MentionableSelectMenu instance.
- Defined in src/builders/SelectMenu.ts:195

setCustomId

setCustomId(id: string): this
Sets the custom ID for the select menu.
Parameters
- id: string
  The custom ID for the select menu.
Returns this
The current SelectMenu instance.
Inherited from SelectMenu.setCustomId
- Defined in src/builders/SelectMenu.ts:57

setDefaultMentionables

setDefaultMentionables(
...mentionables: RestOrArray<MentionableDefaultElement>,
): MentionableSelectMenu
Sets the default selected roles or users for the select menu.
Parameters
- ...mentionables: RestOrArray<MentionableDefaultElement>
  Role/User id and type to be set as default.
Returns MentionableSelectMenu
The current MentionableSelectMenu instance.
- Defined in src/builders/SelectMenu.ts:182

setDisabled

setDisabled(disabled?: boolean): this
Sets whether the select menu is disabled. [disabled=true] - Indicates whether the select menu is disabled.
Parameters
- disabled: boolean = true
Returns this
The current SelectMenu instance.
Inherited from SelectMenu.setDisabled
- Defined in src/builders/SelectMenu.ts:88

setPlaceholder

setPlaceholder(placeholder: string): this
Sets the placeholder text for the select menu.
Parameters
- placeholder: string
  The placeholder text.
Returns this
The current SelectMenu instance.
Inherited from SelectMenu.setPlaceholder
- Defined in src/builders/SelectMenu.ts:67

setValuesLength

setValuesLength(options: Partial<OptionValuesLength>): this
Sets the maximum and minimum number of selected values for the select menu.
Parameters
- options: Partial<OptionValuesLength>
  The maximum and minimum values.
Returns this
The current SelectMenu instance.
Inherited from SelectMenu.setValuesLength
- Defined in src/builders/SelectMenu.ts:77

toJSON

toJSON(): APIMentionableSelectComponent
Returns APIMentionableSelectComponent
Inherited from SelectMenu.toJSON
- Defined in src/builders/Base.ts:8

Class MentionableSelectMenu

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MentionableSelectMenu

Properties

data

Methods

addDefaultMentionables

Parameters

Returns MentionableSelectMenu

setCustomId

Parameters

Returns this

setDefaultMentionables

Parameters

Returns MentionableSelectMenu

setDisabled

Parameters

Returns this

setPlaceholder

Parameters

Returns this

setValuesLength

Parameters

Returns this

toJSON

Returns APIMentionableSelectComponent

Settings

On This Page