Class Channels

Various methods for interacting with channels.

Hierarchy

Channels

Constructors

constructor

new Channels(manager: RESTManager): Channels
Parameters
- manager: RESTManager
Returns Channels
- Defined in lib/routes/Channels.ts:69

Methods

addGroupRecipient

addGroupRecipient(groupID: string, options: AddGroupRecipientOptions): Promise<void>
Add a user to a group channel.
Parameters
- groupID: string
  
  The ID of the group to add the user to.
- options: AddGroupRecipientOptions
  
  The options for adding the recipient.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:78

addThreadMember

addThreadMember(channelID: string, userID: string): Promise<void>
Add a member to a thread.
Parameters
- channelID: string
  
  The ID of the thread to add them to.
- userID: string
  
  The ID of the user to add to the thread.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:94

createDM

createDM(recipient: string): Promise<PrivateChannel>
Create a direct message. This will not create a new channel if you have already started a dm with the user.
Parameters
- recipient: string
  
  The ID of the recipient of the direct message.
Returns Promise<PrivateChannel>
- Defined in lib/routes/Channels.ts:104

createGroupDM

createGroupDM(options: CreateGroupChannelOptions): Promise<GroupChannel>
Create a group dm.
Parameters
- options: CreateGroupChannelOptions
  
  The options for creating the group dm.
Returns Promise<GroupChannel>
- Defined in lib/routes/Channels.ts:121

createInvite

createInvite<T, CH>(channelID: string, options: CreateInviteOptions): Promise<Invite<T, CH>>
Create an invite for a channel.
Type Parameters
- T extends InviteInfoTypes
- CH extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel
Parameters
- channelID: string
  
  The ID of the channel to create an invite for.
- options: CreateInviteOptions
  
  The options for creating the invite.
Returns Promise<Invite<T, CH>>
- Defined in lib/routes/Channels.ts:137

createMessage

createMessage<T>(channelID: string, options: CreateMessageOptions): Promise<Message<T>>
Create a message in a channel.
Type Parameters
- T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel
Parameters
- channelID: string
  
  The ID of the channel to create the message in.
- options: CreateMessageOptions
  
  The options for creating the message.
Returns Promise<Message<T>>
- Defined in lib/routes/Channels.ts:163

createReaction

createReaction(channelID: string, messageID: string, emoji: string): Promise<void>
Add a reaction to a message.
Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message to add a reaction to.
- emoji: string
  
  The reaction to add to the message. name:id for custom emojis, and the unicode codepoint for default emojis.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:197

createStageInstance

createStageInstance(channelID: string, options: CreateStageInstanceOptions): Promise<StageInstance>
Create a stage instance.
Parameters
- channelID: string
  
  The ID of the channel to create the stage instance on.
- options: CreateStageInstanceOptions
  
  The options for creating the stage instance.
Returns Promise<StageInstance>
- Defined in lib/routes/Channels.ts:212

crosspostMessage

crosspostMessage<T>(channelID: string, messageID: string): Promise<Message<T>>
Crosspost a message in an announcement channel.
Type Parameters
- T extends Uncached | AnnouncementChannel = Uncached | AnnouncementChannel
Parameters
- channelID: string
  
  The ID of the channel to crosspost the message in.
- messageID: string
  
  The ID of the message to crosspost.
Returns Promise<Message<T>>
- Defined in lib/routes/Channels.ts:235

delete

delete(channelID: string, reason?: string): Promise<void>
Delete or close a channel.
Parameters
- channelID: string
  
  The ID of the channel to delete or close.
- Optional reason: string
  
  The reason to be displayed in the audit log.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:247

deleteInvite

deleteInvite<T>(code: string, reason?: string): Promise<Invite<"withMetadata", T>>
Delete an invite.
Type Parameters
- T extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel
Parameters
- code: string
  
  The code of the invite to delete.
- Optional reason: string
  
  The reason for deleting the invite.
Returns Promise<Invite<"withMetadata", T>>
- Defined in lib/routes/Channels.ts:260

deleteMessage

