Class StringSelector

Hierarchy (view full)

Selector<StringSelectMenuBuilder, StringSelectMenuInteraction, string>
- StringSelector

Index

Constructors

Properties

customId max min onSelect options placeholder selected

Methods

build getSelect getValues isValidInteraction onInteraction typeSafeIsValidInteraction

Constructors

constructor

new StringSelector(placeholder, onSelect, min?, max?, options?, selected?): StringSelector
Parameters
- placeholder: string
- onSelect: ((msg, objs) => any)
  - - (msg, objs): any
    - Parameters
      msg: StringSelectMenuInteraction<CacheType>
      objs: string[]
      Returns any
- Optional min: number
- Optional max: number
- options: string[] = []
- selected: string[] = []
Returns StringSelector
Overrides Selector.constructor
- Defined in src/navigation.ts:117

Properties

`Readonly` customId

customId: string = ...

`Readonly` max

max: number

`Readonly` min

min: number

`Readonly` onSelect

onSelect: ((msg, objs) => any)

Type declaration

- (msg, objs): any
- Parameters
  - msg: StringSelectMenuInteraction<CacheType>
  - objs: string[]
  Returns any

`Readonly` options

options: string[]

`Readonly` placeholder

placeholder: string

selected

selected: string[]

Methods

build

build(): StringSelectMenuBuilder | UserSelectMenuBuilder | RoleSelectMenuBuilder | MentionableSelectMenuBuilder | ChannelSelectMenuBuilder
Returns StringSelectMenuBuilder | UserSelectMenuBuilder | RoleSelectMenuBuilder | MentionableSelectMenuBuilder | ChannelSelectMenuBuilder
Inherited from Selector.build
- Defined in src/navigation.ts:59

`Protected` getSelect

getSelect(): StringSelectMenuBuilder
Returns StringSelectMenuBuilder
Overrides Selector.getSelect
- Defined in src/navigation.ts:123

`Protected` getValues

getValues(msg): string[]
Parameters
- msg: StringSelectMenuInteraction<CacheType>
Returns string[]
Overrides Selector.getValues
- Defined in src/navigation.ts:127

isValidInteraction

isValidInteraction(msg): boolean
Parameters
- msg: MessageComponentInteraction<CacheType>
Returns boolean
Inherited from Selector.isValidInteraction
- Defined in src/navigation.ts:74

onInteraction

onInteraction(msg): Promise<void>
Parameters
- msg: MessageComponentInteraction<CacheType>
Returns Promise<void>
Inherited from Selector.onInteraction
- Defined in src/navigation.ts:68

`Protected` typeSafeIsValidInteraction

typeSafeIsValidInteraction(msg): msg is StringSelectMenuInteraction<CacheType>
Typesafe version of isValidInteraction. Override this method instead;
Parameters
- msg: MessageComponentInteraction<CacheType>
  Interaction
Returns msg is StringSelectMenuInteraction<CacheType>
Overrides Selector.typeSafeIsValidInteraction
- Defined in src/navigation.ts:132