Skip to main content

Class: MessagePrompterReactionStrategy

Extends

Implements

Constructors

new MessagePrompterReactionStrategy()

new MessagePrompterReactionStrategy(message: string | MessagePayload | MessageCreateOptions, options: IMessagePrompterReactionStrategyOptions): MessagePrompterReactionStrategy

Constructor for the MessagePrompterReactionStrategy class

Parameters

ParameterTypeDescription
messagestring | MessagePayload | MessageCreateOptionsThe message instance for this MessagePrompter
optionsIMessagePrompterReactionStrategyOptionsOverrideable options if needed.

Returns

MessagePrompterReactionStrategy

Overrides

MessagePrompterBaseStrategy.constructor

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterReactionStrategy.ts:18

Properties

appliedMessage

appliedMessage: null | Message<boolean> = null

The message that has been sent in MessagePrompter.run

Implementation of

MessagePrompterReactionStrategy.appliedMessage

Inherited from

MessagePrompterBaseStrategy.appliedMessage

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:27


editMessage

editMessage: undefined | Message<boolean>

The message the bot will edit to send its prompt in MessagePrompter.run

Implementation of

MessagePrompterReactionStrategy.editMessage

Inherited from

MessagePrompterBaseStrategy.editMessage

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:37


explicitReturn

explicitReturn: boolean

Whether to return an explicit object with data, or the strategies' default

Implementation of

MessagePrompterReactionStrategy.explicitReturn

Inherited from

MessagePrompterBaseStrategy.explicitReturn

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:22


message

message: string | MessagePayload | MessageCreateOptions

The message that will be sent in MessagePrompter.run

Implementation of

MessagePrompterReactionStrategy.message

Inherited from

MessagePrompterBaseStrategy.message

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:32


reactions

reactions: EmojiIdentifierResolvable[]

The emojis used

Implementation of

MessagePrompterReactionStrategy.reactions

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterReactionStrategy.ts:11


timeout

timeout: number

The timeout that was used in the collector

Implementation of

MessagePrompterReactionStrategy.timeout

Inherited from

MessagePrompterBaseStrategy.timeout

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:17


type

type: string

The type of strategy that was used

Implementation of

MessagePrompterReactionStrategy.type

Inherited from

MessagePrompterBaseStrategy.type

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:12


defaultStrategyOptions

static defaultStrategyOptions: IMessagePrompterStrategyOptions

The default strategy options

Inherited from

MessagePrompterBaseStrategy.defaultStrategyOptions

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:129

Methods

collectReactions()

protected collectReactions(channel: MessagePrompterChannelTypes, authorOrFilter: User | CollectorFilter <[MessageReaction, User]>, reactions: string[] | EmojiIdentifierResolvable[]): Promise <IMessagePrompterExplicitReturnBase>

Parameters

ParameterType
channelMessagePrompterChannelTypes
authorOrFilterUser | CollectorFilter <[MessageReaction, User]>
reactionsstring[] | EmojiIdentifierResolvable[]

Returns

Promise <IMessagePrompterExplicitReturnBase>

Implementation of

MessagePrompterReactionStrategy.collectReactions

Inherited from

MessagePrompterBaseStrategy.collectReactions

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:55


createReactionPromptFilter()

protected createReactionPromptFilter(reactions: string[] | EmojiIdentifierResolvable[], authorOrFilter: User | CollectorFilter <[MessageReaction, User]>): CollectorOptions <[MessageReaction, User]>

Creates a filter for the collector to filter on

Parameters

ParameterType
reactionsstring[] | EmojiIdentifierResolvable[]
authorOrFilterUser | CollectorFilter <[MessageReaction, User]>

Returns

CollectorOptions <[MessageReaction, User]>

The filter for awaitReactions function

Implementation of

MessagePrompterReactionStrategy.createReactionPromptFilter

Inherited from

MessagePrompterBaseStrategy.createReactionPromptFilter

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts:114


run()

run(channel: MessagePrompterChannelTypes, authorOrFilter: User | CollectorFilter <[MessageReaction, User]>): Promise <EmojiResolvable | IMessagePrompterExplicitReturnBase>

This executes the MessagePrompterReactionStrategy and sends the message. The handler will wait for one (1) reaction.

Parameters

ParameterTypeDescription
channelMessagePrompterChannelTypesThe channel to use.
authorOrFilterUser | CollectorFilter <[MessageReaction, User]>An author object to validate or a CollectorFilter predicate callback.

Returns

Promise <EmojiResolvable | IMessagePrompterExplicitReturnBase>

A promise that resolves to the reaction object.

Implementation of

MessagePrompterReactionStrategy.run

Overrides

MessagePrompterBaseStrategy.run

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterReactionStrategy.ts:31