deleteMessage(channelID: string, messageID: string, reason?: string): Promise<void>
Delete a message.
Parameters
- channelID: string
  
  The ID of the channel to delete the message in.
- messageID: string
  
  The ID of the message to delete.
- Optional reason: string
  
  The reason for deleting the message.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:274

deleteMessages

deleteMessages(channelID: string, messageIDs: string[], reason?: string): Promise<number>
Bulk delete messages.
Parameters
- channelID: string
  
  The ID of the channel to delete the messages in.
- messageIDs: string[]
  
  The IDs of the messages to delete. Any duplicates or messages older than two weeks will cause an error.
- Optional reason: string
  
  The reason for deleting the messages.
Returns Promise<number>
- Defined in lib/routes/Channels.ts:288

deletePermission

deletePermission(channelID: string, overwriteID: string, reason?: string): Promise<void>
Delete a permission overwrite.
Parameters
- channelID: string
  
  The ID of the channel to delete the permission overwrite in.
- overwriteID: string
  
  The ID of the permission overwrite to delete.
- Optional reason: string
  
  The reason for deleting the permission overwrite.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:327

deleteReaction

deleteReaction(channelID: string, messageID: string, emoji: string, user?: string): Promise<void>
Remove a reaction from a message.
Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message to remove a reaction from.
- emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- user: string = "@me"
  
  The user to remove the reaction from, @me for the current user (default).
Returns Promise<void>
- Defined in lib/routes/Channels.ts:342

deleteReactions

deleteReactions(channelID: string, messageID: string, emoji?: string): Promise<void>
Remove all, or a specific emoji's reactions from a message.
Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message to remove reactions from.
- Optional emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis. Omit to remove all reactions.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:358

deleteStageInstance

deleteStageInstance(channelID: string, reason?: string): Promise<void>
Delete a stage instance.
Parameters
- channelID: string
  
  The ID of the channel to delete the stage instance on.
- Optional reason: string
  
  The reason for deleting the stage instance.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:373

edit

edit<T>(channelID: string, options: EditChannelOptions): Promise<T>
Edit a channel.
Type Parameters
- T extends AnyEditableChannel = AnyEditableChannel
Parameters
- channelID: string
  
  The ID of the channel to edit.
- options: EditChannelOptions
  
  The options for editing the channel.
Returns Promise<T>
- Defined in lib/routes/Channels.ts:386

editMessage

editMessage<T>(channelID: string, messageID: string, options: EditMessageOptions): Promise<Message<T>>
Edit a message.
Type Parameters
- T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel
Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message to edit.
- options: EditMessageOptions
  
  The options for editing the message.
Returns Promise<Message<T>>
- Defined in lib/routes/Channels.ts:446

editPermission

editPermission(channelID: string, overwriteID: string, options: EditPermissionOptions): Promise<void>
Edit a permission overwrite.
Parameters
- channelID: string
  
  The ID of the channel to edit the permission overwrite for.
- overwriteID: string
  
  The ID of the permission overwrite to edit.
- options: EditPermissionOptions
  
  The options for editing the permission overwrite.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:472

editStageInstance

editStageInstance(channelID: string, options: EditStageInstanceOptions): Promise<StageInstance>
Edit a stage instance.
Parameters
- channelID: string
  
  The ID of the channel to edit the stage instance on.
- options: EditStageInstanceOptions
  
  The options for editing the stage instance.
Returns Promise<StageInstance>
- Defined in lib/routes/Channels.ts:494

followAnnouncement

followAnnouncement(channelID: string, webhookChannelID: string): Promise<FollowedChannel>
Follow an announcement channel.
Parameters
- channelID: string
  
  The ID of the channel to follow announcements from.
- webhookChannelID: string
  
  The ID of the channel crossposted messages should be sent to. The client must have the MANAGE_WEBHOOKS permission in this channel.
Returns Promise<FollowedChannel>
- Defined in lib/routes/Channels.ts:516

get

get<T>(channelID: string): Promise<T>
Get a channel.
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- channelID: string
  
  The ID of the channel to get.
Returns Promise<T>
- Defined in lib/routes/Channels.ts:531

getInvite

getInvite<T>(code: string, options: GetInviteWithNoneOptions): Promise<Invite<"withMetadata", T>>
Get an invite.
Type Parameters
- T extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel
Parameters
- code: string
  
  The code of the invite to get.
- options: GetInviteWithNoneOptions
  
  The options for getting the invite.
Returns Promise<Invite<"withMetadata", T>>
- Defined in lib/routes/Channels.ts:543
getInvite<T>(code: string, options: GetInviteWithCountsAndExpirationOptions): Promise<Invite<"withMetadata" | "withCounts" | "withExpiration", T>>
Type Parameters
- T extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel
Parameters
- code: string
- options: GetInviteWithCountsAndExpirationOptions
Returns Promise<Invite<"withMetadata" | "withCounts" | "withExpiration", T>>
- Defined in lib/routes/Channels.ts:544
getInvite<T>(code: string, options: GetInviteWithCountsOptions): Promise<Invite<"withMetadata" | "withCounts", T>>
Type Parameters
- T extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel
Parameters
- code: string
- options: GetInviteWithCountsOptions
Returns Promise<Invite<"withMetadata" | "withCounts", T>>
- Defined in lib/routes/Channels.ts:545
getInvite<T>(code: string, options: GetInviteWithExpirationOptions): Promise<Invite<"withMetadata" | "withExpiration", T>>
Type Parameters
- T extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel
Parameters
- code: string
- options: GetInviteWithExpirationOptions
Returns Promise<Invite<"withMetadata" | "withExpiration", T>>
- Defined in lib/routes/Channels.ts:546

getInvites

getInvites<T>(channelID: string): Promise<Invite<"withMetadata", T>[]>
Get the invites of a channel.
Type Parameters
- T extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel
Parameters
- channelID: string
  
  The ID of the channel to get the invites of.
Returns Promise<Invite<"withMetadata", T>[]>
- Defined in lib/routes/Channels.ts:569

getJoinedPrivateArchivedThreads

getJoinedPrivateArchivedThreads(channelID: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<PrivateThreadChannel>>
Get the private archived threads the current user has joined in a channel.
Parameters
- channelID: string
  
  The ID of the channel to get the archived threads from.
- Optional options: GetArchivedThreadsOptions
  
  The options for getting the archived threads.
Returns Promise<ArchivedThreads<PrivateThreadChannel>>
- Defined in lib/routes/Channels.ts:581

getMessage

getMessage<T>(channelID: string, messageID: string): Promise<Message<T>>
Get a message in a channel.
Type Parameters
- T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel
Parameters
- channelID: string
  
  The ID of the channel the message is in
- messageID: string
  
  The ID of the message to get.
Returns Promise<Message<T>>
- Defined in lib/routes/Channels.ts:606

getMessages

getMessages<T>(channelID: string, options?: GetChannelMessagesOptions<T>): Promise<Message<T>[]>
Get messages in a channel.
Type Parameters
- T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel
Parameters
- channelID: string
  
  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.
Returns Promise<Message<T>[]>
- Defined in lib/routes/Channels.ts:618

getMessagesIterator

getMessagesIterator<T>(channelID: string, options?: GetChannelMessagesIteratorOptions<T>): Promise<MessagesIterator<T>>
Get an async iterator for getting messages in a channel.
Type Parameters
- T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel
Parameters
- channelID: string
  
  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.
Returns Promise<MessagesIterator<T>>
- Defined in lib/routes/Channels.ts:680

getPinnedMessages

getPinnedMessages<T>(channelID: string): Promise<Message<T>[]>
Get the pinned messages in a channel.
Type Parameters
- T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel
Parameters
- channelID: string
  
  The ID of the channel to get the pinned messages from.
Returns Promise<Message<T>[]>
- Defined in lib/routes/Channels.ts:730

getPrivateArchivedThreads

getPrivateArchivedThreads(channelID: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<PrivateThreadChannel>>
Get the private archived threads in a channel.
Parameters
- channelID: string
  
  The ID of the channel to get the archived threads from.
- Optional options: GetArchivedThreadsOptions
  
  The options for getting the archived threads.
Returns Promise<ArchivedThreads<PrivateThreadChannel>>
- Defined in lib/routes/Channels.ts:742

getPrivateJoinedArchivedThreads

getPrivateJoinedArchivedThreads(channelID: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<PrivateThreadChannel>>
Parameters
- channelID: string
- Optional options: GetArchivedThreadsOptions
Returns Promise<ArchivedThreads<PrivateThreadChannel>>
- Defined in lib/routes/Channels.ts:766

getPublicArchivedThreads

getPublicArchivedThreads<T>(channelID: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<T>>
Get the public archived threads in a channel.
Type Parameters
- T extends AnnouncementThreadChannel | PublicThreadChannel = AnnouncementThreadChannel | PublicThreadChannel
Parameters
- channelID: string
  
  The ID of the channel to get the archived threads from.
- Optional options: GetArchivedThreadsOptions
  
  The options for getting the archived threads.
Returns Promise<ArchivedThreads<T>>
- Defined in lib/routes/Channels.ts:795

getReactions

getReactions(channelID: string, messageID: string, emoji: string, options?: GetReactionsOptions): Promise<User[]>
Get the users who reacted with a specific emoji on a message.
Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message to get reactions from.
- emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- Optional options: GetReactionsOptions
  
  The options for getting the reactions.
Returns Promise<User[]>
- Defined in lib/routes/Channels.ts:826

getStageInstance

getStageInstance(channelID: string): Promise<StageInstance>
Get the stage instance associated with a channel.
Parameters
- channelID: string
  
  The ID of the channel to get the stage instance on.
Returns Promise<StageInstance>
- Defined in lib/routes/Channels.ts:878

getThreadMember

getThreadMember(channelID: string, userID: string): Promise<ThreadMember>
Get a thread member.
Parameters
- channelID: string
  
  The ID of the thread.
- userID: string
  
  The ID of the user to get the thread member of.
Returns Promise<ThreadMember>
- Defined in lib/routes/Channels.ts:890

getThreadMembers

getThreadMembers(channelID: string, options?: GetThreadMembersOptions): Promise<ThreadMember[]>
Get the members of a thread.
Parameters
- channelID: string
  
  The ID of the thread.
- Optional options: GetThreadMembersOptions
  
  The options for getting the thread members.
Returns Promise<ThreadMember[]>
- Defined in lib/routes/Channels.ts:907

getVoiceRegions

getVoiceRegions(): Promise<VoiceRegion[]>
Deprecated
Get the list of usable voice regions. Moved to misc.

Returns Promise<VoiceRegion[]>
- Defined in lib/routes/Channels.ts:937

joinThread

joinThread(channelID: string): Promise<void>
Join a thread.
Parameters
- channelID: string
  
  The ID of the thread to join.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:948

leaveThread

leaveThread(channelID: string): Promise<void>
Leave a thread.
Parameters
- channelID: string
  
  The ID of the thread to leave.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:959

pinMessage

pinMessage(channelID: string, messageID: string, reason?: string): Promise<void>
Pin a message in a channel.
Parameters
- channelID: string
  
  The ID of the channel to pin the message in.
- messageID: string
  
  The ID of the message to pin.
- Optional reason: string
  
  The reason for pinning the message.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:972

purgeMessages

purgeMessages<T>(channelID: string, options: PurgeOptions<T>): Promise<number>
Purge an amount of messages from a channel.
Type Parameters
- T extends Uncached | AnyTextableGuildChannel = Uncached | AnyTextableGuildChannel
Parameters
- channelID: string
  
  The ID of the channel to purge.
- options: PurgeOptions<T>
  
  The options to purge. before, after, and around All are mutually exclusive.
Returns Promise<number>
- Defined in lib/routes/Channels.ts:985

removeGroupRecipient

removeGroupRecipient(groupID: string, userID: string): Promise<void>
Remove a user from the group channel.
Parameters
- groupID: string
  
  The ID of the group to remove the user from.
- userID: string
  
  The ID of the user to remove.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1040

removeThreadMember

removeThreadMember(channelID: string, userID: string): Promise<void>
Remove a member from a thread.
Parameters
- channelID: string
  
  The ID of the thread to remove them from.
- userID: string
  
  The ID of the user to remove from the thread.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1052

sendTyping

sendTyping(channelID: string): Promise<void>
Show a typing indicator in a channel. How long users see this varies from client to client.
Parameters
- channelID: string
  
  The ID of the channel to show the typing indicator in.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1063

startThreadFromMessage

startThreadFromMessage<T>(channelID: string, messageID: string, options: StartThreadFromMessageOptions): Promise<T>
Create a thread from an existing message.
Type Parameters
- T extends AnnouncementThreadChannel | PublicThreadChannel = AnnouncementThreadChannel | PublicThreadChannel
Parameters
- channelID: string
  
  The ID of the channel to create the thread in.
- messageID: string
  
  The ID of the message to create the thread from.
- options: StartThreadFromMessageOptions
  
  The options for starting the thread.
Returns Promise<T>
- Defined in lib/routes/Channels.ts:1076

startThreadInForum

startThreadInForum(channelID: string, options: StartThreadInForumOptions): Promise<PublicThreadChannel>
Create a thread in a forum channel.
Parameters
- channelID: string
  
  The ID of the channel to start the thread in.
- options: StartThreadInForumOptions
  
  The options for starting the thread.
Returns Promise<PublicThreadChannel>
- Defined in lib/routes/Channels.ts:1098

startThreadWithoutMessage

startThreadWithoutMessage<T>(channelID: string, options: StartThreadWithoutMessageOptions): Promise<T>
Create a thread without an existing message.
Type Parameters
- T extends AnnouncementThreadChannel | PublicThreadChannel | PrivateThreadChannel = AnnouncementThreadChannel | PublicThreadChannel | PrivateThreadChannel
Parameters
- channelID: string
  
  The ID of the channel to start the thread in.
- options: StartThreadWithoutMessageOptions
  
  The options for starting the thread.
Returns Promise<T>
- Defined in lib/routes/Channels.ts:1134

unpinMessage

unpinMessage(channelID: string, messageID: string, reason?: string): Promise<void>
Unpin a message in a channel.
Parameters
- channelID: string
  
  The ID of the channel to unpin the message in.
- messageID: string
  
  The ID of the message to unpin.
- Optional reason: string
  
  The reason for unpinning the message.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1159

Class Channels

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns Channels

Methods

addGroupRecipient

Parameters

groupID: string

options: AddGroupRecipientOptions

Returns Promise<void>

addThreadMember

Parameters

channelID: string

userID: string

Returns Promise<void>

createDM

Parameters

recipient: string

Returns Promise<PrivateChannel>

createGroupDM

Parameters

options: CreateGroupChannelOptions

Returns Promise<GroupChannel>

createInvite

Type Parameters

T extends InviteInfoTypes

CH extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel

Parameters

channelID: string

options: CreateInviteOptions

Returns Promise<Invite<T, CH>>

createMessage

Type Parameters

T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel

Parameters

channelID: string

options: CreateMessageOptions

Returns Promise<Message<T>>

createReaction

Parameters

channelID: string

messageID: string

emoji: string

Returns Promise<void>

createStageInstance

Parameters

channelID: string

options: CreateStageInstanceOptions

Returns Promise<StageInstance>

crosspostMessage

Type Parameters

T extends Uncached | AnnouncementChannel = Uncached | AnnouncementChannel

Parameters

channelID: string

messageID: string

Returns Promise<Message<T>>

delete

Parameters

channelID: string

Optional reason: string

Returns Promise<void>

deleteInvite

Type Parameters

T extends Uncached | AnyInviteChannel | PartialInviteChannel = Uncached | AnyInviteChannel | PartialInviteChannel

Parameters

code: string

Optional reason: string

Returns Promise<Invite<"withMetadata", T>>

deleteMessage

Parameters

channelID: string

messageID: string

Optional reason: string

Returns Promise<void>

`Optional` reason: string

`Optional` reason: string

`Optional` reason: string

`Optional` reason: string

`Optional` reason: string

`Optional` emoji: string

`Optional` reason: string