Skip to main content

Class: MessagePrompterConfirmStrategy

Extends

Implements

Constructors

new MessagePrompterConfirmStrategy()

new MessagePrompterConfirmStrategy(message: string | MessagePayload | MessageCreateOptions, options?: IMessagePrompterConfirmStrategyOptions): MessagePrompterConfirmStrategy

Constructor for the MessagePrompterBaseStrategy class

Parameters

ParameterTypeDescription
messagestring | MessagePayload | MessageCreateOptionsThe message to be sent MessagePrompter
options?IMessagePrompterConfirmStrategyOptionsOverrideable options if needed.

Returns

MessagePrompterConfirmStrategy

Overrides

MessagePrompterBaseStrategy . constructor

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterConfirmStrategy.ts:23

Properties

appliedMessage

appliedMessage: null | Message<boolean> = null

The message that has been sent in MessagePrompter.run

Inherited from

MessagePrompterBaseStrategy . appliedMessage

Source

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


cancelEmoji

cancelEmoji: EmojiResolvable

The cancel emoji used

Implementation of

IMessagePrompterConfirmStrategyOptions . cancelEmoji

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterConfirmStrategy.ts:16


confirmEmoji

confirmEmoji: EmojiResolvable

The confirm emoji used

Implementation of

IMessagePrompterConfirmStrategyOptions . confirmEmoji

Source

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


editMessage

editMessage: undefined | Message<boolean>

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

Implementation of

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

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

Inherited from

MessagePrompterBaseStrategy . message

Source

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

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

Inherited from

MessagePrompterBaseStrategy . type

Source

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


cancelEmoji

static cancelEmoji: EmojiResolvable = '🇳'

The default cancel emoji used for MessagePrompterConfirmStrategy

Source

projects/utilities/packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterConfirmStrategy.ts:57


confirmEmoji

static confirmEmoji: EmojiResolvable = '🇾'

The default confirm emoji used for MessagePrompterConfirmStrategy

Source

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


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>

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

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<boolean | IMessagePrompterExplicitConfirmReturn>

This executes the MessagePrompter and sends the message if IMessagePrompterOptions.type equals confirm. 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<boolean | IMessagePrompterExplicitConfirmReturn>

A promise that resolves to a boolean denoting the value of the input (true for yes, false for no).

Overrides

MessagePrompterBaseStrategy . run

Source

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