Class DMChannel

Represents a direct message (DM) channel between users.

Hierarchy (View Summary)

Channel
- DMChannel

Implements

TextBasedChannel

Index

Constructors

constructor

new DMChannel(
    client: client,
    data: {
        _id: string;
        active: boolean;
        channel_type: "DirectMessage";
        last_message_id?: null | string;
        recipients: string[];
    },
): DMChannel
Creates a new DMChannel instance.
Parameters
- client: client
  The client instance.
- data: {
      _id: string;
      active: boolean;
      channel_type: "DirectMessage";
      last_message_id?: null | string;
      recipients: string[];
  }
  The raw data for the DM channel from the API.
  - _id: string
    Description
    Unique Id
  - active: boolean
    Description
    Whether this direct message channel is currently open on both sides
  - channel_type: "DirectMessage"
  - Optionallast_message_id?: null | string
    Description
    Id of the last message sent in this channel
  - recipients: string[]
    Description
    2-tuple of user ids participating in direct message
Returns DMChannel
Overrides Channel.constructor
- Defined in work/revbot.js/revbot.js/src/struct/dmChannel.ts:41

Properties

active

active: boolean

Whether the DM channel is currently active.

`Readonly`client

client: client

The client instance.

id

id: string

The unique identifier for the object.

lastMessageId

lastMessageId: null | string = null

The ID of the last message sent in this DM channel, if any.

messages

messages: MessageManager = ...

Manages the messages in this DM channel.

permissions

permissions: Readonly<ChannelPermissions> = DEFAULT_PERMISSION_DM

The default permissions for the DM channel.

`Readonly`type

type: DM = ChannelTypes.DM

The type of the channel, which is always DM for direct message channels.

Accessors

createdAt

get createdAt(): Date
Gets the date and time when the channel was created.

Returns Date
The creation date of the channel.
Inherited from Channel.createdAt
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:40

createdTimestamp

get createdTimestamp(): number
Gets the timestamp (in milliseconds) when the channel was created.

Returns number
The timestamp of the channel's creation.
Inherited from Channel.createdTimestamp
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:31

lastMessage

get lastMessage(): null | Message
Retrieves the last message sent in this DM channel.

Returns null | Message
The last message, or null if no message exists.
Implementation of TextBasedChannel.lastMessage
- Defined in work/revbot.js/revbot.js/src/struct/dmChannel.ts:67

Methods

_clone

_clone(): this
Creates a deep clone of the object.

Returns this
A clone of the object.
Inherited from Channel._clone
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:84

_update

_update(data: PartialObject, clear?: string[]): this
Updates the object with new data and returns a clone of the object.
Parameters
- data: PartialObject
  The data to update the object with.
- Optionalclear: string[]
  Fields to clear in the object.
Returns this
A clone of the updated object.
Inherited from Channel._update
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:56

bulkDelete

bulkDelete(
messages: number | Map<string, Message> | MessageResolvable[],
): Promise<void>
Deletes multiple messages from this DM channel.
Parameters
- messages: number | Map<string, Message> | MessageResolvable[]
  The messages to delete. This can be an array of message resolvables, a map of messages, or a number indicating how many recent messages to delete.
Returns Promise<void>
A promise that resolves when the messages have been successfully deleted.
Example
```
await dmChannel.bulkDelete(10); // Deletes the last 10 messages.
```
Implementation of TextBasedChannel.bulkDelete
- Defined in work/revbot.js/revbot.js/src/struct/dmChannel.ts:83

delete

delete(): Promise<void>
Deletes the current channel instance from the client's channel collection.

This method interacts with the client's channel management system to remove the channel. Once deleted, the channel will no longer be accessible through the client.

Returns Promise<void>
A promise that resolves when the channel has been successfully deleted.
Example
```
const channel = client.channels.get('1234567890');
if (channel) {
  await channel.delete();
  console.log('Channel deleted successfully.');
}
```
Inherited from Channel.delete
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:62

equals

equals(obj?: null | DMChannel): boolean
Compares this object with another to determine if they are equal.
Parameters
- Optionalobj: null | DMChannel
  The object to compare with.
Returns boolean
true if the objects are equal, otherwise false.
Inherited from Channel.equals
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:29

fetch

fetch(force?: boolean): Promise<Channel>
Fetches the latest data for the channel from the client's channel collection.
Parameters
- Optionalforce: boolean = true
  Whether to force a fetch even if the channel is cached.
Returns Promise<Channel>
A promise that resolves with the updated channel instance.
Inherited from Channel.fetch
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:117

inServer

inServer(): this is ServerChannel
Checks if the channel is part of a server.

Returns this is ServerChannel
True if the channel is a server channel, otherwise false.
Inherited from Channel.inServer
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:98

isGroup

isGroup(): this is GroupChannel
Checks if the channel is a group channel.

Returns this is GroupChannel
True if the channel is a group channel, otherwise false.
Inherited from Channel.isGroup
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:89

isText

isText(): this is DMChannel | TextChannel | GroupChannel
Checks if the channel is a text-based channel.

Returns this is DMChannel | TextChannel | GroupChannel
True if the channel is a text-based channel, otherwise false.
Inherited from Channel.isText
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:71

isVoice

isVoice(): this is VoiceChannel
Checks if the channel is a voice channel.

Returns this is VoiceChannel
True if the channel is a voice channel, otherwise false.
Inherited from Channel.isVoice
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:80

send

send(options: string | MessageOptions): Promise<Message>
Sends a message to this DM channel.
Parameters
- options: string | MessageOptions
  The message content or options for the message.
Returns Promise<Message>
A promise that resolves with the sent message.
Example
```
await dmChannel.send("Hello, world!");
```
Implementation of TextBasedChannel.send
- Defined in work/revbot.js/revbot.js/src/struct/dmChannel.ts:100

toString

toString(): string
Converts the channel to a string representation.

Returns string
A string representation of the channel in the format <#channelId>.
Inherited from Channel.toString
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:107

Class DMChannel

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_id: string

Description

active: boolean

Description

channel_type: "DirectMessage"

Optionallast_message_id?: null | string

Description

recipients: string[]

Description

Returns DMChannel

Properties

active

Readonlyclient

id

lastMessageId

messages

permissions

Readonlytype

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

lastMessage

Returns null | Message

Methods

_clone

Returns this

_update

Parameters

Returns this

bulkDelete

Parameters

Returns Promise<void>

Example

delete

Returns Promise<void>

Example

equals

Parameters

Returns boolean

fetch

Parameters

Returns Promise<Channel>

inServer

Returns this is ServerChannel

isGroup

Returns this is GroupChannel

isText

Returns this is DMChannel | TextChannel | GroupChannel

isVoice

Returns this is VoiceChannel

send

Parameters

Returns Promise<Message>

Example

toString

Returns string

Settings

On This Page

`Optional`last_message_id?: null | string

`Readonly`client

`Readonly`type