DMChannel

classe · Source

Represents a direct message channel between two users.

Extends: ChannelImplements: TextBasedChannel

Properties

messages

messages: MessageManager

A manager of the messages belonging to this channel Source

recipient

recipient: User

The recipient on the other end of the DM Source

lastMessageId

nullable

lastMessageId: Snowflake

The channel's last message id, if one was sent Source

lastPinTimestamp

nullable

lastPinTimestamp: number

The timestamp when the last pinned message was pinned, if there was one Source

messageRequest

nullable

messageRequest: boolean

Whether the channel is a message request Source

messageRequestTimestamp

nullable

messageRequestTimestamp: number

The timestamp when the message request was created Source

partial

readonly

partial: boolean

Whether this DMChannel is a partial Source

voiceUsers

readonly

voiceUsers: Collection<Snowflake, User>

The user in this voice-based channel Source

shard

readonly

shard: WebSocketShard

Get current shard Source

voiceAdapterCreator

readonly · nullable

voiceAdapterCreator: function

The voice state adapter for this client that can be used with @discordjs/voice to play audio in DM / Group DM channels. Source

lastMessage

readonly · nullable

lastMessage: Message

The Message object of the last message in the channel, if one was sent Source

lastPinAt

readonly · nullable

lastPinAt: Date

The date when the last pinned message was pinned, if there was one Source

type

type: ChannelType

The type of the channel Source

id

id: Snowflake

The channel's id Source

flags

nullable

flags: Readonly<ChannelFlags>

The flags that are applied to the channel. Source

createdTimestamp

readonly

createdTimestamp: number

The timestamp the channel was created at Source

createdAt

readonly

createdAt: Date

The time the channel was created at Source

deleted

deprecated

deleted: boolean

Whether or not the structure has been deleted Source

client

readonly

client: Client

The client that instantiated this Source

Methods

acceptMessageRequest

async

async acceptMessageRequest(): Promise<DMChannel>

Accept this DMChannel. Returns: Promise<DMChannel>Source

cancelMessageRequest

async

async cancelMessageRequest(): Promise<DMChannel>

Cancel this DMChannel. Returns: Promise<DMChannel>Source

fetch

fetch(force?: boolean): Promise<DMChannel>

Fetch this DMChannel. Parameters

Name	Type	Description
force?	boolean	Whether to skip the cache check and request the API Default: true.

Returns: Promise<DMChannel>Source

toString

toString(): string

When concatenated with a string, this automatically returns the recipient's mention instead of the DMChannel object. Returns: string

// Logs: Hello from <@123456789012345678>!
console.log(`Hello from ${channel}!`);

Source

sync

sync(): undefined

Sync VoiceState of this DMChannel. Returns: undefinedSource

ring

ring(): Promise<void>

Ring the user's phone / PC (call) Returns: Promise<void>Source

send

async

async send(options: string | MessagePayload | MessageOptions): Promise<Message>

Sends a message to this channel. Parameters

Name	Type	Description
options	string | MessagePayload | MessageOptions	The options to provide

Returns: Promise<Message>

// Send a basic message
channel.send('hello!')
  .then(message => console.log(`Sent message: ${message.content}`))
  .catch(console.error);

// Send a remote file
channel.send({
  files: ['https://cdn.discordapp.com/icons/222078108977594368/6e1019b3179d71046e463a75915e7244.png?size=2048']
})
  .then(console.log)
  .catch(console.error);

// Send a local file
channel.send({
  files: [{
    attachment: 'entire/path/to/file.jpg',
    name: 'file.jpg',
    description: 'A description of the file'
  }]
})
  .then(console.log)
  .catch(console.error);

Source

sendTyping

sendTyping(): Promise<({message_send_cooldown_ms: number, thread_create_cooldown_ms: number}|void)>

Sends a typing indicator in the channel. Returns: Promise<({message_send_cooldown_ms: number, thread_create_cooldown_ms: number}\|void)> — Resolves upon the typing status being sent

// Start typing in a channel
channel.sendTyping();

Source

createMessageCollector

createMessageCollector(options?: MessageCollectorOptions): MessageCollector

Creates a Message Collector. Parameters

Name	Type	Description
options?	MessageCollectorOptions	The options to pass to the collector Default: {}.

Returns: MessageCollector

// Create a message collector
const filter = m => m.content.includes('discord');
const collector = channel.createMessageCollector({ filter, time: 15_000 });
collector.on('collect', m => console.log(`Collected ${m.content}`));
collector.on('end', collected => console.log(`Collected ${collected.size} items`));

Source

awaitMessages

awaitMessages(options?: AwaitMessagesOptions): Promise<Collection<Snowflake, Message>>

Similar to createMessageCollector but in promise form. Resolves with a collection of messages that pass the specified filter. Parameters

Name	Type	Description
options?	AwaitMessagesOptions	Optional options to pass to the internal collector Default: {}.

Returns: Promise<Collection<Snowflake, Message>>

// Await !vote messages
const filter = m => m.content.startsWith('!vote');
// Errors: ['time'] treats ending because of the time limit as an error
channel.awaitMessages({ filter, max: 4, time: 60_000, errors: ['time'] })
  .then(collected => console.log(collected.size))
  .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));

Source

delete

async

async delete(): Promise<Channel>

Deletes this channel. Returns: Promise<Channel>

// Delete the channel
channel.delete()
  .then(console.log)
  .catch(console.error);

Source

isText

isText(): boolean

Indicates whether this channel is text-based. Returns: booleanSource

isVoice

isVoice(): boolean

Indicates whether this channel is voice-based. Returns: booleanSource

isThread

isThread(): boolean

Indicates whether this channel is a ThreadChannel. Returns: booleanSource

isThreadOnly

isThreadOnly(): boolean

Indicates whether this channel is ThreadOnlyChannel. Returns: booleanSource

isDirectory

isDirectory(): boolean

Indicates whether this channel is a DirectoryChannelReturns: booleanSource