ButtonInteraction

Extends

• ComponentInteraction

Constructors

new ButtonInteraction(client, interaction, __reply)

new ButtonInteraction(
   client: UsingClient,
   interaction: APIMessageComponentInteraction,
   __reply?: __InternalReplyFunction): ButtonInteraction

Parameters

Parameter	Type
client	UsingClient
interaction	APIMessageComponentInteraction
__reply?	__InternalReplyFunction

Returns

ButtonInteraction

Inherited from

ComponentInteraction.constructor

Source

seyfert/src/structures/Interaction.ts:92

Properties

Property	Modifier	Type	Overrides	Inherited from
appPermissions?	public	PermissionsBitField	ComponentInteraction.appPermissions	ComponentInteraction.appPermissions
applicationId	public	string	ComponentInteraction.applicationId	ComponentInteraction.applicationId
channel	public	AllChannels	ComponentInteraction.channel	ComponentInteraction.channel
channelId	public	string	ComponentInteraction.channelId	ComponentInteraction.channelId
client	readonly	UsingClient	ComponentInteraction.client	ComponentInteraction.client
data	public	Object	ComponentInteraction.data	ComponentInteraction.data
data.componentType	public	Button	-	-
data.customId	public	string	-	-
entitlements	public	Object[]	ComponentInteraction.entitlements	ComponentInteraction.entitlements
guildId	public	undefined | string	ComponentInteraction.guildId	ComponentInteraction.guildId
guildLocale	public	| undefined | "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi"	ComponentInteraction.guildLocale	ComponentInteraction.guildLocale
id	public	string	ComponentInteraction.id	ComponentInteraction.id
locale	public	| "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi"	ComponentInteraction.locale	ComponentInteraction.locale
member	public	undefined | InteractionGuildMember	ComponentInteraction.member	ComponentInteraction.member
message	public	Message	ComponentInteraction.message	ComponentInteraction.message
replied?	public	boolean | Promise<boolean>	ComponentInteraction.replied	ComponentInteraction.replied
token	public	string	ComponentInteraction.token	ComponentInteraction.token
type	public	MessageComponent	ComponentInteraction.type	ComponentInteraction.type
user	public	User	ComponentInteraction.user	ComponentInteraction.user
version	public	1	ComponentInteraction.version	ComponentInteraction.version

Accessors

componentType

get componentType():
  | Button
  | StringSelect
  | UserSelect
  | RoleSelect
  | MentionableSelect
  | ChannelSelect

Returns

| Button | StringSelect | UserSelect | RoleSelect | MentionableSelect | ChannelSelect

Source

seyfert/src/structures/Interaction.ts:443

---

createdAt

get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

---

createdTimestamp

get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

---

customId

get customId(): string

Returns

string

Source

seyfert/src/structures/Interaction.ts:439

Methods

deferReply()

deferReply(flags?: MessageFlags): Promise<void>

Parameters

Parameter	Type
flags?	MessageFlags

Returns

Promise<void>

Inherited from

ComponentInteraction.deferReply

Source

seyfert/src/structures/Interaction.ts:207

---

deferUpdate()

deferUpdate(): Promise<void>

Returns

Promise<void>

Inherited from

ComponentInteraction.deferUpdate

Source

seyfert/src/structures/Interaction.ts:433

---

deleteMessage()

deleteMessage(messageId: string): Promise<undefined | void>

Parameters

Parameter	Type
messageId	string

Returns

Promise<undefined | void>

Inherited from

ComponentInteraction.deleteMessage

Source

seyfert/src/structures/Interaction.ts:383

---

deleteResponse()

deleteResponse(): Promise<undefined | void>

Returns

Promise<undefined | void>

Inherited from

ComponentInteraction.deleteResponse

Source

seyfert/src/structures/Interaction.ts:379

---

editMessage()

editMessage(messageId: string, body: Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps): Promise<WebhookMessage>

Parameters

Parameter	Type
messageId	string
body	Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps

Returns

Promise<WebhookMessage>

Inherited from

ComponentInteraction.editMessage

