MentionableSelectMenu
Represents a Select Menu for selecting mentionable entities.
Example
1const mentionableSelectMenu = new MentionableSelectMenu();2mentionableSelectMenu.setCustomId("mentionable-select");
Extends
SelectMenu
<APIMentionableSelectComponent
,MentionableSelectMenuInteraction
>
Constructors
new MentionableSelectMenu(data)
1new MentionableSelectMenu(data: Partial<APIMentionableSelectComponent>): MentionableSelectMenu
Parameters
Parameter | Type |
---|---|
data | Partial <APIMentionableSelectComponent > |
Returns
Overrides
Source
seyfert/src/builders/SelectMenu.ts:187
Properties
Property | Modifier | Type | Inherited from |
---|---|---|---|
data | public | Partial <APIMentionableSelectComponent > | SelectMenu .data |
Methods
addDefaultMentionables()
1addDefaultMentionables(...mentionables: RestOrArray<MentionableDefaultElement>): MentionableSelectMenu
Adds default selected roles or users for the select menu.
Parameters
Parameter | Type | Description |
---|---|---|
…mentionables | RestOrArray <MentionableDefaultElement > | Role/User id and type to be added as default. |
Returns
The current MentionableSelectMenu instance.
Source
seyfert/src/builders/SelectMenu.ts:209
setCustomId()
1setCustomId(id: string): this
Sets the custom ID for the select menu.
Parameters
Parameter | Type | Description |
---|---|---|
id | string | The custom ID for the select menu. |
Returns
this
The current SelectMenu instance.
Inherited from
Source
seyfert/src/builders/SelectMenu.ts:71
setDefaultMentionables()
1setDefaultMentionables(...mentionables: RestOrArray<MentionableDefaultElement>): MentionableSelectMenu
Sets the default selected roles or users for the select menu.
Parameters
Parameter | Type | Description |
---|---|---|
…mentionables | RestOrArray <MentionableDefaultElement > | Role/User id and type to be set as default. |
Returns
The current MentionableSelectMenu instance.
Source
seyfert/src/builders/SelectMenu.ts:196
setDisabled()
1setDisabled(disabled: boolean): this
Sets whether the select menu is disabled. [disabled=true] - Indicates whether the select menu is disabled.
Parameters
Parameter | Type | Default value |
---|---|---|
disabled | boolean | true |
Returns
this
The current SelectMenu instance.
Inherited from
Source
seyfert/src/builders/SelectMenu.ts:102
setPlaceholder()
1setPlaceholder(placeholder: string): this
Sets the placeholder text for the select menu.
Parameters
Parameter | Type | Description |
---|---|---|
placeholder | string | The placeholder text. |
Returns
this
The current SelectMenu instance.
Inherited from
Source
seyfert/src/builders/SelectMenu.ts:81
setValuesLength()
1setValuesLength(options: Partial<OptionValuesLength>): this
Sets the maximum and minimum number of selected values for the select menu.
Parameters
Parameter | Type | Description |
---|---|---|
options | Partial <OptionValuesLength > | The maximum and minimum values. |
Returns
this
The current SelectMenu instance.
Inherited from
Source
seyfert/src/builders/SelectMenu.ts:91
toJSON()
1toJSON(): APIMentionableSelectComponent
Returns
APIMentionableSelectComponent