Class: MessagePrompterNumberStrategy
@sapphire/discord.js-utilities.MessagePrompterNumberStrategy
Hierarchy
-
↳
MessagePrompterNumberStrategy
Implements
Constructors
constructor
• new MessagePrompterNumberStrategy(message, options): MessagePrompterNumberStrategy
Constructor for the MessagePrompterBaseStrategy class
Parameters
| Name | Type | Description |
|---|---|---|
message | string | MessagePayload | MessageCreateOptions | - |
options | IMessagePrompterNumberStrategyOptions | Overrideable options if needed. |
Returns
Overrides
MessagePrompterBaseStrategy.constructor
Defined in
Properties
appliedMessage
• appliedMessage: null | Message<boolean> = null
The message that has been sent in MessagePrompter.run
Inherited from
MessagePrompterBaseStrategy.appliedMessage
Defined in
editMessage
• editMessage: undefined | Message<boolean>
The message the bot will edit to send its prompt in MessagePrompter.run
Implementation of
IMessagePrompterNumberStrategyOptions.editMessage
Inherited from
MessagePrompterBaseStrategy.editMessage
Defined in
end
• end: number
The available number emojis
Implementation of
IMessagePrompterNumberStrategyOptions.end
Defined in
explicitReturn
• explicitReturn: boolean
Whether to return an explicit object with data, or the strategies' default
Implementation of
IMessagePrompterNumberStrategyOptions.explicitReturn
Inherited from
MessagePrompterBaseStrategy.explicitReturn
Defined in
message
• message: string | MessagePayload | MessageCreateOptions
The message that will be sent in MessagePrompter.run
Inherited from
MessagePrompterBaseStrategy.message
Defined in
numberEmojis
• numberEmojis: EmojiIdentifierResolvable[]
The available number emojis
Implementation of
IMessagePrompterNumberStrategyOptions.numberEmojis
Defined in
start
• start: number
The available number emojis
Implementation of
IMessagePrompterNumberStrategyOptions.start
Defined in
timeout
• timeout: number
The timeout that was used in the collector
Implementation of
IMessagePrompterNumberStrategyOptions.timeout
Inherited from
MessagePrompterBaseStrategy.timeout
Defined in
type
• type: string
The type of strategy that was used
Inherited from
MessagePrompterBaseStrategy.type
Defined in
defaultStrategyOptions
▪ Static defaultStrategyOptions: IMessagePrompterStrategyOptions
The default strategy options
Inherited from
MessagePrompterBaseStrategy.defaultStrategyOptions
Defined in
numberEmojis
▪ Static numberEmojis: string[]
The default available number emojis
Defined in
Methods
collectReactions
▸ collectReactions(channel, authorOrFilter, reactions): Promise<IMessagePrompterExplicitReturnBase>
Parameters
| Name | Type |
|---|---|
channel | MessagePrompterChannelTypes |
authorOrFilter | User | CollectorFilter<[MessageReaction, User]> |
reactions | string[] | EmojiIdentifierResolvable[] |
Returns
Promise<IMessagePrompterExplicitReturnBase>
Inherited from
MessagePrompterBaseStrategy.collectReactions
Defined in
createReactionPromptFilter
▸ createReactionPromptFilter(reactions, authorOrFilter): CollectorOptions<[MessageReaction, User]>
Creates a filter for the collector to filter on
Parameters
| Name | Type |
|---|---|
reactions | string[] | EmojiIdentifierResolvable[] |
authorOrFilter | User | CollectorFilter<[MessageReaction, User]> |
Returns
CollectorOptions<[MessageReaction, User]>
The filter for awaitReactions function
Inherited from
MessagePrompterBaseStrategy.createReactionPromptFilter
Defined in
run
▸ run(channel, authorOrFilter): Promise<number | IMessagePrompterExplicitNumberReturn>
This executes the MessagePrompter and sends the message if IMessagePrompterOptions.type equals number. The handler will wait for one (1) reaction.
Parameters
| Name | Type | Description |
|---|---|---|
channel | MessagePrompterChannelTypes | The channel to use. |
authorOrFilter | User | CollectorFilter<[MessageReaction, User]> | An author object to validate or a CollectorFilter predicate callback. |
Returns
Promise<number | IMessagePrompterExplicitNumberReturn>
A promise that resolves to the selected number within the range.
Overrides
MessagePrompterBaseStrategy.run