Skip to main content

Class: MessagePrompterConfirmStrategy

discord.js-utilities/src.MessagePrompterConfirmStrategy

Hierarchy

Implements

Constructors

constructor

new MessagePrompterConfirmStrategy(message, options?)

Parameters

NameTypeDescription
messageMessagePrompterMessage
options?IMessagePrompterConfirmStrategyOptions

Overrides

MessagePrompterBaseStrategy.constructor

Defined in

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

Properties

appliedMessage

appliedMessage: null | Message<boolean> = null

Inherited from

MessagePrompterBaseStrategy.appliedMessage

Defined in

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


cancelEmoji

cancelEmoji: EmojiResolvable

Implementation of

IMessagePrompterConfirmStrategyOptions.cancelEmoji

Defined in

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


confirmEmoji

confirmEmoji: EmojiResolvable

Implementation of

IMessagePrompterConfirmStrategyOptions.confirmEmoji

Defined in

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


editMessage

editMessage: undefined | Message<boolean>

Implementation of

IMessagePrompterConfirmStrategyOptions.editMessage

Inherited from

MessagePrompterBaseStrategy.editMessage

Defined in

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


explicitReturn

explicitReturn: boolean

Implementation of

IMessagePrompterConfirmStrategyOptions.explicitReturn

Inherited from

MessagePrompterBaseStrategy.explicitReturn

Defined in

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


message

message: MessagePrompterMessage

Inherited from

MessagePrompterBaseStrategy.message

Defined in

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


timeout

timeout: number

Implementation of

IMessagePrompterConfirmStrategyOptions.timeout

Inherited from

MessagePrompterBaseStrategy.timeout

Defined in

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


type

type: string

Inherited from

MessagePrompterBaseStrategy.type

Defined in

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


cancelEmoji

Static cancelEmoji: EmojiResolvable = '🇳'

Defined in

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


confirmEmoji

Static confirmEmoji: EmojiResolvable = '🇾'

Defined in

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


defaultStrategyOptions

Static defaultStrategyOptions: IMessagePrompterStrategyOptions

Inherited from

MessagePrompterBaseStrategy.defaultStrategyOptions

Defined in

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

Methods

collectReactions

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

Parameters

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

Returns

Promise<IMessagePrompterExplicitReturnBase>

Inherited from

MessagePrompterBaseStrategy.collectReactions

Defined in

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


createReactionPromptFilter

Protected createReactionPromptFilter(reactions, authorOrFilter): CollectorOptions<[MessageReaction, User]>

Parameters

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

Returns

CollectorOptions<[MessageReaction, User]>

Inherited from

MessagePrompterBaseStrategy.createReactionPromptFilter

Defined in

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


run

run(channel, authorOrFilter): Promise<boolean | IMessagePrompterExplicitConfirmReturn>

Parameters

NameTypeDescription
channelMessagePrompterChannelTypes
authorOrFilterUser | CollectorFilter<[MessageReaction, User]>

Returns

Promise<boolean | IMessagePrompterExplicitConfirmReturn>

Overrides

MessagePrompterBaseStrategy.run

Defined in

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