Source

seyfert/src/structures/Interaction.ts:371

---

editOrReply()

editOrReply<FR>(body: Omit<APIInteractionResponseCallbackData, "components" | "embeds" | "poll"> & SendResolverProps, fetchReply?: FR): Promise<When<FR, WebhookMessage, void>>

Type parameters

Type parameter	Value
FR extends boolean	false

Parameters

Parameter	Type
body	Omit<APIInteractionResponseCallbackData, "components" | "embeds" | "poll"> & SendResolverProps
fetchReply?	FR

Returns

Promise<When<FR, WebhookMessage, void>>

Inherited from

ComponentInteraction.editOrReply

Source

seyfert/src/structures/Interaction.ts:359

---

editResponse()

editResponse(body: Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps): Promise<WebhookMessage>

Parameters

Parameter	Type
body	Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps

Returns

Promise<WebhookMessage>

Inherited from

ComponentInteraction.editResponse

Source

seyfert/src/structures/Interaction.ts:375

---

fetchGuild()

fetchGuild(force: boolean): undefined | Promise<Guild<"cached"> | Guild<"api">>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

undefined | Promise<Guild<"cached"> | Guild<"api">>

Inherited from

ComponentInteraction.fetchGuild

Source

seyfert/src/structures/Interaction.ts:269

---

fetchMessage()

fetchMessage(messageId: string): Promise<undefined | WebhookMessage>

Parameters

Parameter	Type
messageId	string

Returns

Promise<undefined | WebhookMessage>

Inherited from

ComponentInteraction.fetchMessage

Source

seyfert/src/structures/Interaction.ts:332

---

fetchResponse()

fetchResponse(): Promise<undefined | WebhookMessage>

Returns

Promise<undefined | WebhookMessage>

Inherited from

ComponentInteraction.fetchResponse

Source

seyfert/src/structures/Interaction.ts:336

---

followup()

followup(body: Omit<RESTPostAPIWebhookWithTokenJSONBody, "components" | "embeds" | "poll"> & SendResolverProps): Promise<WebhookMessage>

Parameters

Parameter	Type
body	Omit<RESTPostAPIWebhookWithTokenJSONBody, "components" | "embeds" | "poll"> & SendResolverProps

Returns

Promise<WebhookMessage>

Inherited from

ComponentInteraction.followup

Source

seyfert/src/structures/Interaction.ts:387

---

isButton()

isButton(): this is ButtonInteraction

Returns

this is ButtonInteraction

Inherited from

ComponentInteraction.isButton

Source

seyfert/src/structures/Interaction.ts:447

---

isChannelSelectMenu()

isChannelSelectMenu(): this is ChannelSelectMenuInteraction

Returns

this is ChannelSelectMenuInteraction

Inherited from

ComponentInteraction.isChannelSelectMenu

Source

seyfert/src/structures/Interaction.ts:451

---

isMentionableSelectMenu()

isMentionableSelectMenu(): this is MentionableSelectMenuInteraction

Returns

this is MentionableSelectMenuInteraction

Inherited from

ComponentInteraction.isMentionableSelectMenu

Source

seyfert/src/structures/Interaction.ts:459

---

isRoleSelectMenu()

isRoleSelectMenu(): this is RoleSelectMenuInteraction

Returns

this is RoleSelectMenuInteraction

Inherited from

ComponentInteraction.isRoleSelectMenu

Source

seyfert/src/structures/Interaction.ts:455

---

isStringSelectMenu()

isStringSelectMenu(): this is StringSelectMenuInteraction<string[]>

Returns

this is StringSelectMenuInteraction<string[]>

Inherited from

ComponentInteraction.isStringSelectMenu

Source

seyfert/src/structures/Interaction.ts:467

---

isUserSelectMenu()

isUserSelectMenu(): this is UserSelectMenuInteraction

Returns

this is UserSelectMenuInteraction

Inherited from

ComponentInteraction.isUserSelectMenu

Source

seyfert/src/structures/Interaction.ts:463

---

modal()

modal(body: ModalCreateBodyRequest): Promise<void>

