Class: MessagePrompterReactionStrategy

@sapphire/discord.js-utilities.MessagePrompterReactionStrategy

Hierarchy

• MessagePrompterBaseStrategy

  ↳ MessagePrompterReactionStrategy

Implements

• MessagePrompterReactionStrategy

Implemented by

• MessagePrompterReactionStrategy

Constructors

constructor

• new MessagePrompterReactionStrategy(message, options): MessagePrompterReactionStrategy

Constructor for the MessagePrompterReactionStrategy class

Parameters

Name	Type	Description
message	string | MessagePayload | MessageCreateOptions	-
options	IMessagePrompterReactionStrategyOptions	Overrideable options if needed.

Returns

MessagePrompterReactionStrategy

Overrides

MessagePrompterBaseStrategy.constructor

Defined in

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

Defined in

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

Defined in

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

Defined in

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

Defined in

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

---

reactions

• reactions: EmojiIdentifierResolvable[]

The emojis used

Implementation of

MessagePrompterReactionStrategy.reactions

Defined in

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

Defined in

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

Defined in

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

Defined in

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

Methods

collectReactions

▸ collectReactions(channel, authorOrFilter, reactions): Promise<IMessagePrompterExplicitReturnBase>

Parameters

Name	Type
channel	MessagePrompterChannelTypes
authorOrFilter	User | CollectorFilter<[MessageReaction, User]>
reactions	string[] | EmojiIdentifierResolvable[]

Returns

Promise<IMessagePrompterExplicitReturnBase>

Implementation of

MessagePrompterReactionStrategy.collectReactions

Inherited from

MessagePrompterBaseStrategy.collectReactions

Defined in

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

---

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

Implementation of

MessagePrompterReactionStrategy.createReactionPromptFilter

Inherited from

MessagePrompterBaseStrategy.createReactionPromptFilter

Defined in

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

---

run

▸ run(channel, authorOrFilter): Promise<EmojiResolvable | IMessagePrompterExplicitReturnBase>

This executes the MessagePrompterReactionStrategy and sends the message. 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<EmojiResolvable | IMessagePrompterExplicitReturnBase>

A promise that resolves to the reaction object.

Implementation of

MessagePrompterReactionStrategy.run

Overrides

MessagePrompterBaseStrategy.run

Defined in

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