Add a user to a group channel.
The ID of the group to add the user to.
The options for adding the recipient.
This method does not cache its result.
Create a direct message. This will not create a new channel if you have already started a dm with the user.
The ID of the recipient of the direct message.
Create a group dm.
The options for creating the group dm.
Create an invite for a channel. If the guild is not a COMMUNITY
server, invites can only be made to last 30 days.
The ID of the channel to create an invite for.
The options for creating the invite.
This method does not cache its result.
Create a message in a channel.
The ID of the channel to create the message in.
The options for creating the message.
This method may cache its result. The result will not be cached if the channel is not cached.
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
Add a reaction to a message.
The ID of the channel the message is in.
The ID of the message to add a reaction to.
The reaction to add to the message. name:id
for custom emojis, and the unicode codepoint for default emojis.
This method does not cache its result.
Create a stage instance.
The ID of the channel to create the stage instance on.
The options for creating the stage instance.
This method does not cache its result.
Crosspost a message in an announcement channel.
The ID of the channel to crosspost the message in.
The ID of the message to crosspost.
This method may cache its result. The result will not be cached if the channel is not cached.
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
Delete an invite.
The code of the invite to delete.
Optional
reason: stringThe reason for deleting the invite.
This method does not cache its result.
Delete a message.
The ID of the channel to delete the message in.
The ID of the message to delete.
Optional
reason: stringThe reason for deleting the message.
This method does not cache its result.
Bulk delete messages.
The ID of the channel to delete the messages in.
The IDs of the messages to delete. Any duplicates or messages older than two weeks will cause an error.
Optional
reason: stringThe reason for deleting the messages.
This method does not cache its result.
Delete a permission overwrite.
The ID of the channel to delete the permission overwrite in.
The ID of the permission overwrite to delete.
Optional
reason: stringThe reason for deleting the permission overwrite.
This method does not cache its result.
Remove a reaction from a message.
The ID of the channel the message is in.
The ID of the message to remove a reaction from.
The reaction to remove from the message. name:id
for custom emojis, and the unicode codepoint for default emojis.
The user to remove the reaction from, @me
for the current user (default).
This method does not cache its result.
Remove all, or a specific emoji's reactions from a message.
The ID of the channel the message is in.
The ID of the message to remove reactions from.
Optional
emoji: stringThe reaction to remove from the message. name:id
for custom emojis, and the unicode codepoint for default emojis. Omit to remove all reactions.
This method does not cache its result.
Edit a channel.
The ID of the channel to edit.
The options for editing the channel.
This method may cache its result. If a guild channel, the result will not be cached if the guild is not cached.
Edit a message.
The ID of the channel the message is in.
The ID of the message to edit.
The options for editing the message.
This method may cache its result. The result will not be cached if the channel is not cached.
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
Edit a permission overwrite.
The ID of the channel to edit the permission overwrite for.
The ID of the permission overwrite to edit.
The options for editing the permission overwrite.
This method does not cache its result.
Edit a stage instance.
The ID of the channel to edit the stage instance on.
The options for editing the stage instance.
This method does not cache its result.
Follow an announcement channel.
The ID of the channel to follow announcements from.
The ID of the channel crossposted messages should be sent to. The client must have the MANAGE_WEBHOOKS
permission in this channel.
This method does not cache its result.
Get a channel.
The ID of the channel to get.
This method may cache its result. The result will not be cached if the guild is not cached.
Guild#channels
Guild#threads
Client#privateChannels
Client#groupChannels
Get an invite.
The code of the invite to get.
The options for getting the invite.
This method does not cache its result.
Get the invites of a channel.
The ID of the channel to get the invites of.
This method does not cache its result.
Get the private archived threads the current user has joined in a channel.
The ID of the channel to get the archived threads from.
Optional
options: GetArchivedThreadsOptionsThe options for getting the archived threads.
This method does not cache its result.
Get a message in a channel.
The ID of the channel the message is in
The ID of the message to get.
This method may cache its result. The result will not be cached if the channel is not cached.
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
Get messages in a channel.
The ID of the channel to get messages from.
Optional
options: GetChannelMessagesOptions<T>The options for getting messages. before
, after
, and around
All are mutually exclusive.
This method may cache its result. The result will not be cached if the channel is not cached.
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
Get an async iterator for getting messages in a channel.
The ID of the channel to get messages from.
Optional
options: GetChannelMessagesIteratorOptions<T>The options for getting messages. before
, after
, and around
All are mutually exclusive.
This method may cache its result. The result will not be cached if the channel is not cached.
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
Get the pinned messages in a channel.
The ID of the channel to get the pinned messages from.
This method may cache its result. The result will not be cached if the channel is not cached.
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
Get the private archived threads in a channel.
The ID of the channel to get the archived threads from.
Optional
options: GetArchivedThreadsOptionsThe options for getting the archived threads.
This method may cache its result. The result will not be cached if the guild is not cached.
Get the private joined archived threads in a channel.
The ID of the channel to get the archived threads from.
Optional
options: GetArchivedThreadsOptionsThe options for getting the archived threads.
This method may cache its result. The result will not be cached if the guild is not cached.
Get the public archived threads in a channel.
The ID of the channel to get the archived threads from.
Optional
options: GetArchivedThreadsOptionsThe options for getting the archived threads.
This method may cache its result. The result will not be cached if the guild is not cached.
Get the users who reacted with a specific emoji on a message.
The ID of the channel the message is in.
The ID of the message to get reactions from.
The reaction to remove from the message. name:id
for custom emojis, and the unicode codepoint for default emojis.
Optional
options: GetReactionsOptionsThe options for getting the reactions.
This method does not cache its result.
Get the stage instance associated with a channel.
The ID of the channel to get the stage instance on.
This method does not cache its result.
Get a thread member.
The ID of the thread.
The ID of the user to get the thread member of.
This method does not cache its result.
Get the members of a thread.
The ID of the thread.
Optional
options: GetThreadMembersOptionsThe options for getting the thread members.
This method does not cache its result.
Get the list of usable voice regions. Moved to misc
.
Pin a message in a channel.
The ID of the channel to pin the message in.
The ID of the message to pin.
Optional
reason: stringThe reason for pinning the message.
This method does not cache its result.
Purge an amount of messages from a channel.
The ID of the channel to purge.
The options to purge. before
, after
, and around
All are mutually exclusive.
This method does not cache its result.
Create a thread from an existing message.
The ID of the channel to create the thread in.
The ID of the message to create the thread from.
The options for starting the thread.
This method may cache its result. The result will not be cached if the guild is not cached.
Create a thread in a thread only channel (forum & media).
The ID of the channel to start the thread in.
The options for starting the thread.
This method may cache its result. The result will not be cached if the guild is not cached.
Create a thread without an existing message.
The ID of the channel to start the thread in.
The options for starting the thread.
This method may cache its result. The result will not be cached if the guild is not cached.
Unpin a message in a channel.
The ID of the channel to unpin the message in.
The ID of the message to unpin.
Optional
reason: stringThe reason for unpinning the message.
This method does not cache its result.
Various methods for interacting with channels. Located at Client#rest.channels.