2022-03-19 10:37:45 +00:00
|
|
|
'use strict';
|
|
|
|
|
|
|
|
const Interaction = require('./Interaction');
|
|
|
|
const InteractionWebhook = require('./InteractionWebhook');
|
|
|
|
const InteractionResponses = require('./interfaces/InteractionResponses');
|
2022-03-24 10:55:32 +00:00
|
|
|
const { MessageComponentTypes } = require('../util/Constants');
|
2022-03-19 10:37:45 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Represents a message component interaction.
|
|
|
|
* @extends {Interaction}
|
|
|
|
* @implements {InteractionResponses}
|
|
|
|
*/
|
|
|
|
class MessageComponentInteraction extends Interaction {
|
|
|
|
constructor(client, data) {
|
|
|
|
super(client, data);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The id of the channel this interaction was sent in
|
|
|
|
* @type {Snowflake}
|
|
|
|
* @name MessageComponentInteraction#channelId
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The message to which the component was attached
|
|
|
|
* @type {Message|APIMessage}
|
|
|
|
*/
|
|
|
|
this.message = this.channel?.messages._add(data.message) ?? data.message;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The custom id of the component which was interacted with
|
|
|
|
* @type {string}
|
|
|
|
*/
|
|
|
|
this.customId = data.data.custom_id;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The type of component which was interacted with
|
2022-03-24 10:55:32 +00:00
|
|
|
* @type {string}
|
2022-03-19 10:37:45 +00:00
|
|
|
*/
|
2022-03-24 10:55:32 +00:00
|
|
|
this.componentType = MessageComponentInteraction.resolveType(data.data.component_type);
|
2022-03-19 10:37:45 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether the reply to this interaction has been deferred
|
|
|
|
* @type {boolean}
|
|
|
|
*/
|
|
|
|
this.deferred = false;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether the reply to this interaction is ephemeral
|
|
|
|
* @type {?boolean}
|
|
|
|
*/
|
|
|
|
this.ephemeral = null;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether this interaction has already been replied to
|
|
|
|
* @type {boolean}
|
|
|
|
*/
|
|
|
|
this.replied = false;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* An associated interaction webhook, can be used to further interact with this interaction
|
|
|
|
* @type {InteractionWebhook}
|
|
|
|
*/
|
|
|
|
this.webhook = new InteractionWebhook(this.client, this.applicationId, this.token);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Raw message components from the API
|
|
|
|
* * APIMessageButton
|
|
|
|
* * APIMessageSelectMenu
|
|
|
|
* @typedef {APIMessageButton|APIMessageSelectMenu} APIMessageActionRowComponent
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The component which was interacted with
|
|
|
|
* @type {MessageActionRowComponent|APIMessageActionRowComponent}
|
|
|
|
* @readonly
|
|
|
|
*/
|
|
|
|
get component() {
|
|
|
|
return this.message.components
|
|
|
|
.flatMap(row => row.components)
|
|
|
|
.find(component => (component.customId ?? component.custom_id) === this.customId);
|
|
|
|
}
|
|
|
|
|
2022-03-24 10:55:32 +00:00
|
|
|
/**
|
|
|
|
* Resolves the type of a MessageComponent
|
|
|
|
* @param {MessageComponentTypeResolvable} type The type to resolve
|
|
|
|
* @returns {MessageComponentType}
|
|
|
|
* @private
|
|
|
|
*/
|
|
|
|
static resolveType(type) {
|
|
|
|
return typeof type === 'string' ? type : MessageComponentTypes[type];
|
|
|
|
}
|
|
|
|
|
2022-03-19 10:37:45 +00:00
|
|
|
// These are here only for documentation purposes - they are implemented by InteractionResponses
|
|
|
|
/* eslint-disable no-empty-function */
|
|
|
|
deferReply() {}
|
|
|
|
reply() {}
|
|
|
|
fetchReply() {}
|
|
|
|
editReply() {}
|
|
|
|
deleteReply() {}
|
|
|
|
followUp() {}
|
|
|
|
deferUpdate() {}
|
|
|
|
update() {}
|
2022-05-14 08:06:15 +00:00
|
|
|
showModal() {}
|
|
|
|
awaitModalSubmit() {}
|
2022-03-19 10:37:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
InteractionResponses.applyToClass(MessageComponentInteraction);
|
|
|
|
|
|
|
|
module.exports = MessageComponentInteraction;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @external APIMessageSelectMenu
|
|
|
|
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menu-object}
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @external APIMessageButton
|
|
|
|
* @see {@link https://discord.com/developers/docs/interactions/message-components#button-object}
|
|
|
|
*/
|