Class SelectMenuValuesWrapper

A wrapper for select menu data.

Hierarchy

SelectMenuValuesWrapper

Index

Constructors

constructor

new SelectMenuValuesWrapper(resolved: MessageComponentInteractionResolvedData, values: string[]): SelectMenuValuesWrapper
Parameters
- resolved: MessageComponentInteractionResolvedData
- values: string[]
Returns SelectMenuValuesWrapper
- Defined in lib/util/SelectMenuValuesWrapper.ts:17

Properties

raw

raw: string[]

The raw received values.

resolved

resolved: MessageComponentInteractionResolvedData

The resolved data for this instance.

Methods

getChannels

getChannels(ensurePresent?: boolean): InteractionResolvedChannel[]
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[]
- Defined in lib/util/SelectMenuValuesWrapper.ts:28

getCompleteChannels

getCompleteChannels(ensurePresent?: boolean): (InteractionResolvedChannel | AnyImplementedChannel)[]
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)[]
- Defined in lib/util/SelectMenuValuesWrapper.ts:44

getMembers

getMembers(ensurePresent?: boolean): Member[]
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[]
- Defined in lib/util/SelectMenuValuesWrapper.ts:63

getMentionables

getMentionables(ensurePresent?: boolean): (Role | User | InteractionResolvedChannel)[]
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 (Role | User | InteractionResolvedChannel)[]
- Defined in lib/util/SelectMenuValuesWrapper.ts:79

getRoles

getRoles(ensurePresent?: boolean): Role[]
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[]
- Defined in lib/util/SelectMenuValuesWrapper.ts:103

getStrings

getStrings(): string[]
Get the selected string values. This cannot fail.

Returns string[]
- Defined in lib/util/SelectMenuValuesWrapper.ts:116

getUsers

getUsers(ensurePresent?: boolean): User[]
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[]
- Defined in lib/util/SelectMenuValuesWrapper.ts:126

Class SelectMenuValuesWrapper

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

resolved: MessageComponentInteractionResolvedData

values: string[]

Returns SelectMenuValuesWrapper

Properties

raw

resolved

Methods

getChannels

Parameters

Optional ensurePresent: boolean

Returns InteractionResolvedChannel[]

getCompleteChannels

Parameters

Optional ensurePresent: boolean

Returns (InteractionResolvedChannel | AnyImplementedChannel)[]

getMembers

Parameters

Optional ensurePresent: boolean

Returns Member[]

getMentionables

Parameters

Optional ensurePresent: boolean

Returns (Role | User | InteractionResolvedChannel)[]

getRoles

Parameters

Optional ensurePresent: boolean

Returns Role[]

getStrings

Returns string[]

getUsers

Parameters

Optional ensurePresent: boolean

Returns User[]

Settings

Member Visibility

Theme

`Optional` ensurePresent: boolean

`Optional` ensurePresent: boolean

`Optional` ensurePresent: boolean

`Optional` ensurePresent: boolean

`Optional` ensurePresent: boolean

`Optional` ensurePresent: boolean