mirror of
https://github.com/danbulant/discord.js
synced 2026-05-29 20:30:38 +00:00
1a8e8c7a67
* docs: Add/normalize .toString() examples on all classes * docs: Remove exclamation point on ClientApplication#toString example * docs: Normalize .toString() descriptions on all classes * Use "returns" instead of "concatenates"
58 lines
1.5 KiB
JavaScript
58 lines
1.5 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);
|
|
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.create(data.recipients[0]);
|
|
|
|
this.lastMessageID = data.last_message_id;
|
|
}
|
|
|
|
/**
|
|
* 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 */
|
|
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;
|