mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 16:43:31 +01:00
75 lines
2.0 KiB
JavaScript
75 lines
2.0 KiB
JavaScript
const Channel = require('./Channel');
|
|
const TextBasedChannel = require('./interfaces/TextBasedChannel');
|
|
const MessageStore = require('../stores/MessageStore');
|
|
|
|
/**
|
|
* Represents a direct message channel between two users.
|
|
* @extends {Channel}
|
|
* @implements {TextBasedChannel}
|
|
*/
|
|
class DMChannel extends Channel {
|
|
constructor(client, data) {
|
|
super(client, 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 recipient on the other end of the DM
|
|
* @type {User}
|
|
*/
|
|
this.recipient = this.client.users.add(data.recipients[0]);
|
|
|
|
/**
|
|
* The ID of the last message in the channel, if one was sent
|
|
* @type {?Snowflake}
|
|
*/
|
|
this.lastMessageID = data.last_message_id;
|
|
|
|
/**
|
|
* The timestamp when the last pinned message was pinned, if there was one
|
|
* @type {?number}
|
|
*/
|
|
this.lastPinTimestamp = data.last_pin_timestamp ? new Date(data.last_pin_timestamp).getTime() : null;
|
|
}
|
|
|
|
/**
|
|
* When concatenated with a string, this automatically returns the recipient's mention instead of the
|
|
* DMChannel object.
|
|
* @returns {string}
|
|
* @example
|
|
* // Logs: Hello from <@123456789012345678>!
|
|
* console.log(`Hello from ${channel}!`);
|
|
*/
|
|
toString() {
|
|
return this.recipient.toString();
|
|
}
|
|
|
|
// These are here only for documentation purposes - they are implemented by TextBasedChannel
|
|
/* eslint-disable no-empty-function */
|
|
get lastMessage() {}
|
|
get lastPinAt() {}
|
|
send() {}
|
|
search() {}
|
|
startTyping() {}
|
|
stopTyping() {}
|
|
get typing() {}
|
|
get typingCount() {}
|
|
createMessageCollector() {}
|
|
awaitMessages() {}
|
|
// Doesn't work on DM channels; bulkDelete() {}
|
|
acknowledge() {}
|
|
_cacheMessage() {}
|
|
}
|
|
|
|
TextBasedChannel.applyToClass(DMChannel, true, ['bulkDelete']);
|
|
|
|
module.exports = DMChannel;
|