Class DMChannel

Represents a private channel between the Bot and a User

Hierarchy

Channel
- DMChannel

Implements

TextChannel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DMChannel(bot: Bot, dmChannel: GatewayStruct): DMChannel

Overrides Channel.constructor
- Defined in src/structures/channels/DMChannel.ts:27
Parameters
- bot: Bot
- dmChannel: GatewayStruct
Returns DMChannel

Properties

bot

bot: Bot

The Bot operating this structure

id

The ID of this channel

lastMessageId

lastMessageId: Snowflake | null | undefined

The ID of the last message sent in this channel. May not point to an existing or valid message

messages

messages: ChannelMessagesController

The text channel's messages controller

pins

pins: ChannelPinsController

The text channel's pinned messages controller

recipient

recipient: User

The recipient of the DM

type

type: ChannelType

The type of this channel

Methods

clone

clone(): this

Inherited from BaseStruct.clone
- Defined in src/structures/base/BaseStruct.ts:55
Clone a structure

Returns this

delete

delete(): Promise<Channel>

Inherited from Channel.delete
- Defined in src/structures/channels/Channel.ts:54
Deletes a GuildChannel, or closes a DMChannel. Requires the Permission.ManageChannels permission for the guild

Returns Promise<Channel>

sendMessage

sendMessage(data: string | MessageData | MessageEmbed, options?: MessageOptions): Promise<Message>

Implementation of TextChannel.sendMessage
- Defined in src/structures/channels/DMChannel.ts:55
Posts a message to a GuildTextChannel or DMChannel. If operating on a GuildTextChannel, this endpoint requires the Permission.SendMessages permission to be present on the current user. If the MessageOptions.tts field is set to true, the Permission.SendTTSMessages permission is required for the message to be spoken
example
```
channel.sendMessage('Hello World!');
```
1. A MessageData object, containing content and/or embed @example ```typescript channel.sendMessage({ content: 'Hello World!', embed: { title: 'My Embed!' } }); ```
example
```
channel.sendMessage({ content: 'Hello World!', files: [{ path: './my_image.png', name: 'image.png' }] });
```
1. A MessageEmbed instance @param {MessageOptions} options @returns {Promise}
Parameters
- data: string | MessageData | MessageEmbed
  The message data. Can be:
  1. Raw content to be sent as a message
- Optional options: MessageOptions
Returns Promise<Message>

triggerTyping

triggerTyping(): Promise<void>

Implementation of TextChannel.triggerTyping
- Defined in src/structures/channels/DMChannel.ts:63
Posts a typing indicator for a specified text channel. Useful when the bot is responding to a command and expects the computation to take a few seconds. This method may be called to let the user know that the bot is processing their message.

Returns Promise<void>

update

update(data: GatewayStruct): UpdateReturn<this>

Inherited from BaseStruct.update
- Defined in src/structures/base/BaseStruct.ts:64
Update a structure and return its before and after versions

Parameters
- data: GatewayStruct
  
  The updated data
Returns UpdateReturn<this>

Generated using TypeDoc