DMChannel

Package: @erinjs/core

DM channel (direct message between bot and a user).

Constructor

Name	Type	Optional	Description
client	Client	No
data	any	No

Properties

Name	Type	Readonly	Optional	Description
lastMessageId	string | null	No	Yes
messages	MessageManager	Yes	No	Message manager for this channel. Use channel.messages.fetch(messageId).
nicks	Record<string, string>	No	No	Group DM member display names (userId -> nickname).
ownerId	string | null	No	No	Group DM creator ID. Null for 1:1 DMs.
recipients	User[]	No	No	Group DM recipients as User objects. Empty for 1:1 DMs.

Methods

addRecipient() async

Add a recipient to this Group DM. Requires Group DM (type GroupDM). PUT /channels/{id}/recipients/{userId}.

Returns: Promise<void>

Parameters:

Name	Type	Optional	Description
userId	string	No

---

createMessageCollector()

Create a message collector for this DM channel.

Returns: MessageCollector

Parameters:

Name	Type	Optional	Description
options	MessageCollectorOptions	Yes	Filter, time (ms), and max count

---

fetchMessage() async

Fetch a message by ID from this DM channel.

Returns: Promise<Message>

Parameters:

Name	Type	Optional	Description
messageId	string	No	Snowflake of the message

---

fetchPinnedMessages() async

Fetch pinned messages in this DM channel.

Returns: Promise<Message[]>

Parameters:

None

---

removeRecipient() async

Remove a recipient from this Group DM. Requires Group DM (type GroupDM). DELETE /channels/{id}/recipients/{userId}.

Returns: Promise<void>

Parameters:

Name	Type	Optional	Description
userId	string	No
options	{ silent?: boolean; }	Yes	silent: if true, does not send a system message (default false)

---

send() async

Send a message to this DM channel.

Returns: Promise<Message>

Parameters:

Name	Type	Optional	Description
options	MessageSendOptions	No	Text content or object with content, embeds, and/or files