Parameters

Parameter	Type
body	ModalCreateBodyRequest

Returns

Promise<void>

Inherited from

ComponentInteraction.modal

Source

seyfert/src/structures/Interaction.ts:352

---

reply()

reply(body: ReplyInteractionBody): Promise<void>

Parameters

Parameter	Type
body	ReplyInteractionBody

Returns

Promise<void>

Inherited from

ComponentInteraction.reply

Source

seyfert/src/structures/Interaction.ts:196

---

update()

update(data: Omit<APIInteractionResponseCallbackData, "components" | "embeds"> & ResolverProps): Promise<void>

Parameters

Parameter	Type
data	Omit<APIInteractionResponseCallbackData, "components" | "embeds"> & ResolverProps

Returns

Promise<void>

Inherited from

ComponentInteraction.update

Source

seyfert/src/structures/Interaction.ts:426

---

write()

write<FR>(body: Omit<APIInteractionResponseCallbackData, "components" | "embeds" | "poll"> & SendResolverProps, fetchReply?: FR): Promise<When<FR, WebhookMessage, void>>

Type parameters

Type parameter	Value
FR extends boolean	false

Parameters

Parameter	Type
body	Omit<APIInteractionResponseCallbackData, "components" | "embeds" | "poll"> & SendResolverProps
fetchReply?	FR

Returns

Promise<When<FR, WebhookMessage, void>>

Inherited from

ComponentInteraction.write

Source

seyfert/src/structures/Interaction.ts:340

---

from()

static from(
   client: UsingClient,
   gateway: APIInteraction,
   __reply?: __InternalReplyFunction):
  | RoleSelectMenuInteraction
  | UserSelectMenuInteraction
  | MentionableSelectMenuInteraction
  | ChannelSelectMenuInteraction
  | StringSelectMenuInteraction<string[]>
  | AutocompleteInteraction<boolean>
  | ChatInputCommandInteraction<boolean>
  | UserCommandInteraction<boolean>
  | MessageCommandInteraction<boolean>
  | ButtonInteraction
  | ModalSubmitInteraction<boolean>
| BaseInteraction<boolean, APIPingInteraction>

Parameters

Parameter	Type
client	UsingClient
gateway	APIInteraction
__reply?	__InternalReplyFunction

Returns

| RoleSelectMenuInteraction | UserSelectMenuInteraction | MentionableSelectMenuInteraction | ChannelSelectMenuInteraction | StringSelectMenuInteraction<string[]> | AutocompleteInteraction<boolean> | ChatInputCommandInteraction<boolean> | UserCommandInteraction<boolean> | MessageCommandInteraction<boolean> | ButtonInteraction | ModalSubmitInteraction<boolean> | BaseInteraction<boolean, APIPingInteraction>

Inherited from

ComponentInteraction.from

Source

seyfert/src/structures/Interaction.ts:216

---

transformBody()

static transformBody<T>(body: Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps | Omit<RESTPatchAPIChannelMessageJSONBody, "components" | "embeds"> & ResolverProps | Omit<RESTPostAPIWebhookWithTokenJSONBody, "components" | "embeds" | "poll"> & SendResolverProps | Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps, self: UsingClient): T

Type parameters

Type parameter
T

Parameters

Parameter	Type
body	Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps | Omit<RESTPatchAPIChannelMessageJSONBody, "components" | "embeds"> & ResolverProps | Omit<RESTPostAPIWebhookWithTokenJSONBody, "components" | "embeds" | "poll"> & SendResolverProps | Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps
self	UsingClient

Returns

T

Inherited from

ComponentInteraction.transformBody

Source

seyfert/src/structures/Interaction.ts:164

---

transformBodyRequest()

static transformBodyRequest(body: ReplyInteractionBody, self: BaseClient): APIInteractionResponse

Parameters

Parameter	Type
body	ReplyInteractionBody
self	BaseClient

Returns

APIInteractionResponse

Inherited from

ComponentInteraction.transformBodyRequest

Source

seyfert/src/structures/Interaction.ts:118