Class: MessagePrompterMessageStrategy

Extends

• MessagePrompterBaseStrategy

Implements

• IMessagePrompterStrategyOptions

Constructors

new MessagePrompterMessageStrategy()

new MessagePrompterMessageStrategy(message: string | MessagePayload | MessageCreateOptions, options: IMessagePrompterStrategyOptions): MessagePrompterMessageStrategy

Constructor for the MessagePrompterBaseStrategy class

Parameters

Parameter	Type	Description
message	string | MessagePayload | MessageCreateOptions	The message instance for this MessagePrompter
options	IMessagePrompterStrategyOptions	Overrideable options if needed.

Returns

MessagePrompterMessageStrategy

Overrides

MessagePrompterBaseStrategy.constructor

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterMessageStrategy.ts:15

Properties

appliedMessage

appliedMessage: null | Message<boolean> = null

The message that has been sent in MessagePrompter.run

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

IMessagePrompterStrategyOptions.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

IMessagePrompterStrategyOptions.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

Inherited from

MessagePrompterBaseStrategy.message

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

Implementation of

IMessagePrompterStrategyOptions.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

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:129

Methods

collectReactions()

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

Parameters

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

Returns

Promise<IMessagePrompterExplicitReturnBase>

Inherited from

MessagePrompterBaseStrategy.collectReactions

Defined in

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

---

createMessagePromptFilter()

private createMessagePromptFilter(authorOrFilter: User | CollectorFilter<[Message<boolean>]>): CollectorOptions<[Message<boolean>]>

Creates a filter for the collector to filter on

Parameters

Parameter	Type
authorOrFilter	User | CollectorFilter<[Message<boolean>]>

Returns

CollectorOptions<[Message<boolean>]>

The filter for awaitMessages function

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterMessageStrategy.ts:66

---

createReactionPromptFilter()

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

Creates a filter for the collector to filter on

Parameters

Parameter	Type
reactions	string[] | EmojiIdentifierResolvable[]
authorOrFilter	User | CollectorFilter<[MessageReaction, User]>

Returns

CollectorOptions<[MessageReaction, User]>

The filter for awaitReactions function

Inherited from

MessagePrompterBaseStrategy.createReactionPromptFilter

Defined in

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

---

run()

run(channel: MessagePrompterChannelTypes, authorOrFilter: User | CollectorFilter<[Message<boolean>]>): Promise<Message<boolean> | IMessagePrompterExplicitMessageReturn>

This executes the MessagePrompter and sends the message if IMessagePrompterOptions.type equals message. The handler will wait for one (1) message.

Parameters

Parameter	Type	Description
channel	MessagePrompterChannelTypes	The channel to use.
authorOrFilter	User | CollectorFilter<[Message<boolean>]>	An author object to validate or a CollectorFilter predicate callback.

Returns

Promise<Message<boolean> | IMessagePrompterExplicitMessageReturn>

A promise that resolves to the message object received.

Overrides

MessagePrompterBaseStrategy.run

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterMessageStrategy.ts:26