Skip to main content

Interface: PaginatedMessageActionButton

discord.js-utilities/src.PaginatedMessageActionButton

To utilize buttons you can pass an object with the structure of PaginatedMessageActionButton to PaginatedMessage actions.

example

const StopAction: PaginatedMessageActionButton {
customId: 'CustomStopAction',
emoji: '⏹️',
run: ({ collector }) => {
collector.stop();
}
}

Hierarchy

  • Omit<InteractionButtonOptions, "customId" | "style">

    PaginatedMessageActionButton

Properties

customId

customId: string

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:49


disabled

Optional disabled: boolean

Inherited from

Omit.disabled

Defined in

node_modules/discord.js/typings/index.d.ts:5242


emoji

Optional emoji: EmojiIdentifierResolvable

Inherited from

Omit.emoji

Defined in

node_modules/discord.js/typings/index.d.ts:5243


label

Optional label: string

Inherited from

Omit.label

Defined in

node_modules/discord.js/typings/index.d.ts:5244


style

style: ExcludeEnum<typeof MessageButtonStyles, "LINK">

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:51


type

type: ExcludeEnum<typeof MessageComponentTypes, "SELECT_MENU" | "ACTION_ROW">

Overrides

Omit.type

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:50

Methods

run

run(context): unknown

Parameters

NameType
contextPaginatedMessageActionContext

Returns

unknown

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:52