mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 08:33:30 +01:00
e7eab427e5
* Adds JSDocs for TextChannel.lastMessageID * oops * docs: document lastMessageID in (Group)DMChannel as well
120 lines
3.5 KiB
JavaScript
120 lines
3.5 KiB
JavaScript
const GuildChannel = require('./GuildChannel');
|
|
const Webhook = require('./Webhook');
|
|
const TextBasedChannel = require('./interfaces/TextBasedChannel');
|
|
const Collection = require('../util/Collection');
|
|
const DataResolver = require('../util/DataResolver');
|
|
const MessageStore = require('../stores/MessageStore');
|
|
|
|
/**
|
|
* Represents a guild text channel on Discord.
|
|
* @extends {GuildChannel}
|
|
* @implements {TextBasedChannel}
|
|
*/
|
|
class TextChannel extends GuildChannel {
|
|
constructor(guild, data) {
|
|
super(guild, data);
|
|
/**
|
|
* A collection containing the messages sent to this channel
|
|
* @type {MessageStore<Snowflake, Message>}
|
|
*/
|
|
this.messages = new MessageStore(this);
|
|
this._typing = new Map();
|
|
}
|
|
|
|
_patch(data) {
|
|
super._patch(data);
|
|
|
|
/**
|
|
* The topic of the text channel
|
|
* @type {?string}
|
|
*/
|
|
this.topic = data.topic;
|
|
|
|
/**
|
|
* If the guild considers this channel NSFW
|
|
* @type {boolean}
|
|
* @readonly
|
|
*/
|
|
this.nsfw = data.nsfw || /^nsfw(-|$)/.test(this.name);
|
|
|
|
/**
|
|
* The ID of the last message sent in this channel, if one was sent
|
|
* @type {?Snowflake}
|
|
*/
|
|
this.lastMessageID = data.last_message_id;
|
|
|
|
if (data.messages) for (const message of data.messages) this.messages.add(message);
|
|
}
|
|
|
|
/**
|
|
* Sets whether this channel is flagged as NSFW.
|
|
* @param {boolean} nsfw Whether the channel should be considered NSFW
|
|
* @param {string} [reason] Reason for changing the channel's NSFW flag
|
|
* @returns {Promise<TextChannel>}
|
|
*/
|
|
setNSFW(nsfw, reason) {
|
|
return this.edit({ nsfw }, reason);
|
|
}
|
|
|
|
/**
|
|
* Fetches all webhooks for the channel.
|
|
* @returns {Promise<Collection<Snowflake, Webhook>>}
|
|
* @example
|
|
* // Fetch webhooks
|
|
* channel.fetchWebhooks()
|
|
* .then(hooks => console.log(`This channel has ${hooks.size} hooks`))
|
|
* .catch(console.error);
|
|
*/
|
|
fetchWebhooks() {
|
|
return this.client.api.channels[this.id].webhooks.get().then(data => {
|
|
const hooks = new Collection();
|
|
for (const hook of data) hooks.set(hook.id, new Webhook(this.client, hook));
|
|
return hooks;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Creates a webhook for the channel.
|
|
* @param {string} name The name of the webhook
|
|
* @param {Object} [options] Options for creating the webhook
|
|
* @param {BufferResolvable|Base64Resolvable} [options.avatar] Avatar for the webhook
|
|
* @param {string} [options.reason] Reason for creating the webhook
|
|
* @returns {Promise<Webhook>} webhook The created webhook
|
|
* @example
|
|
* // Create a webhook for the current channel
|
|
* channel.createWebhook('Snek', {
|
|
* avatar: 'https://i.imgur.com/mI8XcpG.jpg',
|
|
* reason: 'Needed a cool new Webhook'
|
|
* })
|
|
* .then(console.log)
|
|
* .catch(console.error)
|
|
*/
|
|
async createWebhook(name, { avatar, reason } = {}) {
|
|
if (typeof avatar === 'string' && !avatar.startsWith('data:')) {
|
|
avatar = await DataResolver.resolveImage(avatar);
|
|
}
|
|
return this.client.api.channels[this.id].webhooks.post({ data: {
|
|
name, avatar,
|
|
}, reason }).then(data => new Webhook(this.client, data));
|
|
}
|
|
|
|
// These are here only for documentation purposes - they are implemented by TextBasedChannel
|
|
/* eslint-disable no-empty-function */
|
|
get lastMessage() {}
|
|
send() {}
|
|
search() {}
|
|
startTyping() {}
|
|
stopTyping() {}
|
|
get typing() {}
|
|
get typingCount() {}
|
|
createMessageCollector() {}
|
|
awaitMessages() {}
|
|
bulkDelete() {}
|
|
acknowledge() {}
|
|
_cacheMessage() {}
|
|
}
|
|
|
|
TextBasedChannel.applyToClass(TextChannel, true);
|
|
|
|
module.exports = TextChannel;
|