Class: MessagePrompterBaseStrategy

@sapphire/discord.js-utilities.MessagePrompterBaseStrategy

Hierarchy

• MessagePrompterBaseStrategy

  ↳ MessagePrompterConfirmStrategy

  ↳ MessagePrompterMessageStrategy

  ↳ MessagePrompterNumberStrategy

  ↳ MessagePrompterReactionStrategy

Constructors

constructor

• new MessagePrompterBaseStrategy(type, message, options?): MessagePrompterBaseStrategy

Constructor for the MessagePrompterBaseStrategy class

Parameters

Name	Type	Description
type	string	-
message	string | MessagePayload | MessageCreateOptions	-
options?	IMessagePrompterStrategyOptions	Overrideable options if needed.

Returns

MessagePrompterBaseStrategy

Defined in

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

Properties

appliedMessage

• appliedMessage: null | Message<boolean> = null

The message that has been sent in MessagePrompter.run

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

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

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

Defined in

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

---

timeout

• timeout: number

The timeout that was used in the collector

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

Defined in

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

---

defaultStrategyOptions

▪ Static defaultStrategyOptions: IMessagePrompterStrategyOptions

The default strategy options

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>

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

Defined in

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

---

run

▸ run(channel, authorOrFilter): unknown

Parameters

Name	Type
channel	MessagePrompterChannelTypes
authorOrFilter	User | CollectorFilter<unknown[]>

Returns

unknown

Defined in

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