Class SelectMenuValuesWrapper

A wrapper for select menu data.

Hierarchy

  • SelectMenuValuesWrapper

Constructors

Properties

raw: string[]

The raw received values.

The resolved data for this instance.

Methods

  • Get the selected channels.

    If ensurePresent is false, channels that aren't in resolved will be ignored.

    Parameters

    • Optional ensurePresent: boolean

      If true, an error will be thrown if any value cannot be mapped to a channel.

    Returns InteractionResolvedChannel[]

  • Get the complete version of the selected channels. This will only succeed if the channel is cached. If the channel is private and isn't cached, an InteractionResolvedChannel instance will still be returned.

    If ensurePresent is false, channels that aren't in resolved will be ignored.

    Parameters

    • Optional ensurePresent: boolean

      If true, an error will be thrown if any value cannot be mapped to a channel.

    Returns (InteractionResolvedChannel | AnyImplementedChannel)[]

  • Get the selected members.

    If ensurePresent is false, members that aren't in resolved will be ignored.

    Parameters

    • Optional ensurePresent: boolean

      If true, an error will be thrown if any value cannot be mapped to a member.

    Returns Member[]

  • Get the selected mentionables. (channels, users, roles)

    If ensurePresent is false, mentionables that aren't in resolved will be ignored.

    Parameters

    • Optional ensurePresent: boolean

      If true, an error will be thrown if any value cannot be mapped to a channel, user, or role.

    Returns (User | Role | InteractionResolvedChannel)[]

  • Get the selected roles.

    If ensurePresent is false, roles that aren't in resolved will be ignored.

    Parameters

    • Optional ensurePresent: boolean

      If true, an error will be thrown if any value cannot be mapped to a role.

    Returns Role[]

  • Get the selected string values. This cannot fail.

    Returns string[]

  • Get the selected users.

    If ensurePresent is false, users that aren't in resolved will be ignored.

    Parameters

    • Optional ensurePresent: boolean

      If true, an error will be thrown if any value cannot be mapped to a user.

    Returns User[]

Generated using TypeDoc