Class: ButtonInteraction
Hierarchy
↳
ButtonInteraction
Constructors
constructor
• new ButtonInteraction(app, raw, params?)
Parameters
| Name | Type |
|---|---|
app | App |
raw | APIMessageComponentButtonInteraction |
params? | RouteParams |
Overrides
MessageComponentInteraction.constructor
Defined in
packages/disploy/src/structs/ButtonInteraction.ts:7
Properties
app
• app: App
Inherited from
MessageComponentInteraction.app
Defined in
packages/disploy/src/structs/Base.ts:4
createdTimestamp
• createdTimestamp: number
Timestamp of when the interaction was created.
Inherited from
MessageComponentInteraction.createdTimestamp
Defined in
packages/disploy/src/structs/BaseInteraction.ts:33
customId
• customId: string
The custom ID of the component.
Inherited from
MessageComponentInteraction.customId
Defined in
packages/disploy/src/structs/MessageComponentInteraction.ts:10
guild
• guild: null | ToBeFetched<Guild>
The guild of the interaction.
Inherited from
MessageComponentInteraction.guild
Defined in
packages/disploy/src/structs/BaseInteraction.ts:53
id
• id: string
The ID of the interaction.
Inherited from
MessageComponentInteraction.id
Defined in
packages/disploy/src/structs/BaseInteraction.ts:28
member
• member: null | GuildMember
The GuildMember who invoked the interaction.
Inherited from
MessageComponentInteraction.member
Defined in
packages/disploy/src/structs/BaseInteraction.ts:48
params
• params: RouteParams
The parsed parameters of the interaction from the custom ID.
Inherited from
MessageComponentInteraction.params
Defined in
packages/disploy/src/structs/MessageComponentInteraction.ts:15
token
• token: string
The token of the interaction.
Inherited from
MessageComponentInteraction.token
Defined in
packages/disploy/src/structs/BaseInteraction.ts:38
user
• user: User
The User that invoked the interaction.
Inherited from
MessageComponentInteraction.user
Defined in
packages/disploy/src/structs/BaseInteraction.ts:43
Methods
deferReply
▸ deferReply(options?): Promise<Message>
Defers the reply to the interaction.
Parameters
| Name | Type | Description |
|---|---|---|
options? | Object | The options to defer the reply with. |
options.ephemeral? | boolean | - |
options.fetchReply? | true | - |
Returns
Promise<Message>
Inherited from
MessageComponentInteraction.deferReply
Defined in
packages/disploy/src/structs/BaseInteraction.ts:71
editReply
▸ editReply(payload): Promise<Message>
Edit the original reply that has been sent by the interaction.
Parameters
| Name | Type | Description |
|---|---|---|
payload | AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Nullable<Pick<AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ allowed_mentions?: APIAllowedMentions ; attachments?: Pick<APIAttachment, "id" | "description"> & Partial<Pick<APIAttachment, "filename">>[] ; avatar_url?: string ; components?: APIActionRowComponent<APIMessageActionRowComponent>[] ; content?: string ; embeds?: APIEmbed[] ; flags?: MessageFlags ; thread_name?: string ; tts?: boolean ; username?: string }>, "content" | "embeds" | "allowed_mentions" | "components">> & { attachments?: Pick<APIAttachment, "id"> & Partial<Pick<APIAttachment, "description" | "filename">>[] }> | The payload to edit the reply with. |
Returns
Promise<Message>
The edited message.
Inherited from
MessageComponentInteraction.editReply
Defined in
packages/disploy/src/structs/BaseInteraction.ts:125
fetchReply
▸ fetchReply(id?): Promise<Message>
Fetch the message reply that has been sent by the interaction.
Parameters
| Name | Type |
|---|---|
id? | string |
Returns
Promise<Message>
The message that was sent by the interaction.
Inherited from
MessageComponentInteraction.fetchReply
Defined in
packages/disploy/src/structs/BaseInteraction.ts:139
followUp
▸ followUp(payload): Promise<Message>
Send a followup message to the interaction.
Parameters
| Name | Type | Description |
|---|---|---|
payload | APIInteractionResponseCallbackData | The payload to send the followup message with. |
Returns
Promise<Message>
The sent message.
Inherited from
MessageComponentInteraction.followUp
Defined in
packages/disploy/src/structs/BaseInteraction.ts:111
reply
▸ reply(payload, fetchReply?): Promise<Message>
Send a reply to the interaction.
Parameters
| Name | Type | Description |
|---|---|---|
payload | APIInteractionResponseCallbackData | The payload to send the reply with. |
fetchReply? | true | Whether to fetch the reply that was sent. |
Returns
Promise<Message>
Inherited from
MessageComponentInteraction.reply
Defined in
packages/disploy/src/structs/BaseInteraction.ts:92