Class SelectMenu

Hierarchy

Constructors

constructor

Properties

channelTypes? customID disabled load maxValues? minValues? options placeholder? type

Methods

addOption addOptions clearOptions disable enable setChannelTypes setCustomID setPlaceholder setValues toJSON toJSONRaw

Constructors

constructor

  • Create a new SelectMenu.

    Parameters

    • type: SelectMenuTypes
    • customID: string

      The custom ID of this select menu.

    Returns SelectMenu

Properties

Optional channelTypes

channelTypes?: ChannelTypes[]

customID

customID: string

disabled

disabled: boolean

Private load

load: any

this method is meant to be for internal use only, don't use it, as it may break or change at a moments notice

Optional maxValues

maxValues?: number

Optional minValues

minValues?: number

options

options: SelectOption[]

Optional placeholder

placeholder?: string

type

type: SelectMenuTypes

Methods

addOption

  • Add an option to this select menu.

    Parameters

    • label: string

      The label for this option.

    • value: string

      The value of this option.

    • Optional description: string

      The description of this option.

    • Optional emoji: PartialEmoji

      The emoji to displayed with this option.

    • Optional defaultSelection: boolean

    Returns SelectMenu

addOptions

  • Add options to this select menu in bulk.

    Parameters

    Returns SelectMenu

clearOptions

  • Clear all currently present options on this select menu.

    Returns SelectMenu

disable

  • Disable this component.

    Returns SelectMenu

enable

  • Enable this component.

    Returns SelectMenu

setChannelTypes

  • Set the valid channel types for a channel select menu.

    Parameters

    Returns SelectMenu

setCustomID

  • Set the custom ID of this select menu.

    Parameters

    • customID: string

      A developer-defined identifier for the button, max 100 characters.

    Returns SelectMenu

setPlaceholder

  • Set the placeholder of this select menu.

    Parameters

    • placeholder: string

      Custom placeholder text if nothing is selected, max 100 characters.

    Returns SelectMenu

setValues

  • Set the minimum/maximum values of this select menu.

    Parameters

    • Optional min: number

      The minimum selected values.

    • Optional max: number

      The maximum selected values.

    Returns SelectMenu

toJSON

  • converts this SelectMenu instance to json.

    Returns SelectMenuComponent

toJSONRaw

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc