Class REST/Channels

Various methods for interacting with channels. Located at Client#rest .channels.

Hierarchy

REST/Channels

Index

Constructors

constructor

Methods

Constructors

constructor

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

Methods

addGroupRecipient

addGroupRecipient(groupID, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:78

addThreadMember

addThreadMember(channelID, userID): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:95

createDM

createDM(recipient): 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>

Caching
This method does cache its result.

Caches
Client#privateChannels
- Defined in lib/routes/Channels.ts:107

createGroupDM

createGroupDM(options): Promise<GroupChannel>
Create a group dm.
Parameters
- options: CreateGroupChannelOptions
  
  The options for creating the group dm.
Returns Promise<GroupChannel>

Caching
This method does cache its result.

Caches
Client#groupChannels
- Defined in lib/routes/Channels.ts:126

createInvite

createInvite<T, CH>(channelID, options): Promise<Invite<T, CH>>
Create an invite for a channel. If the guild is not a COMMUNITY server, invites can only be made to last 30 days.
Type Parameters
- T extends InviteInfoTypes
- CH extends AnyInviteChannel | Uncached | PartialInviteChannel = AnyInviteChannel | Uncached | 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>>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:143

createMessage

createMessage<T>(channelID, options): 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>>

Caching
This method may cache its result. The result will not be cached if the channel is not cached.

Caches
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
- Defined in lib/routes/Channels.ts:171

createReaction

createReaction(channelID, messageID, emoji): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:206

createStageInstance

createStageInstance(channelID, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:222

crosspostMessage

crosspostMessage<T>(channelID, messageID): Promise<Message<T>>
Crosspost a message in an announcement channel.
Type Parameters
- T extends AnnouncementChannel | Uncached = AnnouncementChannel | Uncached
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>>

Caching
This method may cache its result. The result will not be cached if the channel is not cached.

Caches
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
- Defined in lib/routes/Channels.ts:247

delete

delete(channelID, reason?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:260

deleteInvite

deleteInvite<T>(code, reason?): Promise<Invite<"withMetadata", T>>
Delete an invite.
Type Parameters
- T extends AnyInviteChannel | Uncached | PartialInviteChannel = AnyInviteChannel | Uncached | 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>>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:274

deleteMessage

deleteMessage(channelID, messageID, reason?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:289

deleteMessages

deleteMessages(channelID, messageIDs, reason?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:304

deletePermission

deletePermission(channelID, overwriteID, reason?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:344

deleteReaction

deleteReaction(channelID, messageID, emoji, user?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:360

deleteReactions

deleteReactions(channelID, messageID, emoji?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:377

deleteStageInstance

deleteStageInstance(channelID, reason?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:393

edit

edit<T>(channelID, options): 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>

Caching
This method may cache its result. If a guild channel, the result will not be cached if the guild is not cached.

Caches
Guild#channels
Guild#threads
Client#groupChannels
- Defined in lib/routes/Channels.ts:408

editMessage

editMessage<T>(channelID, messageID, options): 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>>

Caching
This method may cache its result. The result will not be cached if the channel is not cached.

Caches
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
- Defined in lib/routes/Channels.ts:470

editPermission

editPermission(channelID, overwriteID, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:497

editStageInstance

editStageInstance(channelID, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:520

followAnnouncement

followAnnouncement(channelID, webhookChannelID): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:543

get

get<T>(channelID): Promise<T>
Get a channel.
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- channelID: string
  
  The ID of the channel to get.
Returns Promise<T>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#channels
Guild#threads
Client#privateChannels
Client#groupChannels
- Defined in lib/routes/Channels.ts:560

getInvite

getInvite<T>(code, options): Promise<Invite<"withMetadata", T>>
Get an invite.
Type Parameters
- T extends AnyInviteChannel | Uncached | PartialInviteChannel = AnyInviteChannel | Uncached | PartialInviteChannel
Parameters
- code: string
  
  The code of the invite to get.
- options: GetInviteWithNoneOptions
  
  The options for getting the invite.
Returns Promise<Invite<"withMetadata", T>>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:573
getInvite<T>(code, options): Promise<Invite<"withMetadata" | "withCounts" | "withExpiration", T>>
Type Parameters
- T extends AnyInviteChannel | Uncached | PartialInviteChannel = AnyInviteChannel | Uncached | PartialInviteChannel
Parameters
- code: string
- options: GetInviteWithCountsAndExpirationOptions
Returns Promise<Invite<"withMetadata" | "withCounts" | "withExpiration", T>>
- Defined in lib/routes/Channels.ts:574
getInvite<T>(code, options): Promise<Invite<"withMetadata" | "withCounts", T>>
Type Parameters
- T extends AnyInviteChannel | Uncached | PartialInviteChannel = AnyInviteChannel | Uncached | PartialInviteChannel
Parameters
- code: string
- options: GetInviteWithCountsOptions
Returns Promise<Invite<"withMetadata" | "withCounts", T>>
- Defined in lib/routes/Channels.ts:575
getInvite<T>(code, options): Promise<Invite<"withMetadata" | "withExpiration", T>>
Type Parameters
- T extends AnyInviteChannel | Uncached | PartialInviteChannel = AnyInviteChannel | Uncached | PartialInviteChannel
Parameters
- code: string
- options: GetInviteWithExpirationOptions
Returns Promise<Invite<"withMetadata" | "withExpiration", T>>
- Defined in lib/routes/Channels.ts:576

getInvites

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

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:600

getJoinedPrivateArchivedThreads

getJoinedPrivateArchivedThreads(channelID, options?): 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>>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:613

getMessage

getMessage<T>(channelID, messageID): 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>>

Caching
This method may cache its result. The result will not be cached if the channel is not cached.

Caches
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
- Defined in lib/routes/Channels.ts:640

getMessages

getMessages<T>(channelID, options?): 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>[]>

Caching
This method may cache its result. The result will not be cached if the channel is not cached.

Caches
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
- Defined in lib/routes/Channels.ts:654

getMessagesIterator

getMessagesIterator<T>(channelID, options?): 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 MessagesIterator<T>

Caching
This method may cache its result. The result will not be cached if the channel is not cached.

Caches
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
- Defined in lib/routes/Channels.ts:718

getPinnedMessages

getPinnedMessages<T>(channelID): 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>[]>

Caching
This method may cache its result. The result will not be cached if the channel is not cached.

Caches
TextableChannel#messages
ThreadChannel#messages
PrivateChannel#messages
- Defined in lib/routes/Channels.ts:770

getPrivateArchivedThreads

getPrivateArchivedThreads(channelID, options?): 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>>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#threads
- Defined in lib/routes/Channels.ts:784

getPrivateJoinedArchivedThreads

getPrivateJoinedArchivedThreads(channelID, options?): Promise<ArchivedThreads<PrivateThreadChannel>>
Get the private joined 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>>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#threads
- Defined in lib/routes/Channels.ts:815

getPublicArchivedThreads

getPublicArchivedThreads<T>(channelID, options?): 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>>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#threads
- Defined in lib/routes/Channels.ts:846

getReactions

getReactions(channelID, messageID, emoji, options?): 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[]>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:878

getStageInstance

getStageInstance(channelID): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:934

getThreadMember

getThreadMember(channelID, userID): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:947

getThreadMembers

getThreadMembers(channelID, options?): 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[]>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:965

getVoiceRegions

getVoiceRegions(): Promise<VoiceRegion[]>
Returns Promise<VoiceRegion[]>

Deprecated
Get the list of usable voice regions. Moved to misc.
- Defined in lib/routes/Channels.ts:995

joinThread

joinThread(channelID): Promise<void>
Join a thread.
Parameters
- channelID: string
  
  The ID of the thread to join.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:1007

leaveThread

leaveThread(channelID): Promise<void>
Leave a thread.
Parameters
- channelID: string
  
  The ID of the thread to leave.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:1019

pinMessage

pinMessage(channelID, messageID, reason?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:1033

purgeMessages

purgeMessages<T>(channelID, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:1047

removeGroupRecipient

removeGroupRecipient(groupID, userID): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:1103

removeThreadMember

removeThreadMember(channelID, userID): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:1116

sendTyping

sendTyping(channelID): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:1128

setVoiceStatus

setVoiceStatus(channelID, status): Promise<void>
Set a voice status in a channel.
Parameters
- channelID: string
  
  The ID of the channel to set the voice status in.
- status: null | string
  
  The voice status to set.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1140

startThreadFromMessage

startThreadFromMessage<T>(channelID, messageID, options): 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>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#threads
- Defined in lib/routes/Channels.ts:1156

startThreadInThreadOnlyChannel

startThreadInThreadOnlyChannel(channelID, options): Promise<PublicThreadChannel>
Create a thread in a thread only channel (forum & media).
Parameters
- channelID: string
  
  The ID of the channel to start the thread in.
- options: StartThreadInThreadOnlyChannelOptions
  
  The options for starting the thread.
Returns Promise<PublicThreadChannel>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#threads
- Defined in lib/routes/Channels.ts:1180

startThreadInThreadOnlyChannl

startThreadInThreadOnlyChannl(channelID, options): Promise<PublicThreadChannel>
Create a thread in a thread only channel (forum & media).
Parameters
- channelID: string
  
  The ID of the channel to start the thread in.
- options: StartThreadInThreadOnlyChannelOptions
  
  The options for starting the thread.
Returns Promise<PublicThreadChannel>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#threads

Deprecated
Use REST/Channels#startThreadInThreadOnlyChannel. This will be removed in 1.9.0.
- Defined in lib/routes/Channels.ts:1219

startThreadWithoutMessage

startThreadWithoutMessage<T>(channelID, options): 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>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#threads
- Defined in lib/routes/Channels.ts:1230

unpinMessage

unpinMessage(channelID, messageID, reason?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Channels.ts:1256

Class REST/Channels

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns REST/Channels

Methods

addGroupRecipient

Parameters

groupID: string

options: AddGroupRecipientOptions

Returns Promise<void>

Caching

addThreadMember

Parameters

channelID: string

userID: string

Returns Promise<void>

Caching

createDM

Parameters

recipient: string

Returns Promise<PrivateChannel>

Caching

Caches

createGroupDM

Parameters

options: CreateGroupChannelOptions

Returns Promise<GroupChannel>

Caching

Caches

createInvite

Type Parameters

T extends InviteInfoTypes

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

Parameters

channelID: string

options: CreateInviteOptions

Returns Promise<Invite<T, CH>>

Caching

createMessage

Type Parameters

T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel

Parameters

channelID: string

options: CreateMessageOptions

Returns Promise<Message<T>>

Caching

Caches

createReaction

Parameters

channelID: string

messageID: string

emoji: string

Returns Promise<void>

Caching

createStageInstance

Parameters

channelID: string

options: CreateStageInstanceOptions

Returns Promise<StageInstance>

Caching

crosspostMessage

Type Parameters

T extends AnnouncementChannel | Uncached = AnnouncementChannel | Uncached

Parameters

channelID: string

messageID: string

Returns Promise<Message<T>>

Caching

Caches

delete

Parameters

channelID: 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